Struct gtk4::AppChooserButton

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

The application selection widgets should be implemented according to the design of each platform and/or application requiring them. The AppChooserButton lets the user select an application.

Initially, a AppChooserButton selects the first application in its list, which will either be the most-recently used application or, if show-default-item is true, the default application.

The list of applications shown in a AppChooserButton includes the recommended applications for the given content type. When show-default-item is set, the default application is also included. To let the user chooser other applications, you can set the show-dialog-item property, which allows to open a full AppChooserDialog.

It is possible to add custom items to the list, using append_custom_item(). These items cause the custom-item-activated signal to be emitted when they are selected.

To track changes in the selected application, use the changed signal.

CSS nodes

AppChooserButton has a single CSS node with the name “appchooserbutton”.

Properties

heading

The text to show at the top of the dialog that can be opened from the button.

The string may contain Pango markup.

Readable | Writeable

modal

Whether the app chooser dialog should be modal.

Readable | Writeable | Construct

show-default-item

Determines whether the dropdown menu shows the default application on top for the provided content type.

Readable | Writeable | Construct

show-dialog-item

Determines whether the dropdown menu shows an item to open a AppChooserDialog.

Readable | Writeable | Construct

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

AppChooser

content-type

The content type of the AppChooser object.

See GContentType for more information about content types.

Readable | Writeable | Construct Only

Signals

activate

Emitted to when the button is activated.

The ::activate signal on AppChooserButton is an action signal and emitting it causes the button to pop up its dialog.

Action

changed

Emitted when the active application changes.

custom-item-activated

Emitted when a custom item is activated.

Use AppChooserButton::append_custom_item(), to add custom items.

Detailed

Widget

destroy

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

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

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See WidgetExt::keynav_failed() for details.

map

Emitted when @widget is going to be mapped.

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

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

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

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

move-focus

Emitted when the focus is moved.

Action

query-tooltip

Emitted when the widgets tooltip is about to be shown.

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

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

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

realize

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

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

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See WidgetExt::state_flags().

unmap

Emitted when @widget is going to be unmapped.

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

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

unrealize

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

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

Implements

WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, AppChooserExt, WidgetExtManual, AccessibleExtManual

Implementations

impl AppChooserButton

pub fn new(content_type: &str) -> AppChooserButton

Creates a new AppChooserButton for applications that can handle content of the given type.

Deprecated since 4.10

This widget will be removed in GTK 5

content_type

the content type to show applications for

Returns

a newly created AppChooserButton

pub fn builder() -> AppChooserButtonBuilder

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

This method returns an instance of AppChooserButtonBuilder which can be used to create AppChooserButton objects.

pub fn append_custom_item(&self, name: &str, label: &str, icon: &impl IsA<Icon>)

Appends a custom item to the list of applications that is shown in the popup.

The item name must be unique per-widget. Clients can use the provided name as a detail for the custom-item-activated signal, to add a callback for the activation of a particular custom item in the list.

See also append_separator().

Deprecated since 4.10

This widget will be removed in GTK 5

name

the name of the custom item

label

the label for the custom item

icon

the icon for the custom item

pub fn append_separator(&self)

Appends a separator to the list of applications that is shown in the popup.

Deprecated since 4.10

This widget will be removed in GTK 5

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

Returns the text to display at the top of the dialog.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the text to display at the top of the dialog, or None, in which case a default text is displayed

pub fn is_modal(&self) -> bool

Gets whether the dialog is modal.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

true if the dialog is modal

pub fn shows_default_item(&self) -> bool

Returns whether the dropdown menu should show the default application at the top.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of show-default-item

pub fn shows_dialog_item(&self) -> bool

Returns whether the dropdown menu shows an item for a AppChooserDialog.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of show-dialog-item

pub fn set_active_custom_item(&self, name: &str)

Selects a custom item.

See append_custom_item().

Use AppChooserExt::refresh() to bring the selection to its initial state.

Deprecated since 4.10

This widget will be removed in GTK 5

name

the name of the custom item

pub fn set_heading(&self, heading: &str)

Sets the text to display at the top of the dialog.

If the heading is not set, the dialog displays a default text.

Deprecated since 4.10

This widget will be removed in GTK 5

heading

a string containing Pango markup

pub fn set_modal(&self, modal: bool)

Sets whether the dialog should be modal.

Deprecated since 4.10

This widget will be removed in GTK 5

modal

true to make the dialog modal

pub fn set_show_default_item(&self, setting: bool)

Sets whether the dropdown menu of this button should show the default application for the given content type at top.

Deprecated since 4.10

This widget will be removed in GTK 5

setting

the new value for show-default-item

pub fn set_show_dialog_item(&self, setting: bool)

Sets whether the dropdown menu of this button should show an entry to trigger a AppChooserDialog.

Deprecated since 4.10

This widget will be removed in GTK 5

setting

the new value for show-dialog-item

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

Available on crate feature v4_4 only.

Emitted to when the button is activated.

The ::activate signal on AppChooserButton is an action signal and emitting it causes the button to pop up its dialog.

pub fn emit_activate(&self)

Available on crate feature v4_4 only.

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

Emitted when the active application changes.

pub fn connect_custom_item_activated<F: Fn(&Self, &str) + 'static>( &self, detail: Option<&str>, f: F ) -> SignalHandlerId

Emitted when a custom item is activated.

Use append_custom_item(), to add custom items.

item_name

the name of the activated item

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

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

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

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

Trait Implementations

impl Clone for AppChooserButton

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AppChooserButton

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

Formats the value using the given formatter.

impl Default for AppChooserButton

fn default() -> Self

Returns the “default value” for a type.

impl Display for AppChooserButton

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

Formats the value using the given formatter.

impl HasParamSpec for AppChooserButton

type ParamSpec = ParamSpecObject

type SetValue = AppChooserButton

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AppChooserButton

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl Ord for AppChooserButton

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for AppChooserButton

type Parent = Widget

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl StaticType for AppChooserButton

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AppChooserButton

impl IsA<Accessible> for AppChooserButton

impl IsA<AppChooser> for AppChooserButton

impl IsA<Buildable> for AppChooserButton

impl IsA<ConstraintTarget> for AppChooserButton

impl IsA<Widget> for AppChooserButton