[−]Struct gtk::ApplicationWindow

pub struct ApplicationWindow(_, _);

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 Settings:gtk-shell-shows-app-menu and 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 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 `ApplicationWindow` with a menubar

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::object::ObjectExt, BuildableExt, gio::ActionGroupExt, gio::ActionMapExt, GtkWindowExtManual, WidgetExtManual, BuildableExtManual

Implementations

`impl ApplicationWindow`[src]

`pub fn new<P: IsA<Application>>(application: &P) -> ApplicationWindow`[src]

Creates a new ApplicationWindow.

`application`

a Application

Returns

a newly created ApplicationWindow

Trait Implementations

`impl Clone for ApplicationWindow`

`fn clone(&self) -> ApplicationWindow`

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for ApplicationWindow`

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

`impl Display for ApplicationWindow`[src]

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

`impl Eq for ApplicationWindow`

`impl Hash for ApplicationWindow`

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

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

`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`

`impl Ord for ApplicationWindow`

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

`#[must_use]fn max(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn min(self, other: Self) -> Self`1.21.0[src]

`#[must_use]fn clamp(self, min: Self, max: Self) -> Self`[src]

`impl<T: ObjectType> PartialEq<T> for ApplicationWindow`

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

`#[must_use]fn ne(&self, other: &Rhs) -> bool`1.0.0[src]

`impl<T: ObjectType> PartialOrd<T> for ApplicationWindow`

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

`#[must_use]fn lt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn le(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn gt(&self, other: &Rhs) -> bool`1.0.0[src]

`#[must_use]fn ge(&self, other: &Rhs) -> bool`1.0.0[src]

`impl StaticType for ApplicationWindow`

`fn static_type() -> Type`

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 get_action_enabled(&self, action_name: &str) -> bool`

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

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

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

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

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

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

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

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

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

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

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

`fn add_action(&self, action: &P) where P: 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,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<Super, Sub> CanDowncast for Super where Sub: IsA<Super>, Super: IsA<Super>,`

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

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

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

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

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

`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> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

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

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

`fn get_type(&self) -> Type`

`fn get_object_class(&self) -> &ObjectClass`

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

`fn set_property<'a, N>( &self, property_name: N, value: &dyn ToValue ) -> Result<(), BoolError> where N: Into<&'a str>,`

`fn get_property<'a, N>(&self, property_name: N) -> Result<Value, BoolError> where N: Into<&'a str>,`

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

`unsafe fn get_qdata<QD>(&self, key: Quark) -> Option<&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 get_data<QD>(&self, key: &str) -> Option<&QD> where QD: 'static,`

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

`fn block_signal(&self, handler_id: &SignalHandlerId)`

`fn unblock_signal(&self, handler_id: &SignalHandlerId)`

`fn stop_signal_emission(&self, signal_name: &str)`

`fn disconnect(&self, handler_id: SignalHandlerId)`

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

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

`fn notify<'a, N>(&self, property_name: N) where N: Into<&'a str>,`

`fn notify_by_pspec(&self, pspec: &ParamSpec)`

`fn has_property<'a, N>(&self, property_name: N, type_: Option<Type>) -> bool where N: Into<&'a str>,`

`fn get_property_type<'a, N>(&self, property_name: N) -> Option<Type> where N: Into<&'a str>,`

`fn find_property<'a, N>(&self, property_name: N) -> Option<ParamSpec> where N: Into<&'a str>,`

`fn list_properties(&self) -> Vec<ParamSpec>`

`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>,`

`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>,`

`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>,`

`fn emit<'a, N>( &self, signal_name: N, args: &[&dyn ToValue] ) -> Result<Option<Value>, BoolError> where N: Into<&'a str>,`

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

`fn bind_property<'a, O, N, M>( &'a self, source_property: N, target: &'a O, target_property: M ) -> BindingBuilder<'a> where M: Into<&'a str>, N: Into<&'a str>, O: ObjectType,`

`fn ref_count(&self) -> u32`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GList, <T as ToGlibContainerFromSlice<'a, const GList>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *const GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( _t: &'a [T] ) -> (const GPtrArray, <T as ToGlibContainerFromSlice<'a, const GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(_t: &[T]) -> *const GPtrArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<Array>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GArray, <T as ToGlibContainerFromSlice<'a, mut GArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GArray`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GList> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<List>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GList, <T as ToGlibContainerFromSlice<'a, mut GList>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GList`

`impl<'a, T> ToGlibContainerFromSlice<'a, *mut GPtrArray> for T where T: GlibPtrDefault + ToGlibPtr<'a, <T as GlibPtrDefault>::GlibType>,`

`type Storage = (Option<PtrArray>, Vec<Stash<'a, <T as GlibPtrDefault>::GlibType, T>>)`

`fn to_glib_none_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_container_from_slice( t: &'a [T] ) -> (mut GPtrArray, <T as ToGlibContainerFromSlice<'a, mut GPtrArray>>::Storage)`

`fn to_glib_full_from_slice(t: &[T]) -> *mut GPtrArray`

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T> ToString for T where T: Display + ?Sized,` [src]

`default fn to_string(&self) -> String`[src]

`impl<T> ToValue for T where T: SetValue + ?Sized,`

`fn to_value(&self) -> Value`

`fn to_value_type(&self) -> Type`

`impl<T, U> TryFrom for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

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

`impl<T, U> TryInto for T where U: TryFrom<T>,` [src]

`type Error = >::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, >::Error>`[src]

[−]Struct gtk::ApplicationWindow

A ApplicationWindow with a menubar

Handling fallback yourself

Implements

Implementations

impl ApplicationWindow[src]

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

application

Returns

Trait Implementations

impl Clone for ApplicationWindow

fn clone(&self) -> ApplicationWindow

fn clone_from(&mut self, source: &Self)1.0.0[src]

impl Debug for ApplicationWindow

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

impl Display for ApplicationWindow[src]

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

impl Eq for ApplicationWindow

impl Hash for ApplicationWindow

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

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

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

impl Ord for ApplicationWindow

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

#[must_use]fn max(self, other: Self) -> Self1.21.0[src]

#[must_use]fn min(self, other: Self) -> Self1.21.0[src]

#[must_use]fn clamp(self, min: Self, max: Self) -> Self[src]

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool1.0.0[src]

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

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

#[must_use]fn lt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn le(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn gt(&self, other: &Rhs) -> bool1.0.0[src]

#[must_use]fn ge(&self, other: &Rhs) -> bool1.0.0[src]

impl StaticType for ApplicationWindow

fn static_type() -> Type

Auto Trait Implementations

impl RefUnwindSafe for ApplicationWindow

impl !Send for ApplicationWindow

impl !Sync for ApplicationWindow

impl Unpin for ApplicationWindow

impl UnwindSafe for ApplicationWindow