433 lines
32 KiB
HTML
433 lines
32 KiB
HTML
|
<!doctype html>
|
||
|
|
<html class="no-js">
|
||
|
|
<head><meta charset="utf-8"/>
|
||
|
|
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||
|
|
<meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||
|
|
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Saving and Loading Window State" href="save-state.html" /><link rel="prev" title="Application ID" href="application-id.html" />
|
||
|
|
|
||
|
|
<meta name="generator" content="sphinx-4.3.0, furo 2022.06.21"/>
|
||
|
|
<title>Using GtkApplication - GNOME Developer Documentation</title>
|
||
|
|
<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="../_static/tabs.css" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
|
||
|
|
<link rel="stylesheet" type="text/css" href="../_static/gnome.css" />
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<style>
|
||
|
|
body {
|
||
|
|
--color-code-background: #f8f8f8;
|
||
|
|
--color-code-foreground: black;
|
||
|
|
--color-brand-primary: #4a86cf;
|
||
|
|
--color-brand-content: #4a86cf;
|
||
|
|
|
||
|
|
}
|
||
|
|
@media not print {
|
||
|
|
body[data-theme="dark"] {
|
||
|
|
--color-code-background: #202020;
|
||
|
|
--color-code-foreground: #d0d0d0;
|
||
|
|
|
||
|
|
}
|
||
|
|
@media (prefers-color-scheme: dark) {
|
||
|
|
body:not([data-theme="light"]) {
|
||
|
|
--color-code-background: #202020;
|
||
|
|
--color-code-foreground: #d0d0d0;
|
||
|
|
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
</style></head>
|
||
|
|
<body>
|
||
|
|
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
|
|
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
|
|
<title>Contents</title>
|
||
|
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||
|
|
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||
|
|
</svg>
|
||
|
|
</symbol>
|
||
|
|
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
|
|
<title>Menu</title>
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||
|
|
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
|
|
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
|
|
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
|
|
</svg>
|
||
|
|
</symbol>
|
||
|
|
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
|
|
<title>Expand</title>
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
|
|
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||
|
|
<polyline points="9 18 15 12 9 6"></polyline>
|
||
|
|
</svg>
|
||
|
|
</symbol>
|
||
|
|
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||
|
|
<title>Light mode</title>
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||
|
|
<circle cx="12" cy="12" r="5"></circle>
|
||
|
|
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||
|
|
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||
|
|
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||
|
|
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||
|
|
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||
|
|
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||
|
|
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||
|
|
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||
|
|
</svg>
|
||
|
|
</symbol>
|
||
|
|
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||
|
|
<title>Dark mode</title>
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||
|
|
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||
|
|
</svg>
|
||
|
|
</symbol>
|
||
|
|
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||
|
|
<title>Auto light/dark mode</title>
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||
|
|
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||
|
|
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||
|
|
<circle cx="12" cy="12" r="9" />
|
||
|
|
<path d="M13 12h5" />
|
||
|
|
<path d="M13 15h4" />
|
||
|
|
<path d="M13 18h1" />
|
||
|
|
<path d="M13 9h4" />
|
||
|
|
<path d="M13 6h1" />
|
||
|
|
</svg>
|
||
|
|
</symbol>
|
||
|
|
</svg>
|
||
|
|
|
||
|
|
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
|
|
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
|
|
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||
|
|
<label class="overlay toc-overlay" for="__toc"></label>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="page">
|
||
|
|
<header class="mobile-header">
|
||
|
|
<div class="header-left">
|
||
|
|
<label class="nav-overlay-icon" for="__navigation">
|
||
|
|
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
|
|
</label>
|
||
|
|
</div>
|
||
|
|
<div class="header-center">
|
||
|
|
<a href="../index.html"><div class="brand">GNOME Developer Documentation</div></a>
|
||
|
|
</div>
|
||
|
|
<div class="header-right">
|
||
|
|
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
|
|
</label>
|
||
|
|
</div>
|
||
|
|
</header>
|
||
|
|
<aside class="sidebar-drawer">
|
||
|
|
<div class="sidebar-container">
|
||
|
|
|
||
|
|
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="sidebar-brand-text">GNOME Developer Documentation</span>
|
||
|
|
|
||
|
|
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||
|
|
<input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
|
||
|
|
<input type="hidden" name="check_keywords" value="yes">
|
||
|
|
<input type="hidden" name="area" value="default">
|
||
|
|
</form>
|
||
|
|
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||
|
|
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||
|
|
<ul class="current">
|
||
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../introduction.html">Platform Introduction</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l2 has-children"><a class="reference internal" href="../introduction/components.html">Platform Components</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../introduction/overview/libraries.html">Libraries</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../introduction/overview/services.html">Services</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../introduction/languages.html">Programming Languages</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../introduction/builder.html">GNOME Builder</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../introduction/flatpak.html">Flatpak</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1 has-children"><a class="reference internal" href="../guidelines.html">Guidelines</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l2 has-children"><a class="reference internal" href="../guidelines/programming.html">Programming Guidelines</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/programming/coding-style.html">C Coding Style</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/programming/memory-management.html">Managing Memory</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/programming/writing-good-code.html">The Importance of Writing Good Code</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/programming/optimizing.html">Optimizing GNOME Applications</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/programming/namespacing.html">Namespacing</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/programming/introspection.html">Introspection</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2 has-children"><a class="reference internal" href="../guidelines/accessibility.html">Accessibility</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/accessibility/coding-guidelines.html">Coding Guidelines for Supporting Accessibility</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/accessibility/custom-widgets.html">Making Custom Components Accessible</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2 has-children"><a class="reference internal" href="../guidelines/localization.html">Localization</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/localization/practices.html">Best Practices for Localization</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2 has-children"><a class="reference internal" href="../guidelines/maintainer.html">Maintainer Guidelines</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/maintainer/api-stability.html">API Stability</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/maintainer/parallel-installability.html">Parallel Installability</a></li>
|
||
|
|
<li class="toctree-l3"><a class="reference internal" href="../guidelines/maintainer/integrating.html">Integrating with GNOME</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="../guidelines/devel-docs.html">Developer Documentation Style Guidelines</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l1 current has-children"><a class="reference internal" href="../tutorials.html">Tutorials</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||
|
|
<li class="toctree-l2 has-children"><a class="reference internal" href="beginners.html">Beginners Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l3 has-children"><a class="reference internal" href="beginners/getting_started.html">Getting Started</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/getting_started/content_view.html">Adding A Content View</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/getting_started/opening_files.html">Loading Content From A File</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/getting_started/cursor_position.html">Showing The Cursor Position</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/getting_started/saving_files.html">Saving The Content To A File</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/getting_started/saving_state.html">Saving The Application State</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/getting_started/adding_toasts.html">Notifying The User With Toasts</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/getting_started/dark_mode.html">Forcing The Dark Color Scheme</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l3 has-children"><a class="reference internal" href="beginners/components.html">UI components</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/window.html">Windows</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/image.html">Images</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/label.html">Labels</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/button.html">Buttons</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/box.html">Boxes</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/stack.html">Stacks</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/leaflet.html">Leaflets</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/toggle.html">Toggles</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/check_box.html">Check Boxes</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/radio_button.html">Radio Buttons</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/spin_button.html">Spin Buttons</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/link_button.html">Link Buttons</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/switch.html">Switches</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/menu_button.html">Menu Buttons</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/entry.html">Entries</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/password_entry.html">Password Entries</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/message_dialog.html">Messages</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/file_dialog.html">File Dialogs</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/spinner.html">Spinners</a></li>
|
||
|
|
<li class="toctree-l4"><a class="reference internal" href="beginners/components/level_bar.html">Level Bars</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="application-id.html">Application ID</a></li>
|
||
|
|
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Using GtkApplication</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="save-state.html">Saving and Loading Window State</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="notifications.html">Using Notifications</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="themed-icons.html">Themed Icons</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="deprecations.html">Dealing With Deprecations</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="actions.html">Actions</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="menus.html">Menus</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="search-provider.html">Writing a Search Provider</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="pre-and-post-conditions.html">Pre- and Post-Conditions</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="main-contexts.html">Main Contexts</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="lists.html">Using GLib Lists</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="threading.html">Threading</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="asynchronous-programming.html">Asynchronous Programming</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="drag-and-drop.html">Drag and Drop</a></li>
|
||
|
|
<li class="toctree-l2"><a class="reference internal" href="widget-templates.html">Widget Templates</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</aside>
|
||
|
|
<main class="main">
|
||
|
|
<div class="content">
|
||
|
|
<article role="main">
|
||
|
|
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||
|
|
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
|
|
</label>
|
||
|
|
<section id="using-gtkapplication">
|
||
|
|
<h1>Using GtkApplication<a class="headerlink" href="#using-gtkapplication" title="Permalink to this headline">#</a></h1>
|
||
|
|
<p><code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> is the base class of a GTK Application.</p>
|
||
|
|
<p>The philosophy of <code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> is that applications are interested in
|
||
|
|
being told what needs to happen, when it needs to happen, in response to actions
|
||
|
|
from the user. The exact mechanism by which the operating system starts
|
||
|
|
applications is uninteresting.</p>
|
||
|
|
<p>To this end, <code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> exposes a set of signals (or virtual functions)
|
||
|
|
that an application should respond to:</p>
|
||
|
|
<ul class="simple">
|
||
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">startup</span></code>: sets up the application when it first starts</p></li>
|
||
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">shutdown</span></code>: performs shutdown tasks</p></li>
|
||
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">activate</span></code>: shows the default first window of the application (like a new
|
||
|
|
document). This corresponds to the application being launched by the desktop
|
||
|
|
environment.</p></li>
|
||
|
|
<li><p><code class="docutils literal notranslate"><span class="pre">open</span></code>: opens files and shows them in a new window. This corresponds to
|
||
|
|
someone trying to open a document (or documents) using the application from
|
||
|
|
the file browser, or similar.</p></li>
|
||
|
|
</ul>
|
||
|
|
<p>When your application starts, the <code class="docutils literal notranslate"><span class="pre">startup</span></code> signal will be fired. This gives
|
||
|
|
you a chance to perform initialisation tasks that are not directly related to
|
||
|
|
showing a new window. After this, depending on how the application is started,
|
||
|
|
either <code class="docutils literal notranslate"><span class="pre">activate</span></code> or <code class="docutils literal notranslate"><span class="pre">open</span></code> will be called next.</p>
|
||
|
|
<p><code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> defaults to applications being single-instance. If the user
|
||
|
|
attempts to start a second instance of a single-instance application then
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> will signal the first instance and you will receive additional
|
||
|
|
activate or open signals. In this case, the second instance will exit
|
||
|
|
immediately, without calling <code class="docutils literal notranslate"><span class="pre">startup</span></code> or <code class="docutils literal notranslate"><span class="pre">shutdown</span></code>.</p>
|
||
|
|
<p>All startup initialisation should be done in startup. This avoids wasting work
|
||
|
|
in the second-instance case where the program just exits immediately.</p>
|
||
|
|
<p>The application will continue to run for as long as it needs to. This is usually
|
||
|
|
for as long as there are any open windows. You can additionally force the
|
||
|
|
application to stay alive using <code class="docutils literal notranslate"><span class="pre">g_application_hold()</span></code>.</p>
|
||
|
|
<p>On shutdown, you receive a <code class="docutils literal notranslate"><span class="pre">shutdown</span></code> signal where you can do any necessary
|
||
|
|
cleanup tasks (such as saving files to disk).</p>
|
||
|
|
<p>You main entry point for your application should only create a
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> instance, set up the signal handlers, and then call
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">g_application_run()</span></code>.</p>
|
||
|
|
<section id="primary-vs-local-instance">
|
||
|
|
<h2>Primary vs. local instance<a class="headerlink" href="#primary-vs-local-instance" title="Permalink to this headline">#</a></h2>
|
||
|
|
<p>The “primary instance” of an application is the first instance of it that was
|
||
|
|
run. A “remote instance” is another instance that is started that is not the
|
||
|
|
primary instance. The term “local instance” is used to refer to the current
|
||
|
|
process which may or may not be the primary instance.</p>
|
||
|
|
<p><code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> only ever emits signals in the primary instance. Calls to
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> API can be made in primary or remote instances (and are made
|
||
|
|
from the vantage of being the “local instance”). In the case that the local
|
||
|
|
instance is the primary instance, function calls on <code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> will
|
||
|
|
result in signals being emitted locally, in the primary instance. In the case
|
||
|
|
that the local instance is a remote instance, function calls result in messages
|
||
|
|
being sent to the primary instance and signals being emitted there.</p>
|
||
|
|
<p>For example, calling <code class="docutils literal notranslate"><span class="pre">g_application_activate()</span></code> on the primary instance will
|
||
|
|
emit the <code class="docutils literal notranslate"><span class="pre">activate</span></code> signal. Calling it on a remote instance will result in a
|
||
|
|
message being sent to the primary instance and it will emit <code class="docutils literal notranslate"><span class="pre">activate</span></code>.</p>
|
||
|
|
<p>You rarely need to know if the local instance is primary or remote. In almost
|
||
|
|
all cases, you should just call the <code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> method you are interested
|
||
|
|
in and either have it be forwarded or handled locally, as appropriate.</p>
|
||
|
|
</section>
|
||
|
|
<section id="actions">
|
||
|
|
<h2>Actions<a class="headerlink" href="#actions" title="Permalink to this headline">#</a></h2>
|
||
|
|
<p>An application can register a set of actions that it supports in addition to the
|
||
|
|
default activate and open. Actions are added to the application with the
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">GActionMap</span></code> interface and invoked or queried with the <code class="docutils literal notranslate"><span class="pre">GActionGroup</span></code>
|
||
|
|
interface.</p>
|
||
|
|
<p>As with <code class="docutils literal notranslate"><span class="pre">activate</span></code> and <code class="docutils literal notranslate"><span class="pre">open</span></code>, calling <code class="docutils literal notranslate"><span class="pre">g_action_group_activate_action()</span></code>
|
||
|
|
on the primary instance will activate the named action in the current process.
|
||
|
|
Calling <code class="docutils literal notranslate"><span class="pre">g_action_group_activate_action()</span></code> on a remote instance will send a
|
||
|
|
message to the primary instance, causing the action to be activated there.</p>
|
||
|
|
</section>
|
||
|
|
<section id="dealing-with-the-command-line">
|
||
|
|
<h2>Dealing with the command line<a class="headerlink" href="#dealing-with-the-command-line" title="Permalink to this headline">#</a></h2>
|
||
|
|
<p>Normally, <code class="docutils literal notranslate"><span class="pre">GtkApplication</span></code> will assume that arguments passed on the command
|
||
|
|
line are files to be opened. If no arguments are passed, then it assumes that an
|
||
|
|
application is being launched to show its main window or an empty document. In
|
||
|
|
the case that files were given, you will receive these files (in the form of
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">GFile</span></code>) from the open signal. Otherwise you will receive an activate signal.
|
||
|
|
It is recommended that new applications make use of this default handling of
|
||
|
|
command line arguments.</p>
|
||
|
|
<p>If you want to deal with command line arguments in more advanced ways, there are
|
||
|
|
several (complementary) mechanisms by which you can do this.</p>
|
||
|
|
<p>First, the <code class="docutils literal notranslate"><span class="pre">handle-local-options</span></code> signal will be emitted and the signal
|
||
|
|
handler gets a dictionary with the parsed options. To make use of this, you need
|
||
|
|
to register your options with <code class="docutils literal notranslate"><span class="pre">g_application_add_main_option_entries()</span></code>. The
|
||
|
|
signal handler can return a non-negative value to end the process with this exit
|
||
|
|
code, or a negative value to continue with the regular handling of commandline
|
||
|
|
options. A popular use of for this signal is to implement a <code class="docutils literal notranslate"><span class="pre">--version</span></code>
|
||
|
|
argument that works without communicating with a remote instance.</p>
|
||
|
|
<p>If <code class="docutils literal notranslate"><span class="pre">handle-local-options</span></code> is not flexible enough for your needs, you can
|
||
|
|
override the <code class="docutils literal notranslate"><span class="pre">local_command_line</span></code> virtual function to take over the handling
|
||
|
|
of command line arguments in the local instance entirely. If you do so, you will
|
||
|
|
be responsible for registering the application, and for handling a <code class="docutils literal notranslate"><span class="pre">--help</span></code>
|
||
|
|
argument (the default <code class="docutils literal notranslate"><span class="pre">local_command_line</span></code> function does this for you).</p>
|
||
|
|
<p>It is also possible to invoke actions from <code class="docutils literal notranslate"><span class="pre">handle-local-options</span></code> or
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">local_command_line</span></code> in response to command line arguments. For example, a
|
||
|
|
mail client may choose to map the <code class="docutils literal notranslate"><span class="pre">--compose</span></code> command line argument to an
|
||
|
|
invocation of its <code class="docutils literal notranslate"><span class="pre">compose</span></code> action. This is done by calling
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">g_action_group_activate_action()</span></code> from the <code class="docutils literal notranslate"><span class="pre">local_command_line</span></code>
|
||
|
|
implementation. In the case that the command line being processed is in the
|
||
|
|
primary instance then the <code class="docutils literal notranslate"><span class="pre">compose</span></code> action is invoked locally. In the case
|
||
|
|
that it is a remote instance, the action invocation is forwarded to the primary
|
||
|
|
instance.</p>
|
||
|
|
<div class="admonition note">
|
||
|
|
<p class="admonition-title">Note</p>
|
||
|
|
<p>It is possible to use action activations instead of <code class="docutils literal notranslate"><span class="pre">activate</span></code> or <code class="docutils literal notranslate"><span class="pre">open</span></code>.
|
||
|
|
It is perfectly reasonable that an application could start without an
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">activate</span></code> signal ever being emitted. The <code class="docutils literal notranslate"><span class="pre">activate</span></code> signal is only
|
||
|
|
supposed to be the default “started with no options” signal. Actions are
|
||
|
|
meant to be used for anything else.</p>
|
||
|
|
</div>
|
||
|
|
<p>Some applications may wish to perform even more advanced handling of command
|
||
|
|
lines, including controlling the life cycle of the remote instance and its exit
|
||
|
|
status once it quits as well as forwarding the entire contents of the command
|
||
|
|
line arguments, the environment and even forwarding standard input, output, and
|
||
|
|
error streams. This can be accomplished using
|
||
|
|
<code class="docutils literal notranslate"><span class="pre">G_APPLICATION_HANDLES_COMMAND_LINE</span></code> and the <code class="docutils literal notranslate"><span class="pre">command-line</span></code> signal.</p>
|
||
|
|
</section>
|
||
|
|
</section>
|
||
|
|
|
||
|
|
</article>
|
||
|
|
<footer>
|
||
|
|
|
||
|
|
<div class="related-pages">
|
||
|
|
<a class="next-page" href="save-state.html">
|
||
|
|
<div class="page-info">
|
||
|
|
<div class="context">
|
||
|
|
<span>Next</span>
|
||
|
|
</div>
|
||
|
|
<div class="title">Saving and Loading Window State</div>
|
||
|
|
</div>
|
||
|
|
<svg><use href="#svg-arrow-right"></use></svg>
|
||
|
|
</a>
|
||
|
|
<a class="prev-page" href="application-id.html">
|
||
|
|
<svg><use href="#svg-arrow-right"></use></svg>
|
||
|
|
<div class="page-info">
|
||
|
|
<div class="context">
|
||
|
|
<span>Previous</span>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="title">Application ID</div>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</a>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
</footer>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
<aside class="toc-drawer">
|
||
|
|
|
||
|
|
|
||
|
|
<div class="toc-sticky toc-scroll">
|
||
|
|
<div class="toc-title-container">
|
||
|
|
<span class="toc-title">
|
||
|
|
Contents
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
<div class="toc-tree-container">
|
||
|
|
<div class="toc-tree">
|
||
|
|
<ul>
|
||
|
|
<li><a class="reference internal" href="#">Using GtkApplication</a><ul>
|
||
|
|
<li><a class="reference internal" href="#primary-vs-local-instance">Primary vs. local instance</a></li>
|
||
|
|
<li><a class="reference internal" href="#actions">Actions</a></li>
|
||
|
|
<li><a class="reference internal" href="#dealing-with-the-command-line">Dealing with the command line</a></li>
|
||
|
|
</ul>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</aside>
|
||
|
|
</main>
|
||
|
|
</div><script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
|
||
|
|
<script src="../_static/jquery.js"></script>
|
||
|
|
<script src="../_static/underscore.js"></script>
|
||
|
|
<script src="../_static/doctools.js"></script>
|
||
|
|
<script src="../_static/scripts/furo.js"></script>
|
||
|
|
</body>
|
||
|
|
</html>
|