ViewCollection.h

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

#include <system/collections/icollection.h>
#include <system/array.h>
#include <cstdint>

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

namespace Aspose
{
namespace Tasks
{
namespace IO
{
namespace MSProject
{
class MPPReader;
class MppViewWriter;
} // namespace MSProject
} // namespace IO
class Project;
class View;
enum class ViewScreen;
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IEnumerator;
template <typename> class List;
template <typename, typename> class SortedList;
} // namespace Generic
} // namespace Collections
} // namespace System

namespace Aspose {

namespace Tasks {

/// <summary>
/// Contains a list of <see cref="View"></see> objects.
/// Implements ICollection&lt;View&gt; interface.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ViewCollection : public System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Tasks::View>>
{
    typedef ViewCollection ThisType;
    typedef System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Tasks::View>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Project;
    friend class Aspose::Tasks::IO::MSProject::MPPReader;
    friend class Aspose::Tasks::IO::MSProject::MppViewWriter;
    
public:

    /// <summary>
    /// Gets the number of elements contained in this collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_Count() const override;
    /// <summary>
    /// Gets a value indicating whether this collection is read-only; otherwise, false.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IsReadOnly() const override;
    /// <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>
    /// Returns an enumerator for this collection.
    /// </summary>
    /// <returns>an enumerator for this collection.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<View>>> GetEnumerator() override;
    /// <summary>
    /// Adds the specified item to this collection.
    /// </summary>
    /// <param name="item">the specified item to add to this collection.</param>
    ASPOSE_TASKS_SHARED_API void Add(const System::SharedPtr<View>& item) override;
    /// <summary>
    /// Removes all items from this collection.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void Clear() override;
    /// <summary>
    /// Returns true if the specified item is found in this collection; otherwise, false.
    /// </summary>
    /// <param name="item">the specified item to find.</param>
    /// <returns>true if the specified item is found in this collection; otherwise, false.</returns>
    ASPOSE_TASKS_SHARED_API bool Contains(const System::SharedPtr<View>& item) const override;
    /// <summary>
    /// Copies the elements of this collection to the specified array, starting at the specified array index.
    /// </summary>
    /// <param name="array">the specified one-dimensional array to copy elements to</param>
    /// <param name="arrayIndex">the zero-based index of the specified array at which copying begins.</param>
    ASPOSE_TASKS_SHARED_API void CopyTo(System::ArrayPtr<System::SharedPtr<View>> array, int32_t arrayIndex) override;
    /// <summary>
    /// Removes the first occurrence of a specific object from this collection.
    /// </summary>
    /// <param name="item">the specified object to remove.</param>
    /// <returns>true if the specified object was successfully removed from this collection; otherwise, false.</returns>
    ASPOSE_TASKS_SHARED_API bool Remove(const System::SharedPtr<View>& item) override;
    /// <summary>
    /// Converts a view collection to a list of <see cref="View"></see> objects.
    /// </summary>
    /// <returns>Generic list of <see cref="View"></see> objects.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<View>>> ToList();
    /// <summary>
    /// Searches for a View with the specified Screen property, and returns the first occurrence within the collection.
    /// </summary>
    /// <param name="screen"><see cref="ViewScreen"></see> enumeration value.</param>
    /// <returns>The first View in collection which Screen property matches the specified screen argument, if found; otherwise, null.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<View> GetByViewScreen(ViewScreen screen);
    /// <summary>
    /// Searches for a View with the name, and returns the first occurrence within the collection.
    /// </summary>
    /// <param name="viewName">Name of the View to search.</param>
    /// <returns>The first View in collection with the specified name, if found; otherwise, null.</returns>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<View> GetByName(const System::String& viewName);
    
protected:

    /// <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>
    /// Initializes a new instance of the <see cref="ViewCollection"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ViewCollection(const System::SharedPtr<Project>& parentProject);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ViewCollection, CODEPORTING_ARGS(const System::SharedPtr<Project>& parentProject));
    ASPOSE_TASKS_SHARED_API System::SharedPtr<View> GetByIndex(int32_t index);
    ASPOSE_TASKS_SHARED_API void SetViewUid(int32_t oldUid, int32_t newUid);
    
    virtual ASPOSE_TASKS_SHARED_API ~ViewCollection();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:

    System::SharedPtr<System::Collections::Generic::SortedList<int32_t, System::SharedPtr<View>>> views;
    System::WeakPtr<Project> pr_ParentProject;
    
};

} // namespace Tasks
} // namespace Aspose