Struct gtk4::FontButton

#[repr(transparent)]
pub struct FontButton { /* private fields */ }

Use FontDialogButton instead The FontButton allows to open a font chooser dialog to change the font.

It is suitable widget for selecting a font in a preference dialog.

CSS nodes

fontbutton
╰── button.font
    ╰── [content]

FontButton has a single CSS node with name fontbutton which contains a button node with the .font style class.

Properties

modal

Whether the font chooser dialog should be modal.

Readable | Writeable

title

The title of the font chooser dialog.

Readable | Writeable

use-font

Whether the buttons label will be drawn in the selected font.

Readable | Writeable

use-size

Whether the buttons label will use the selected font size.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the ::query-tooltip signal on @widget.

A value of true indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Override for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from WidgetExt::set_size_request() for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The Root widget of the widget tree containing this widget.

This will be None if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not None: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Override for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

FontChooser

font

The font description as a string, e.g. “Sans Italic 12”.

Readable | Writeable

font-desc

The font description as a pango::FontDescription.

Readable | Writeable

font-features

The selected font features.

The format of the string is compatible with CSS and with Pango attributes.

Readable

language

The language for which the font features were selected.

Readable | Writeable

level

The level of granularity to offer for selecting fonts.

Readable | Writeable

preview-text

The string with which to preview the font.

Readable | Writeable

show-preview-entry

Whether to show an entry to change the preview text.

Readable | Writeable

Signals

activate

Emitted to when the font button is activated.

The ::activate signal on FontButton is an action signal and emitting it causes the button to present its dialog.

Action

font-set

Emitted when the user selects a font.

When handling this signal, use FontChooserExt::font() to find out which font was just selected.

Note that this signal is only emitted when the user changes the font. If you need to react to programmatic font changes as well, use the notify::font signal.

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

Action

query-tooltip

Emitted when the widgets tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering “above” @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a gdk::Surface.

This means that WidgetExt::realize() has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the gdk::Surface associated with @widget is destroyed.

This means that WidgetExt::unrealize() has been called or the widget has been unmapped (that is, it is going to be hidden).

FontChooser

font-activated

Emitted when a font is activated.

This usually happens when the user double clicks an item, or an item is selected and the user presses one of the keys Space, Shift+Space, Return or Enter.

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, FontChooserExt, WidgetExtManual, AccessibleExtManual, FontChooserExtManual

Implementations

impl FontButton

pub fn new() -> FontButton

Creates a new font picker widget.

Deprecated since 4.10

Use FontDialogButton instead

Returns

a new font picker widget.

pub fn with_font(fontname: &str) -> FontButton

Creates a new font picker widget showing the given font.

Deprecated since 4.10

Use FontDialogButton instead

fontname

Name of font to display in font chooser dialog

Returns

a new font picker widget.

pub fn builder() -> FontButtonBuilder

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

This method returns an instance of FontButtonBuilder which can be used to create FontButton objects.

pub fn is_modal(&self) -> bool

Gets whether the dialog is modal.

Deprecated since 4.10

Use FontDialogButton instead

Returns

true if the dialog is modal

pub fn title(&self) -> GString

Retrieves the title of the font chooser dialog.

Deprecated since 4.10

Use FontDialogButton instead

Returns

an internal copy of the title string which must not be freed.

pub fn uses_font(&self) -> bool

Returns whether the selected font is used in the label.

Deprecated since 4.10

Use FontDialogButton instead

Returns

whether the selected font is used in the label.

pub fn uses_size(&self) -> bool

Returns whether the selected size is used in the label.

Deprecated since 4.10

Use FontDialogButton instead

Returns

whether the selected size is used in the label.

pub fn set_modal(&self, modal: bool)

Sets whether the dialog should be modal.

Deprecated since 4.10

Use FontDialogButton instead

modal

true to make the dialog modal

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

Sets the title for the font chooser dialog.

Deprecated since 4.10

Use FontDialogButton instead

title

a string containing the font chooser dialog title

pub fn set_use_font(&self, use_font: bool)

If @use_font is true, the font name will be written using the selected font.

Deprecated since 4.10

Use FontDialogButton instead

use_font

If true, font name will be written using font chosen.

pub fn set_use_size(&self, use_size: bool)

If @use_size is true, the font name will be written using the selected size.

Deprecated since 4.10

Use FontDialogButton instead

use_size

If true, font name will be written using the selected size.

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

Available on crate feature v4_4 only.

Emitted to when the font button is activated.

The ::activate signal on FontButton is an action signal and emitting it causes the button to present its dialog.

pub fn emit_activate(&self)

Available on crate feature v4_4 only.

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

Emitted when the user selects a font.

When handling this signal, use FontChooserExt::font() to find out which font was just selected.

Note that this signal is only emitted when the user changes the font. If you need to react to programmatic font changes as well, use the notify::font signal.

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

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

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

Trait Implementations

impl Clone for FontButton

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 FontButton

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

Formats the value using the given formatter.

impl Default for FontButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for FontButton

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

Formats the value using the given formatter.

impl HasParamSpec for FontButton

type ParamSpec = ParamSpecObject

type SetValue = FontButton

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for FontButton

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 FontButton

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl ParentClassIs for FontButton

type Parent = Widget

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

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 FontButton

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 FontButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for FontButton

impl IsA<Accessible> for FontButton

impl IsA<Buildable> for FontButton

impl IsA<ConstraintTarget> for FontButton

impl IsA<FontChooser> for FontButton

impl IsA<Widget> for FontButton