Struct gtk4::ApplicationWindow

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

ApplicationWindow is a Window subclass that integrates with Application.

Notably, ApplicationWindow can handle an application menubar.

This class implements the GActionGroup and GActionMap 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 GMenuModel.

Note that widgets that are placed inside a ApplicationWindow can also activate these actions, if they implement the Actionable interface.

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.

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.

See PopoverMenu for information about the XML language used by Builder for menu models.

See also: GtkApplicationExt::set_menubar().

A GtkApplicationWindow with a menubar

The code sample below shows how to set up a ApplicationWindow with a menu bar defined on the Application:

⚠️ 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>"
    "      <attribute name='label' translatable='yes'>_Edit</attribute>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>_Copy</attribute>"
    "        <attribute name='action'>win.copy</attribute>"
    "      </item>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>_Paste</attribute>"
    "        <attribute name='action'>win.paste</attribute>"
    "      </item>"
    "    </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);

Implements

ApplicationWindowExt, GtkWindowExt, WidgetExt, glib::ObjectExt, AccessibleExt, BuildableExt, ConstraintTargetExt, NativeExt, RootExt, ShortcutManagerExt, gio::prelude::ActionGroupExt, gio::prelude::ActionMapExt, WidgetExtManual, AccessibleExtManual

Implementations

impl ApplicationWindow

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

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

Creates a new ApplicationWindow.

application

a Application

Returns

a newly created ApplicationWindow

pub fn builder() -> ApplicationWindowBuilder

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

impl Clone for ApplicationWindow

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ApplicationWindow

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

Formats the value using the given formatter.

impl Default for ApplicationWindow

fn default() -> Self

Returns the “default value” for a type.

impl Display for ApplicationWindow

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

Formats the value using the given formatter.

impl Hash for ApplicationWindow

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

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

Override the virtual methods of this class for the given subclass and do other class initialization.

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

Instance specific initialization.

impl Ord for ApplicationWindow

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl ParentClassIs for ApplicationWindow

type Parent = Window

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

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

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

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.

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for ApplicationWindow

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for ApplicationWindow

impl IsA<Accessible> for ApplicationWindow

impl IsA<ActionGroup> for ApplicationWindow

impl IsA<ActionMap> for ApplicationWindow

impl IsA<Buildable> for ApplicationWindow

impl IsA<ConstraintTarget> for ApplicationWindow

impl IsA<Native> for ApplicationWindow

impl IsA<Root> for ApplicationWindow

impl IsA<ShortcutManager> for ApplicationWindow

impl IsA<Widget> for ApplicationWindow

impl IsA<Window> for ApplicationWindow