PdfSaveOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="PdfSaveOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2025 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/shared_ptr.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 Rendering
{
namespace Pdf
{
class PdfOptionsCore;
enum class PdfTextCompressionCore;
} // namespace Pdf
} // namespace Rendering
namespace Tasks
{
class FontSettings;
class IWriter;
namespace Saving
{
class IPageSavingCallback;
enum class PdfCompliance;
class PdfDigitalSignatureDetails;
class PdfEncryptionDetails;
enum class PdfTextCompression;
class PdfWriter;
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 PDF.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS PdfSaveOptions : public Aspose::Tasks::Saving::SaveOptions, public Aspose::Tasks::Saving::SaveOptions::IReduceBottomGap, public Aspose::Tasks::Saving::SaveOptions::IFontCallbacks, public Aspose::Tasks::Saving::ICloneableSaveOptions
{
    typedef PdfSaveOptions 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::PdfWriter;
    
public:
 
    /// <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 desired compliance level for generated PDF document.
    /// Default is <see cref="PdfCompliance::Pdf15"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API PdfCompliance get_Compliance() const;
    /// <summary>
    /// Sets a desired compliance level for generated PDF document.
    /// Default is <see cref="PdfCompliance::Pdf15"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_Compliance(PdfCompliance value);
    /// <summary>
    /// Gets a encryption details. If not set, then no encryption will be performed.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<PdfEncryptionDetails> get_EncryptionDetails() const;
    /// <summary>
    /// Sets a encryption details. If not set, then no encryption will be performed.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_EncryptionDetails(const System::SharedPtr<PdfEncryptionDetails>& value);
    /// <summary>
    /// Gets a compression type to be used for all content streams except images.
    /// Default is <see cref="PdfTextCompression::Flate"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API PdfTextCompression get_TextCompression() const;
    /// <summary>
    /// Sets a compression type to be used for all content streams except images.
    /// Default is <see cref="PdfTextCompression::Flate"></see>.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_TextCompression(PdfTextCompression value);
    /// <summary>
    /// Gets a digital signature details. If not set, then no signing will be performed.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<PdfDigitalSignatureDetails> get_DigitalSignatureDetails() const;
    /// <summary>
    /// Sets a digital signature details. If not set, then no signing will be performed.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DigitalSignatureDetails(const System::SharedPtr<PdfDigitalSignatureDetails>& value);
    /// <summary>
    /// Gets a value indicating whether to save project pages to separate files.
    /// </summary>
    ASPOSE_TASKS_SHARED_API bool get_SaveToSeparateFiles() const;
    /// <summary>
    /// Sets a value indicating whether to save project pages to separate files.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_SaveToSeparateFiles(bool value);
    /// <summary>
    /// Gets a user-defined callback which is used to get an output stream for each rendered page.
    /// Is applicable when <see cref="SaveToSeparateFiles"></see> option is used.
    /// </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.
    /// Is applicable when <see cref="SaveToSeparateFiles"></see> option is used.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PageSavingCallback(const System::SharedPtr<IPageSavingCallback>& value);
    /// <summary>
    /// Gets the list of pages numbers to save when saving project layout to separate files.
    /// <remarks>All 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 the list of pages numbers to save when saving project layout to separate files.
    /// <remarks>All 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>
    /// Specifies font settings used when rendering project's view.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Tasks::FontSettings> get_FontSettings() override;
    
    /// <summary>
    /// Initializes a new instance of the <see cref="PdfSaveOptions"></see> class that can be used to save a document in the <see cref="SaveFileFormat">PDF</see> format. 
    /// </summary>
    ASPOSE_TASKS_SHARED_API PdfSaveOptions();
    
protected:
 
    ASPOSE_TASKS_SHARED_API PdfSaveOptions(const System::SharedPtr<PdfSaveOptions>& options);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(PdfSaveOptions, CODEPORTING_ARGS(const System::SharedPtr<PdfSaveOptions>& options));
    ASPOSE_TASKS_SHARED_API System::SharedPtr<Aspose::Rendering::Pdf::PdfOptionsCore> GetOptionsCore();
    ASPOSE_TASKS_SHARED_API System::SharedPtr<IWriter> GetWriter() override;
    
    virtual ASPOSE_TASKS_SHARED_API ~PdfSaveOptions();
    
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::SharedPtr<Aspose::Rendering::Pdf::PdfOptionsCore> optionsCore;
    PdfCompliance compliance;
    System::SharedPtr<PdfEncryptionDetails> encryptionDetails;
    PdfTextCompression textCompression;
    System::SharedPtr<System::Collections::Generic::List<int32_t>> pages;
    System::SharedPtr<PdfDigitalSignatureDetails> digitalSignatureDetails;
    bool pr_ReduceFooterGap;
    bool pr_SaveToSeparateFiles;
    System::SharedPtr<IPageSavingCallback> pr_PageSavingCallback;
    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);
    
    System::SharedPtr<SaveOptions> Clone() override;
    void CopyOutputPropertiesFrom(System::SharedPtr<SaveOptions> source) override;
    Aspose::Rendering::Pdf::PdfTextCompressionCore ToPdfTextCompressionCore(PdfTextCompression value);
    
};
 
} // namespace Saving
} // namespace Tasks
} // namespace Aspose