Struct gtk::ApplicationWindow [−][src]
pub struct ApplicationWindow(_);
Expand description
ApplicationWindow is a Window subclass that offers some
extra functionality for better integration with Application
features. Notably, it can handle both the application menu as well
as the menubar. See GtkApplicationExt::set_app_menu() and
GtkApplicationExt::set_menubar().
This class implements the gio::ActionGroup and gio::ActionMap interfaces,
to let you add window-specific actions that will be exported by the
associated Application, together with its application-wide
actions. Window-specific actions are prefixed with the “win.”
prefix and application-wide actions are prefixed with the “app.”
prefix. Actions must be addressed with the prefixed name when
referring to them from a gio::MenuModel.
Note that widgets that are placed inside a ApplicationWindow
can also activate these actions, if they implement the
Actionable interface.
As with Application, the GDK lock will be acquired when
processing actions arriving from other processes and should therefore
be held when activating actions locally (if GDK threads are enabled).
The settings property::Settings::gtk-shell-shows-app-menu and
property::Settings::gtk-shell-shows-menubar tell GTK+ whether the
desktop environment is showing the application menu and menubar
models outside the application as part of the desktop shell.
For instance, on OS X, both menus will be displayed remotely;
on Windows neither will be. gnome-shell (starting with version 3.4)
will display the application menu, but not the menubar.
If the desktop environment does not display the menubar, then
ApplicationWindow will automatically show a MenuBar for it.
This behaviour can be overridden with the property::ApplicationWindow::show-menubar
property. If the desktop environment does not display the application
menu, then it will automatically be included in the menubar or in the
windows client-side decorations.
A GtkApplicationWindow with a menubar
⚠️ The following code is in C ⚠️
GtkApplication *app = gtk_application_new ("org.gtk.test", 0);
GtkBuilder *builder = gtk_builder_new_from_string (
"<interface>"
" <menu id='menubar'>"
" <submenu label='_Edit'>"
" <item label='_Copy' action='win.copy'/>"
" <item label='_Paste' action='win.paste'/>"
" </submenu>"
" </menu>"
"</interface>",
-1);
GMenuModel *menubar = G_MENU_MODEL (gtk_builder_get_object (builder,
"menubar"));
gtk_application_set_menubar (GTK_APPLICATION (app), menubar);
g_object_unref (builder);
// ...
GtkWidget *window = gtk_application_window_new (app);
Handling fallback yourself
The XML format understood by Builder for gio::MenuModel consists
of a toplevel <menu> element, which contains one or more <item>
elements. Each <item> element contains <attribute> and <link>
elements with a mandatory name attribute. <link> elements have the
same content model as <menu>. Instead of <link name="submenu> or
<link name="section">, you can use <submenu> or <section>
elements.
Attribute values can be translated using gettext, like other Builder
content. <attribute> elements can be marked for translation with a
translatable="yes" attribute. It is also possible to specify message
context and translator comments, using the context and comments attributes.
To make use of this, the Builder must have been given the gettext
domain to use.
The following attributes are used when constructing menu items:
- “label”: a user-visible string to display
- “action”: the prefixed name of the action to trigger
- “target”: the parameter to use when activating the action
- “icon” and “verb-icon”: names of icons that may be displayed
- “submenu-action”: name of an action that may be used to determine if a submenu can be opened
- “hidden-when”: a string used to determine when the item will be hidden. Possible values include “action-disabled”, “action-missing”, “macos-menubar”.
The following attributes are used when constructing sections:
- “label”: a user-visible string to use as section heading
- “display-hint”: a string used to determine special formatting for the section. Possible values include “horizontal-buttons”.
- “text-direction”: a string used to determine the
TextDirectionto use when “display-hint” is set to “horizontal-buttons”. Possible values include “rtl”, “ltr”, and “none”.
The following attributes are used when constructing submenus:
- “label”: a user-visible string to display
- “icon”: icon name to display
Implements
ApplicationWindowExt, GtkWindowExt, BinExt, ContainerExt, WidgetExt, glib::ObjectExt, BuildableExt, gio::prelude::ActionGroupExt, gio::prelude::ActionMapExt, [GtkWindowExtManual][trait@crate::prelude::GtkWindowExtManual], WidgetExtManual, BuildableExtManual
Implementations
Creates a new builder-pattern struct instance to construct ApplicationWindow objects.
This method returns an instance of ApplicationWindowBuilder which can be used to create ApplicationWindow objects.
Trait Implementations
This 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 ApplicationWindowimpl !Send for ApplicationWindowimpl !Sync for ApplicationWindowimpl Unpin for ApplicationWindowimpl UnwindSafe for ApplicationWindowBlanket 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), 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>,