xtd - Reference Guide  0.1.0
Modern c++17/20 framework to create console, GUI and unit test applications on Windows, macOS, Linux, iOS and android.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
Public Member Functions | List of all members
xtd::drawing::text::private_font_collection Class Referencefinal

#include <private_font_collection.h>

Definition

Provides a collection of font families built from font files that are provided by the client application.

Namespace
xtd::drawing::text
Library
xtd.drawing
Remarks
The xtd::drawing::text::private_font_collection class allows applications to install a private version of an existing font without the requirement to replace the system version of the font. For example, GDI+ can create a private version of the Arial font in addition to the Arial font that the system uses. xtd::drawing::text::private_font_collection can also be used to install fonts that do not exist in the operating system. This is a temporary font install that does not affect the system-installed collection. To see the installed collection, use the xtd::drawing::text::installed_font_collection class.

Inherits xtd::drawing::text::font_collection.

Public Member Functions

 private_font_collection ()
 Initializes a new instance of the xtd::drawing::text::private_font_collection class.
 
void add_font_file (const xtd::ustring &filename)
 Adds a font from the specified file to this xtd::drawing::text::private_font_collection.
 
void add_memory_font (intptr_t memory, size_t length)
 Adds a font contained in system memory to this td::drawing::text::private_font_collection.
 
- Public Member Functions inherited from xtd::drawing::text::font_collection
const std::vector< font_family > & families () const
 Gets the array of FontFamily objects associated with this FontCollection.
 
- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
template<typename object_t >
std::unique_ptr< object_t > memberwise_clone () const
 Gets the type of the current instance.
 
virtual xtd::ustring to_string () const noexcept
 Returns a std::string that represents the current object.
 

Additional Inherited Members

- Static Public Member Functions inherited from xtd::object
static bool equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
static bool reference_equals (const object &object_a, const object &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 
- Protected Member Functions inherited from xtd::drawing::text::font_collection
 font_collection ()
 Initialise new instance of font_collection class.
 

Constructor & Destructor Documentation

◆ private_font_collection()

xtd::drawing::text::private_font_collection::private_font_collection ( )

Initializes a new instance of the xtd::drawing::text::private_font_collection class.

Member Function Documentation

◆ add_font_file()

void xtd::drawing::text::private_font_collection::add_font_file ( const xtd::ustring filename)

Adds a font from the specified file to this xtd::drawing::text::private_font_collection.

Parameters
filenameA string that contains the file name of the font to add.
Exceptions
std::invalid_argumentThe specified font is not supported or the font file cannot be found.

◆ add_memory_font()

void xtd::drawing::text::private_font_collection::add_memory_font ( intptr_t  memory,
size_t  length 
)

Adds a font contained in system memory to this td::drawing::text::private_font_collection.

Parameters
memoryThe memory address of the font to add.
lengthThe memory length of the font to add.
Remarks
To use the memory font, text on a control must be rendered with GDI+. Use the set_compatible_text_rendering_default method, passing true, to set GDI+ rendering on the application, or on individual controls by setting the control's use_compatible_text_rendering property to true. Some controls cannot be rendered with GDI+.

The documentation for this class was generated from the following file: