Struct gtk::Application [−][src]
pub struct Application(_);
Expand description
Application is a class that handles many important aspects
of a GTK+ application in a convenient fashion, without enforcing
a one-size-fits-all application model.
Currently, GtkApplication 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 GtkApplication works fine with plain GtkWindows, it is recommended
to use it together with ApplicationWindow.
When GDK threads are enabled, GtkApplication will acquire the GDK
lock when invoking actions that arrive from other processes. The GDK
lock is not touched for local action invocations. In order to have
actions invoked in a predictable context it is therefore recommended
that the GDK lock be held while invoking actions locally with
[ActionGroupExtManual::activate_action()][crate::gio::prelude::ActionGroupExtManual::activate_action()]. The same applies to actions
associated with ApplicationWindow and to the “activate” and
“open” gio::Application methods.
Automatic resources ## {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 “app-menu” is taken as the application’s app menu
and 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.
If the resources “gtk/menus-appmenu.ui” or “gtk/menus-traditional.ui” are
present then these files will be used in preference, depending on the value
of GtkApplicationExt::prefers_app_menu(). If the resource “gtk/menus-common.ui”
is present it will be loaded as well. This is useful for storing items that
are referenced from both “gtk/menus-appmenu.ui” and
“gtk/menus-traditional.ui”.
It is also possible to provide the menus manually using
GtkApplicationExt::set_app_menu() and 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 IconThemeExt::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 GtkApplication
associates an instance of this shortcuts window with each
ApplicationWindow and sets up keyboard accelerators (Control-F1
and 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 ## {gtkapplication}
GtkApplication optionally registers with a session manager
of the users session (if you set the property::Application::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 ## {seealso}
HowDoI: Using GtkApplication, Getting Started with GTK+: Basics
Implements
GtkApplicationExt, gio::prelude::ApplicationExt, glib::ObjectExt, gio::prelude::ActionGroupExt, gio::prelude::ActionMapExt, [gio::ApplicationExtManual][trait@crate::prelude::gio::ApplicationExtManual]
Implementations
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.
Creates a new Application instance.
When using Application, it is not necessary to call gtk_init()
manually. It is called as soon as the application gets registered as
the primary instance.
Concretely, gtk_init() is called in the default handler for the
signal::gio::Application::startup signal. Therefore, Application subclasses should
chain up in their signal::gio::Application::startup handler before using any GTK+ API.
Note that commandline arguments are not passed to gtk_init().
All GTK+ functionality that is available via commandline arguments
can also be achieved by setting suitable environment variables
such as G_DEBUG, so this should not be a big
problem. If you absolutely must support GTK+ commandline arguments,
you can explicitly call gtk_init() before creating the application
instance.
If non-None, the application ID must be valid. See
gio::Application::id_is_valid().
If no application ID is given then some features (most notably application uniqueness) will be disabled. A null application ID is only allowed with GTK+ 3.6 or later.
application_id
The application ID.
flags
the application flags
Returns
a new Application instance
Trait Implementations
type Parent = ApplicationThis method returns an ordering between self and other values if one exists. Read more
This method tests less than (for self and other) and is used by the < operator. Read more
This method tests less than or equal to (for self and other) and is used by the <=
operator. Read more
This method tests greater than (for self and other) and is used by the > operator. Read more
Returns the type identifier of Self.
Auto Trait Implementations
impl RefUnwindSafe for Applicationimpl !Send for Applicationimpl !Sync for Applicationimpl Unpin for Applicationimpl UnwindSafe for ApplicationBlanket Implementations
pub fn connect_action_added<F>(
&self,
detail: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &str), pub fn connect_action_enabled_changed<F>(
&self,
detail: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &str, bool), pub fn connect_action_removed<F>(
&self,
detail: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &str), pub fn connect_action_state_changed<F>(
&self,
detail: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&O, &str, &Variant), pub fn add_main_option(
&self,
long_name: &str,
short_name: Char,
flags: OptionFlags,
arg: OptionArg,
description: &str,
arg_description: Option<&str>
)v2_56 only.v2_56 only.v2_56 only.pub fn connect_command_line<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &ApplicationCommandLine) -> i32, pub fn connect_handle_local_options<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O, &VariantDict) -> i32, v2_60 only.pub fn connect_action_group_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O), pub fn connect_application_id_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O), pub fn connect_inactivity_timeout_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O), pub fn connect_is_registered_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O), pub fn connect_resource_base_path_notify<F>(&self, f: F) -> SignalHandlerId where
F: 'static + Fn(&O), Mutably borrows from an owned value. Read more
Upcasts an object to a superclass or interface T. Read more
Upcasts an object to a reference of its superclass or interface T. Read more
Tries to downcast to a subclass or interface implementor T. Read more
Tries to downcast to a reference of its subclass or interface implementor T. Read more
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 downcast and upcast will do many checks at compile-time already. Read more
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
Casts to T unconditionally. Read more
Casts to &T unconditionally. Read more
Returns true if the object is an instance of (can be cast to) T.
pub fn set_properties_from_value(
&self,
property_values: &[(&str, Value)]
) -> Result<(), BoolError>pub fn set_property<'a, N, V>(
&self,
property_name: N,
value: V
) -> Result<(), BoolError> where
V: ToValue,
N: Into<&'a str>, pub fn set_property_from_value<'a, N>(
&self,
property_name: N,
value: &Value
) -> Result<(), BoolError> where
N: Into<&'a str>, Safety Read more
Safety Read more
Safety Read more
Safety Read more
pub fn connect_notify<F>(&self, name: Option<&str>, f: F) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec) + Send + Sync, pub fn connect_notify_local<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: 'static + Fn(&T, &ParamSpec), pub unsafe fn connect_notify_unsafe<F>(
&self,
name: Option<&str>,
f: F
) -> SignalHandlerId where
F: Fn(&T, &ParamSpec), pub fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where
N: Into<&'a str>, pub fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where
N: Into<&'a str>, pub fn connect<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + Send + Sync + 'static,
N: Into<&'a str>, Same as connect but takes a SignalId instead of a signal name.
pub fn connect_local<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value> + 'static,
N: Into<&'a str>, Same as connect_local but takes a SignalId instead of a signal name.
pub unsafe fn connect_unsafe<'a, N, F>(
&self,
signal_name: N,
after: bool,
callback: F
) -> Result<SignalHandlerId, BoolError> where
F: Fn(&[Value]) -> Option<Value>,
N: Into<&'a str>, Same as connect_unsafe but takes a SignalId instead of a signal name.
Emit signal by signal id.
Emit signal with details by signal id.
Emit signal by it’s name.
pub fn bind_property<'a, O, N, M>(
&'a self,
source_property: N,
target: &'a O,
target_property: M
) -> BindingBuilder<'a> where
O: ObjectType,
N: Into<&'a str>,
M: Into<&'a str>, Same as emit but takes Value for the arguments.
Same as emit_by_name but takes Value for the arguments.
Returns a SendValue clone of self.
impl<'a, T, C> FromValueOptional<'a> for T where
C: ValueTypeChecker<Error = ValueTypeMismatchOrNoneError>,
T: FromValue<'a, Checker = C>,