ImageSaveOptions.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="ImageSaveOptions.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 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 Tasks
{
class FontSettings;
class IWriter;
namespace Saving
{
class IPageSavingCallback;
enum class SaveFileFormat;
class SaveOptions;
enum class TiffCompression;
} // namespace Saving
} // namespace Tasks
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class List;
} // namespace Generic
} // namespace Collections
namespace Drawing
{
namespace Imaging
{
enum class PixelFormat;
} // namespace Imaging
} // namespace Drawing
} // namespace System
 
namespace Aspose {
 
namespace Tasks {
 
namespace Saving {
 
/// <summary>
/// Allows to specify additional options when rendering project pages to images.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS ImageSaveOptions : public Aspose::Tasks::Saving::SaveOptions, public Aspose::Tasks::Saving::SaveOptions::IReduceBottomGap, public Aspose::Tasks::Saving::SaveOptions::IFontCallbacks, public Aspose::Tasks::Saving::ICloneableSaveOptions
{
    typedef ImageSaveOptions 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();
    
public:
 
    /// <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 list of page 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 a list of page 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>
    /// Gets a JPEG quality. The allowed value range is 0..100.
    /// </summary>
    ASPOSE_TASKS_SHARED_API int32_t get_JpegQuality() const;
    /// <summary>
    /// Sets a JPEG quality. The allowed value range is 0..100.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_JpegQuality(int32_t value);
    /// <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 the type of compression to apply when saving generated images to the TIFF format.
    /// </summary> 
    /// <remarks>
    /// Has effect only when saving to TIFF.
    /// The default value is <see cref="TiffCompression">LZW</see>.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API Aspose::Tasks::Saving::TiffCompression get_TiffCompression() const;
    /// <summary>
    /// Sets the type of compression to apply when saving generated images to the TIFF format.
    /// </summary> 
    /// <remarks>
    /// Has effect only when saving to TIFF.
    /// The default value is <see cref="TiffCompression">LZW</see>.
    /// </remarks>
    ASPOSE_TASKS_SHARED_API void set_TiffCompression(Aspose::Tasks::Saving::TiffCompression value);
    /// <summary>
    /// Gets the format of the color data for each pixel in the image.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::Drawing::Imaging::PixelFormat get_PixelFormat() const;
    /// <summary>
    /// Sets the format of the color data for each pixel in the image.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_PixelFormat(System::Drawing::Imaging::PixelFormat value);
    /// <summary>
    /// Gets the horizontal resolution in dpi.
    /// </summary>
    ASPOSE_TASKS_SHARED_API float get_HorizontalResolution() const;
    /// <summary>
    /// Sets the horizontal resolution in dpi.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_HorizontalResolution(float value);
    /// <summary>
    /// Gets the vertical resolution in dpi.
    /// </summary>
    ASPOSE_TASKS_SHARED_API float get_VerticalResolution() const;
    /// <summary>
    /// Sets the vertical resolution in dpi.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_VerticalResolution(float value);
    /// <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="ImageSaveOptions"></see> class which can be used to save rendered images in TIFF, PNG, BMP or JPEG formats.
    /// </summary>
    /// <param name="saveFormat">Can be TIFF, PNG, BMP or JPEG<see cref="SaveFileFormat"></see>.</param>
    /// <exception cref="ArgumentException">Thrown of <paramref name="saveFormat"></paramref> is not a valid image format. The valid values are TIFF, PNG, BMP or JPEG.</exception>
    ASPOSE_TASKS_SHARED_API ImageSaveOptions(SaveFileFormat saveFormat);
    
protected:
 
    /// <summary>
    /// Initializes a new instance of the <see cref="ImageSaveOptions"></see> class.
    /// </summary>
    /// <param name="options">
    /// The options to copy to.
    /// </param>
    ASPOSE_TASKS_SHARED_API ImageSaveOptions(const System::SharedPtr<ImageSaveOptions>& options);
    
    ASPOSE_TASKS_SHARED_API MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ImageSaveOptions, CODEPORTING_ARGS(const System::SharedPtr<ImageSaveOptions>& options));
    ASPOSE_TASKS_SHARED_API System::SharedPtr<IWriter> GetWriter() override;
    
    virtual ASPOSE_TASKS_SHARED_API ~ImageSaveOptions();
    
    #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;
    int32_t jpegQuality;
    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;
    Aspose::Tasks::Saving::TiffCompression pr_TiffCompression;
    System::Drawing::Imaging::PixelFormat pr_PixelFormat;
    float pr_HorizontalResolution;
    float pr_VerticalResolution;
    System::SharedPtr<IPageSavingCallback> pr_PageSavingCallback;
    
    System::SharedPtr<SaveOptions> Clone() override;
    void CopyOutputPropertiesFrom(System::SharedPtr<SaveOptions> source) override;
    
};
 
} // namespace Saving
} // namespace Tasks
} // namespace Aspose