Struct gtk4::FontDialog

pub struct FontDialog { /* private fields */ }

Available on crate feature v4_10 only.

A FontDialog object collects the arguments that are needed to present a font chooser dialog to the user, such as a title for the dialog and whether it should be modal.

The dialog is shown with the choose_font() function or its variants. This API follows the GIO async pattern, and the result can be obtained by calling the corresponding finish function, such as Gtk::FontDialog::choose_font_finish().

See FontDialogButton for a convenient control that uses FontDialog and presents the results.

Properties

filter

Sets a filter to restrict what fonts are shown in the font chooser dialog.

Readable | Writeable

font-map

Sets a custom font map to select fonts from.

A custom font map can be used to present application-specific fonts instead of or in addition to the normal system fonts.

Readable | Writeable

language

The language for which the font features are selected.

Readable | Writeable

modal

Whether the font chooser dialog is modal.

Readable | Writeable

title

A title that may be shown on the font chooser dialog that is presented by FontDialog::choose_font().

Readable | Writeable

Implements

[trait@glib::ObjectExt]

Implementations

impl FontDialog

pub fn new() -> FontDialog

Creates a new FontDialog object.

Returns

the new FontDialog

pub fn builder() -> FontDialogBuilder

Creates a new builder-pattern struct instance to construct FontDialog objects.

This method returns an instance of FontDialogBuilder which can be used to create FontDialog objects.

pub fn choose_face<P: FnOnce(Result<FontFace, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, initial_value: Option<&impl IsA<FontFace>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function initiates a font selection operation by presenting a dialog to the user for selecting a font face (i.e. a font family and style, but not a specific font size).

The @callback will be called when the dialog is dismissed. It should call Gtk::FontDialog::choose_face_finish() to obtain the result.

parent

the parent Window

initial_value

the initial value

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn choose_face_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)>, initial_value: Option<&(impl IsA<FontFace> + Clone + 'static)> ) -> Pin<Box_<dyn Future<Output = Result<FontFace, Error>> + 'static>>

pub fn choose_family<P: FnOnce(Result<FontFamily, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, initial_value: Option<&impl IsA<FontFamily>>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function initiates a font selection operation by presenting a dialog to the user for selecting a font family.

The @callback will be called when the dialog is dismissed. It should call Gtk::FontDialog::choose_family_finish() to obtain the result.

parent

the parent Window

initial_value

the initial value

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn choose_family_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)>, initial_value: Option<&(impl IsA<FontFamily> + Clone + 'static)> ) -> Pin<Box_<dyn Future<Output = Result<FontFamily, Error>> + 'static>>

pub fn choose_font<P: FnOnce(Result<FontDescription, Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, initial_value: Option<&FontDescription>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function initiates a font selection operation by presenting a dialog to the user for selecting a font.

The @callback will be called when the dialog is dismissed. It should call Gtk::FontDialog::choose_font_finish() to obtain the result.

If you want to let the user select font features as well, use choose_font_and_features() instead.

parent

the parent Window

initial_value

the font to select initially

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn choose_font_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)>, initial_value: Option<&FontDescription> ) -> Pin<Box_<dyn Future<Output = Result<FontDescription, Error>> + 'static>>

pub fn filter(&self) -> Option<Filter>

Returns the filter that decides which fonts to display in the font chooser dialog.

Returns

the filter

pub fn font_map(&self) -> Option<FontMap>

Returns the fontmap from which fonts are selected, or NULL for the default fontmap.

Returns

the fontmap

pub fn language(&self) -> Option<Language>

Returns the language for which font features are applied.

Returns

the language for font features

pub fn is_modal(&self) -> bool

Returns whether the font chooser dialog blocks interaction with the parent window while it is presented.

Returns

TRUE if the font chooser dialog is modal

pub fn title(&self) -> GString

Returns the title that will be shown on the font chooser dialog.

Returns

the title

pub fn set_filter(&self, filter: Option<&impl IsA<Filter>>)

Adds a filter that decides which fonts to display in the font chooser dialog.

The Filter must be able to handle both pango::FontFamily and pango::FontFace objects.

filter

a Filter

pub fn set_font_map(&self, fontmap: Option<&impl IsA<FontMap>>)

Sets the fontmap from which fonts are selected.

If @fontmap is NULL, the default fontmap is used.

fontmap

the fontmap

pub fn set_language(&self, language: &Language)

Sets the language for which font features are applied.

language

the language for font features

pub fn set_modal(&self, modal: bool)

Sets whether the font chooser dialog blocks interaction with the parent window while it is presented.

modal

the new value

pub fn set_title(&self, title: &str)

Sets the title that will be shown on the font chooser dialog.

title

the new title

pub fn connect_filter_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_font_map_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_language_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_modal_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

pub fn connect_title_notify<F: Fn(&Self) + 'static>( &self, f: F ) -> SignalHandlerId

impl FontDialog

pub fn choose_font_and_features<P: FnOnce(Result<(Option<FontDescription>, GString, Language), Error>) + 'static>( &self, parent: Option<&impl IsA<Window>>, initial_value: Option<&FontDescription>, cancellable: Option<&impl IsA<Cancellable>>, callback: P )

This function initiates a font selection operation by presenting a dialog to the user for selecting a font and font features.

Font features affect how the font is rendered, for example enabling glyph variants or ligatures.

The @callback will be called when the dialog is dismissed. It should call Gtk::FontDialog::choose_font_and_features_finish() to obtain the result.

parent

the parent Window

initial_value

the font to select initially

cancellable

a GCancellable to cancel the operation

callback

a callback to call when the operation is complete

pub fn choose_font_and_features_future( &self, parent: Option<&(impl IsA<Window> + Clone + 'static)>, initial_value: Option<&FontDescription> ) -> Pin<Box_<dyn Future<Output = Result<(Option<FontDescription>, GString, Language), Error>> + 'static>>

Trait Implementations

impl Clone for FontDialog

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FontDialog

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FontDialog

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for FontDialog

type ParamSpec = ParamSpecObject

type SetValue = FontDialog

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, FontDialog>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FontDialog

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FontDialog

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for FontDialog

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for FontDialog

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for FontDialog

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for FontDialog

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FontDialog