Blame hig/C/application-menus.page

Packit 1470ea
Packit 1470ea
      type="topic"
Packit 1470ea
      id="application-menus">
Packit 1470ea
Packit 1470ea
  <info>
Packit 1470ea
    <link type="guide" xref="patterns#primary"/>
Packit 1470ea
    <desc>Global application menu that is accessed from the top bar</desc>
Packit 1470ea
    <credit type="author">
Packit 1470ea
      <name>Allan Day</name>
Packit 1470ea
      <email>aday@gnome.org</email>
Packit 1470ea
    </credit>
Packit 1470ea
    <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"/>
Packit 1470ea
  </info>
Packit 1470ea
Packit 1470ea
<title>Application menus</title>
Packit 1470ea
Packit 1470ea
<media type="image" mime="image/svg" src="figures/patterns/application-menu.svg"/>
Packit 1470ea
Packit 1470ea

Application menus provide access to global, top level actions and options for your application. These include standard items for accessing documentation and information about the application.

Packit 1470ea
Packit 1470ea
<section id="when-to-use">
Packit 1470ea
<title>When to use</title>
Packit 1470ea
Packit 1470ea

Application menus are a standard part of GNOME 3, and every application that runs under GNOME 3 should have one.

Packit 1470ea
Packit 1470ea
</section>
Packit 1470ea
Packit 1470ea
<section id="general-guidelines">
Packit 1470ea
<title>General guidelines</title>
Packit 1470ea
Packit 1470ea
<list>
Packit 1470ea
<item>

Follow the standard <link xref="menus">guidance for menus</link>.

</item>
Packit 1470ea
<item>

Only include menu items that relate to the application as a whole, such as application preferences. Items that are specific to a particular window or view, or which act on content within an application window, should not be included.

</item>
Packit 1470ea
<item>

If an item from the application menu is frequently used, consider moving it to a more accessible location.

</item>
Packit 1470ea
</list>
Packit 1470ea
Packit 1470ea
</section>
Packit 1470ea
Packit 1470ea
<section id="standard-menu-items">
Packit 1470ea
<title>Standard menu items</title>
Packit 1470ea
Packit 1470ea

Common application menu items include <gui>New Window</gui>, <gui>Preferences</gui>, <gui>Help</gui>, <gui>About</gui> and <gui>Quit</gui>. <gui>Help</gui>, <gui>About</gui> and <gui>Quit</gui> should be contained within their own group at the bottom of the menu.

Packit 1470ea
Packit 1470ea
Packit 1470ea
Packit 1470ea

<gui>New Window</gui>

Packit 1470ea

Opens a new window. Only <link xref="primary-windows#application-types">multiple instance applications</link> should include this menu item. If the new window contains a specific type of content item, or simultaneously performs an action, rename it to be less generic. For example: <gui>New Connection</gui> or <gui>New Document</gui>.

Packit 1470ea
Packit 1470ea
Packit 1470ea

<gui>Preferences</gui>

Packit 1470ea

Opens the application's preferences dialog. Only show this menu item if your application has a preferences dialog.

Packit 1470ea
Packit 1470ea
Packit 1470ea

<gui>Help</gui>

Packit 1470ea

Opens your application's user documentation in the <app>Help</app> application. Only show this menu item if your application has user documentation.

Packit 1470ea
Packit 1470ea
Packit 1470ea

<gui>About</gui>

Packit 1470ea

Opens the application's about dialog. Every application menu should include this item.

Packit 1470ea
Packit 1470ea
Packit 1470ea

<gui>Quit</gui>

Packit 1470ea

Closes the application, including all application windows. Every application menu should include this item.

Packit 1470ea
Packit 1470ea
Packit 1470ea
Packit 1470ea
</section>
Packit 1470ea
Packit 1470ea
<section id="api-reference">
Packit 1470ea
<title>API reference</title>
Packit 1470ea
<list>
Packit 1470ea
<item>

<link href="https://developer.gnome.org/gtk3/stable/GtkApplication.html">GtkApplication</link>

</item>
Packit 1470ea
</list>
Packit 1470ea
</section>
Packit 1470ea
</page>