Filter.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="Filter.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <system/iequatable.h>
#include <system/icomparable.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class FilterCollection;
class FilterCriteria;
namespace IO
{
namespace MSProject
{
class MPP14GanttChartReader;
class MPP9GanttChartReader;
class MPPFilterReader;
class MPPFilterWriter;
} // namespace MSProject
} // namespace IO
enum class ItemType;
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a filter in Project.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS Filter final : public System::IComparable<System::SharedPtr<Aspose::Tasks::Filter>>, public System::IEquatable<System::SharedPtr<Aspose::Tasks::Filter>>
{
    typedef Filter ThisType;
    typedef System::IComparable<System::SharedPtr<Aspose::Tasks::Filter>> BaseType;
    typedef System::IEquatable<System::SharedPtr<Aspose::Tasks::Filter>> BaseType1;
    
    typedef ::System::BaseTypesInfo<BaseType, BaseType1> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::MSProject::MPPFilterWriter;
    friend class Aspose::Tasks::FilterCollection;
    friend class Aspose::Tasks::IO::MSProject::MPP9GanttChartReader;
    friend class Aspose::Tasks::IO::MSProject::MPPFilterReader;
    friend class Aspose::Tasks::IO::MSProject::MPP14GanttChartReader;
    friend ASPOSE_TASKS_SHARED_API bool operator ==(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator !=(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator <(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator >(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator >=(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator <=(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
    
public:
 
    /// <summary>
    /// Gets the type of the filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ItemType get_FilterType() const;
    /// <summary>
    /// Gets the type of the filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FilterType(ItemType value);
    /// <summary>
    /// Gets the name of a Filter object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Name() const;
    /// <summary>
    /// Sets the name of a Filter object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Name(const System::String& value);
    /// <summary>
    /// Gets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ShowInMenu() const;
    /// <summary>
    /// Sets a value indicating whether project shows the filter name in the Filter drop-down list on the View tab of the Ribbon.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ShowInMenu(bool value);
    /// <summary>
    /// Gets a value indicating whether related summary rows are displayed for the filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ShowRelatedSummaryRows() const;
    /// <summary>
    /// Sets a value indicating whether related summary rows are displayed for the filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ShowRelatedSummaryRows(bool value);
    /// <summary>
    /// Gets the index of a <see cref="Filter"></see> object in the Filters containing object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Index() const;
    /// <summary>
    /// Gets the unique identifier of a filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Uid() const;
    /// <summary>
    /// Gets the criteria that tasks or resources must meet to be displayed in MSP view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<FilterCriteria>& get_Criteria() const;
    /// <summary>
    /// Sets the criteria that tasks or resources must meet to be displayed in MSP view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Criteria(const System::SharedPtr<FilterCriteria>& value);
    
    /// <summary>
    /// Compares this instance to the specified instance of the <see cref="Filter"></see> class and returns an indication of their relative order.
    /// </summary>
    /// <param name="other">the specified instance of the <see cref="Filter"></see> class to compare to this object.</param>
    /// <returns>an indication of their relative order.</returns>
    ASPOSE_TASKS_SHARED_API int32_t CompareTo(System::SharedPtr<Filter> other) override;
    /// <summary>
    /// Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
    /// </summary>
    /// <param name="other">the specified AssignmentBaseline object to compare with this instance.</param>
    /// <returns>returns true if this instance is equal to the specified AssignmentBaseline object; otherwise, false.</returns>
    ASPOSE_TASKS_SHARED_API bool Equals(System::SharedPtr<Filter> other) override;
    /// <summary>
    /// Returns a value indicating whether this instance is equal to the specified AssignmentBaseline object.
    /// </summary>
    /// <param name="obj">the specified AssignmentBaseline object to compare with this instance.</param>
    /// <returns>returns true if this instance is equal to the specified AssignmentBaseline object; otherwise, false.</returns>
    ASPOSE_TASKS_SHARED_API bool Equals(System::SharedPtr<System::Object> obj) override;
    /// <summary>
    /// Returns a hash code value for the filter.
    /// </summary>
    /// <returns>returns a hash code value for this object.</returns>
    ASPOSE_TASKS_SHARED_API int32_t GetHashCode() const override;
    
    ASPOSE_TASKS_SHARED_API Filter();
    
protected:
 
    /// <summary>
    /// Gets the index of a <see cref="Filter"></see> object in the Filters containing object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Index(int32_t value);
    /// <summary>
    /// Gets the unique identifier of a filter.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Uid(int32_t value);
    
    virtual ASPOSE_TASKS_SHARED_API ~Filter();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    static const int32_t MaxNameLength;
    System::String name;
    ItemType pr_FilterType;
    bool pr_ShowInMenu;
    bool pr_ShowRelatedSummaryRows;
    int32_t pr_Index;
    int32_t pr_Uid;
    System::SharedPtr<FilterCriteria> pr_Criteria;
    
    System::String get_DebuggerDisplay();
    
    System::String GetFilterTypeString();
    
};
 
ASPOSE_TASKS_SHARED_API bool operator ==(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
ASPOSE_TASKS_SHARED_API bool operator !=(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
ASPOSE_TASKS_SHARED_API bool operator <(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
ASPOSE_TASKS_SHARED_API bool operator >(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
ASPOSE_TASKS_SHARED_API bool operator >=(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
ASPOSE_TASKS_SHARED_API bool operator <=(const System::SharedPtr<Filter>& a, const System::SharedPtr<Filter>& b);
 
} // namespace Tasks
} // namespace Aspose