View.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="View.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <system/icomparable.h>
#include <system/guid.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class Filter;
class GanttChartView;
class Group;
namespace IO
{
namespace MSProject
{
class MPP12Reader;
class MPP12ViewReader;
class Mpp12ViewWriter;
class MPP14Reader;
class MPP9Reader;
class MppFolderBinaryStructure;
class MPPGanttBarStyleWriter;
class MppOleObjectWriter;
class MppSavedViewStateWriter;
class MppViewPropsInitializer;
class MPPViewReader;
class MppViewWriter;
class MppVisualObjectPlacementReader;
class TimelineViewWriter;
namespace Writers
{
class MppVisualObjectPlacementWriter;
} // namespace Writers
} // namespace MSProject
namespace Pwa
{
namespace InternalApi
{
namespace Mapping
{
class ProjectViewsMapper;
} // namespace Mapping
} // namespace InternalApi
} // namespace Pwa
} // namespace IO
enum class ItemType;
class OleObject;
class Project;
class ResourceUsageView;
namespace Saving
{
class LayoutBuilderFactory;
class SaveOptions;
} // namespace Saving
class Table;
class TaskUsageView;
class TimelineView;
class UsageView;
class ViewCollection;
enum class ViewScreen;
namespace Visualization
{
template <typename> class ApsBaseChartBuilder;
class PageInfo;
class ProjectView;
class VisualObjectPlacement;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IEnumerable;
template <typename> class List;
} // namespace Generic
} // namespace Collections
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Represents a view in Project.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS View : public System::IComparable<System::SharedPtr<Aspose::Tasks::View>>
{
    typedef View ThisType;
    typedef System::IComparable<System::SharedPtr<Aspose::Tasks::View>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::IO::MSProject::MppVisualObjectPlacementReader;
    friend class Aspose::Tasks::IO::MSProject::Writers::MppVisualObjectPlacementWriter;
    friend class Aspose::Tasks::IO::MSProject::MppViewPropsInitializer;
    friend class Aspose::Tasks::IO::Pwa::InternalApi::Mapping::ProjectViewsMapper;
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::IO::MSProject::MppOleObjectWriter;
    friend class Aspose::Tasks::GanttChartView;
    friend class Aspose::Tasks::IO::MSProject::MPP12Reader;
    friend class Aspose::Tasks::IO::MSProject::MPP14Reader;
    friend class Aspose::Tasks::IO::MSProject::MPP9Reader;
    friend class Aspose::Tasks::IO::MSProject::MPP12ViewReader;
    friend class Aspose::Tasks::IO::MSProject::MPPViewReader;
    friend class Aspose::Tasks::IO::MSProject::MppSavedViewStateWriter;
    friend class Aspose::Tasks::IO::MSProject::Mpp12ViewWriter;
    friend class Aspose::Tasks::IO::MSProject::MppViewWriter;
    friend class Aspose::Tasks::IO::MSProject::MPPGanttBarStyleWriter;
    friend class Aspose::Tasks::IO::MSProject::TimelineViewWriter;
    friend class Aspose::Tasks::OleObject;
    friend class Aspose::Tasks::ResourceUsageView;
    friend class Aspose::Tasks::UsageView;
    friend class Aspose::Tasks::Saving::SaveOptions;
    friend class Aspose::Tasks::Saving::LayoutBuilderFactory;
    friend class Aspose::Tasks::TaskUsageView;
    friend class Aspose::Tasks::TimelineView;
    friend class Aspose::Tasks::ViewCollection;
    template<typename FT0> friend class Aspose::Tasks::Visualization::ApsBaseChartBuilder;
    friend class Aspose::Tasks::Visualization::ProjectView;
    friend ASPOSE_TASKS_SHARED_API bool operator ==(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator !=(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator <(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator >(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator >=(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
    friend ASPOSE_TASKS_SHARED_API bool operator <=(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
    
public:
 
    /// <summary>
    /// Gets a filter used in a single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Filter> get_Filter();
    /// <summary>
    /// Sets a filter used in a single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Filter(const System::SharedPtr<Aspose::Tasks::Filter>& value);
    /// <summary>
    /// Gets a group of the single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Group> get_Group();
    /// <summary>
    /// Sets a group of the single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Group(const System::SharedPtr<Aspose::Tasks::Group>& value);
    /// <summary>
    /// Gets the unique identifier of a view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Uid() const;
    /// <summary>
    /// Gets a value indicating whether Microsoft Project highlights the filter for a single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_HighlightFilter() const;
    /// <summary>
    /// Sets a value indicating whether Microsoft Project highlights the filter for a single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_HighlightFilter(bool value);
    /// <summary>
    /// Gets the name of a View object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_Name() const;
    /// <summary>
    /// Sets the name of a View object.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Name(const System::String& value);
    /// <summary>
    /// Gets the screen type for the single view.
    /// Read-only <see cref="ViewScreen"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ViewScreen get_Screen() const;
    /// <summary>
    /// Gets the parent of the View object.
    /// Read-only <see cref="Project"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<Project>& get_ParentProject() const;
    /// <summary>
    /// Gets a table of the single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Table> get_Table();
    /// <summary>
    /// Sets a table of the single view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Table(const System::SharedPtr<Aspose::Tasks::Table>& value);
    /// <summary>
    /// Gets the type of item in the single view, such as tasks or resources.
    /// Read-only <see cref="ItemType"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ItemType get_Type() const;
    /// <summary>
    /// Gets a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ShowInMenu() const;
    /// <summary>
    /// Sets a value indicating whether Microsoft Project shows the single view name in the View or the Other Views drop-down lists in the Ribbon.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ShowInMenu(bool value);
    /// <summary>
    /// Gets an instance of the <see cref="PageInfo"></see> class. Represents page setup data which is present in mpp file format.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::Visualization::PageInfo> get_PageInfo() const;
    /// <summary>
    /// Gets a collection of objects representing placement and appearance of <see cref="OleObject"></see> in the view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Visualization::VisualObjectPlacement>>> get_VisualObjectsPlacements();
    
    /// <summary>
    /// Initializes a new instance of the <see cref="View"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API View();
    /// <summary>
    /// Initializes a new instance of the <see cref="View"></see> class.
    /// </summary>
    /// <param name="viewScreen">The screen type for which the view can be displayed.</param>
    ASPOSE_TASKS_SHARED_API View(ViewScreen viewScreen);
    
    /// <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 the specified object is  a View 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>
    /// Returns a hash code value for the instance of the <see cref="Resource"></see> class.
    /// </summary>
    /// <returns>returns a hash code value for this object.</returns>
    ASPOSE_TASKS_SHARED_API int32_t GetHashCode() const override;
    /// <summary>
    /// Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object.
    /// </summary>
    /// <returns>
    /// A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: Value Meaning Less than zero This instance precedes <paramref name="other"></paramref> in the sort order. Zero This instance occurs in the same position in the sort order as <paramref name="other"></paramref>. Greater than zero This instance follows <paramref name="other"></paramref> in the sort order.
    /// </returns>
    /// <param name="other">the specified View object to compare this instance to. </param>
    ASPOSE_TASKS_SHARED_API int32_t CompareTo(System::SharedPtr<View> other) override;
    
protected:
 
    /// <summary>
    /// Gets the unique identifier of a view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Uid(int32_t value);
    /// <summary>
    /// Gets the screen type for the single view.
    /// Read-only <see cref="ViewScreen"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Screen(ViewScreen value);
    /// <summary>
    /// Gets the parent of the View object.
    /// Read-only <see cref="Project"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ParentProject(const System::SharedPtr<Project>& value);
    /// <summary>
    /// Gets the type of item in the single view, such as tasks or resources.
    /// Read-only <see cref="ItemType"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Type(ItemType value);
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Visualization::VisualObjectPlacement>>>& get_VisualObjectsPlacementsInternal() const;
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Visualization::VisualObjectPlacement>>>& get_VisualObjectsPlacementsDrawingObjects() const;
    ASPOSE_TASKS_SHARED_API System::Guid get_Guid() const;
    ASPOSE_TASKS_SHARED_API void set_Guid(System::Guid value);
    /// <summary>
    /// Gets the X position of the Chart (Gantt Chart for GanttChart View or Usage section for Task\Resource Usage views).
    /// </summary>
    ASPOSE_TASKS_SHARED_API int16_t get_ChartXPosition() const;
    /// <summary>
    /// Sets the X position of the Chart (Gantt Chart for GanttChart View or Usage section for Task\Resource Usage views).
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ChartXPosition(int16_t value);
    ASPOSE_TASKS_SHARED_API System::String get_DefaultTableName() const;
    ASPOSE_TASKS_SHARED_API void set_DefaultTableName(const System::String& value);
    ASPOSE_TASKS_SHARED_API System::String get_DefaultFilterName() const;
    ASPOSE_TASKS_SHARED_API void set_DefaultFilterName(const System::String& value);
    ASPOSE_TASKS_SHARED_API System::String get_DefaultGroupName() const;
    ASPOSE_TASKS_SHARED_API void set_DefaultGroupName(const System::String& value);
    /// <summary>
    /// Gets the original mpp data.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<IO::MSProject::MppFolderBinaryStructure>& get_BinaryStruct() const;
    /// <summary>
    /// Sets the original mpp data.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_BinaryStruct(const System::SharedPtr<IO::MSProject::MppFolderBinaryStructure>& value);
    
    ASPOSE_TASKS_SHARED_API View(int32_t uid);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(View, CODEPORTING_ARGS(int32_t uid));
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::SharedPtr<Aspose::Tasks::Visualization::PageInfo> pageInfo;
    int32_t uid;
    System::SharedPtr<Aspose::Tasks::Filter> filter;
    System::SharedPtr<Aspose::Tasks::Table> table;
    System::SharedPtr<Aspose::Tasks::Group> group;
    System::String defaultTableName;
    bool pr_HighlightFilter;
    System::String pr_Name;
    ViewScreen pr_Screen;
    System::WeakPtr<Project> pr_ParentProject;
    ItemType pr_Type;
    bool pr_ShowInMenu;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Visualization::VisualObjectPlacement>>> pr_VisualObjectsPlacementsInternal;
    
    ASPOSE_TASKS_SHARED_API void set_VisualObjectsPlacementsInternal(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Visualization::VisualObjectPlacement>>>& value);
    
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Visualization::VisualObjectPlacement>>> pr_VisualObjectsPlacementsDrawingObjects;
    
    ASPOSE_TASKS_SHARED_API void set_VisualObjectsPlacementsDrawingObjects(const System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Visualization::VisualObjectPlacement>>>& value);
    
    System::Guid pr_Guid;
    int16_t pr_ChartXPosition;
    System::String pr_DefaultFilterName;
    System::String pr_DefaultGroupName;
    System::SharedPtr<IO::MSProject::MppFolderBinaryStructure> pr_BinaryStruct;
    
    System::String get_DebuggerDisplay();
    
};
 
ASPOSE_TASKS_SHARED_API bool operator ==(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
ASPOSE_TASKS_SHARED_API bool operator !=(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
ASPOSE_TASKS_SHARED_API bool operator <(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
ASPOSE_TASKS_SHARED_API bool operator >(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
ASPOSE_TASKS_SHARED_API bool operator >=(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
ASPOSE_TASKS_SHARED_API bool operator <=(const System::SharedPtr<View>& a, const System::SharedPtr<View>& b);
 
} // namespace Tasks
} // namespace Aspose