FontSettings.h

#pragma once
//-----------------------------------------------------------------------
// <copyright file="FontSettings.cs" company="Aspose Pty Ltd">
//   Copyright (c) 2002-2024 Aspose Pty Ltd. All Rights Reserved.
// </copyright>
//-----------------------------------------------------------------------
 
#include <system/array.h>
 
#include "aspose.tasks.cpp/Saving/FontResolveCallbackDelegate.h"
#include "aspose.tasks.cpp/aspose_tasks_api_defs.h"
 
namespace Aspose
{
namespace Tasks
{
class FontResolveEventArgs;
namespace Saving
{
class HtmlSaveOptions;
class ImageSaveOptions;
class PdfSaveOptions;
} // namespace Saving
namespace Visualization
{
class FontManager;
} // namespace Visualization
} // namespace Tasks
} // namespace Aspose
 
namespace Aspose {
 
namespace Tasks {
 
/// <summary>
/// Specifies font settings used when rendering project's view.
/// </summary>
class ASPOSE_TASKS_SHARED_CLASS FontSettings final : public System::Object
{
    typedef FontSettings ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_TASKS_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Tasks::Saving::HtmlSaveOptions;
    friend class Aspose::Tasks::Saving::ImageSaveOptions;
    friend class Aspose::Tasks::Saving::PdfSaveOptions;
    friend class Aspose::Tasks::Visualization::FontManager;
    
public:
 
    /// <summary>
    /// Gets the default (or fallback) font for rendering.
    /// </summary>
    ASPOSE_TASKS_SHARED_API System::String get_DefaultFontName() const;
    /// <summary>
    /// Sets the default (or fallback) font for rendering.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_DefaultFontName(const System::String& value);
    /// <summary>
    /// Gets a value indicating whether the default font must be used for rendering.
    /// </summary>
    /// <remarks>When the value is False and DefaultFontName is specified, the rendering engine will utilize the font specified by DefaultFontName as a fallback font.
    /// Otherwise 'Arial' (if installed) or 'Generic Sans Serif' fonts are used as a fallback font.    
    /// The fallback font is utilized during the rendering of project view when a text style references a font that is not installed on the current operating system.
    /// For greater control over font resolution you can use <see cref="FontResolveCallback"></see> callback.</remarks>
    ASPOSE_TASKS_SHARED_API bool get_UseProjectDefaultFont() const;
    /// <summary>
    /// Sets a value indicating whether the default font must be used for rendering.
    /// </summary>
    /// <remarks>When the value is False and DefaultFontName is specified, the rendering engine will utilize the font specified by DefaultFontName as a fallback font.
    /// Otherwise 'Arial' (if installed) or 'Generic Sans Serif' fonts are used as a fallback font.    
    /// The fallback font is utilized during the rendering of project view when a text style references a font that is not installed on the current operating system.
    /// For greater control over font resolution you can use <see cref="FontResolveCallback"></see> callback.</remarks>
    ASPOSE_TASKS_SHARED_API void set_UseProjectDefaultFont(bool value);
    /// <summary>
    /// Gets a callback which can be used to customize resolved fonts.
    /// </summary>
    ASPOSE_TASKS_SHARED_API FontResolveCallbackDelegate get_FontResolveCallback() const;
    /// <summary>
    /// Sets a callback which can be used to customize resolved fonts.
    /// </summary>
    ASPOSE_TASKS_SHARED_API void set_FontResolveCallback(FontResolveCallbackDelegate value);
    
    /// <summary>
    /// Sets the folders where Aspose.Tasks looks for TrueType fonts when rendering project's view.
    /// </summary>
    /// <param name="fontFolders">An array of folders that contain TrueType fonts.</param>
    /// <param name="recursive">If true the specified folders will be scanned recursively.</param>
    ASPOSE_TASKS_SHARED_API void SetFontFolders(const System::ArrayPtr<System::String>& fontFolders, bool recursive);
    
    ASPOSE_TASKS_SHARED_API FontSettings();
    
protected:
 
    ASPOSE_TASKS_SHARED_API const System::ArrayPtr<System::String>& get_FontFolders() const;
    ASPOSE_TASKS_SHARED_API void set_FontFolders(const System::ArrayPtr<System::String>& value);
    ASPOSE_TASKS_SHARED_API bool get_Recursive() const;
    ASPOSE_TASKS_SHARED_API void set_Recursive(bool value);
    
    ASPOSE_TASKS_SHARED_API System::SharedPtr<FontSettings> Clone();
    #ifdef ASPOSE_GET_SHARED_MEMBERS
    ASPOSE_TASKS_SHARED_API void GetSharedMembers(System::Object::shared_members_type& result) const override;
    #endif
    
    
private:
 
    System::ArrayPtr<System::String> pr_FontFolders;
    bool pr_Recursive;
    System::String pr_DefaultFontName;
    bool pr_UseProjectDefaultFont;
    FontResolveCallbackDelegate pr_FontResolveCallback;
    
};
 
} // namespace Tasks
} // namespace Aspose