gtk4

Struct SearchEntry

source
pub struct SearchEntry { /* private fields */ }
Expand description

SearchEntry is an entry widget that has been tailored for use as a search entry.

The main API for interacting with a SearchEntry as entry is the Editable interface.

An example GtkSearchEntry

It will show an inactive symbolic “find” icon when the search entry is empty, and a symbolic “clear” icon when there is text. Clicking on the “clear” icon will empty the search entry.

To make filtering appear more reactive, it is a good idea to not react to every change in the entry text immediately, but only after a short delay. To support this, SearchEntry emits the search-changed signal which can be used instead of the changed signal.

The previous-match, next-match and stop-search signals can be used to implement moving between search results and ending the search.

Often, SearchEntry will be fed events by means of being placed inside a SearchBar. If that is not the case, you can use set_key_capture_widget() to let it capture key input from another widget.

SearchEntry provides only minimal API and should be used with the Editable API.

§Shortcuts and Gestures

The following signals have default keybindings:

§CSS Nodes

entry.search
╰── text

SearchEntry has a single CSS node with name entry that carries a .search style class, and the text node is a child of that.

§Accessibility

SearchEntry uses the AccessibleRole::SearchBox role.

§Properties

§activates-default

Whether to activate the default widget when Enter is pressed.

Readable | Writeable

§input-hints

The hints about input for the SearchEntry used to alter the behaviour of input methods.

Readable | Writeable

§input-purpose

The purpose for the SearchEntry input used to alter the behaviour of input methods.

Readable | Writeable

§placeholder-text

The text that will be displayed in the SearchEntry when it is empty and unfocused.

Readable | Writeable

§search-delay

The delay in milliseconds from last keypress to the search changed signal.

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

Editable

§cursor-position

The current position of the insertion cursor in chars.

Readable

§editable

Whether the entry contents can be edited.

Readable | Writeable

§enable-undo

If undo/redo should be enabled for the editable.

Readable | Writeable

§max-width-chars

The desired maximum width of the entry, in characters.

Readable | Writeable

§selection-bound

The position of the opposite end of the selection from the cursor in chars.

Readable

§text

The contents of the entry.

Readable | Writeable

§width-chars

Number of characters to leave space for in the entry.

Readable | Writeable

§xalign

The horizontal alignment, from 0 (left) to 1 (right).

Reversed for RTL layouts.

Readable | Writeable

§Signals

§activate

Emitted when the entry is activated.

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

Action

§next-match

Emitted when the user initiates a move to the next match for the current search string.

This is a keybinding signal.

Applications should connect to it, to implement moving between matches.

The default bindings for this signal is Ctrl+g.

Action

§previous-match

Emitted when the user initiates a move to the previous match for the current search string.

This is a keybinding signal.

Applications should connect to it, to implement moving between matches.

The default bindings for this signal is Ctrl+Shift+g.

Action

§search-changed

Emitted with a delay. The length of the delay can be changed with the search-delay property.

§search-started

Emitted when the user initiated a search on the entry.

Emitted when the user stops a search via keyboard input.

This is a keybinding signal.

Applications should connect to it, to implement hiding the search entry in this case.

The default bindings for this signal is Escape.

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

Editable

§changed

Emitted at the end of a single user-visible operation on the contents.

E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).

§delete-text

Emitted when text is deleted from the widget by the user.

The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the range of deleted text, or prevent it from being deleted entirely.

The @start_pos and @end_pos parameters are interpreted as for EditableExt::delete_text().

§insert-text

Emitted when text is inserted into the widget by the user.

The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.

§Implements

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

GLib type: GObject with reference counted clone semantics.

Implementations§

source§

impl SearchEntry

source

pub fn new() -> SearchEntry

Creates a SearchEntry.

§Returns

a new SearchEntry

source

pub fn builder() -> SearchEntryBuilder

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

This method returns an instance of SearchEntryBuilder which can be used to create SearchEntry objects.

source

pub fn input_hints(&self) -> InputHints

Available on crate feature v4_14 only.

Gets the input purpose for @self.

§Returns

The input hints

source

pub fn input_purpose(&self) -> InputPurpose

Available on crate feature v4_14 only.

Gets the input purpose of @self.

§Returns

The input hints

source

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

Gets the widget that @self is capturing key events from.

§Returns

The key capture widget.

source

pub fn search_delay(&self) -> u32

Available on crate feature v4_8 only.

Get the delay to be used between the last keypress and the search-changed signal being emitted.

§Returns

a delay in milliseconds.

source

pub fn set_input_hints(&self, hints: InputHints)

Available on crate feature v4_14 only.

Sets the input hints for @self.

§hints

the new input hints

source

pub fn set_input_purpose(&self, purpose: InputPurpose)

Available on crate feature v4_14 only.

Sets the input purpose of @self.

§purpose

the new input purpose

source

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

Sets @widget as the widget that @self will capture key events from.

Key events are consumed by the search entry to start or continue a search.

If the entry is part of a SearchBar, it is preferable to call SearchBar::set_key_capture_widget() instead, which will reveal the entry in addition to triggering the search entry.

Note that despite the name of this function, the events are only ‘captured’ in the bubble phase, which means that editable child widgets of @widget will receive text input before it gets captured. If that is not desired, you can capture and forward the events yourself with EventControllerKey::forward().

§widget

a Widget

source

pub fn set_search_delay(&self, delay: u32)

Available on crate feature v4_8 only.

Set the delay to be used between the last keypress and the search-changed signal being emitted.

§delay

a delay in milliseconds

source

pub fn activates_default(&self) -> bool

Whether to activate the default widget when Enter is pressed.

source

pub fn set_activates_default(&self, activates_default: bool)

Whether to activate the default widget when Enter is pressed.

source

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

source

pub fn set_placeholder_text(&self, placeholder_text: Option<&str>)

source

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

Emitted when the entry is activated.

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

source

pub fn emit_activate(&self)

source

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

Emitted when the user initiates a move to the next match for the current search string.

This is a keybinding signal.

Applications should connect to it, to implement moving between matches.

The default bindings for this signal is Ctrl+g.

source

pub fn emit_next_match(&self)

source

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

Emitted when the user initiates a move to the previous match for the current search string.

This is a keybinding signal.

Applications should connect to it, to implement moving between matches.

The default bindings for this signal is Ctrl+Shift+g.

source

pub fn emit_previous_match(&self)

source

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

Emitted with a delay. The length of the delay can be changed with the search-delay property.

source

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

Emitted when the user initiated a search on the entry.

Emitted when the user stops a search via keyboard input.

This is a keybinding signal.

Applications should connect to it, to implement hiding the search entry in this case.

The default bindings for this signal is Escape.

source

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

source

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

Available on crate feature v4_14 only.
source

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

Available on crate feature v4_14 only.
source

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

source

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

Available on crate feature v4_8 only.

Trait Implementations§

source§

impl Clone for SearchEntry

source§

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

1.6.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for SearchEntry

source§

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

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

impl Default for SearchEntry

source§

fn default() -> Self

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

impl HasParamSpec for SearchEntry

source§

type ParamSpec = ParamSpecObject

source§

type SetValue = SearchEntry

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

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

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for SearchEntry

source§

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

Hashes the memory address of this object.

1.6.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 SearchEntry

source§

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

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

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,

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

impl ParentClassIs for SearchEntry

source§

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

source§

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

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

1.6.0 · source§

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

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 SearchEntry

source§

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

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

1.6.0 · source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.6.0 · source§

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

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

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.6.0 · source§

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

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

impl StaticType for SearchEntry

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for SearchEntry

source§

impl IsA<Accessible> for SearchEntry

source§

impl IsA<Buildable> for SearchEntry

source§

impl IsA<ConstraintTarget> for SearchEntry

source§

impl IsA<Editable> for SearchEntry

source§

impl IsA<Widget> for SearchEntry

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
source§

impl<O> EditableExt for O
where O: IsA<Editable>,

source§

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

Available on crate feature v4_10 only.
Retrieves the accessible platform state from the editable delegate. Read more
source§

fn delete_selection(&self)

Deletes the currently selected text of the editable. Read more
source§

fn delete_text(&self, start_pos: i32, end_pos: i32)

Deletes a sequence of characters. Read more
source§

fn finish_delegate(&self)

Undoes the setup done by init_delegate(). Read more
source§

fn alignment(&self) -> f32

Gets the alignment of the editable. Read more
source§

fn chars(&self, start_pos: i32, end_pos: i32) -> GString

Retrieves a sequence of characters. Read more
source§

fn delegate(&self) -> Option<Editable>

Gets the Editable that @self is delegating its implementation to. Read more
source§

fn is_editable(&self) -> bool

Retrieves whether @self is editable. Read more
source§

fn enables_undo(&self) -> bool

Gets if undo/redo actions are enabled for @self Read more
source§

fn max_width_chars(&self) -> i32

Retrieves the desired maximum width of @self, in characters. Read more
source§

fn position(&self) -> i32

Retrieves the current position of the cursor relative to the start of the content of the editable. Read more
source§

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

Retrieves the selection bound of the editable. Read more
source§

fn text(&self) -> GString

Retrieves the contents of @self. Read more
source§

fn width_chars(&self) -> i32

Gets the number of characters of space reserved for the contents of the editable. Read more
source§

fn init_delegate(&self)

Sets up a delegate for Editable. Read more
source§

fn insert_text(&self, text: &str, position: &mut i32)

Inserts @length bytes of @text into the contents of the widget, at position @position. Read more
source§

fn select_region(&self, start_pos: i32, end_pos: i32)

Selects a region of text. Read more
source§

fn set_alignment(&self, xalign: f32)

Sets the alignment for the contents of the editable. Read more
source§

fn set_editable(&self, is_editable: bool)

Determines if the user can edit the text in the editable widget. Read more
source§

fn set_enable_undo(&self, enable_undo: bool)

If enabled, changes to @self will be saved for undo/redo actions. Read more
source§

fn set_max_width_chars(&self, n_chars: i32)

Sets the desired maximum width in characters of @self. Read more
source§

fn set_position(&self, position: i32)

Sets the cursor position in the editable to the given value. Read more
source§

fn set_text(&self, text: &str)

Sets the text in the editable to the given value. Read more
source§

fn set_width_chars(&self, n_chars: i32)

Changes the size request of the editable to be about the right size for @n_chars characters. Read more
source§

fn selection_bound(&self) -> i32

The position of the opposite end of the selection from the cursor in chars.
source§

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

Emitted at the end of a single user-visible operation on the contents. Read more
source§

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

Emitted when text is deleted from the widget by the user. Read more
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<O> EditableExtManual for O
where O: IsA<Editable>,

source§

fn connect_insert_text<F>(&self, f: F) -> SignalHandlerId
where F: Fn(&Self, &str, &mut i32) + 'static,

Emitted when text is inserted into the widget by the user. 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,

source§

type Value = T

source§

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

source§

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,

source§

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>,

source§

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>,

source§

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>

👎Deprecated: Since 4.16
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>)

👎Deprecated: Since 4.16
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>,