GanttBarStyle.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="GanttBarStyle.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <system/nullable.h>
#include <drawing/color.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/Visualization/View/Styles/TaskBarTextConverter.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
enum class Field;
namespace IO
{
namespace MSProject
{
class MPP14GanttBarStyleReader;
class MPP14GanttBarStyleWriter;
class MPP9GanttBarStyleReader;
class MPP9GanttBarStyleWriter;
} // namespace MSProject
} // namespace IO
class Task;
namespace Visualization
{
class ApsGanttChartLayoutBuilder;
enum class BarShape;
class BarStyle;
enum class GanttBarEndShape;
enum class GanttBarFillPattern;
enum class GanttBarMiddleShape;
enum class GanttBarShowFor;
enum class GanttBarType;
class GanttChartBarStylesManager;
enum class Shape;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename, typename> class Dictionary;
template <typename> class IList;
} // namespace Generic
} // namespace Collections
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace Visualization {
 
/// <summary>
/// Represents a bar style used by MSP in Gantt Chart view.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS GanttBarStyle : public System::Object
{
    typedef GanttBarStyle ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::MSProject::MPP14GanttBarStyleReader;
    friend class Aspose::Tasks::IO::MSProject::MPP9GanttBarStyleReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14GanttBarStyleWriter;
    friend class Aspose::Tasks::IO::MSProject::MPP9GanttBarStyleWriter;
    friend class Aspose::Tasks::Visualization::GanttChartBarStylesManager;
    friend class Aspose::Tasks::Visualization::ApsGanttChartLayoutBuilder;
    
public:
 
    /// <summary>
    /// Gets data to be displayed on the bottom of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Field get_BottomField() const;
    /// <summary>
    /// Sets data to be displayed on the bottom of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_BottomField(Field value);
    /// <summary>
    /// Gets an end shape of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API GanttBarEndShape get_EndShape() const;
    /// <summary>
    /// Sets an end shape of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_EndShape(GanttBarEndShape value);
    /// <summary>
    /// Gets a color of the end shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::Color get_EndShapeColor() const;
    /// <summary>
    /// Sets a color of the end shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_EndShapeColor(System::Drawing::Color value);
    /// <summary>
    /// Gets a type of the end shape.
    /// <see cref="GanttBarType"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API GanttBarType get_EndShapeType() const;
    /// <summary>
    /// Sets a type of the end shape.
    /// <see cref="GanttBarType"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_EndShapeType(GanttBarType value);
    /// <summary>
    /// Gets a start point position of the gantt bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Field get_From() const;
    /// <summary>
    /// Sets a start point position of the gantt bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_From(Field value);
    /// <summary>
    /// Gets data to be displayed inside of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Field get_InsideField() const;
    /// <summary>
    /// Sets data to be displayed inside of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_InsideField(Field value);
    /// <summary>
    /// Gets data to be displayed on the left of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Field get_LeftField() const;
    /// <summary>
    /// Sets data to be displayed on the left of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_LeftField(Field value);
    /// <summary>
    /// Gets a fill pattern of the gantt bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API GanttBarFillPattern get_MiddleFillPattern() const;
    /// <summary>
    /// Sets a fill pattern of the gantt bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MiddleFillPattern(GanttBarFillPattern value);
    /// <summary>
    /// Gets a middle shape of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API GanttBarMiddleShape get_MiddleShape() const;
    /// <summary>
    /// Sets a middle shape of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MiddleShape(GanttBarMiddleShape value);
    /// <summary>
    /// Gets a color of the middle shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::Color get_MiddleShapeColor() const;
    /// <summary>
    /// Sets a color of the middle shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_MiddleShapeColor(System::Drawing::Color value);
    /// <summary>
    /// Gets a name of the style.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Name() const;
    /// <summary>
    /// Sets a name of the style.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Name(const System::String& value);
    /// <summary>
    /// Gets data to be displayed on the right of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Field get_RightField() const;
    /// <summary>
    /// Sets data to be displayed on the right of the bar.
    /// <see cref="Field"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_RightField(Field value);
    /// <summary>
    /// Gets user-defined converter to get text to render on the left of the task's bar. Overrides the value of <see cref="LeftField"></see> property.
    /// <remarks>Is not persisted to MPP format.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API TaskBarTextConverter get_LeftBarTextConverter() const;
    /// <summary>
    /// Sets user-defined converter to get text to render on the left of the task's bar. Overrides the value of <see cref="LeftField"></see> property.
    /// <remarks>Is not persisted to MPP format.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_LeftBarTextConverter(TaskBarTextConverter value);
    /// <summary>
    /// Gets user-defined  converter to get text to render on the top of the task's bar. Overrides the value of <see cref="TopField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API TaskBarTextConverter get_TopBarTextConverter() const;
    /// <summary>
    /// Sets user-defined  converter to get text to render on the top of the task's bar. Overrides the value of <see cref="TopField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API void set_TopBarTextConverter(TaskBarTextConverter value);
    /// <summary>
    /// Gets user-defined converter to get text to render on the right of the task's bar. Overrides the value of <see cref="RightField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API TaskBarTextConverter get_RightBarTextConverter() const;
    /// <summary>
    /// Sets user-defined converter to get text to render on the right of the task's bar. Overrides the value of <see cref="RightField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API void set_RightBarTextConverter(TaskBarTextConverter value);
    /// <summary>
    /// Gets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of <see cref="BottomField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API TaskBarTextConverter get_BottomBarTextConverter() const;
    /// <summary>
    /// Sets user-defined converter to get text to render on the bottom of the task's bar. Overrides the value of <see cref="BottomField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API void set_BottomBarTextConverter(TaskBarTextConverter value);
    /// <summary>
    /// Gets user-defined converter to get text to render inside of the task's bar. Overrides the value of <see cref="InsideField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API TaskBarTextConverter get_InsideBarTextConverter() const;
    /// <summary>
    /// Sets user-defined converter to get text to render inside of the task's bar. Overrides the value of <see cref="InsideField"></see> property.
    /// </summary>
    /// <remarks>Is not persisted to MPP format.</remarks>
    ASPOSE_TASKS_SHARED_API void set_InsideBarTextConverter(TaskBarTextConverter value);
    /// <summary>
    /// Gets a row number.
    /// <remarks> Can be from 1 to 4 (1 is default value).</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Row() const;
    /// <summary>
    /// Sets a row number.
    /// <remarks> Can be from 1 to 4 (1 is default value).</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Row(int32_t value);
    /// <summary>
    /// Gets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart
    /// (see <see cref="GanttChartView::BarStyles"></see>).
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Collections::Generic::IList<GanttBarShowFor>>& get_ShowForCategories() const;
    /// <summary>
    /// Sets task categories for which the style is applied. Is applicable for parent (or common) styles of bars in Gantt chart
    /// (see <see cref="GanttChartView::BarStyles"></see>).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ShowForCategories(const System::SharedPtr<System::Collections::Generic::IList<GanttBarShowFor>>& value);
    /// <summary>
    /// Gets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see <see cref="GanttChartView::CustomBarStyles"></see>).
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Nullable<int32_t> get_ShowForTaskUid() const;
    /// <summary>
    /// Sets Unique Id of a task for which the style is applied. Is applicable for task-specific styles of bars in Gantt chart (see <see cref="GanttChartView::CustomBarStyles"></see>).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ShowForTaskUid(System::Nullable<int32_t> value);
    /// <summary>
    /// Gets a start shape of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API GanttBarEndShape get_StartShape() const;
    /// <summary>
    /// Sets a start shape of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StartShape(GanttBarEndShape value);
    /// <summary>
    /// Gets a color of the start shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::Color get_StartShapeColor() const;
    /// <summary>
    /// Sets a color of the start shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StartShapeColor(System::Drawing::Color value);
    /// <summary>
    /// Gets a type of the start shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API GanttBarType get_StartShapeType() const;
    /// <summary>
    /// Sets a type of the start shape.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StartShapeType(GanttBarType value);
    /// <summary>
    /// Gets a finish point position of the gantt bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Field get_To() const;
    /// <summary>
    /// Sets a finish point position of the gantt bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_To(Field value);
    /// <summary>
    /// Gets data to be displayed on the top of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Field get_TopField() const;
    /// <summary>
    /// Sets data to be displayed on the top of the bar.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TopField(Field value);
    /// <summary>
    /// Gets parent (or common) style for custom task-specific style.
    /// </summary>
    /// <remarks>
    /// Task can have multiple custom styles with different parent styles. For example consider task having custom style with "Critical" parent style and another style with "Normal" parent style.
    /// Simply put, if task is critical, the first style is applied. If task becomes non-critical, the second style is applied (this logic is inherited from Microsoft Project Professional). 
    /// </remarks>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<GanttBarStyle> get_ParentStyle() const;
    /// <summary>
    /// Sets parent (or common) style for custom task-specific style.
    /// </summary>
    /// <remarks>
    /// Task can have multiple custom styles with different parent styles. For example consider task having custom style with "Critical" parent style and another style with "Normal" parent style.
    /// Simply put, if task is critical, the first style is applied. If task becomes non-critical, the second style is applied (this logic is inherited from Microsoft Project Professional). 
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_ParentStyle(const System::SharedPtr<GanttBarStyle>& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="GanttBarStyle"></see> class.
    /// </summary>
    // ReSharper disable once EmptyConstructor
    ASPOSE_TASKS_SHARED_API GanttBarStyle();
    
protected:
 
    ASPOSE_TASKS_SHARED_API System::Nullable<int16_t> get_Id() const;
    ASPOSE_TASKS_SHARED_API void set_Id(System::Nullable<int16_t> value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="GanttBarStyle"></see> class.
    /// </summary>
    /// <param name="that">The style to copy.</param>
    ASPOSE_TASKS_SHARED_API GanttBarStyle(const System::SharedPtr<GanttBarStyle>& that);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(GanttBarStyle, CODEPORTING_ARGS(const System::SharedPtr<GanttBarStyle>& that));
    ASPOSE_TASKS_SHARED_API bool IsShownFor(const System::String& taskType);
    ASPOSE_TASKS_SHARED_API System::SharedPtr<BarStyle> ToBarStyle();
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    static System::SharedPtr<System::Collections::Generic::Dictionary<GanttBarEndShape, Shape>>& EndShapesTableInternal();
    static System::SharedPtr<System::Collections::Generic::Dictionary<GanttBarMiddleShape, BarShape>>& MiddleShapesTableInternal();
    
    int32_t row;
    System::SharedPtr<GanttBarStyle> parentStyle;
    Field pr_BottomField;
    GanttBarEndShape pr_EndShape;
    System::Drawing::Color pr_EndShapeColor;
    GanttBarType pr_EndShapeType;
    Field pr_From;
    Field pr_InsideField;
    Field pr_LeftField;
    GanttBarFillPattern pr_MiddleFillPattern;
    GanttBarMiddleShape pr_MiddleShape;
    System::Drawing::Color pr_MiddleShapeColor;
    System::String pr_Name;
    Field pr_RightField;
    TaskBarTextConverter pr_LeftBarTextConverter;
    TaskBarTextConverter pr_TopBarTextConverter;
    TaskBarTextConverter pr_RightBarTextConverter;
    TaskBarTextConverter pr_BottomBarTextConverter;
    TaskBarTextConverter pr_InsideBarTextConverter;
    System::SharedPtr<System::Collections::Generic::IList<GanttBarShowFor>> pr_ShowForCategories;
    System::Nullable<int32_t> pr_ShowForTaskUid;
    GanttBarEndShape pr_StartShape;
    System::Drawing::Color pr_StartShapeColor;
    GanttBarType pr_StartShapeType;
    Field pr_To;
    Field pr_TopField;
    System::Nullable<int16_t> pr_Id;
    
    System::String get_DebuggerDisplay();
    bool get_IsParentStyle();
    
    static System::SharedPtr<System::Collections::Generic::Dictionary<GanttBarEndShape, Shape>> InitEndShapesTable();
    static System::SharedPtr<System::Collections::Generic::Dictionary<GanttBarMiddleShape, BarShape>> InitMiddleShapesTable();
    
};
 
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose