HtmlSaveOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="HtmlSaveOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/string.h>
#include <system/enum_helpers.h>
#include <cstdint>
 
#include "aspose.tasks.cpp/Saving/ICloneableSaveOptions.h"
#include "aspose.tasks.cpp/Saving/SaveOptions.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Builder
{
namespace HTML
{
namespace Builders
{
class HtmlBuilderOptions;
} // namespace Builders
class Html5BuilderOptions;
} // namespace HTML
} // namespace Builder
namespace Tasks
{
enum class FontFaceType;
class FontSettings;
class ICssSavingCallback;
class IFontSavingCallback;
class IImageSavingCallback;
class IWriter;
enum class ResourceExportType;
namespace Saving
{
class HtmlWriter;
class IPageSavingCallback;
class SaveOptions;
} // namespace Saving
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class List;
} // namespace Generic
} // namespace Collections
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace Saving {
 
/// <summary>
/// Allows to specify additional options when rendering project pages to HTML.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS HtmlSaveOptions : public Aspose::Tasks::Saving::SaveOptions, public Aspose::Tasks::Saving::SaveOptions::IReduceBottomGap, public Aspose::Tasks::Saving::SaveOptions::IFontCallbacks, public Aspose::Tasks::Saving::ICloneableSaveOptions
{
    typedef HtmlSaveOptions ThisType;
    typedef Aspose::Tasks::Saving::SaveOptions BaseType;
    typedef Aspose::Tasks::Saving::SaveOptions::IReduceBottomGap BaseType1;
    typedef Aspose::Tasks::Saving::SaveOptions::IFontCallbacks BaseType2;
    typedef Aspose::Tasks::Saving::ICloneableSaveOptions BaseType3;
    
    typedef ::System::BaseTypesInfo<BaseType, BaseType1, BaseType2, BaseType3> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Saving::HtmlWriter;
    
public:
 
    /// <summary>
    /// Gets CSS style prefix.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_CssStylePrefix() const;
    /// <summary>
    /// Sets CSS style prefix.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_CssStylePrefix(const System::String& value);
    /// <summary>
    /// Specifies font settings used when rendering project's view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::FontSettings> get_FontSettings() override;
    /// <summary>
    /// Gets a value indicating whether a gap between last task and the footer must be reduced.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_ReduceFooterGap() override;
    /// <summary>
    /// Sets a value indicating whether a gap between last task and the footer must be reduced.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ReduceFooterGap(bool value);
    /// <summary>
    /// Gets a value indicating whether to include project name in HTML page header.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IncludeProjectNameInPageHeader() const;
    /// <summary>
    /// Sets a value indicating whether to include project name in HTML page header.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_IncludeProjectNameInPageHeader(bool value);
    /// <summary>
    /// Gets a value indicating whether to include project name in HTML title.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_IncludeProjectNameInTitle() const;
    /// <summary>
    /// Sets a value indicating whether to include project name in HTML title.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_IncludeProjectNameInTitle(bool value);
    /// <summary>
    /// Gets a list of page numbers to save when rendering project layout.
    /// <remarks>All project pages will be saved if this list is empty.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<System::Collections::Generic::List<int32_t>> get_Pages();
    /// <summary>
    /// Sets a list of page numbers to save when rendering project layout.
    /// <remarks>All project pages will be saved if this list is empty.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Pages(const System::SharedPtr<System::Collections::Generic::List<int32_t>>& value);
    /// <summary>
    /// Gets the way CSS are exported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ResourceExportType get_ExportCss() const;
    /// <summary>
    /// Sets the way CSS are exported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ExportCss(ResourceExportType value);
    /// <summary>
    /// Gets the way images are exported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ResourceExportType get_ExportImages() const;
    /// <summary>
    /// Sets the way images are exported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ExportImages(ResourceExportType value);
    /// <summary>
    /// Gets the way fonts are exported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API ResourceExportType get_ExportFonts() const;
    /// <summary>
    /// Sets the way fonts are exported.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ExportFonts(ResourceExportType value);
    /// <summary>
    /// Gets the callback that is called to create resource to store CSS.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<ICssSavingCallback>& get_CssSavingCallback() const;
    /// <summary>
    /// Sets the callback that is called to create resource to store CSS.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_CssSavingCallback(const System::SharedPtr<ICssSavingCallback>& value);
    /// <summary>
    /// Gets the callback that is called to create resource to store font.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<IFontSavingCallback>& get_FontSavingCallback() const;
    /// <summary>
    /// Sets the callback that is called to create resource to store font.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FontSavingCallback(const System::SharedPtr<IFontSavingCallback>& value);
    /// <summary>
    /// Gets the callback that is called to create resource to store font.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<IImageSavingCallback>& get_ImageSavingCallback() const;
    /// <summary>
    /// Sets the callback that is called to create resource to store font.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_ImageSavingCallback(const System::SharedPtr<IImageSavingCallback>& value);
    /// <summary>
    /// Gets the font face types.
    /// </summary>
    /// <value>
    /// The font face types.
    /// </value>
    ASPOSE_TASKS_SHARED_API FontFaceType get_FontFaceTypes() const;
    /// <summary>
    /// Sets the font face types.
    /// </summary>
    /// <value>
    /// The font face types.
    /// </value>
    ASPOSE_TASKS_SHARED_API void set_FontFaceTypes(FontFaceType value);
    /// <summary>
    /// Gets a value indicating whether to use gradient brush when rendering project layout.
    /// <remarks>Currently using of gradient brush is not supported when rendering to HTML.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_UseGradientBrush() override;
    /// <summary>
    /// Sets a value indicating whether to use gradient brush when rendering project layout.
    /// <remarks>Currently using of gradient brush is not supported when rendering to HTML.</remarks>
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_UseGradientBrush(bool value) override;
    /// <summary>
    /// Gets a user-defined callback which is used to get an output stream for each rendered page.
    /// </summary>
    ASPOSE_TASKS_SHARED_API const System::SharedPtr<IPageSavingCallback>& get_PageSavingCallback() const;
    /// <summary>
    /// Sets a user-defined callback which is used to get an output stream for each rendered page.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PageSavingCallback(const System::SharedPtr<IPageSavingCallback>& value);
    
    /// <summary>
    /// Initializes a new instance of the <see cref="HtmlSaveOptions"></see> class.
    /// </summary>
    ASPOSE_TASKS_SHARED_API HtmlSaveOptions();
    
protected:
 
    ASPOSE_TASKS_SHARED_API System::SharedPtr<IWriter> GetWriter() override;
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Builder::HTML::Html5BuilderOptions> GetHtmlConverterOptions();
    
    virtual ASPOSE_TASKS_SHARED_API ~HtmlSaveOptions();
    
    #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::List<int32_t>> pages;
    System::String pr_CssStylePrefix;
    System::SharedPtr<Aspose::Tasks::FontSettings> pr_FontSettings;
    
    /// <summary>
    /// Specifies font settings used when rendering project's view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FontSettings(const System::SharedPtr<Aspose::Tasks::FontSettings>& value);
    
    bool pr_ReduceFooterGap;
    bool pr_IncludeProjectNameInPageHeader;
    bool pr_IncludeProjectNameInTitle;
    ResourceExportType pr_ExportCss;
    ResourceExportType pr_ExportImages;
    ResourceExportType pr_ExportFonts;
    System::SharedPtr<ICssSavingCallback> pr_CssSavingCallback;
    System::SharedPtr<IFontSavingCallback> pr_FontSavingCallback;
    System::SharedPtr<IImageSavingCallback> pr_ImageSavingCallback;
    FontFaceType pr_FontFaceTypes;
    System::SharedPtr<IPageSavingCallback> pr_PageSavingCallback;
    
    HtmlSaveOptions(const System::SharedPtr<HtmlSaveOptions>& options);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(HtmlSaveOptions, CODEPORTING_ARGS(const System::SharedPtr<HtmlSaveOptions>& options));
    System::SharedPtr<SaveOptions> Clone() override;
    void CopyOutputPropertiesFrom(System::SharedPtr<SaveOptions> source) override;
    void SetCallbacks(const System::SharedPtr<Builder::HTML::Builders::HtmlBuilderOptions>& converterOptions);
    
};
 
} // namespace Saving
} // namespace Tasks
} // namespace Aspose