Struct gtk4::AppChooserWidget

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

The application selection widgets should be implemented according to the design of each platform and/or application requiring them. AppChooserWidget is a widget for selecting applications.

It is the main building block for AppChooserDialog. Most applications only need to use the latter; but you can use this widget as part of a larger widget if you have special needs.

AppChooserWidget offers detailed control over what applications are shown, using the show-default, show-recommended, show-fallback, show-other and show-all properties. See the AppChooser documentation for more information about these groups of applications.

To keep track of the selected application, use the application-selected and application-activated signals.

CSS nodes

AppChooserWidget has a single CSS node with name appchooser.

Properties

default-text

The text that appears in the widget when there are no applications for the given content type.

Readable | Writeable

show-all

If true, the app chooser presents all applications in a single list, without subsections for default, recommended or related applications.

Readable | Writeable | Construct

show-default

Determines whether the app chooser should show the default handler for the content type in a separate section.

If false, the default handler is listed among the recommended applications.

Readable | Writeable | Construct

show-fallback

Determines whether the app chooser should show a section for fallback applications.

If false, the fallback applications are listed among the other applications.

Readable | Writeable | Construct

show-other

Determines whether the app chooser should show a section for other applications.

Readable | Writeable | Construct

show-recommended

Determines whether the app chooser should show a section for recommended applications.

If false, the recommended applications are listed among the other applications.

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

application-activated

Emitted when an application item is activated from the widget’s list.

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

application-selected

Emitted when an application item is selected from the widget’s list.

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 AppChooserWidget

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

Creates a new AppChooserWidget 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 AppChooserWidget

pub fn builder() -> AppChooserWidgetBuilder

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

This method returns an instance of AppChooserWidgetBuilder which can be used to create AppChooserWidget objects.

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

Returns the text that is shown if there are not applications that can handle the content type.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of default-text

pub fn shows_all(&self) -> bool

Gets whether the app chooser should show all applications in a flat list.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of show-all

pub fn shows_default(&self) -> bool

Gets whether the app chooser should show the default handler for the content type in a separate section.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of show-default

pub fn shows_fallback(&self) -> bool

Gets whether the app chooser should show related applications for the content type in a separate section.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of show-fallback

pub fn shows_other(&self) -> bool

Gets whether the app chooser should show applications which are unrelated to the content type.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of show-other

pub fn shows_recommended(&self) -> bool

Gets whether the app chooser should show recommended applications for the content type in a separate section.

Deprecated since 4.10

This widget will be removed in GTK 5

Returns

the value of show-recommended

pub fn set_default_text(&self, text: &str)

Sets the text that is shown if there are not applications that can handle the content type.

Deprecated since 4.10

This widget will be removed in GTK 5

text

the new value for default-text

pub fn set_show_all(&self, setting: bool)

Sets whether the app chooser should show all applications in a flat list.

Deprecated since 4.10

This widget will be removed in GTK 5

setting

the new value for show-all

pub fn set_show_default(&self, setting: bool)

Sets whether the app chooser should show the default handler for the content type in a separate section.

Deprecated since 4.10

This widget will be removed in GTK 5

setting

the new value for show-default

pub fn set_show_fallback(&self, setting: bool)

Sets whether the app chooser should show related applications for the content type in a separate section.

Deprecated since 4.10

This widget will be removed in GTK 5

setting

the new value for show-fallback

pub fn set_show_other(&self, setting: bool)

Sets whether the app chooser should show applications which are unrelated to the content type.

Deprecated since 4.10

This widget will be removed in GTK 5

setting

the new value for show-other

pub fn set_show_recommended(&self, setting: bool)

Sets whether the app chooser should show recommended applications for the content type in a separate section.

Deprecated since 4.10

This widget will be removed in GTK 5

setting

the new value for show-recommended

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

Emitted when an application item is activated from the widget’s list.

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

application

the activated GAppInfo

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

Emitted when an application item is selected from the widget’s list.

application

the selected GAppInfo

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

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

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

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

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

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

Trait Implementations

impl Clone for AppChooserWidget

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 AppChooserWidget

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

Formats the value using the given formatter.

impl Default for AppChooserWidget

fn default() -> Self

Returns the “default value” for a type.

impl Display for AppChooserWidget

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

Formats the value using the given formatter.

impl HasParamSpec for AppChooserWidget

type ParamSpec = ParamSpecObject

type SetValue = AppChooserWidget

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for AppChooserWidget

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 AppChooserWidget

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 AppChooserWidget

type Parent = Widget

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

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 AppChooserWidget

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 AppChooserWidget

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for AppChooserWidget

impl IsA<Accessible> for AppChooserWidget

impl IsA<AppChooser> for AppChooserWidget

impl IsA<Buildable> for AppChooserWidget

impl IsA<ConstraintTarget> for AppChooserWidget

impl IsA<Widget> for AppChooserWidget