Inheritance diagram for xtd::forms::font_dialog:

Definition

Prompts the user to choose a font from among those installed on the local computer.

Header: #include <xtd/forms/font_dialog>

Namespace: xtd::forms

Library: xtd.forms

Remarks: The inherited member show_dialog must be invoked to create this specific common dialog box. hook_proc can be overridden to implement specific dialog box hook functionality.; When you create an instance of font_dialog, some of the read/write properties are set to initial values. For a list of these values, see the font_dialog constructor.

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples: The following code example demonstrates the use of font_dialog dialog.
#include <xtd/forms/application>

#include <xtd/forms/button>

#include <xtd/forms/font_dialog>

#include <xtd/forms/form>

#include <xtd/forms/label>

using namespace xtd::forms;

class form1 : public form {

public:

form1() {

text("Font dialog example");

client_size({400, 400});

controls().push_back_range({button1, label1});

auto_scroll(true);

button1.location({10, 10});

button1.text("Font...");

button1.click += [&] {

auto dialog = font_dialog {};

dialog.color(label1.fore_color());

dialog.font(label1.font());

if (dialog.show_dialog(*this) == xtd::forms::dialog_result::ok) {

label1.fore_color(dialog.color());

label1.font(dialog.font());

}

};

label1.location({10, 50});

label1.auto_size(true);

label1.text(u8"The quick brown fox jumps over the lazy dog.\n"

u8"THE QUICK BROWN FOX JUMPS OVER THE LAZY DOG.\n"

u8"0123456789+-*/%~^&|=<>≤≥±÷≠{{[()]}},;:.?¿!¡\n"

u8"àçéèêëïî@@°_#§$ù£€æœøπµ©®∞\\\"'\n"

u8"\u0400\u0401\u0402\u0403\u0404\u0405\u0406\u0407\u0408\u0409\u040a\u040b\u040c\u040d\u040e\u040f\n"

u8"\u0410\u0411\u0412\u0413\u0414\u0415\u0416\u0417\u0418\u0419\u041a\u041b\u041c\u041d\u041e\u041f\n"

u8"\u4ea0\u4ea1\u4ea2\u4ea3\u4ea4\u4ea5\u4ea6\u4ea7\u4ea8\u4ea9\u4eaa\u4eab\u4eac\u4ead\u4eae\u4eaf\n"

u8"\u4eb0\u4eb1\u4eb2\u4eb3\u4eb4\u4eb5\u4eb6\u4eb7\u4eb8\u4eb9\u4eba\u4ebb\u4ebc\u4ebd\u4ebe\u4ebf\n"

u8"\U0001F428");

}

private:

button button1;

label label1;

};

auto main() -> int {

application::run(form1 {});

}

xtd::forms::application::run
static void run()
Begins running a standard application message loop on the current thread, without a form.

xtd::forms::button
Represents a Windows button control.
Definition button.hpp:49

xtd::forms::font_dialog
Prompts the user to choose a font from among those installed on the local computer.
Definition font_dialog.hpp:36

xtd::forms::font_dialog::color
drawing::color color() const noexcept
Gets the selected font color.

xtd::forms::form
Represents a window or dialog box that makes up an application's user interface.
Definition form.hpp:54

xtd::forms::label
Represents a standard Windows label.
Definition label.hpp:38

xtd::forms::dialog_result::ok
@ ok
The dialog box return value is OK (usually sent from a button labeled OK).

xtd::forms::message_dialog_default_button::button1
@ button1
The first button on the message box is the default button.

xtd::forms::status_bar_panel_style::text
@ text
The xtd::forms::status_bar_panel displays text in the standard font.

xtd::forms
The xtd::forms namespace contains classes for creating Windows-based applications that take full adva...
Definition xtd_about_box.hpp:12

Examples: demo.cpp, and font_dialog.cpp.

Public Events
event< font_dialog, event_handler >	apply
	Occurs when the user clicks the Apply button in the font dialog box.

Public Constructors
	font_dialog ()
	Initializes a new instance of the font_dialog class.

Public Properties
bool	allow_script_change () const noexcept
	Gets a value indicating whether the user can change the character set specified in the Script combo box to display a character set other than the one currently displayed.

font_dialog &	allow_script_change (bool allow_script_change)
	Sets a value indicating whether the user can change the character set specified in the Script combo box to display a character set other than the one currently displayed.

bool	allow_simulation () const noexcept
	Gets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations.

font_dialog &	allow_simulation (bool allow_simulation)
	Sets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations.

bool	allow_vector_fonts () const noexcept
	Gets a value indicating whether the dialog box allows vector font selections.

font_dialog &	allow_vector_fonts (bool allow_vector_fonts)
	Sets a value indicating whether the dialog box allows vector font selections.

bool	allow_vertical_fonts () const noexcept
	Gets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts.

font_dialog &	allow_vertical_fonts (bool allow_vertical_fonts)
	Sets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts.

drawing::color	color () const noexcept
	Gets the selected font color.

font_dialog &	color (const drawing::color &color)
	Sets the selected font color.

bool	fixed_pitch_only () const noexcept
	Gets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts.

font_dialog &	fixed_pitch_only (bool fixed_pitch_only)
	Sets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts.

drawing::font	font () const noexcept
	Gets the selected font.

font_dialog &	font (const drawing::font &font)
	Sets the selected font.

bool	font_must_exist () const noexcept
	Gets a value indicating whether the dialog box specifies an error condition if the user attempts to select a font or style that does not exist.

font_dialog &	font_must_exist (bool font_must_exist)
	Sets a value indicating whether the dialog box specifies an error condition if the user attempts to select a font or style that does not exist.

size_t	max_size () const noexcept
	Gets the maximum point size a user can select.

font_dialog &	max_size (size_t max_size)
	Sets the maximum point size a user can select.

size_t	min_size () const noexcept
	Gets the minimum point size a user can select.

font_dialog &	min_size (size_t min_size)
	Sets the minimum point size a user can select.

size_t	options () const noexcept
	Gets values to initialize the font_dialog.

bool	script_only () const noexcept
	Gets a value indicating whether the dialog box allows selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set.

font_dialog &	script_only (bool script_only)
	Sets a value indicating whether the dialog box allows selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set.

bool	show_apply () const noexcept
	Gets a value indicating whether the dialog box contains an Apply button.

font_dialog &	show_apply (bool show_apply)
	Sets a value indicating whether the dialog box contains an Apply button.

bool	show_color () const noexcept
	Gets a value indicating whether the dialog box displays the color choice.

font_dialog &	show_color (bool show_color)
	Sets a value indicating whether the dialog box displays the color choice.

bool	show_effect () const noexcept
	Gets a value indicating whether the dialog box contains controls that allow the user to specify strikethrough, underline, and text color options.

font_dialog &	show_effect (bool show_effect)
	Sets a value indicating whether the dialog box contains controls that allow the user to specify strikethrough, underline, and text color options.

bool	show_help () const noexcept
	Gets a value indicating whether the dialog box displays a Help button.

font_dialog &	show_help (bool show_help)
	Sets a value indicating whether the dialog box displays a Help button.

Public Methods
void	reset () noexcept override
	Resets all dialog box options to their default values.

Protected Methods
virtual void	on_apply (const event_args &e)
	Raises the font_dialog::apply event.

bool	run_dialog (intptr owner) override

void	run_sheet (intptr owner) override
	When overridden in a derived class, specifies a common dialog box.

Additional Inherited Members
Public Attributes inherited from xtd::forms::common_dialog
event< common_dialog, help_event_handler >	help_request
	Occurs when the user clicks the Help button on a common dialog box.

event< common_dialog, dialog_closed_event_handler >	dialog_closed
	Occurs when the user close a common dialog box with dialog close button or other dialog buttons.

Public Member Functions inherited from xtd::forms::common_dialog
	common_dialog ()
	Initializes a new instance of the common_dialog class.

xtd::forms::dialog_result	dialog_result () const noexcept
	Gets async dialog_result result after dialog box is closing.

std::any	tag () const noexcept
	Gets an object that contains data about the control.

common_dialog &	tag (const std::any &tag)
	Sets an object that contains data about the control.

xtd::forms::dialog_result	show_dialog ()
	Runs a common dialog box with a default owner.

xtd::forms::dialog_result	show_dialog (const iwin32_window &owner)
	Runs a common dialog box with the specified owner.

void	show_sheet (const iwin32_window &owner)
	Runs a common dialog box with the specified owner.

xtd::forms::dialog_result	show_sheet_dialog (const iwin32_window &owner)
	Runs a common dialog box with the specified owner.

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 xtd::size	get_hash_code () const noexcept
	Serves as a hash function for a particular type.

virtual type_object	get_type () const noexcept
	Gets the type of the current instance.

template<class object_t >
xtd::uptr< object_t >	memberwise_clone () const
	Creates a shallow copy of the current object.

virtual xtd::string	to_string () const noexcept
	Returns a xtd::string that represents the current object.

Static Public Member Functions inherited from xtd::object
template<class object_a_t , class object_b_t >
static bool	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are considered equal.

template<class object_a_t , class object_b_t >
static bool	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
	Determines whether the specified object instances are the same instance.

Protected Member Functions inherited from xtd::forms::common_dialog
virtual void	on_dialog_closed (const dialog_closed_event_args &e)
	Raises the common_dialog::dialog_close event.

virtual void	on_help_request (help_event_args &e)
	Raises the common_dialog::help_request event.

void	set_dialog_result (xtd::forms::dialog_result value)
	Sets async dialog_result result after dialog box is closing.

Protected Member Functions inherited from xtd::forms::component
	component ()
	Initialises a new instance of the component class.

virtual bool	can_raise_events () const noexcept
	Gets a value indicating whether the component can raise an event.

bool	design_mode () const noexcept
	Gets a value that indicates whether the component is currently in design mode.

Constructor & Destructor Documentation

◆ font_dialog()

xtd::forms::font_dialog::font_dialog ( )

Initializes a new instance of the font_dialog class.

Remarks

When you create an instance of font_dialog, the following read/write properties are initialized.

Property	Initial value
allow_simulations	`true`
allow_vector_fonts	`true`
allow_vertical_fonts	`true`
allow_script_change	`true`
color	color::black
fixed_pitch_only	`false`
max_size	0
min_size	0
scripts_only	`false`
show_apply	`false`
show_color	`false`
show_effects	`true`
show_help	`false`

You can change the value for any of these properties through a separate call to the property.

Member Function Documentation

◆ allow_script_change() [1/2]

bool xtd::forms::font_dialog::allow_script_change ( ) const

noexcept

Gets a value indicating whether the user can change the character set specified in the Script combo box to display a character set other than the one currently displayed.

Returns: true if the user can change the character set specified in the Script combo box; otherwise, false. The default value is true.

Remarks: The Script combo box found on the Font dialog box contains character sets associated with the selected font.

◆ allow_script_change() [2/2]

font_dialog & xtd::forms::font_dialog::allow_script_change ( bool allow_script_change )

Sets a value indicating whether the user can change the character set specified in the Script combo box to display a character set other than the one currently displayed.

Parameters

allow_script_change true if the user can change the character set specified in the Script combo box; otherwise, false. The default value is true.

Returns: Current font_dialog.

Remarks: The Script combo box found on the Font dialog box contains character sets associated with the selected font.

◆ allow_simulation() [1/2]

bool xtd::forms::font_dialog::allow_simulation ( ) const

noexcept

Gets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations.

Returns: true if font simulations are allowed; otherwise, false. The default value is true.

◆ allow_simulation() [2/2]

font_dialog & xtd::forms::font_dialog::allow_simulation ( bool allow_simulation )

Sets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations.

Parameters

allow_simulation true if font simulations are allowed; otherwise, false. The default value is true.

Returns: Current font_dialog.

◆ allow_vector_fonts() [1/2]

bool xtd::forms::font_dialog::allow_vector_fonts ( ) const

noexcept

Gets a value indicating whether the dialog box allows vector font selections.

Returns: true if vector fonts are allowed; otherwise, false. The default value is true.

◆ allow_vector_fonts() [2/2]

font_dialog & xtd::forms::font_dialog::allow_vector_fonts ( bool allow_vector_fonts )

Sets a value indicating whether the dialog box allows vector font selections.

Parameters

allow_vector_fonts true if vector fonts are allowed; otherwise, false. The default value is true.

Returns: Current font_dialog.

◆ allow_vertical_fonts() [1/2]

bool xtd::forms::font_dialog::allow_vertical_fonts ( ) const

noexcept

Gets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts.

Returns: true if both vertical and horizontal fonts are allowed; otherwise, false. The default value is true.

◆ allow_vertical_fonts() [2/2]

font_dialog & xtd::forms::font_dialog::allow_vertical_fonts ( bool allow_vertical_fonts )

Sets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts.

Parameters

allow_vertical_fonts true if both vertical and horizontal fonts are allowed; otherwise, false. The default value is true.

Returns: Current font_dialog.

◆ color() [1/2]

drawing::color xtd::forms::font_dialog::color ( ) const

noexcept

Gets the selected font color.

Returns: The color of the selected font. The default value is Black.

Examples: demo.cpp, and font_dialog.cpp.

◆ color() [2/2]

font_dialog & xtd::forms::font_dialog::color ( const drawing::color & color )

Sets the selected font color.

Parameters

color The color of the selected font. The default value is Black.

Returns: Current font_dialog.

◆ fixed_pitch_only() [1/2]

bool xtd::forms::font_dialog::fixed_pitch_only ( ) const

noexcept

Gets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts.

Returns: true if only fixed-pitch fonts can be selected; otherwise, false. The default value is false.

◆ fixed_pitch_only() [2/2]

font_dialog & xtd::forms::font_dialog::fixed_pitch_only ( bool fixed_pitch_only )

Sets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts.

Parameters

fixed_pitch_only true if only fixed-pitch fonts can be selected; otherwise, false. The default value is false.

Returns: Current font_dialog.

◆ font() [1/2]

drawing::font xtd::forms::font_dialog::font ( ) const

noexcept

Gets the selected font.

Returns: The selected font.

Examples: demo.cpp.

◆ font() [2/2]

font_dialog & xtd::forms::font_dialog::font ( const drawing::font & font )

Sets the selected font.

Parameters

font	The selected font.

Returns: Current font_dialog.

◆ font_must_exist() [1/2]

bool xtd::forms::font_dialog::font_must_exist ( ) const

noexcept

Gets a value indicating whether the dialog box specifies an error condition if the user attempts to select a font or style that does not exist.

Returns: true if the dialog box specifies an error condition when the user tries to select a font or style that does not exist; otherwise, false. The default is false.

◆ font_must_exist() [2/2]

font_dialog & xtd::forms::font_dialog::font_must_exist ( bool font_must_exist )

Sets a value indicating whether the dialog box specifies an error condition if the user attempts to select a font or style that does not exist.

Parameters

font_must_exist true if the dialog box specifies an error condition when the user tries to select a font or style that does not exist; otherwise, false. The default is false.

Returns: Current font_dialog.

◆ max_size() [1/2]

size_t xtd::forms::font_dialog::max_size ( ) const

noexcept

Gets the maximum point size a user can select.

Returns: The maximum point size a user can select. The default is 0.

◆ max_size() [2/2]

font_dialog & xtd::forms::font_dialog::max_size ( size_t max_size )

Sets the maximum point size a user can select.

Parameters

max_size The maximum point size a user can select. The default is 0.

Returns: Current font_dialog.

◆ min_size() [1/2]

size_t xtd::forms::font_dialog::min_size ( ) const

noexcept

Gets the minimum point size a user can select.

Returns: The minimum point size a user can select. The default is 0.

◆ min_size() [2/2]

font_dialog & xtd::forms::font_dialog::min_size ( size_t min_size )

Sets the minimum point size a user can select.

Parameters

min_size The minimum point size a user can select. The default is 0.

Returns: Current font_dialog.

◆ options()

size_t xtd::forms::font_dialog::options ( ) const

noexcept

Gets values to initialize the font_dialog.

Returns: A bitwise combination of internal values that initializes the font_dialog.

Remarks: The options property corresponds to the flags used to initialize a color dialog box using Win32. Use the properties of the font_dialog class to get and set the options.

◆ script_only() [1/2]

bool xtd::forms::font_dialog::script_only ( ) const

noexcept

Gets a value indicating whether the dialog box allows selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set.

Returns: true if selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set, is allowed; otherwise, false. The default value is false.

◆ script_only() [2/2]

font_dialog & xtd::forms::font_dialog::script_only ( bool script_only )

Sets a value indicating whether the dialog box allows selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set.

Parameters

script_script = true if selection of fonts for all non-OEM and Symbol character sets, as well as the ANSI character set, is allowed; otherwise, false. The default value is false.

Returns: Current font_dialog.

◆ show_apply() [1/2]

bool xtd::forms::font_dialog::show_apply ( ) const

noexcept

Gets a value indicating whether the dialog box contains an Apply button.

Returns: true if the dialog box contains an Apply button; otherwise, false. The default value is false.

◆ show_apply() [2/2]

font_dialog & xtd::forms::font_dialog::show_apply ( bool show_apply )

Sets a value indicating whether the dialog box contains an Apply button.

Parameters

show_apply true if the dialog box contains an Apply button; otherwise, false. The default value is false.

Returns: Current font_dialog.

◆ show_color() [1/2]

bool xtd::forms::font_dialog::show_color ( ) const

noexcept

Gets a value indicating whether the dialog box displays the color choice.

Returns: true if the dialog box displays the color choice; otherwise, false. The default value is false.

◆ show_color() [2/2]

font_dialog & xtd::forms::font_dialog::show_color ( bool show_color )

Sets a value indicating whether the dialog box displays the color choice.

Parameters

show_color true if the dialog box displays the color choice; otherwise, false. The default value is false.

Returns: Current font_dialog.

◆ show_effect() [1/2]

bool xtd::forms::font_dialog::show_effect ( ) const

noexcept

Gets a value indicating whether the dialog box contains controls that allow the user to specify strikethrough, underline, and text color options.

Returns: true if the dialog box contains controls to set strikethrough, underline, and text color options; otherwise, false. The default value is true.

◆ show_effect() [2/2]

font_dialog & xtd::forms::font_dialog::show_effect ( bool show_effect )

Sets a value indicating whether the dialog box contains controls that allow the user to specify strikethrough, underline, and text color options.

Parameters

show_effect true if the dialog box contains controls to set strikethrough, underline, and text color options; otherwise, false. The default value is true.

Returns: Current font_dialog.

◆ show_help() [1/2]

bool xtd::forms::font_dialog::show_help ( ) const

noexcept

Gets a value indicating whether the dialog box displays a Help button.

Returns: true if the dialog box displays a Help button; otherwise, false. The default value is false.

◆ show_help() [2/2]

font_dialog & xtd::forms::font_dialog::show_help ( bool show_help )

Sets a value indicating whether the dialog box displays a Help button.

Parameters

show_help true if the dialog box displays a Help button; otherwise, false. The default value is false.

Returns: Current font_dialog.

◆ reset()

void xtd::forms::font_dialog::reset ( )

overridevirtualnoexcept

Resets all dialog box options to their default values.

Remarks: When the options are reset, the strikethrough, underline, and color effects are enabled. The fonts listed include only the screen fonts supported by the system.

Implements xtd::forms::common_dialog.

◆ on_apply()

virtual void xtd::forms::font_dialog::on_apply ( const event_args & e )

protectedvirtual

Raises the font_dialog::apply event.

Parameters

e	An event_args that contains the data.

Remarks: Raising an event invokes the event handler through a delegate.

Notes to Inheritors: When overriding on_apply(const event_args&) in a derived class, be sure to call the base class's on_apply(const event_args&) method.

◆ run_dialog()

bool xtd::forms::font_dialog::run_dialog ( intptr owner )

overrideprotectedvirtual

Returns: Specifies a file dialog box.

Parameters

owner The window handle of the owner window for the common dialog box.

Returns: true if the dialog box was successfully run; otherwise, false.

Remarks: The run_dialog method is invoked when the user of a font dialog box calls the show_dialog method.

Implements xtd::forms::common_dialog.

◆ run_sheet()

void xtd::forms::font_dialog::run_sheet ( intptr owner )

overrideprotectedvirtual

When overridden in a derived class, specifies a common dialog box.

Parameters

owner A value that represents the window handle of the owner window for the common dialog box.

Implements xtd::forms::common_dialog.

Member Data Documentation

◆ apply

event<font_dialog, event_handler> xtd::forms::font_dialog::apply

Occurs when the user clicks the Apply button in the font dialog box.

Remarks: Every time the Apply button is clicked, another apply event is raised.; For more information about handling events, see Handling and Raising Events.

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

xtd.forms/include/xtd/forms/font_dialog.hpp

Definition

Public Events

Public Constructors

Public Properties

Public Methods

Protected Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ font_dialog()

Member Function Documentation

◆ allow_script_change() [1/2]

◆ allow_script_change() [2/2]

◆ allow_simulation() [1/2]

◆ allow_simulation() [2/2]

◆ allow_vector_fonts() [1/2]

◆ allow_vector_fonts() [2/2]

◆ allow_vertical_fonts() [1/2]

◆ allow_vertical_fonts() [2/2]

◆ color() [1/2]

◆ color() [2/2]

◆ fixed_pitch_only() [1/2]

◆ fixed_pitch_only() [2/2]

◆ font() [1/2]

◆ font() [2/2]

◆ font_must_exist() [1/2]

◆ font_must_exist() [2/2]

◆ max_size() [1/2]

◆ max_size() [2/2]

◆ min_size() [1/2]

◆ min_size() [2/2]

◆ options()

◆ script_only() [1/2]

◆ script_only() [2/2]

◆ show_apply() [1/2]

◆ show_apply() [2/2]

◆ show_color() [1/2]

◆ show_color() [2/2]

◆ show_effect() [1/2]

◆ show_effect() [2/2]

◆ show_help() [1/2]

◆ show_help() [2/2]

◆ reset()

◆ on_apply()

◆ run_dialog()

◆ run_sheet()

Member Data Documentation

◆ apply