GroupCriterion.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="GroupCriterion.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------

#include <system/object.h>
#include <system/guid.h>
#include <drawing/color.h>
#include <cstdint>

#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"

namespace Aspose
{
namespace Tasks
{
enum class BackgroundPattern;
enum class Field;
class Group;
class GroupCriterionCollection;
enum class GroupOn;
namespace Visualization
{
class FontDescriptor;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose

namespace Aspose {

namespace Tasks {

/// <summary>
/// Represents a criterion in a group definition.
/// The GroupCriterion object is a member of the <see cref="GroupCriterionCollection"></see> collection.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS GroupCriterion : public System::Object
{
    typedef GroupCriterion ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::GroupCriterionCollection;
    
public:

    /// <summary>
    /// Gets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order. False if the field is sorted in descending order.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_Ascending() const;
    /// <summary>
    /// Sets a value indicating whether a field used as a criterion in a group definition is sorted in ascending order. False if the field is sorted in descending order.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Ascending(bool value);
    /// <summary>
    /// Gets the color of the cell background for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::Color get_CellColor() const;
    /// <summary>
    /// Sets the color of the cell background for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_CellColor(System::Drawing::Color value);
    /// <summary>
    /// Gets the color of the font for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::Color get_FontColor() const;
    /// <summary>
    /// Sets the color of the font for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FontColor(System::Drawing::Color value);
    /// <summary>
    /// Gets the field being grouped by.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Field get_Field() const;
    /// <summary>
    /// Sets the field being grouped by.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Field(Aspose::Tasks::Field value);
    /// @deprecated This member is obsolete and will be removed after release 25.6.
    /// <summary>
    /// Gets the index of a <see cref="GroupCriterion"></see> object in the containing <see cref="GroupCriterionCollection"></see> collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Index() const;
    /// @deprecated This member is obsolete and will be removed after release 25.6.
    /// <summary>
    /// Gets the parent of the <see cref="GroupCriterion"></see> object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Group>& get_ParentGroup() const;
    /// <summary>
    /// Gets the type of grouping for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::GroupOn get_GroupOn() const;
    /// <summary>
    /// Sets the type of grouping for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_GroupOn(Aspose::Tasks::GroupOn value);
    /// <summary>
    /// Gets the pattern of the cell for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API BackgroundPattern get_Pattern() const;
    /// <summary>
    /// Sets the pattern of the cell for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Pattern(BackgroundPattern value);
    /// <summary>
    /// Gets the start of the intervals for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Object>& get_StartAt() const;
    /// <summary>
    /// Sets the start of the intervals for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_StartAt(const System::SharedPtr<System::Object>& value);
    /// <summary>
    /// Gets the interval for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Object>& get_GroupInterval() const;
    /// <summary>
    /// Sets the interval for a field used as a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_GroupInterval(const System::SharedPtr<System::Object>& value);
    /// <summary>
    /// Gets the font for a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Visualization::FontDescriptor>& get_Font() const;
    /// <summary>
    /// Sets the font for a criterion in a group definition.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Font(const System::SharedPtr<Visualization::FontDescriptor>& value);
    
    /// <summary>
    /// Returns a value indicating whether this instance is equal to a specified object.
    /// </summary>
    /// <param name="obj">The object to compare with this instance.</param>
    /// <returns><b>True</b> if o is a GroupCriterion that has the same UID value as this instance; otherwise, <b>false</b>.</returns>
    ASPOSE_TASKS_SHARED_API bool Equals(System::SharedPtr<System::Object> obj) override;
    /// <summary>Serves as a hash function for a particular type. </summary>
    /// <returns>A hash code for the current <see cref="System::Object"></see>.</returns>
    ASPOSE_TASKS_SHARED_API int32_t GetHashCode() const override;
    
    ASPOSE_TASKS_SHARED_API GroupCriterion();
    
protected:

    /// @deprecated This member is obsolete and will be removed after release 25.6.
    /// <summary>
    /// Gets the index of a <see cref="GroupCriterion"></see> object in the containing <see cref="GroupCriterionCollection"></see> collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Index(int32_t value);
    /// @deprecated This member is obsolete and will be removed after release 25.6.
    /// <summary>
    /// Gets the parent of the <see cref="GroupCriterion"></see> object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ParentGroup(const System::SharedPtr<Group>& value);
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:

    System::Guid guid;
    bool pr_Ascending;
    System::Drawing::Color pr_CellColor;
    System::Drawing::Color pr_FontColor;
    Aspose::Tasks::Field pr_Field;
    int32_t pr_Index;
    System::WeakPtr<Group> pr_ParentGroup;
    Aspose::Tasks::GroupOn pr_GroupOn;
    BackgroundPattern pr_Pattern;
    System::SharedPtr<System::Object> pr_StartAt;
    System::SharedPtr<System::Object> pr_GroupInterval;
    System::SharedPtr<Visualization::FontDescriptor> pr_Font;
    
};

} // namespace Tasks
} // namespace Aspose