xtd.forms - Reference Guide  0.1.0
Modern c++17 library containing classes for creating Windows-based applications that take full advantage of the rich user interface features available in the Microsoft Windows, Apple macOS and Linux like Ubuntu operating system.
xtd::forms::font_dialog Class Reference

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

#include <font_dialog.hpp>

Inheritance diagram for xtd::forms::font_dialog:
xtd::forms::common_dialog xtd::forms::component

Public Member Functions

 font_dialog ()=default
 Initializes a new instance of the font_dialog class. More...
 
bool allow_script_change () const
 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. More...
 
font_dialogallow_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. More...
 
bool allow_simulation () const
 Gets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations. More...
 
font_dialogallow_simulation (bool allow_simulation)
 Sets a value indicating whether the dialog box allows graphics device interface (GDI) font simulations. More...
 
bool allow_vector_fonts () const
 Gets a value indicating whether the dialog box allows vector font selections. More...
 
font_dialogallow_vector_fonts (bool allow_vector_fonts)
 Sets a value indicating whether the dialog box allows vector font selections. More...
 
bool allow_vertical_fonts () const
 Gets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts. More...
 
font_dialogallow_vertical_fonts (bool allow_vertical_fonts)
 Sets a value indicating whether the dialog box displays both vertical and horizontal fonts or only horizontal fonts. More...
 
drawing::color color () const
 Gets the selected font color. More...
 
font_dialogcolor (const drawing::color &color)
 Sets the selected font color. More...
 
bool fixed_pitch_only () const
 Gets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts. More...
 
font_dialogfixed_pitch_only (bool fixed_pitch_only)
 Sets a value indicating whether the dialog box allows only the selection of fixed-pitch fonts. More...
 
drawing::font font () const
 Gets the selected font. More...
 
font_dialogfont (const drawing::font &font)
 Sets the selected font. More...
 
bool font_must_exist () const
 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. More...
 
font_dialogfont_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. More...
 
size_t max_size () const
 Gets the maximum point size a user can select. More...
 
font_dialogmax_size (size_t max_size)
 Sets the maximum point size a user can select. More...
 
size_t min_size () const
 Gets the minimum point size a user can select. More...
 
font_dialogmin_size (size_t min_size)
 Sets the minimum point size a user can select. More...
 
size_t options () const
 Gets values to initialize the font_dialog. More...
 
void reset () override
 Resets all dialog box options to their default values. More...
 
bool script_only () const
 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. More...
 
font_dialogscript_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. More...
 
bool show_apply () const
 Gets a value indicating whether the dialog box contains an Apply button. More...
 
font_dialogshow_apply (bool show_apply)
 Sets a value indicating whether the dialog box contains an Apply button. More...
 
bool show_color () const
 Gets a value indicating whether the dialog box displays the color choice. More...
 
font_dialogshow_color (bool show_color)
 Sets a value indicating whether the dialog box displays the color choice. More...
 
bool show_effect () const
 Gets a value indicating whether the dialog box contains controls that allow the user to specify strikethrough, underline, and text color options. More...
 
font_dialogshow_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. More...
 
bool show_help () const
 Gets a value indicating whether the dialog box displays a Help button. More...
 
font_dialogshow_help (bool show_help)
 Sets a value indicating whether the dialog box displays a Help button. More...
 
- Public Member Functions inherited from xtd::forms::common_dialog
 common_dialog ()=default
 Initializes a new instance of the common_dialog class. More...
 
xtd::forms::dialog_result show_dialog ()
 Runs a common dialog box with a default owner. More...
 
xtd::forms::dialog_result show_dialog (const iwin32_window &owner)
 Runs a common dialog box with the specified owner. More...
 
std::any tag () const
 Gets an object that contains data about the control. More...
 
common_dialogtag (const std::any &tag)
 Sets an object that contains data about the control. More...
 

Public Attributes

event< font_dialog, event_handler< component & > > apply
 Occurs when the user clicks the Apply button in the font dialog box. More...
 
- Public Attributes inherited from xtd::forms::common_dialog
event< common_dialog, help_event_handler< component & > > help_request
 Occurs when the user clicks the Help button on a common dialog box. More...
 

Protected Member Functions

virtual void on_apply (const event_args &e)
 Raises the apply event. More...
 
bool run_dialog (intptr_t owner) override
 
- Protected Member Functions inherited from xtd::forms::common_dialog
virtual void on_help_request (help_event_args &e)
 Raises the help_request event. More...
 
- Protected Member Functions inherited from xtd::forms::component
virtual bool can_raise_events () const
 Gets a value indicating whether the component can raise an event. More...
 
bool design_mode () const
 Gets a value that indicates whether the component is currently in design mode. More...
 

Detailed Description

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

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.

Constructor & Destructor Documentation

§ font_dialog()

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

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_shange 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
inline

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)
inline

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_changetrue 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_simulation() [1/2]

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

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)
inline

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

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

§ allow_vector_fonts() [1/2]

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

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)
inline

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

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

§ allow_vertical_fonts() [1/2]

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

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)
inline

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

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

§ color() [1/2]

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

Gets the selected font color.

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

§ color() [2/2]

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

Sets the selected font color.

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

§ fixed_pitch_only() [1/2]

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

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)
inline

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

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

§ font() [1/2]

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

Gets the selected font.

Returns
The selected font.

§ font() [2/2]

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

Sets the selected font.

Parameters
fontThe selected font.

§ font_must_exist() [1/2]

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

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)
inline

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_existtrue 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.

§ max_size() [1/2]

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

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)
inline

Sets the maximum point size a user can select.

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

§ min_size() [1/2]

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

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)
inline

Sets the minimum point size a user can select.

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

§ on_apply()

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

Raises the apply event.

Parameters
eAn 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.

§ options()

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

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.

§ reset()

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

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.

§ run_dialog()

bool xtd::forms::font_dialog::run_dialog ( intptr_t  owner)
overrideprotectedvirtual
Returns
Specifies a file dialog box.
Parameters
ownerThe 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.

§ script_only() [1/2]

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

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)
inline

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.

§ show_apply() [1/2]

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

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)
inline

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

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

§ show_color() [1/2]

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

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)
inline

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

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

§ show_effect() [1/2]

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

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)
inline

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

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

§ show_help() [1/2]

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

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)
inline

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

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

Member Data Documentation

§ apply

event<font_dialog, event_handler<component&> > 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.

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