TimescaleTier.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="TimescaleTier.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <system/date_time.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/Visualization/Thickness.h"
#include "aspose.tasks.cpp/Visualization/View/DateTimeConverter.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
namespace Visualization
{
class ApsTimescaleTierBuilder;
class ApsTimescaleTiersCommonSettings;
class ApsUsagePage;
enum class DateLabel;
enum class HorizontalStringAlignment;
enum class TimescaleUnit;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
namespace Visualization {
 
/// <summary>
/// Represents a single tier of the timescale on a Gantt Chart.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS TimescaleTier final : public System::Object
{
    typedef TimescaleTier ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Visualization::ApsUsagePage;
    friend class Aspose::Tasks::Visualization::ApsTimescaleTierBuilder;
    friend class Aspose::Tasks::Visualization::ApsTimescaleTiersCommonSettings;
    
public:
 
    /// <summary>
    /// Gets a callback function for handling rendering date tick in this tier.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Visualization::DateTimeConverter get_DateTimeConverter() const;
    /// <summary>
    /// Sets a callback function for handling rendering date tick in this tier.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DateTimeConverter(Aspose::Tasks::Visualization::DateTimeConverter value);
    /// <summary>
    /// Gets the time unit interval in which to show labels for the tier.
    /// The default value is 1.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const;
    /// <summary>
    /// Sets the time unit interval in which to show labels for the tier.
    /// The default value is 1.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Count(int32_t value);
    /// <summary>
    /// Gets date label <see cref="DateLabel"></see> for the timescale tier. 
    /// </summary>
    ASPOSE_TASKS_SHARED_API DateLabel get_Label() const;
    /// <summary>
    /// Sets date label <see cref="DateLabel"></see> for the timescale tier. 
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Label(DateLabel value);
    /// <summary>
    /// Gets how to align labels within each time period of the tier (<see cref="HorizontalStringAlignment"></see>).
    /// </summary>
    ASPOSE_TASKS_SHARED_API HorizontalStringAlignment get_Alignment() const;
    /// <summary>
    /// Sets how to align labels within each time period of the tier (<see cref="HorizontalStringAlignment"></see>).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Alignment(HorizontalStringAlignment value);
    /// <summary>
    /// Gets a value indicating whether to base the tier labels on the fiscal year.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_UsesFiscalYear() const;
    /// <summary>
    /// Sets a value indicating whether to base the tier labels on the fiscal year.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_UsesFiscalYear(bool value);
    /// <summary>
    /// Gets a value indicating whether whether to show tick marks that separate time periods in the tier.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ShowTicks() const;
    /// <summary>
    /// Sets a value indicating whether whether to show tick marks that separate time periods in the tier.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ShowTicks(bool value);
    /// <summary>
    /// Gets timescale unit <see cref="TimescaleUnit"></see> for the timescale tier.
    /// The default value is <see cref="TimescaleUnit">Days</see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API TimescaleUnit get_Unit() const;
    /// <summary>
    /// Sets timescale unit <see cref="TimescaleUnit"></see> for the timescale tier.
    /// The default value is <see cref="TimescaleUnit">Days</see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Unit(TimescaleUnit value);
    /// <summary>
    /// Gets flag that defines whether date labels should be rendered on each page when a time period spans over several pages.
    /// If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page.
    /// If values is 'false', date label is rendered only once according to a value of <see cref="Alignment"></see> property.
    /// </summary>
    /// <remarks>Doesn't have the equivalent in MS Project.</remarks>
    ASPOSE_TASKS_SHARED_API bool get_RenderLabelOnEachPage() const;
    /// <summary>
    /// Sets flag that defines whether date labels should be rendered on each page when a time period spans over several pages.
    /// If value is 'true', when time period spans over several pages, date labels for the period are rendered on each page.
    /// If values is 'false', date label is rendered only once according to a value of <see cref="Alignment"></see> property.
    /// </summary>
    /// <remarks>Doesn't have the equivalent in MS Project.</remarks>
    ASPOSE_TASKS_SHARED_API void set_RenderLabelOnEachPage(bool value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="TimescaleTier"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API TimescaleTier();
    /// <summary>
    /// Initializes a new instance of the <see cref="TimescaleTier"></see> class.
    /// </summary>
    /// <param name="unit">
    /// The timescale unit <see cref="TimescaleUnit"></see>.
    /// </param>
    /// <param name="count">
    /// The count of <see cref="TimescaleUnit"></see> units.
    /// </param>
    ASPOSE_TASKS_SHARED_API TimescaleTier(TimescaleUnit unit, int32_t count);
    
protected:
 
    ASPOSE_TASKS_SHARED_API Thickness get_LabelMargin() const;
    /// <summary>
    /// Gets days count in one tick
    /// </summary>
    ASPOSE_TASKS_SHARED_API float get_TotalDaysInTick();
    /// <summary>
    /// Gets days count in timescale unit
    /// </summary>
    ASPOSE_TASKS_SHARED_API float get_DaysInUnit();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    int32_t count;
    Aspose::Tasks::Visualization::DateTimeConverter pr_DateTimeConverter;
    DateLabel pr_Label;
    HorizontalStringAlignment pr_Alignment;
    bool pr_UsesFiscalYear;
    bool pr_ShowTicks;
    TimescaleUnit pr_Unit;
    bool pr_RenderLabelOnEachPage;
    Thickness pr_LabelMargin;
    
    ASPOSE_TASKS_SHARED_API void set_LabelMargin(Thickness value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="TimescaleTier"></see> class.
    /// </summary>
    /// <param name="unit">
    /// The timescale unit <see cref="TimescaleUnit"></see>.
    /// </param>
    TimescaleTier(TimescaleUnit unit);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(TimescaleTier, CODEPORTING_ARGS(TimescaleUnit unit));
    
};
 
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose