VbaModule.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="VbaModule.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/Vba/IVbaModule.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Vba
{
class VbaModuleReader;
class VbaModuleSourceCodeWriter;
class VbaProjectFolderBuilder;
class VbaProjectWriter;
} // namespace Vba
class VbaInternalModule;
class VbaModuleAttributeCollection;
class VbaModuleCollection;
enum class VbaModuleType;
class VbaProject;
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a VBA module.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS VbaModule final : public Aspose::Tasks::IVbaModule
{
    typedef VbaModule ThisType;
    typedef Aspose::Tasks::IVbaModule BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Vba::VbaProjectFolderBuilder;
    friend class Aspose::Tasks::Vba::VbaProjectWriter;
    friend class Aspose::Tasks::Vba::VbaModuleSourceCodeWriter;
    friend class Aspose::Tasks::Vba::VbaModuleReader;
    friend class Aspose::Tasks::VbaInternalModule;
    friend class Aspose::Tasks::VbaModuleCollection;
    friend class Aspose::Tasks::VbaProject;
    
public:
 
    /// <summary>
    /// Gets a collection of the module's attributes.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<VbaModuleAttributeCollection> get_Attributes() override;
    /// <summary>
    /// Gets a name of the VBA module
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Name() override;
    /// <summary>
    /// Gets a name of the VBA module
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Name(const System::String& value);
    /// <summary>
    /// Gets the type of the module.
    /// </summary>
    ASPOSE_TASKS_SHARED_API VbaModuleType get_Type() const;
    /// <summary>
    /// Gets a source code of the VBA module
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_SourceCode() override;
    /// <summary>
    /// Sets a source code of the VBA module
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_SourceCode(const System::String& value);
    
    /// <summary>
    /// Creates an instance of <see cref="VbaModule"></see> with VbaModuleType.ProceduralModule type.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<VbaModule> CreateProceduralModule(const System::String& name);
    /// <summary>
    /// Creates an instance of <see cref="VbaModule"></see> with VbaModuleType.ClassModule type.
    /// </summary>
    static ASPOSE_TASKS_SHARED_API System::SharedPtr<VbaModule> CreateClassModule(const System::String& name);
    
protected:
 
    /// <summary>
    /// Gets a collection of the module's attributes.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Attributes(const System::SharedPtr<VbaModuleAttributeCollection>& value);
    /// <summary>
    /// Gets the type of the module.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Type(VbaModuleType value);
    ASPOSE_TASKS_SHARED_API bool get_Modified() const;
    ASPOSE_TASKS_SHARED_API void set_Modified(bool value);
    ASPOSE_TASKS_SHARED_API bool get_IsNew() const;
    ASPOSE_TASKS_SHARED_API void set_IsNew(bool value);
    ASPOSE_TASKS_SHARED_API int32_t get_Offset() const;
    ASPOSE_TASKS_SHARED_API void set_Offset(int32_t value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="VbaModule"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API VbaModule();
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(VbaModule, CODEPORTING_ARGS());
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::String sourceCode;
    System::String name;
    System::SharedPtr<VbaModuleAttributeCollection> pr_Attributes;
    VbaModuleType pr_Type;
    bool pr_Modified;
    bool pr_IsNew;
    int32_t pr_Offset;
    
    static void ValidateModuleName(const System::String& name);
    
};
 
} // namespace Tasks
} // namespace Aspose