Struct gtk::ApplicationWindow

source · [−]

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

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

A simple example

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 TextDirection to 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], ContainerExtManual, WidgetExtManual, BuildableExtManual

Struct gtk::ApplicationWindow

Implementations

impl ApplicationWindow

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

pub fn builder() -> ApplicationWindowBuilder

impl ApplicationWindow

pub fn new<P: IsA<Application>>(application: &P) -> ApplicationWindow

Trait Implementations

impl Clone for ApplicationWindow

fn clone(&self) -> Self

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

impl Debug for ApplicationWindow

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

impl Display for ApplicationWindow

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

impl Hash for ApplicationWindow

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

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

impl<T: ApplicationWindowImpl> IsSubclassable<T> for ApplicationWindow

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

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

impl Ord for ApplicationWindow

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

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

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

fn clamp(self, min: Self, max: Self) -> Self

impl ParentClassIs for ApplicationWindow

type Parent = Window

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

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

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

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

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

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

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

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

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

impl StaticType for ApplicationWindow

fn static_type() -> Type

impl Eq for ApplicationWindow

impl IsA<ActionGroup> for ApplicationWindow

impl IsA<ActionMap> for ApplicationWindow

impl IsA<Bin> for ApplicationWindow

impl IsA<Buildable> for ApplicationWindow

impl IsA<Container> for ApplicationWindow

impl IsA<Widget> for ApplicationWindow

impl IsA<Window> for ApplicationWindow

Auto Trait Implementations

impl RefUnwindSafe for ApplicationWindow

impl !Send for ApplicationWindow

impl !Sync for ApplicationWindow

impl Unpin for ApplicationWindow

impl UnwindSafe for ApplicationWindow

Blanket Implementations

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

fn action_added(&self, action_name: &str)

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

fn action_removed(&self, action_name: &str)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fn remove_action(&self, action_name: &str)

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

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

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

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

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

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

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

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

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

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

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

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

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

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

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

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

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

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

impl<U> IsSubclassableExt for U where
U: IsClass + ParentClassIs,

fn parent_class_init<T>(class: &mut Class<U>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

fn parent_instance_init<T>(instance: &mut InitializingObject<T>) where
T: ObjectSubclass,
<U as ParentClassIs>::Parent: IsSubclassable<T>,

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

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

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

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

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

fn try_set_property<V>(
&self,
property_name: &str,
value: V
) -> Result<(), BoolError> where
V: ToValue,

fn set_property<V>(&self, property_name: &str, value: V) where
V: ToValue,

fn try_set_property_from_value(
&self,
property_name: &str,
value: &Value
) -> Result<(), BoolError>

fn try_set_properties(
&self,
property_values: &[(&str, &dyn ToValue )]
) -> Result<(), BoolError>

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

fn try_set_properties_from_value(
&self,
property_values: &[(&str, Value )]
) -> Result<(), BoolError>

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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