xtd::forms::font_box Class Reference

Inheritance diagram for xtd::forms::font_box:

Definition

Represents a common dialog box that displays a dialog to the user to choose a font from among those installed on the local computer.

Header

#include <xtd/forms/font_box>

Namespace

xtd::forms

Library

xtd.forms

Appearance

	Windows	macOS	Gnome
Light
Dark

Examples

The following code example demonstrates the use of xtd::forms::font_box dialog.

#include <xtd/xtd>
 
class form1 : public form {
public:
  form1() {
    text("Font box example");
    client_size({220, 160});
    controls().add_range({button_font, button_font_and_color});
    
    button_font.parent(*this)
    .location({10, 10})
    .text("Select a font")
    .size({200, 45})
    .click += delegate_ {
      auto font = system_fonts::default_font();
      auto res = font_box::show(font, *this);
      if (res == dialog_result::ok)
        message_box::show(string::format("Selected font is: {}", font));
    };
    
    button_font_and_color.parent(*this)
    .location({10, 60})
    .text("Select a font and a font color")
    .size({200, 45})
    .click += delegate_ {
      drawing::font font(drawing::font_family::generic_sans_serif(), 16);
      drawing::color color = drawing::color::blue;
      auto res = font_box::show(font, color, font_box_options::show_color);
      if (res == dialog_result::ok)
        message_box::show(string::format("Selected font is: {}\ncolor: {}", font, color));
    };
  }
  
private:
  button button_font;
  button button_font_and_color;
};
 
auto main() -> int {
  application::run(form1 {});
}

Public Static Methods
static auto	show (xtd::drawing::font &font) -> xtd::forms::dialog_result
	Displays a font dialog box.
static auto	show (xtd::drawing::font &font, const font_box_options options) -> xtd::forms::dialog_result
	Displays a font dialog box.
static auto	show (xtd::drawing::font &font, const iwin32_window &owner) -> xtd::forms::dialog_result
	Displays a font dialog box in front of a specified window.
static auto	show (xtd::drawing::font &font, const iwin32_window &owner, const font_box_options options) -> xtd::forms::dialog_result
	Displays a font dialog box in front of a specified window.
static auto	show (xtd::drawing::font &font, xtd::drawing::color &color) -> xtd::forms::dialog_result
	Displays a font dialog box.
static auto	show (xtd::drawing::font &font, xtd::drawing::color &color, const font_box_options options) -> xtd::forms::dialog_result
	Displays a font dialog box.
static auto	show (xtd::drawing::font &font, xtd::drawing::color &color, const iwin32_window &owner) -> xtd::forms::dialog_result
	Displays a font dialog box in front of a specified window.
static auto	show (xtd::drawing::font &font, xtd::drawing::color &color, const iwin32_window &owner, const font_box_options options) -> xtd::forms::dialog_result
	Displays a font dialog box in front of a specified window.

Member Function Documentation

show() [1/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box.

Parameters

font	An output xtd::drawing::font that will store the selected font.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output font parameter will contain the selected font, otherwise it will be ignored.

show() [2/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font, const font_box_options options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box.

Parameters

font	An output xtd::drawing::font that will store the selected font.
options	A bitwise combination of enum xtd::forms::font_box_options to specify additional options to the font dialog box.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output font parameter will contain the selected font, otherwise it will be ignored.

show() [3/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font, const iwin32_window & owner ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box in front of a specified window.

Parameters

font	An output xtd::drawing::font that will store the selected font.
owner	An xtd::forms::iwin32_window that represents the owner window of the font dialog box.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output font parameter will contain the selected font, otherwise it will be ignored.

show() [4/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font, const iwin32_window & owner, const font_box_options options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box in front of a specified window.

Parameters

font	An output xtd::drawing::font that will store the selected font.
owner	An xtd::forms::iwin32_window that represents the owner window of the font dialog box.
options	A bitwise combination of enum xtd::forms::font_box_options to specify additional options to the font dialog box.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is ok, the output font parameter will contain the selected font, otherwise it will be ignored.

show() [5/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font, xtd::drawing::color & color ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box.

Parameters

font	An output xtd::drawing::font that will store the selected font.
color	An output xtd::drawing::color that will store the selected font color.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output parameters font and color will contain the selected font and color, otherwise they will be ignored.

show() [6/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font, xtd::drawing::color & color, const font_box_options options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box.

Parameters

font	An output xtd::drawing::font that will store the selected font.
color	An output xtd::drawing::color that will store the selected font color.
options	A bitwise combination of enum xtd::forms::font_box_options to specify additional options to the font dialog box.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output parameters font and color will contain the selected font and color, otherwise they will be ignored.

show() [7/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font, xtd::drawing::color & color, const iwin32_window & owner ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box in front of a specified window.

Parameters

font	An output xtd::drawing::font that will store the selected font.
color	An output xtd::drawing::color that will store the selected font color.
owner	An xtd::forms::iwin32_window that represents the owner window of the font dialog box.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output parameters font and color will contain the selected font and color, otherwise they will be ignored.

show() [8/8]

auto xtd::forms::font_box::show ( xtd::drawing::font & font, xtd::drawing::color & color, const iwin32_window & owner, const font_box_options options ) -> xtd::forms::dialog_result

staticnodiscard

Displays a font dialog box in front of a specified window.

Parameters

font	An output xtd::drawing::font that will store the selected font.
color	An output xtd::drawing::color that will store the selected font color.
owner	An xtd::forms::iwin32_window that represents the owner window of the font dialog box.
options	A bitwise combination of enum xtd::forms::font_box_options to specify additional options to the font dialog box.

Returns

xtd::forms::dialog_result::ok if the user clicks OK in the dialog box; otherwise, xtd::forms::dialog_result::cancel.

Remarks

If xtd::forms::dialog_result is xtd::forms::dialog_result::ok, the output parameters font and color will contain the selected font and color, otherwise they will be ignored.

---

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

• xtd.forms/include/xtd/forms/font_box.hpp