Struct gtk4::Application

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

Application is a high-level API for writing applications.

It supports many aspects of writing a GTK application in a convenient fashion, without enforcing a one-size-fits-all model.

Currently, Application handles GTK initialization, application uniqueness, session management, provides some basic scriptability and desktop shell integration by exporting actions and menus and manages a list of toplevel windows whose life-cycle is automatically tied to the life-cycle of your application.

While Application works fine with plain Windows, it is recommended to use it together with ApplicationWindow.

§Automatic resources

Application will automatically load menus from the Builder resource located at “gtk/menus.ui”, relative to the application’s resource base path (see [ApplicationExtManual::set_resource_base_path()][crate::gio::prelude::ApplicationExtManual::set_resource_base_path()]). The menu with the ID “menubar” is taken as the application’s menubar. Additional menus (most interesting submenus) can be named and accessed via GtkApplicationExt::menu_by_id() which allows for dynamic population of a part of the menu structure.

Note that automatic resource loading uses the resource base path that is set at construction time and will not work if the resource base path is changed at a later time.

It is also possible to provide the menubar manually using GtkApplicationExt::set_menubar().

Application will also automatically setup an icon search path for the default icon theme by appending “icons” to the resource base path. This allows your application to easily store its icons as resources. See IconTheme::add_resource_path() for more information.

If there is a resource located at gtk/help-overlay.ui which defines a ShortcutsWindow with ID help_overlay then Application associates an instance of this shortcuts window with each ApplicationWindow and sets up the keyboard accelerator Control+? to open it. To create a menu item that displays the shortcuts window, associate the item with the action win.show-help-overlay.

§A simple application

A simple example is available in the GTK source code repository

Application optionally registers with a session manager of the users session (if you set the register-session property) and offers various functionality related to the session life-cycle.

An application can block various ways to end the session with the GtkApplicationExt::inhibit() function. Typical use cases for this kind of inhibiting are long-running, uninterruptible operations, such as burning a CD or performing a disk backup. The session manager may not honor the inhibitor, but it can be expected to inform the user about the negative consequences of ending the session while inhibitors are present.

§See Also

HowDoI: Using GtkApplication, Getting Started with GTK: Basics

§Properties

§active-window

The currently focused window of the application.

Readable

The GMenuModel to be used for the application’s menu bar.

Readable | Writeable

§register-session

Set this property to TRUE to register with the session manager.

This will make GTK track the session state (such as the screensaver-active property).

Readable | Writeable

§screensaver-active

This property is TRUE if GTK believes that the screensaver is currently active.

GTK only tracks session state (including this) when register-session is set to true.

Tracking the screensaver state is currently only supported on Linux.

Readable

Application

§action-group

The group of actions that the application exports.

Writeable

§application-id

The unique identifier for the application.

Readable | Writeable | Construct

§flags

Flags specifying the behaviour of the application.

Readable | Writeable

§inactivity-timeout

Time (in milliseconds) to stay alive after becoming idle.

Readable | Writeable

§is-busy

Whether the application is currently marked as busy through g_application_mark_busy() or g_application_bind_busy_property().

Readable

§is-registered

Whether [ApplicationExtManual::register()][crate::gio::prelude::ApplicationExtManual::register()] has been called.

Readable

§is-remote

Whether this application instance is remote.

Readable

§resource-base-path

The base resource path for the application.

Readable | Writeable

§version

The human-readable version number of the application.

Readable | Writeable

§Signals

§query-end

Emitted when the session manager is about to end the session.

This signal is only emitted if register-session is TRUE. Applications can connect to this signal and call GtkApplicationExt::inhibit() with GTK_APPLICATION_INHIBIT_LOGOUT to delay the end of the session until state has been saved.

§window-added

Emitted when a Window is added to application through GtkApplicationExt::add_window().

§window-removed

Emitted when a Window is removed from application.

This can happen as a side-effect of the window being destroyed or explicitly through GtkApplicationExt::remove_window().

Application

§activate

The ::activate signal is emitted on the primary instance when an activation occurs. See g_application_activate().

§command-line

The ::command-line signal is emitted on the primary instance when a commandline is not handled locally. See g_application_run() and the #GApplicationCommandLine documentation for more information.

§handle-local-options

The ::handle-local-options signal is emitted on the local instance after the parsing of the commandline options has occurred.

You can add options to be recognised during commandline option parsing using g_application_add_main_option_entries() and g_application_add_option_group().

Signal handlers can inspect @options (along with values pointed to from the @arg_data of an installed #GOptionEntrys) in order to decide to perform certain actions, including direct local handling (which may be useful for options like –version).

In the event that the application is marked gio::ApplicationFlags::HANDLES_COMMAND_LINE the “normal processing” will send the @options dictionary to the primary instance where it can be read with g_application_command_line_get_options_dict(). The signal handler can modify the dictionary before returning, and the modified dictionary will be sent.

In the event that gio::ApplicationFlags::HANDLES_COMMAND_LINE is not set, “normal processing” will treat the remaining uncollected command line arguments as filenames or URIs. If there are no arguments, the application is activated by g_application_activate(). One or more arguments results in a call to g_application_open().

If you want to handle the local commandline arguments for yourself by converting them to calls to g_application_open() or g_action_group_activate_action() then you must be sure to register the application first. You should probably not call g_application_activate() for yourself, however: just return -1 and allow the default handler to do it for you. This will ensure that the --gapplication-service switch works properly (i.e. no activation in that case).

Note that this signal is emitted from the default implementation of local_command_line(). If you override that function and don’t chain up then this signal will never be emitted.

You can override local_command_line() if you need more powerful capabilities than what is provided here, but this should not normally be required.

§name-lost

The ::name-lost signal is emitted only on the registered primary instance when a new instance has taken over. This can only happen if the application is using the gio::ApplicationFlags::ALLOW_REPLACEMENT flag.

The default handler for this signal calls g_application_quit().

§open

The ::open signal is emitted on the primary instance when there are files to open. See g_application_open() for more information.

§shutdown

The ::shutdown signal is emitted only on the registered primary instance immediately after the main loop terminates.

§startup

The ::startup signal is emitted on the primary instance immediately after registration. See g_application_register().

ActionGroup

§action-added

Signals that a new action was just added to the group. This signal is emitted after the action has been added and is now visible.

Detailed

§action-enabled-changed

Signals that the enabled status of the named action has changed.

Detailed

§action-removed

Signals that an action is just about to be removed from the group. This signal is emitted before the action is removed, so the action is still visible and can be queried from the signal handler.

Detailed

§action-state-changed

Signals that the state of the named action has changed.

Detailed

§Implements

GtkApplicationExt, gio::prelude::ApplicationExt, [trait@glib::ObjectExt], gio::prelude::ActionGroupExt, gio::prelude::ActionMapExt

Implementations§

source§

impl Application

source

pub const NONE: Option<&'static Application> = None

source

pub fn builder() -> ApplicationBuilder

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

This method returns an instance of ApplicationBuilder which can be used to create Application objects.

source§

impl Application

source

pub fn new( application_id: impl IntoOptionalGStr, flags: ApplicationFlags ) -> Self

Trait Implementations§

source§

impl Clone for Application

source§

fn clone(&self) -> Self

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

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

Performs copy-assignment from source. Read more
source§

impl Debug for Application

source§

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

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

impl Default for Application

source§

fn default() -> Self

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

impl HasParamSpec for Application

§

type ParamSpec = ParamSpecObject

§

type SetValue = Application

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

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

source§

fn param_spec_builder() -> Self::BuilderFn

source§

impl Hash for Application

source§

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

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

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

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

impl<T: GtkApplicationImpl> IsSubclassable<T> for Application

source§

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization. Read more
source§

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization. Read more
source§

impl Ord for Application

source§

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

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

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

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

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

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

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

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

impl ParentClassIs for Application

source§

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

source§

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

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

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

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

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

source§

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

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

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

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

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

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

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

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

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

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

impl StaticType for Application

source§

fn static_type() -> Type

Returns the type identifier of Self.
source§

impl Eq for Application

source§

impl IsA<ActionGroup> for Application

source§

impl IsA<ActionMap> for Application

source§

impl IsA<Application> for Application

Auto Trait Implementations§

Blanket Implementations§

source§

impl<O> ActionGroupExt for O
where O: IsA<ActionGroup>,

source§

fn action_added(&self, action_name: &str)

source§

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

source§

fn action_removed(&self, action_name: &str)

source§

fn action_state_changed(&self, action_name: &str, state: &Variant)

source§

fn activate_action(&self, action_name: &str, parameter: Option<&Variant>)

source§

fn change_action_state(&self, action_name: &str, value: &Variant)

source§

fn is_action_enabled(&self, action_name: &str) -> bool

source§

fn action_parameter_type(&self, action_name: &str) -> Option<VariantType>

source§

fn action_state(&self, action_name: &str) -> Option<Variant>

source§

fn action_state_hint(&self, action_name: &str) -> Option<Variant>

source§

fn action_state_type(&self, action_name: &str) -> Option<VariantType>

source§

fn has_action(&self, action_name: &str) -> bool

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<O> ActionMapExt for O
where O: IsA<ActionMap>,

source§

fn add_action(&self, action: &impl IsA<Action>)

source§

fn lookup_action(&self, action_name: &str) -> Option<Action>

source§

fn remove_action(&self, action_name: &str)

source§

impl<O> ActionMapExtManual for O
where O: IsA<ActionMap>,

source§

fn add_action_entries( &self, entries: impl IntoIterator<Item = ActionEntry<Self>> )

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<O> ApplicationExt for O
where O: IsA<Application>,

source§

fn activate(&self)

source§

fn add_main_option( &self, long_name: &str, short_name: Char, flags: OptionFlags, arg: OptionArg, description: &str, arg_description: Option<&str> )

source§

fn bind_busy_property(&self, object: &impl IsA<Object>, property: &str)

source§

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

source§

fn dbus_connection(&self) -> Option<DBusConnection>

source§

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

source§

fn flags(&self) -> ApplicationFlags

source§

fn inactivity_timeout(&self) -> u32

source§

fn is_busy(&self) -> bool

source§

fn is_registered(&self) -> bool

source§

fn is_remote(&self) -> bool

source§

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

source§

fn open(&self, files: &[File], hint: &str)

source§

fn quit(&self)

source§

fn register( &self, cancellable: Option<&impl IsA<Cancellable>> ) -> Result<(), Error>

source§

fn send_notification(&self, id: Option<&str>, notification: &Notification)

source§

fn set_application_id(&self, application_id: Option<&str>)

source§

fn set_default(&self)

source§

fn set_flags(&self, flags: ApplicationFlags)

source§

fn set_inactivity_timeout(&self, inactivity_timeout: u32)

source§

fn set_option_context_description(&self, description: Option<&str>)

source§

fn set_option_context_parameter_string(&self, parameter_string: Option<&str>)

source§

fn set_option_context_summary(&self, summary: Option<&str>)

source§

fn set_resource_base_path(&self, resource_path: Option<&str>)

source§

fn unbind_busy_property(&self, object: &impl IsA<Object>, property: &str)

source§

fn withdraw_notification(&self, id: &str)

source§

fn set_action_group<P>(&self, action_group: Option<&P>)
where P: IsA<ActionGroup>,

source§

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

source§

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

source§

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

source§

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

Available on crate feature v2_60 only.
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

impl<O> ApplicationExtManual for O
where O: IsA<Application>,

source§

fn run(&self) -> ExitCode

source§

fn run_with_args<S>(&self, args: &[S]) -> ExitCode
where S: AsRef<str>,

source§

fn connect_open<F>(&self, f: F) -> SignalHandlerId
where F: Fn(&Self, &[File], &str) + 'static,

source§

fn hold(&self) -> ApplicationHoldGuard

source§

fn mark_busy(&self) -> ApplicationBusyGuard

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<T> Cast for T
where T: ObjectType,

source§

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

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

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

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

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

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

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

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

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

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

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

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

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

Casts to T unconditionally. Read more
source§

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

Casts to &T unconditionally. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

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

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

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

fn this_expression(property_name: &str) -> PropertyExpression

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

impl<O> GtkApplicationExt for O
where O: IsA<Application>,

source§

fn add_window(&self, window: &impl IsA<Window>)

Adds a window to application. Read more
source§

fn accels_for_action(&self, detailed_action_name: &str) -> Vec<GString>

Gets the accelerators that are currently associated with the given action. Read more
source§

fn actions_for_accel(&self, accel: &str) -> Vec<GString>

Returns the list of actions (possibly empty) that accel maps to. Read more
source§

fn active_window(&self) -> Option<Window>

Gets the “active” window for the application. Read more
source§

fn menu_by_id(&self, id: &str) -> Option<Menu>

Gets a menu from automatically loaded resources. Read more
source§

fn menubar(&self) -> Option<MenuModel>

Returns the menu model that has been set with set_menubar(). Read more
source§

fn window_by_id(&self, id: u32) -> Option<Window>

Returns the ApplicationWindow with the given ID. Read more
source§

fn windows(&self) -> Vec<Window>

Gets a list of the Window instances associated with application. Read more
source§

fn inhibit( &self, window: Option<&impl IsA<Window>>, flags: ApplicationInhibitFlags, reason: Option<&str> ) -> u32

Inform the session manager that certain types of actions should be inhibited. Read more
source§

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

Lists the detailed action names which have associated accelerators. Read more
source§

fn remove_window(&self, window: &impl IsA<Window>)

Remove a window from application. Read more
source§

fn set_accels_for_action(&self, detailed_action_name: &str, accels: &[&str])

Sets zero or more keyboard accelerators that will trigger the given action. Read more
source§

fn set_menubar(&self, menubar: Option<&impl IsA<MenuModel>>)

Sets or unsets the menubar for windows of application. Read more
source§

fn uninhibit(&self, cookie: u32)

Removes an inhibitor that has been previously established. Read more
source§

fn is_register_session(&self) -> bool

Set this property to TRUE to register with the session manager. Read more
source§

fn set_register_session(&self, register_session: bool)

Set this property to TRUE to register with the session manager. Read more
source§

fn is_screensaver_active(&self) -> bool

This property is TRUE if GTK believes that the screensaver is currently active. Read more
source§

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

Emitted when the session manager is about to end the session. Read more
source§

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

Emitted when a Window is added to application through add_window(). Read more
source§

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

Emitted when a Window is removed from application. Read more
source§

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

source§

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

source§

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

source§

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

source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

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

source§

impl<U> IsSubclassableExt for U

source§

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

source§

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

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

fn type_(&self) -> Type

Returns the type of the object.
source§

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

Returns the ObjectClass of the object. Read more
source§

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

Returns the class of the object.
source§

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn freeze_notify(&self) -> PropertyNotificationFreezeGuard

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

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

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

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

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

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

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

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

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

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

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

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

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

fn block_signal(&self, handler_id: &SignalHandlerId)

Block a given signal handler. Read more
source§

fn unblock_signal(&self, handler_id: &SignalHandlerId)

Unblock a given signal handler.
source§

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

Stop emission of the currently emitted signal.
source§

fn stop_signal_emission_by_name(&self, signal_name: &str)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Emit signal by signal id. Read more
source§

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

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

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

Emit signal by its name. Read more
source§

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

Emit signal by its name. Read more
source§

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

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

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

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

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

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

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

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

fn disconnect(&self, handler_id: SignalHandlerId)

Disconnect a previously connected signal handler.
source§

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

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

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

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

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

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

fn notify(&self, property_name: &str)

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

fn notify_by_pspec(&self, pspec: &ParamSpec)

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

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

Downgrade this object to a weak reference.
source§

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

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

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

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

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

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

fn ref_count(&self) -> u32

Returns the strong reference count of this object.
source§

unsafe fn run_dispose(&self)

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

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

§

type Value = T

source§

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

§

type Value = T

source§

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

source§

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

source§

fn ensure_type()

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

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<T> TransparentType for T

source§

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

§

type Error = Infallible

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

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

Performs the conversion.
source§

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

source§

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

§

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

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

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

Performs the conversion.
source§

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