Struct gtk4::Label

source ·
pub struct Label { /* private fields */ }
Expand description

The Label widget displays a small amount of text.

As the name implies, most labels are used to label another widget such as a Button.

An example GtkLabel

§CSS nodes

label
├── [selection]
├── [link]
┊
╰── [link]

Label has a single CSS node with the name label. A wide variety of style classes may be applied to labels, such as .title, .subtitle, .dim-label, etc. In the ShortcutsWindow, labels are used with the .keycap style class.

If the label has a selection, it gets a subnode with name selection.

If the label has links, there is one subnode per link. These subnodes carry the link or visited state depending on whether they have been visited. In this case, label node also gets a .link style class.

§GtkLabel as GtkBuildable

The GtkLabel implementation of the GtkBuildable interface supports a custom <attributes> element, which supports any number of <attribute> elements. The <attribute> element has attributes named “name“, “value“, “start“ and “end“ and allows you to specify Pango::Attribute values for this label.

An example of a UI definition fragment specifying Pango attributes:

<object class="GtkLabel">
  <attributes>
    <attribute name="weight" value="PANGO_WEIGHT_BOLD"/>
    <attribute name="background" value="red" start="5" end="10"/>
  </attributes>
</object>

The start and end attributes specify the range of characters to which the Pango attribute applies. If start and end are not specified, the attribute is applied to the whole text. Note that specifying ranges does not make much sense with translatable attributes. Use markup embedded in the translatable content instead.

§Accessibility

Label uses the AccessibleRole::Label role.

§Mnemonics

Labels may contain “mnemonics”. Mnemonics are underlined characters in the label, used for keyboard navigation. Mnemonics are created by providing a string with an underscore before the mnemonic character, such as "_File", to the functions with_mnemonic() or set_text_with_mnemonic().

Mnemonics automatically activate any activatable widget the label is inside, such as a Button; if the label is not inside the mnemonic’s target widget, you have to tell the label about the target using set_mnemonic_widget().

Here’s a simple example where the label is inside a button:

⚠️ The following code is in c ⚠️

// Pressing Alt+H will activate this button
GtkWidget *button = gtk_button_new ();
GtkWidget *label = gtk_label_new_with_mnemonic ("_Hello");
gtk_button_set_child (GTK_BUTTON (button), label);

There’s a convenience function to create buttons with a mnemonic label already inside:

⚠️ The following code is in c ⚠️

// Pressing Alt+H will activate this button
GtkWidget *button = gtk_button_new_with_mnemonic ("_Hello");

To create a mnemonic for a widget alongside the label, such as a Entry, you have to point the label at the entry with set_mnemonic_widget():

⚠️ The following code is in c ⚠️

// Pressing Alt+H will focus the entry
GtkWidget *entry = gtk_entry_new ();
GtkWidget *label = gtk_label_new_with_mnemonic ("_Hello");
gtk_label_set_mnemonic_widget (GTK_LABEL (label), entry);

§Markup (styled text)

To make it easy to format text in a label (changing colors, fonts, etc.), label text can be provided in a simple markup format:

Here’s how to create a label with a small font: ⚠️ The following code is in c ⚠️

GtkWidget *label = gtk_label_new (NULL);
gtk_label_set_markup (GTK_LABEL (label), "<small>Small text</small>");

(See the Pango manual for complete documentation] of available tags, parse_markup())

The markup passed to set_markup() must be valid; for example, literal <, > and & characters must be escaped as &lt;, &gt;, and &amp;. If you pass text obtained from the user, file, or a network to set_markup(), you’ll want to escape it with markup_escape_text() or markup_printf_escaped().

Markup strings are just a convenient way to set the pango::AttrList on a label; set_attributes() may be a simpler way to set attributes in some cases. Be careful though; pango::AttrList tends to cause internationalization problems, unless you’re applying attributes to the entire string (i.e. unless you set the range of each attribute to [0, G_MAXINT)). The reason is that specifying the start_index and end_index for a Pango::Attribute requires knowledge of the exact string being displayed, so translations will cause problems.

§Selectable labels

Labels can be made selectable with set_selectable(). Selectable labels allow the user to copy the label contents to the clipboard. Only labels that contain useful-to-copy information—such as error messages—should be made selectable.

§Text layout

A label can contain any number of paragraphs, but will have performance problems if it contains more than a small number. Paragraphs are separated by newlines or other paragraph separators understood by Pango.

Labels can automatically wrap text if you call set_wrap().

set_justify() sets how the lines in a label align with one another. If you want to set how the label as a whole aligns in its available space, see the halign and valign properties.

The width-chars and max-width-chars properties can be used to control the size allocation of ellipsized or wrapped labels. For ellipsizing labels, if either is specified (and less than the actual text size), it is used as the minimum width, and the actual text size is used as the natural width of the label. For wrapping labels, width-chars is used as the minimum width, if specified, and max-width-chars is used as the natural width. Even if max-width-chars specified, wrapping labels will be rewrapped to use all of the available width.

GTK supports markup for clickable hyperlinks in addition to regular Pango markup. The markup for links is borrowed from HTML, using the <a> with “href“, “title“ and “class“ attributes. GTK renders links similar to the way they appear in web browsers, with colored, underlined text. The “title“ attribute is displayed as a tooltip on the link. The “class“ attribute is used as style class on the CSS node for the link.

An example of inline links looks like this:

⚠️ The following code is in c ⚠️

const char *text =
"Go to the "
"<a href=\"https://www.gtk.org\" title=\"&lt;i&gt;Our&lt;/i&gt; website\">"
"GTK website</a> for more...";
GtkWidget *label = gtk_label_new (NULL);
gtk_label_set_markup (GTK_LABEL (label), text);

It is possible to implement custom handling for links and their tooltips with the activate-link signal and the current_uri() function.

§Properties

§attributes

A list of style attributes to apply to the text of the label.

Readable | Writeable

§ellipsize

The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.

Note that setting this property to a value other than pango::EllipsizeMode::None has the side-effect that the label requests only enough space to display the ellipsis “…”. In particular, this means that ellipsizing labels do not work well in notebook tabs, unless the tab-expand child property is set to true. Other ways to set a label’s width are WidgetExt::set_size_request() and Label::set_width_chars().

Readable | Writeable

§extra-menu

A menu model whose contents will be appended to the context menu.

Readable | Writeable

§justify

The alignment of the lines in the text of the label, relative to each other.

This does not affect the alignment of the label within its allocation. See xalign for that.

Readable | Writeable

§label

The contents of the label.

If the string contains Pango markup (see parse_markup()), you will have to set the use-markup property to true in order for the label to display the markup attributes. See also Label::set_markup() for a convenience function that sets both this property and the use-markup property at the same time.

If the string contains underlines acting as mnemonics, you will have to set the use-underline property to true in order for the label to display them.

Readable | Writeable

§lines

The number of lines to which an ellipsized, wrapping label should be limited.

This property has no effect if the label is not wrapping or ellipsized. Set this property to -1 if you don’t want to limit the number of lines.

Readable | Writeable

§max-width-chars

The desired maximum width of the label, in characters.

If this property is set to -1, the width will be calculated automatically.

See the section on text layout for details of how width-chars and max-width-chars determine the width of ellipsized and wrapped labels.

Readable | Writeable

§mnemonic-keyval

The mnemonic accelerator key for the label.

Readable

§mnemonic-widget

The widget to be activated when the labels mnemonic key is pressed.

Readable | Writeable

§natural-wrap-mode

Select the line wrapping for the natural size request.

This only affects the natural size requested. For the actual wrapping used, see the wrap-mode property.

The default is NaturalWrapMode::Inherit, which inherits the behavior of the wrap-mode property.

Readable | Writeable

§selectable

Whether the label text can be selected with the mouse.

Readable | Writeable

§single-line-mode

Whether the label is in single line mode.

In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This can be an advantage in situations where resizing the label because of text changes would be distracting, e.g. in a statusbar.

Readable | Writeable

§tabs

Custom tabs for this label.

Readable | Writeable

§use-markup

true if the text of the label includes Pango markup.

See parse_markup().

Readable | Writeable

§use-underline

true if the text of the label indicates a mnemonic with an _ before the mnemonic character.

Readable | Writeable

§width-chars

The desired width of the label, in characters.

If this property is set to -1, the width will be calculated automatically.

See the section on text layout for details of how width-chars and max-width-chars determine the width of ellipsized and wrapped labels.

Readable | Writeable

§wrap

true if the label text will wrap if it gets too wide.

Readable | Writeable

§wrap-mode

Controls how the line wrapping is done.

This only affects the formatting if line wrapping is on (see the wrap property). The default is pango::WrapMode::Word, which means wrap on word boundaries.

For sizing behavior, also consider the natural-wrap-mode property.

Readable | Writeable

§xalign

The horizontal alignment of the label text inside its size allocation.

Compare this to halign, which determines how the labels size allocation is positioned in the space available for the label.

Readable | Writeable

§yalign

The vertical alignment of the label text inside its size allocation.

Compare this to valign, which determines how the labels size allocation is positioned in the space available for the label.

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

§Signals

Gets emitted when the user activates a link in the label.

The ::activate-current-link is a keybinding signal.

Applications may also emit the signal with g_signal_emit_by_name() if they need to control activation of URIs programmatically.

The default bindings for this signal are all forms of the Enter key.

Action

Gets emitted to activate a URI.

Applications may connect to it to override the default behaviour, which is to call FileLauncher::launch().

§copy-clipboard

Gets emitted to copy the selection to the clipboard.

The ::copy-clipboard signal is a keybinding signal.

The default binding for this signal is Ctrl+c.

Action

§move-cursor

Gets emitted when the user initiates a cursor movement.

The ::move-cursor signal is a keybinding signal. If the cursor is not visible in @entry, this signal causes the viewport to be moved instead.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.

  • , , , move by individual characters/lines
  • Ctrl+, etc. move by words/paragraphs
  • Home and End move to the ends of the buffer

Action

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.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

§query-tooltip

Emitted when the widget’s 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).

§Implements

WidgetExt, [trait@glib::ObjectExt], AccessibleExt, BuildableExt, ConstraintTargetExt, WidgetExtManual, AccessibleExtManual

Implementations§

source§

impl Label

source

pub fn new(str: Option<&str>) -> Label

Creates a new label with the given text inside it.

You can pass None to get an empty label widget.

§str

The text of the label

§Returns

the new Label

source

pub fn with_mnemonic(str: &str) -> Label

Creates a new Label, containing the text in @str.

If characters in @str are preceded by an underscore, they are underlined. If you need a literal underscore character in a label, use ‘__’ (two underscores). The first underlined character represents a keyboard accelerator called a mnemonic. The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using set_mnemonic_widget().

If set_mnemonic_widget() is not called, then the first activatable ancestor of the Label will be chosen as the mnemonic widget. For instance, if the label is inside a button or menu item, the button or menu item will automatically become the mnemonic widget and be activated by the mnemonic.

§str

The text of the label, with an underscore in front of the mnemonic character

§Returns

the new Label

source

pub fn builder() -> LabelBuilder

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

This method returns an instance of LabelBuilder which can be used to create Label objects.

source

pub fn attributes(&self) -> Option<AttrList>

Gets the label’s attribute list.

This is the pango::AttrList that was set on the label using set_attributes(), if any. This function does not reflect attributes that come from the label’s markup (see set_markup()). If you want to get the effective attributes for the label, use pango_layout_get_attributes (gtk_label_get_layout (self)).

§Returns

the attribute list

source

pub fn current_uri(&self) -> Option<GString>

Returns the URI for the currently active link in the label.

The active link is the one under the mouse pointer or, in a selectable label, the link in which the text cursor is currently positioned.

This function is intended for use in a activate-link handler or for use in a query-tooltip handler.

§Returns

the currently active URI

source

pub fn ellipsize(&self) -> EllipsizeMode

Returns the ellipsizing position of the label.

See set_ellipsize().

§Returns

pango::EllipsizeMode

source

pub fn extra_menu(&self) -> Option<MenuModel>

Gets the extra menu model of @label.

See set_extra_menu().

§Returns

the menu model

source

pub fn justify(&self) -> Justification

Returns the justification of the label.

See set_justify().

§Returns

Justification

source

pub fn label(&self) -> GString

Fetches the text from a label.

The returned text includes any embedded underlines indicating mnemonics and Pango markup. (See text()).

§Returns

the text of the label widget. This string is owned by the widget and must not be modified or freed.

source

pub fn layout(&self) -> Layout

Gets the pango::Layout used to display the label.

The layout is useful to e.g. convert text positions to pixel positions, in combination with layout_offsets(). The returned layout is owned by the @label so need not be freed by the caller. The @label is free to recreate its layout at any time, so it should be considered read-only.

§Returns

the pango::Layout for this label

source

pub fn layout_offsets(&self) -> (i32, i32)

Obtains the coordinates where the label will draw its pango::Layout.

The coordinates are useful to convert mouse events into coordinates inside the pango::Layout, e.g. to take some action if some part of the label is clicked. Remember when using the pango::Layout functions you need to convert to and from pixels using PANGO_PIXELS() or Pango::SCALE.

§Returns
§x

location to store X offset of layout

§y

location to store Y offset of layout

source

pub fn lines(&self) -> i32

Gets the number of lines to which an ellipsized, wrapping label should be limited.

See set_lines().

§Returns

The number of lines

source

pub fn max_width_chars(&self) -> i32

Retrieves the desired maximum width of @label, in characters.

See set_width_chars().

§Returns

the maximum width of the label in characters.

source

pub fn mnemonic_widget(&self) -> Option<Widget>

Retrieves the target of the mnemonic (keyboard shortcut) of this label.

See set_mnemonic_widget().

§Returns

the target of the label’s mnemonic, or None if none has been set and the default algorithm will be used.

source

pub fn natural_wrap_mode(&self) -> NaturalWrapMode

Available on crate feature v4_6 only.

Returns line wrap mode used by the label.

See set_natural_wrap_mode().

§Returns

the natural line wrap mode

source

pub fn is_selectable(&self) -> bool

Returns whether the label is selectable.

§Returns

true if the user can copy text from the label

source

pub fn selection_bounds(&self) -> Option<(i32, i32)>

Gets the selected range of characters in the label.

§Returns

true if selection is non-empty

§start

return location for start of selection, as a character offset

§end

return location for end of selection, as a character offset

source

pub fn is_single_line_mode(&self) -> bool

Returns whether the label is in single line mode.

§Returns

true when the label is in single line mode.

source

pub fn tabs(&self) -> Option<TabArray>

Available on crate feature v4_8 only.

Gets the tabs for @self.

The returned array will be None if “standard” (8-space) tabs are used. Free the return value with Pango::TabArray::free().

§Returns

copy of default tab array, or None if standard tabs are used; must be freed with Pango::TabArray::free().

source

pub fn text(&self) -> GString

Fetches the text from a label.

The returned text is as it appears on screen. This does not include any embedded underlines indicating mnemonics or Pango markup. (See label())

§Returns

the text in the label widget. This is the internal string used by the label, and must not be modified.

source

pub fn uses_markup(&self) -> bool

Returns whether the label’s text is interpreted as Pango markup.

See set_use_markup().

§Returns

true if the label’s text will be parsed for markup.

source

pub fn uses_underline(&self) -> bool

Returns whether an embedded underlines in the label indicate mnemonics.

See set_use_underline().

§Returns

true whether an embedded underline in the label indicates the mnemonic accelerator keys.

source

pub fn width_chars(&self) -> i32

Retrieves the desired width of @label, in characters.

See set_width_chars().

§Returns

the width of the label in characters.

source

pub fn wraps(&self) -> bool

Returns whether lines in the label are automatically wrapped.

See set_wrap().

§Returns

true if the lines of the label are automatically wrapped.

source

pub fn wrap_mode(&self) -> WrapMode

Returns line wrap mode used by the label.

See set_wrap_mode().

§Returns

the line wrap mode

source

pub fn xalign(&self) -> f32

Gets the xalign of the label.

See the xalign property.

§Returns

the xalign property

source

pub fn yalign(&self) -> f32

Gets the yalign of the label.

See the yalign property.

§Returns

the yalign property

source

pub fn select_region(&self, start_offset: i32, end_offset: i32)

Selects a range of characters in the label, if the label is selectable.

See set_selectable(). If the label is not selectable, this function has no effect. If @start_offset or @end_offset are -1, then the end of the label will be substituted.

§start_offset

start offset (in characters not bytes)

§end_offset

end offset (in characters not bytes)

source

pub fn set_attributes(&self, attrs: Option<&AttrList>)

Apply attributes to the label text.

The attributes set with this function will be applied and merged with any other attributes previously effected by way of the use-underline or use-markup properties. While it is not recommended to mix markup strings with manually set attributes, if you must; know that the attributes will be applied to the label after the markup string is parsed.

§attrs

a pango::AttrList

source

pub fn set_ellipsize(&self, mode: EllipsizeMode)

Sets the mode used to ellipsize the text.

The text will be ellipsized if there is not enough space to render the entire string.

§mode

a pango::EllipsizeMode

source

pub fn set_extra_menu(&self, model: Option<&impl IsA<MenuModel>>)

Sets a menu model to add when constructing the context menu for @label.

§model

a GMenuModel

source

pub fn set_justify(&self, jtype: Justification)

Sets the alignment of the lines in the text of the label relative to each other.

Justification::Left is the default value when the widget is first created with new(). If you instead want to set the alignment of the label as a whole, use WidgetExt::set_halign() instead. set_justify() has no effect on labels containing only a single line.

§jtype

a Justification

source

pub fn set_label(&self, str: &str)

Sets the text of the label.

The label is interpreted as including embedded underlines and/or Pango markup depending on the values of the use-underline and use-markup properties.

§str

the new text to set for the label

source

pub fn set_lines(&self, lines: i32)

Sets the number of lines to which an ellipsized, wrapping label should be limited.

This has no effect if the label is not wrapping or ellipsized. Set this to -1 if you don’t want to limit the number of lines.

§lines

the desired number of lines, or -1

source

pub fn set_markup(&self, str: &str)

Sets the labels text and attributes from markup.

The string must be marked up with Pango markup (see parse_markup()).

If the @str is external data, you may need to escape it with g_markup_escape_text() or g_markup_printf_escaped():

⚠️ The following code is in c ⚠️

GtkWidget *self = gtk_label_new (NULL);
const char *str = "...";
const char *format = "<span style=\"italic\">\%s</span>";
char *markup;

markup = g_markup_printf_escaped (format, str);
gtk_label_set_markup (GTK_LABEL (self), markup);
g_free (markup);

This function will set the use-markup property to true as a side effect.

If you set the label contents using the label property you should also ensure that you set the use-markup property accordingly.

See also: set_text()

§str

a markup string

source

pub fn set_markup_with_mnemonic(&self, str: &str)

Sets the labels text, attributes and mnemonic from markup.

Parses @str which is marked up with Pango markup (see parse_markup()), setting the label’s text and attribute list based on the parse results. If characters in @str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic.

The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using set_mnemonic_widget().

§str

a markup string

source

pub fn set_max_width_chars(&self, n_chars: i32)

Sets the desired maximum width in characters of @label to @n_chars.

§n_chars

the new desired maximum width, in characters.

source

pub fn set_mnemonic_widget(&self, widget: Option<&impl IsA<Widget>>)

Associate the label with its mnemonic target.

If the label has been set so that it has a mnemonic key (using i.e. set_markup_with_mnemonic(), set_text_with_mnemonic(), with_mnemonic() or the use_underline property) the label can be associated with a widget that is the target of the mnemonic. When the label is inside a widget (like a Button or a Notebook tab) it is automatically associated with the correct widget, but sometimes (i.e. when the target is a Entry next to the label) you need to set it explicitly using this function.

The target widget will be accelerated by emitting the mnemonic-activate signal on it. The default handler for this signal will activate the widget if there are no mnemonic collisions and toggle focus between the colliding widgets otherwise.

§widget

the target Widget, or None to unset

source

pub fn set_natural_wrap_mode(&self, wrap_mode: NaturalWrapMode)

Available on crate feature v4_6 only.

Select the line wrapping for the natural size request.

This only affects the natural size requested, for the actual wrapping used, see the wrap-mode property.

§wrap_mode

the line wrapping mode

source

pub fn set_selectable(&self, setting: bool)

Makes text in the label selectable.

Selectable labels allow the user to select text from the label, for copy-and-paste.

§setting

true to allow selecting text in the label

source

pub fn set_single_line_mode(&self, single_line_mode: bool)

Sets whether the label is in single line mode.

§single_line_mode

true if the label should be in single line mode

source

pub fn set_tabs(&self, tabs: Option<&TabArray>)

Available on crate feature v4_8 only.

Sets the default tab stops for paragraphs in @self.

§tabs

tabs as a pango::TabArray

source

pub fn set_text(&self, str: &str)

Sets the text within the Label widget.

It overwrites any text that was there before.

This function will clear any previously set mnemonic accelerators, and set the use-underline property to false as a side effect.

This function will set the use-markup property to false as a side effect.

See also: set_markup()

§str

The text you want to set

source

pub fn set_text_with_mnemonic(&self, str: &str)

Sets the label’s text from the string @str.

If characters in @str are preceded by an underscore, they are underlined indicating that they represent a keyboard accelerator called a mnemonic. The mnemonic key can be used to activate another widget, chosen automatically, or explicitly using set_mnemonic_widget().

§str

a string

source

pub fn set_use_markup(&self, setting: bool)

Sets whether the text of the label contains markup.

See set_markup().

§setting

true if the label’s text should be parsed for markup.

source

pub fn set_use_underline(&self, setting: bool)

Sets whether underlines in the text indicate mnemonics.

§setting

true if underlines in the text indicate mnemonics

source

pub fn set_width_chars(&self, n_chars: i32)

Sets the desired width in characters of @label to @n_chars.

§n_chars

the new desired width, in characters.

source

pub fn set_wrap(&self, wrap: bool)

Toggles line wrapping within the Label widget.

true makes it break lines if text exceeds the widget’s size. false lets the text get cut off by the edge of the widget if it exceeds the widget size.

Note that setting line wrapping to true does not make the label wrap at its parent container’s width, because GTK widgets conceptually can’t make their requisition depend on the parent container’s size. For a label that wraps at a specific position, set the label’s width using WidgetExt::set_size_request().

§wrap

the setting

source

pub fn set_wrap_mode(&self, wrap_mode: WrapMode)

Controls how line wrapping is done.

This only affects the label if line wrapping is on. (See set_wrap()) The default is pango::WrapMode::Word which means wrap on word boundaries.

For sizing behavior, also consider the natural-wrap-mode property.

§wrap_mode

the line wrapping mode

source

pub fn set_xalign(&self, xalign: f32)

Sets the xalign of the label.

See the xalign property.

§xalign

the new xalign value, between 0 and 1

source

pub fn set_yalign(&self, yalign: f32)

Sets the yalign of the label.

See the yalign property.

§yalign

the new yalign value, between 0 and 1

Gets emitted when the user activates a link in the label.

The ::activate-current-link is a keybinding signal.

Applications may also emit the signal with g_signal_emit_by_name() if they need to control activation of URIs programmatically.

The default bindings for this signal are all forms of the Enter key.

Gets emitted to activate a URI.

Applications may connect to it to override the default behaviour, which is to call FileLauncher::launch().

§uri

the URI that is activated

§Returns

true if the link has been activated

source

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

Gets emitted to copy the selection to the clipboard.

The ::copy-clipboard signal is a keybinding signal.

The default binding for this signal is Ctrl+c.

source

pub fn emit_copy_clipboard(&self)

source

pub fn connect_move_cursor<F: Fn(&Self, MovementStep, i32, bool) + 'static>( &self, f: F ) -> SignalHandlerId

Gets emitted when the user initiates a cursor movement.

The ::move-cursor signal is a keybinding signal. If the cursor is not visible in @entry, this signal causes the viewport to be moved instead.

Applications should not connect to it, but may emit it with g_signal_emit_by_name() if they need to control the cursor programmatically.

The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifier does not. There are too many key combinations to list them all here.

  • , , , move by individual characters/lines
  • Ctrl+, etc. move by words/paragraphs
  • Home and End move to the ends of the buffer
§step

the granularity of the move, as a MovementStep

§count

the number of @step units to move

§extend_selection

true if the move should extend the selection

source

pub fn emit_move_cursor( &self, step: MovementStep, count: i32, extend_selection: bool )

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

Available on crate feature v4_6 only.
source

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

source

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

source

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

Available on crate feature v4_8 only.
source

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

source

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

source

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

source

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

source

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

source

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

source

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

source§

impl Label

source

pub fn mnemonic_keyval(&self) -> Key

Return the mnemonic accelerator.

If the label has been set so that it has a mnemonic key this function returns the keyval used for the mnemonic accelerator. If there is no mnemonic set up it returns GDK_KEY_VoidSymbol.

§Returns

GDK keyval usable for accelerators, or GDK_KEY_VoidSymbol

Trait Implementations§

source§

impl Clone for Label

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for Label

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for Label

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl HasParamSpec for Label

§

type ParamSpec = ParamSpecObject

§

type SetValue = Label

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

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

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for Label

source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · source§

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

Feeds a slice of this type into the given Hasher. Read more
source§

impl Ord for Label

source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · source§

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

Restrict a value to a certain interval. Read more
source§

impl ParentClassIs for Label

source§

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

source§

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

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

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.
source§

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

source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · source§

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

This method tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · source§

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

This method tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · source§

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

This method tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · source§

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

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

impl StaticType for Label

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for Label

source§

impl IsA<Accessible> for Label

source§

impl IsA<Buildable> for Label

source§

impl IsA<ConstraintTarget> for Label

source§

impl IsA<Widget> for Label

Auto Trait Implementations§

§

impl RefUnwindSafe for Label

§

impl !Send for Label

§

impl !Sync for Label

§

impl Unpin for Label

§

impl UnwindSafe for Label

Blanket Implementations§

source§

impl<O> AccessibleExt for O
where O: IsA<Accessible>,

source§

fn announce(&self, message: &str, priority: AccessibleAnnouncementPriority)

Available on crate feature v4_14 only.
Requests the user’s screen reader to announce the given message. Read more
source§

fn accessible_parent(&self) -> Option<Accessible>

Available on crate feature v4_10 only.
Retrieves the accessible parent for an accessible object. Read more
source§

fn accessible_role(&self) -> AccessibleRole

Retrieves the accessible role of an accessible object. Read more
source§

fn at_context(&self) -> ATContext

Available on crate feature v4_10 only.
Retrieves the accessible implementation for the given Accessible. Read more
source§

fn bounds(&self) -> Option<(i32, i32, i32, i32)>

Available on crate feature v4_10 only.
Queries the coordinates and dimensions of this accessible Read more
source§

fn first_accessible_child(&self) -> Option<Accessible>

Available on crate feature v4_10 only.
Retrieves the first accessible child of an accessible object. Read more
source§

fn next_accessible_sibling(&self) -> Option<Accessible>

Available on crate feature v4_10 only.
Retrieves the next accessible sibling of an accessible object Read more
source§

fn platform_state(&self, state: AccessiblePlatformState) -> bool

Available on crate feature v4_10 only.
Query a platform state, such as focus. Read more
source§

fn reset_property(&self, property: AccessibleProperty)

Resets the accessible @property to its default value. Read more
source§

fn reset_relation(&self, relation: AccessibleRelation)

Resets the accessible @relation to its default value. Read more
source§

fn reset_state(&self, state: AccessibleState)

Resets the accessible @state to its default value. Read more
source§

fn set_accessible_parent( &self, parent: Option<&impl IsA<Accessible>>, next_sibling: Option<&impl IsA<Accessible>> )

Available on crate feature v4_10 only.
Sets the parent and sibling of an accessible object. Read more
source§

fn update_next_accessible_sibling( &self, new_sibling: Option<&impl IsA<Accessible>> )

Available on crate feature v4_10 only.
Updates the next accessible sibling of @self. Read more
source§

fn set_accessible_role(&self, accessible_role: AccessibleRole)

The accessible role of the given Accessible implementation. Read more
source§

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

source§

impl<O> AccessibleExtManual for O
where O: IsA<Accessible>,

source§

fn update_property(&self, properties: &[Property<'_>])

Updates an array of accessible properties. Read more
source§

fn update_relation(&self, relations: &[Relation<'_>])

Updates an array of accessible relations. Read more
source§

fn update_state(&self, states: &[State])

Updates an array of accessible states. Read more
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<O> BuildableExt for O
where O: IsA<Buildable>,

source§

fn buildable_id(&self) -> Option<GString>

Gets the ID of the @self object. Read more
source§

impl<T> Cast for T
where T: ObjectType,

source§

fn upcast<T>(self) -> T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a superclass or interface T. Read more
source§

fn upcast_ref<T>(&self) -> &T
where T: ObjectType, Self: IsA<T>,

Upcasts an object to a reference of its superclass or interface T. Read more
source§

fn downcast<T>(self) -> Result<T, Self>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a subclass or interface implementor T. Read more
source§

fn downcast_ref<T>(&self) -> Option<&T>
where T: ObjectType, Self: MayDowncastTo<T>,

Tries to downcast to a reference of its subclass or interface implementor T. Read more
source§

fn dynamic_cast<T>(self) -> Result<T, Self>
where T: ObjectType,

Tries to cast to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while upcast will do many checks at compile-time already. downcast will perform the same checks at runtime as dynamic_cast, but will also ensure some amount of compile-time safety. Read more
source§

fn dynamic_cast_ref<T>(&self) -> Option<&T>
where T: ObjectType,

Tries to cast to reference to an object of type T. This handles upcasting, downcasting and casting between interface and interface implementors. All checks are performed at runtime, while downcast and upcast will do many checks at compile-time already. Read more
source§

unsafe fn unsafe_cast<T>(self) -> T
where T: ObjectType,

Casts to T unconditionally. Read more
source§

unsafe fn unsafe_cast_ref<T>(&self) -> &T
where T: ObjectType,

Casts to &T unconditionally. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( _: *const GPtrArray, _: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GPtrArray, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *const GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(_: *const GSList, _: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GList, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec( ptr: *mut GPtrArray, num: usize ) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GPtrArray, num: usize) -> Vec<T>

source§

impl<T> FromGlibContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_container_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

unsafe fn from_glib_full_num_as_vec(ptr: *mut GSList, num: usize) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *const GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(_: *const GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(_: *const GSList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GList) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GPtrArray> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GPtrArray) -> Vec<T>

source§

impl<T> FromGlibPtrArrayContainerAsVec<<T as GlibPtrDefault>::GlibType, *mut GSList> for T

source§

unsafe fn from_glib_none_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_container_as_vec(ptr: *mut GSList) -> Vec<T>

source§

unsafe fn from_glib_full_as_vec(ptr: *mut GSList) -> Vec<T>

source§

impl<O> GObjectPropertyExpressionExt for O
where O: IsA<Object>,

source§

fn property_expression(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property.
source§

fn property_expression_weak(&self, property_name: &str) -> PropertyExpression

Create an expression looking up an object’s property with a weak reference.
source§

fn this_expression(property_name: &str) -> PropertyExpression

Create an expression looking up a property in the bound this object.
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoClosureReturnValue for T
where T: Into<Value>,

source§

impl<U> IsSubclassableExt for U

source§

impl<T> ObjectExt for T
where T: ObjectType,

source§

fn is<U>(&self) -> bool
where U: StaticType,

Returns true if the object is an instance of (can be cast to) T.
source§

fn type_(&self) -> Type

Returns the type of the object.
source§

fn object_class(&self) -> &Class<Object>

Returns the ObjectClass of the object. Read more
source§

fn class(&self) -> &Class<T>
where T: IsClass,

Returns the class of the object.
source§

fn class_of<U>(&self) -> Option<&Class<U>>
where U: IsClass,

Returns the class of the object in the given type T. Read more
source§

fn interface<U>(&self) -> Option<InterfaceRef<'_, U>>
where U: IsInterface,

Returns the interface T of the object. Read more
source§

fn set_property(&self, property_name: &str, value: impl Into<Value>)

Sets the property property_name of the object to value value. Read more
source§

fn set_property_from_value(&self, property_name: &str, value: &Value)

Sets the property property_name of the object to value value. Read more
source§

fn set_properties(&self, property_values: &[(&str, &dyn ToValue)])

Sets multiple properties of the object at once. Read more
source§

fn set_properties_from_value(&self, property_values: &[(&str, Value)])

Sets multiple properties of the object at once. Read more
source§

fn property<V>(&self, property_name: &str) -> V
where V: for<'b> FromValue<'b> + 'static,

Gets the property property_name of the object and cast it to the type V. Read more
source§

fn property_value(&self, property_name: &str) -> Value

Gets the property property_name of the object. Read more
source§

fn has_property(&self, property_name: &str, type_: Option<Type>) -> bool

Check if the object has a property property_name of the given type_. Read more
source§

fn property_type(&self, property_name: &str) -> Option<Type>

Get the type of the property property_name of this object. Read more
source§

fn find_property(&self, property_name: &str) -> Option<ParamSpec>

Get the ParamSpec of the property property_name of this object.
source§

fn list_properties(&self) -> PtrSlice<ParamSpec>

Return all ParamSpec of the properties of this object.
source§

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

Freeze all property notifications until the return guard object is dropped. Read more
source§

unsafe fn set_qdata<QD>(&self, key: Quark, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn qdata<QD>(&self, key: Quark) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_qdata<QD>(&self, key: Quark) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn set_data<QD>(&self, key: &str, value: QD)
where QD: 'static,

Set arbitrary data on this object with the given key. Read more
source§

unsafe fn data<QD>(&self, key: &str) -> Option<NonNull<QD>>
where QD: 'static,

Return previously set arbitrary data of this object with the given key. Read more
source§

unsafe fn steal_data<QD>(&self, key: &str) -> Option<QD>
where QD: 'static,

Retrieve previously set arbitrary data of this object with the given key. Read more
source§

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

fn stop_signal_emission(&self, signal_id: SignalId, detail: Option<Quark>)

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

Stop emission of the currently emitted signal by the (possibly detailed) signal name.
source§

fn connect<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,

Connect to the signal signal_id on this object. Read more
source§

fn connect_local<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_name on this object. Read more
source§

fn connect_local_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value> + 'static,

Connect to the signal signal_id on this object. Read more
source§

unsafe fn connect_unsafe<F>( &self, signal_name: &str, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_name on this object. Read more
source§

unsafe fn connect_unsafe_id<F>( &self, signal_id: SignalId, details: Option<Quark>, after: bool, callback: F ) -> SignalHandlerId
where F: Fn(&[Value]) -> Option<Value>,

Connect to the signal signal_id on this object. Read more
source§

fn connect_closure( &self, signal_name: &str, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_name on this object. Read more
source§

fn connect_closure_id( &self, signal_id: SignalId, details: Option<Quark>, after: bool, closure: RustClosure ) -> SignalHandlerId

Connect a closure to the signal signal_id on this object. Read more
source§

fn watch_closure(&self, closure: &impl AsRef<Closure>)

Limits the lifetime of closure to the lifetime of the object. When the object’s reference count drops to zero, the closure will be invalidated. An invalidated closure will ignore any calls to invoke_with_values, or invoke when using Rust closures.
source§

fn emit<R>(&self, signal_id: SignalId, args: &[&dyn ToValue]) -> R

Emit signal by signal id. Read more
source§

fn emit_with_values(&self, signal_id: SignalId, args: &[Value]) -> Option<Value>

Same as Self::emit but takes Value for the arguments.
source§

fn emit_by_name<R>(&self, signal_name: &str, args: &[&dyn ToValue]) -> R

Emit signal by its name. Read more
source§

fn emit_by_name_with_values( &self, signal_name: &str, args: &[Value] ) -> Option<Value>

Emit signal by its name. Read more
source§

fn emit_by_name_with_details<R>( &self, signal_name: &str, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by its name with details. Read more
source§

fn emit_by_name_with_details_and_values( &self, signal_name: &str, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by its name with details. Read more
source§

fn emit_with_details<R>( &self, signal_id: SignalId, details: Quark, args: &[&dyn ToValue] ) -> R

Emit signal by signal id with details. Read more
source§

fn emit_with_details_and_values( &self, signal_id: SignalId, details: Quark, args: &[Value] ) -> Option<Value>

Emit signal by signal id with details. Read more
source§

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + Send + Sync + 'static,

Connect to the notify signal of the object. Read more
source§

fn connect_notify_local<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId
where F: Fn(&T, &ParamSpec) + 'static,

Connect to the notify signal of the object. Read more
source§

unsafe fn connect_notify_unsafe<F>( &self, name: Option<&str>, f: F ) -> SignalHandlerId
where F: Fn(&T, &ParamSpec),

Connect to the notify signal of the object. Read more
source§

fn notify(&self, property_name: &str)

Notify that the given property has changed its value. Read more
source§

fn notify_by_pspec(&self, pspec: &ParamSpec)

Notify that the given property has changed its value. Read more
source§

fn downgrade(&self) -> WeakRef<T>

Downgrade this object to a weak reference.
source§

fn add_weak_ref_notify<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + Send + 'static,

Add a callback to be notified when the Object is disposed.
source§

fn add_weak_ref_notify_local<F>(&self, f: F) -> WeakRefNotify<T>
where F: FnOnce() + 'static,

Add a callback to be notified when the Object is disposed. Read more
source§

fn bind_property<'a, 'f, 't, O>( &'a self, source_property: &'a str, target: &'a O, target_property: &'a str ) -> BindingBuilder<'a, 'f, 't>
where O: ObjectType,

Bind property source_property on this object to the target_property on the target object. Read more
source§

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

Runs the dispose mechanism of the object. Read more
source§

impl<T> Property for T
where T: HasParamSpec,

§

type Value = T

source§

impl<T> PropertyGet for T
where T: HasParamSpec,

§

type Value = T

source§

fn get<R, F>(&self, f: F) -> R
where F: Fn(&<T as PropertyGet>::Value) -> R,

source§

impl<T> StaticTypeExt for T
where T: StaticType,

source§

fn ensure_type()

Ensures that the type has been registered with the type system.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TransparentType for T

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T> TryFromClosureReturnValue for T
where T: for<'a> FromValue<'a> + StaticType + 'static,

source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<O> WidgetExt for O
where O: IsA<Widget>,

source§

fn action_set_enabled(&self, action_name: &str, enabled: bool)

Enable or disable an action installed with gtk_widget_class_install_action(). Read more
source§

fn activate(&self) -> bool

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them. Read more
source§

fn activate_action( &self, name: &str, args: Option<&Variant> ) -> Result<(), BoolError>

Looks up the action in the action groups associated with @self and its ancestors, and activates it. Read more
source§

fn activate_default(&self)

Activates the default.activate action from @self.
source§

fn add_controller(&self, controller: impl IsA<EventController>)

Adds @controller to @self so that it will receive events. Read more
source§

fn add_css_class(&self, css_class: &str)

Adds a style class to @self. Read more
source§

fn add_mnemonic_label(&self, label: &impl IsA<Widget>)

Adds a widget to the list of mnemonic labels for this widget. Read more
source§

fn allocate( &self, width: i32, height: i32, baseline: i32, transform: Option<Transform> )

This function is only used by Widget subclasses, to assign a size, position and (optionally) baseline to their child widgets. Read more
source§

fn child_focus(&self, direction: DirectionType) -> bool

Called by widgets as the user moves around the window using keyboard shortcuts. Read more
source§

fn compute_bounds(&self, target: &impl IsA<Widget>) -> Option<Rect>

Computes the bounds for @self in the coordinate space of @target. Read more
source§

fn compute_expand(&self, orientation: Orientation) -> bool

Computes whether a container should give this widget extra space when possible. Read more
source§

fn compute_point( &self, target: &impl IsA<Widget>, point: &Point ) -> Option<Point>

Translates the given @point in @self’s coordinates to coordinates relative to @target’s coordinate system. Read more
source§

fn compute_transform(&self, target: &impl IsA<Widget>) -> Option<Matrix>

Computes a matrix suitable to describe a transformation from @self’s coordinate system into @target’s coordinate system. Read more
source§

fn contains(&self, x: f64, y: f64) -> bool

Tests if the point at (@x, @y) is contained in @self. Read more
source§

fn create_pango_context(&self) -> Context

Creates a new pango::Context with the appropriate font map, font options, font description, and base direction for drawing text for this widget. Read more
source§

fn create_pango_layout(&self, text: Option<&str>) -> Layout

Creates a new pango::Layout with the appropriate font map, font description, and base direction for drawing text for this widget. Read more
source§

fn drag_check_threshold( &self, start_x: i32, start_y: i32, current_x: i32, current_y: i32 ) -> bool

Checks to see if a drag movement has passed the GTK drag threshold. Read more
source§

fn error_bell(&self)

Notifies the user about an input-related error on this widget. Read more
source§

fn allocated_baseline(&self) -> i32

👎Deprecated: Since 4.12
Returns the baseline that has currently been allocated to @self. Read more
source§

fn allocated_height(&self) -> i32

👎Deprecated: Since 4.12
Returns the height that has currently been allocated to @self. Read more
source§

fn allocated_width(&self) -> i32

👎Deprecated: Since 4.12
Returns the width that has currently been allocated to @self. Read more
source§

fn allocation(&self) -> Allocation

👎Deprecated: Since 4.12
Retrieves the widget’s allocation. Read more
source§

fn ancestor(&self, widget_type: Type) -> Option<Widget>

Gets the first ancestor of @self with type @widget_type. Read more
source§

fn baseline(&self) -> i32

Available on crate feature v4_12 only.
Returns the baseline that has currently been allocated to @self. Read more
source§

fn can_focus(&self) -> bool

Determines whether the input focus can enter @self or any of its children. Read more
source§

fn can_target(&self) -> bool

Queries whether @self can be the target of pointer events. Read more
source§

fn is_child_visible(&self) -> bool

Gets the value set with gtk_widget_set_child_visible(). Read more
source§

fn clipboard(&self) -> Clipboard

Gets the clipboard object for @self. Read more
source§

fn color(&self) -> RGBA

Available on crate feature v4_10 only.
Gets the current foreground color for the widget’s CSS style. Read more
source§

fn css_classes(&self) -> Vec<GString>

Returns the list of style classes applied to @self. Read more
source§

fn css_name(&self) -> GString

Returns the CSS name that is used for @self. Read more
source§

fn cursor(&self) -> Option<Cursor>

Queries the cursor set on @self. Read more
source§

fn direction(&self) -> TextDirection

Gets the reading direction for a particular widget. Read more
source§

fn display(&self) -> Display

Get the gdk::Display for the toplevel window associated with this widget. Read more
source§

fn first_child(&self) -> Option<Widget>

Returns the widget’s first child. Read more
source§

fn focus_child(&self) -> Option<Widget>

Returns the current focus child of @self. Read more
source§

fn gets_focus_on_click(&self) -> bool

Returns whether the widget should grab focus when it is clicked with the mouse. Read more
source§

fn is_focusable(&self) -> bool

Determines whether @self can own the input focus. Read more
source§

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

Gets the font map of @self. Read more
source§

fn font_options(&self) -> Option<FontOptions>

Returns the cairo::FontOptions of widget. Read more
source§

fn frame_clock(&self) -> Option<FrameClock>

Obtains the frame clock for a widget. Read more
source§

fn halign(&self) -> Align

Gets the horizontal alignment of @self. Read more
source§

fn has_tooltip(&self) -> bool

Returns the current value of the has-tooltip property. Read more
source§

fn height(&self) -> i32

Returns the content height of the widget. Read more
source§

fn hexpands(&self) -> bool

Gets whether the widget would like any available extra horizontal space. Read more
source§

fn is_hexpand_set(&self) -> bool

Gets whether gtk_widget_set_hexpand() has been used to explicitly set the expand flag on this widget. Read more
source§

fn last_child(&self) -> Option<Widget>

Returns the widget’s last child. Read more
source§

fn layout_manager(&self) -> Option<LayoutManager>

Retrieves the layout manager used by @self. Read more
source§

fn is_mapped(&self) -> bool

Whether the widget is mapped. Read more
source§

fn margin_bottom(&self) -> i32

Gets the bottom margin of @self. Read more
source§

fn margin_end(&self) -> i32

Gets the end margin of @self. Read more
source§

fn margin_start(&self) -> i32

Gets the start margin of @self. Read more
source§

fn margin_top(&self) -> i32

Gets the top margin of @self. Read more
source§

fn widget_name(&self) -> GString

Retrieves the name of a widget. Read more
source§

fn native(&self) -> Option<Native>

Returns the nearest Native ancestor of @self. Read more
source§

fn next_sibling(&self) -> Option<Widget>

Returns the widget’s next sibling. Read more
source§

fn opacity(&self) -> f64

#Fetches the requested opacity for this widget. Read more
source§

fn overflow(&self) -> Overflow

Returns the widget’s overflow value. Read more
source§

fn pango_context(&self) -> Context

Gets a pango::Context with the appropriate font map, font description, and base direction for this widget. Read more
source§

fn parent(&self) -> Option<Widget>

Returns the parent widget of @self. Read more
source§

fn preferred_size(&self) -> (Requisition, Requisition)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management. Read more
source§

fn prev_sibling(&self) -> Option<Widget>

Returns the widget’s previous sibling. Read more
source§

fn primary_clipboard(&self) -> Clipboard

Gets the primary clipboard of @self. Read more
source§

fn is_realized(&self) -> bool

Determines whether @self is realized. Read more
source§

fn receives_default(&self) -> bool

Determines whether @self is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default. Read more
source§

fn request_mode(&self) -> SizeRequestMode

Gets whether the widget prefers a height-for-width layout or a width-for-height layout. Read more
source§

fn root(&self) -> Option<Root>

Returns the Root widget of @self. Read more
source§

fn scale_factor(&self) -> i32

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels. Read more
source§

fn get_sensitive(&self) -> bool

Returns the widget’s sensitivity. Read more
source§

fn settings(&self) -> Settings

Gets the settings object holding the settings used for this widget. Read more
source§

fn size(&self, orientation: Orientation) -> i32

Returns the content width or height of the widget. Read more
source§

fn size_request(&self) -> (i32, i32)

Gets the size request that was explicitly set for the widget using gtk_widget_set_size_request(). Read more
source§

fn state_flags(&self) -> StateFlags

Returns the widget state as a flag set. Read more
source§

fn style_context(&self) -> StyleContext

👎Deprecated: Since 4.10
Returns the style context associated to @self. Read more
source§

fn tooltip_markup(&self) -> Option<GString>

Gets the contents of the tooltip for @self. Read more
source§

fn tooltip_text(&self) -> Option<GString>

Gets the contents of the tooltip for @self. Read more
source§

fn valign(&self) -> Align

Gets the vertical alignment of @self. Read more
source§

fn vexpands(&self) -> bool

Gets whether the widget would like any available extra vertical space. Read more
source§

fn is_vexpand_set(&self) -> bool

Gets whether gtk_widget_set_vexpand() has been used to explicitly set the expand flag on this widget. Read more
source§

fn get_visible(&self) -> bool

Determines whether the widget is visible. Read more
source§

fn width(&self) -> i32

Returns the content width of the widget. Read more
source§

fn grab_focus(&self) -> bool

Causes @self to have the keyboard focus for the Window it’s inside. Read more
source§

fn has_css_class(&self, css_class: &str) -> bool

Returns whether @css_class is currently applied to @self. Read more
source§

fn has_default(&self) -> bool

Determines whether @self is the current default widget within its toplevel. Read more
source§

fn has_focus(&self) -> bool

Determines if the widget has the global input focus. Read more
source§

fn has_visible_focus(&self) -> bool

Determines if the widget should show a visible indication that it has the global input focus. Read more
source§

fn hide(&self)

👎Deprecated: Since 4.10
Reverses the effects of gtk_widget_show(). Read more
source§

fn in_destruction(&self) -> bool

Returns whether the widget is currently being destroyed. Read more
source§

fn insert_action_group(&self, name: &str, group: Option<&impl IsA<ActionGroup>>)

Inserts @group into @self. Read more
source§

fn insert_after( &self, parent: &impl IsA<Widget>, previous_sibling: Option<&impl IsA<Widget>> )

Inserts @self into the child widget list of @parent. Read more
source§

fn insert_before( &self, parent: &impl IsA<Widget>, next_sibling: Option<&impl IsA<Widget>> )

Inserts @self into the child widget list of @parent. Read more
source§

fn is_ancestor(&self, ancestor: &impl IsA<Widget>) -> bool

Determines whether @self is somewhere inside @ancestor, possibly with intermediate containers. Read more
source§

fn is_drawable(&self) -> bool

Determines whether @self can be drawn to. Read more
source§

fn is_focus(&self) -> bool

Determines if the widget is the focus widget within its toplevel. Read more
source§

fn is_sensitive(&self) -> bool

Returns the widget’s effective sensitivity. Read more
source§

fn is_visible(&self) -> bool

Determines whether the widget and all its parents are marked as visible. Read more
source§

fn keynav_failed(&self, direction: DirectionType) -> bool

Emits the ::keynav-failed signal on the widget. Read more
source§

fn list_mnemonic_labels(&self) -> Vec<Widget>

Returns the widgets for which this widget is the target of a mnemonic. Read more
source§

fn map(&self)

Causes a widget to be mapped if it isn’t already. Read more
source§

fn measure( &self, orientation: Orientation, for_size: i32 ) -> (i32, i32, i32, i32)

Measures @self in the orientation @orientation and for the given @for_size. Read more
source§

fn mnemonic_activate(&self, group_cycling: bool) -> bool

Emits the ::mnemonic-activate signal. Read more
source§

fn observe_children(&self) -> ListModel

Returns a GListModel to track the children of @self. Read more
source§

fn observe_controllers(&self) -> ListModel

Returns a GListModel to track the EventControllers of @self. Read more
source§

fn pick(&self, x: f64, y: f64, flags: PickFlags) -> Option<Widget>

Finds the descendant of @self closest to the point (@x, @y). Read more
source§

fn queue_allocate(&self)

Flags the widget for a rerun of the WidgetImpl::size_allocate() function. Read more
source§

fn queue_draw(&self)

Schedules this widget to be redrawn in the paint phase of the current or the next frame. Read more
source§

fn queue_resize(&self)

Flags a widget to have its size renegotiated. Read more
source§

fn realize(&self)

Creates the GDK resources associated with a widget. Read more
source§

fn remove_controller(&self, controller: &impl IsA<EventController>)

Removes @controller from @self, so that it doesn’t process events anymore. Read more
source§

fn remove_css_class(&self, css_class: &str)

Removes a style from @self. Read more
source§

fn remove_mnemonic_label(&self, label: &impl IsA<Widget>)

Removes a widget from the list of mnemonic labels for this widget. Read more
source§

fn set_can_focus(&self, can_focus: bool)

Specifies whether the input focus can enter the widget or any of its children. Read more
source§

fn set_can_target(&self, can_target: bool)

Sets whether @self can be the target of pointer events. Read more
source§

fn set_child_visible(&self, child_visible: bool)

Sets whether @self should be mapped along with its parent. Read more
source§

fn set_css_classes(&self, classes: &[&str])

Clear all style classes applied to @self and replace them with @classes. Read more
source§

fn set_cursor(&self, cursor: Option<&Cursor>)

Sets the cursor to be shown when pointer devices point towards @self. Read more
source§

fn set_cursor_from_name(&self, name: Option<&str>)

Sets a named cursor to be shown when pointer devices point towards @self. Read more
source§

fn set_direction(&self, dir: TextDirection)

Sets the reading direction on a particular widget. Read more
source§

fn set_focus_child(&self, child: Option<&impl IsA<Widget>>)

Set @child as the current focus child of @self. Read more
source§

fn set_focus_on_click(&self, focus_on_click: bool)

Sets whether the widget should grab focus when it is clicked with the mouse. Read more
source§

fn set_focusable(&self, focusable: bool)

Specifies whether @self can own the input focus. Read more
source§

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

Sets the font map to use for Pango rendering. Read more
source§

fn set_font_options(&self, options: Option<&FontOptions>)

Sets the cairo::FontOptions used for Pango rendering in this widget. Read more
source§

fn set_halign(&self, align: Align)

Sets the horizontal alignment of @self. Read more
source§

fn set_has_tooltip(&self, has_tooltip: bool)

Sets the has-tooltip property on @self to @has_tooltip. Read more
source§

fn set_hexpand(&self, expand: bool)

Sets whether the widget would like any available extra horizontal space. Read more
source§

fn set_hexpand_set(&self, set: bool)

Sets whether the hexpand flag will be used. Read more
source§

fn set_layout_manager(&self, layout_manager: Option<impl IsA<LayoutManager>>)

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of @self. Read more
source§

fn set_margin_bottom(&self, margin: i32)

Sets the bottom margin of @self. Read more
source§

fn set_margin_end(&self, margin: i32)

Sets the end margin of @self. Read more
source§

fn set_margin_start(&self, margin: i32)

Sets the start margin of @self. Read more
source§

fn set_margin_top(&self, margin: i32)

Sets the top margin of @self. Read more
source§

fn set_widget_name(&self, name: &str)

Sets a widgets name. Read more
source§

fn set_opacity(&self, opacity: f64)

Request the @self to be rendered partially transparent. Read more
source§

fn set_overflow(&self, overflow: Overflow)

Sets how @self treats content that is drawn outside the widget’s content area. Read more
source§

fn set_parent(&self, parent: &impl IsA<Widget>)

Sets @parent as the parent widget of @self. Read more
source§

fn set_receives_default(&self, receives_default: bool)

Specifies whether @self will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default. Read more
source§

fn set_sensitive(&self, sensitive: bool)

Sets the sensitivity of a widget. Read more
source§

fn set_size_request(&self, width: i32, height: i32)

Sets the minimum size of a widget. Read more
source§

fn set_state_flags(&self, flags: StateFlags, clear: bool)

Turns on flag values in the current widget state. Read more
source§

fn set_tooltip_markup(&self, markup: Option<&str>)

Sets @markup as the contents of the tooltip, which is marked up with Pango markup. Read more
source§

fn set_tooltip_text(&self, text: Option<&str>)

Sets @text as the contents of the tooltip. Read more
source§

fn set_valign(&self, align: Align)

Sets the vertical alignment of @self. Read more
source§

fn set_vexpand(&self, expand: bool)

Sets whether the widget would like any available extra vertical space. Read more
source§

fn set_vexpand_set(&self, set: bool)

Sets whether the vexpand flag will be used. Read more
source§

fn set_visible(&self, visible: bool)

Sets the visibility state of @self. Read more
source§

fn should_layout(&self) -> bool

Returns whether @self should contribute to the measuring and allocation of its parent. Read more
source§

fn show(&self)

👎Deprecated: Since 4.10
Flags a widget to be displayed. Read more
source§

fn size_allocate(&self, allocation: &Allocation, baseline: i32)

Allocates widget with a transformation that translates the origin to the position in @allocation. Read more
source§

fn snapshot_child( &self, child: &impl IsA<Widget>, snapshot: &impl IsA<Snapshot> )

Snapshot the a child of @self. Read more
source§

fn translate_coordinates( &self, dest_widget: &impl IsA<Widget>, src_x: f64, src_y: f64 ) -> Option<(f64, f64)>

👎Deprecated: Since 4.12
Translate coordinates relative to @self’s allocation to coordinates relative to @dest_widget’s allocations. Read more
source§

fn trigger_tooltip_query(&self)

Triggers a tooltip query on the display where the toplevel of @self is located.
source§

fn unmap(&self)

Causes a widget to be unmapped if it’s currently mapped. Read more
source§

fn unparent(&self)

Dissociate @self from its parent. Read more
source§

fn unrealize(&self)

Causes a widget to be unrealized (frees all GDK resources associated with the widget). Read more
source§

fn unset_state_flags(&self, flags: StateFlags)

Turns off flag values for the current widget state. Read more
source§

fn height_request(&self) -> i32

Override for height request of the widget. Read more
source§

fn set_height_request(&self, height_request: i32)

Override for height request of the widget. Read more
source§

fn width_request(&self) -> i32

Override for width request of the widget. Read more
source§

fn set_width_request(&self, width_request: i32)

Override for width request of the widget. Read more
source§

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

Signals that all holders of a reference to the widget should release the reference that they hold. Read more
source§

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

Emitted when the text direction of a widget changes. Read more
source§

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

Emitted when @widget is hidden.
source§

fn connect_keynav_failed<F: Fn(&Self, DirectionType) -> Propagation + 'static>( &self, f: F ) -> SignalHandlerId

Emitted if keyboard navigation fails. Read more
source§

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

Emitted when @widget is going to be mapped. Read more
source§

fn connect_mnemonic_activate<F: Fn(&Self, bool) -> Propagation + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when a widget is activated via a mnemonic. Read more
source§

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

Emitted when the focus is moved. Read more
source§

fn emit_move_focus(&self, direction: DirectionType)

source§

fn connect_query_tooltip<F: Fn(&Self, i32, i32, bool, &Tooltip) -> bool + 'static>( &self, f: F ) -> SignalHandlerId

Emitted when the widget’s tooltip is about to be shown. Read more
source§

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

Emitted when @widget is associated with a gdk::Surface. Read more
source§

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

Emitted when @widget is shown.
source§

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

Emitted when the widget state changes. Read more
source§

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

Emitted when @widget is going to be unmapped. Read more
source§

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

Emitted when the gdk::Surface associated with @widget is destroyed. Read more
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<O> WidgetExtManual for O
where O: IsA<Widget>,

source§

fn add_tick_callback<P: Fn(&Self, &FrameClock) -> ControlFlow + 'static>( &self, callback: P ) -> TickCallbackId

Queues an animation frame update and adds a callback to be called before each frame. Read more
source§

impl<O> ConstraintTargetExt for O

source§

impl<'a, T, C, E> FromValueOptional<'a> for T
where T: FromValue<'a, Checker = C>, C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError<E>>, E: Error + Send + 'static,

source§

impl<Super, Sub> MayDowncastTo<Sub> for Super
where Super: IsA<Super>, Sub: IsA<Super>,