gem-graph/gem-graph-client
gem-graph
/
gem-graph-client
3
0
Fork 0
Code Issues 14 Pull Requests Projects Releases Activity
gem-graph-client/docs/GTK-docs/gnome-dev-documentation/developer.gnome.org/documentation/tutorials/save-state.html

488 lines
44 KiB
HTML
Raw Normal View History

docs/*: integrate doxygen, create a documentation zone, adds notes We wanted to have an automated documentation for our project. We choose doxygen since this is a well-established project, with common standards. To generate the documentation, simply type `make docs` and open `docs/html/index.html`. The documentation zone actually contains: - archives: several files from past of the projects, historical purpose - GTK-docs: ressources on GTK internals and API - rtfm: first draft of a user manual - showcase: some pictures of the UI example, that were communicated on the Gem-graph discussion room (XMPP) - html: doxygen-generated docs
2024-10-28 13:57:44 +01:00
<!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="Using Notifications" href="notifications.html" /><link rel="prev" title="Using GtkApplication" href="application.html" />
<meta name="generator" content="sphinx-4.3.0, furo 2022.06.21"/>
<title>Saving and Loading Window State - 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"><a class="reference internal" href="application.html">Using GtkApplication</a></li>
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">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="saving-and-loading-window-state">
<h1>Saving and Loading Window State<a class="headerlink" href="#saving-and-loading-window-state" title="Permalink to this headline">#</a></h1>
<section id="use-cases">
<h2>Use cases<a class="headerlink" href="#use-cases" title="Permalink to this headline">#</a></h2>
<p>Saving and restoring the window state across sessions is a useful feature for
some applications.</p>
<p>Since applications know best what their state and geometry are—and whether, or
how, those should be applied once the application is launched—it’s better to
have this function near the code that creates the application window itself.</p>
</section>
<section id="where-should-the-state-be-stored">
<h2>Where should the state be stored<a class="headerlink" href="#where-should-the-state-be-stored" title="Permalink to this headline">#</a></h2>
<p>The are two options for storing the window state:</p>
<ul class="simple">
<li><p>a file under <code class="docutils literal notranslate"><span class="pre">$XDG_CACHE_HOME/your.application.id</span></code> (or simply
<code class="docutils literal notranslate"><span class="pre">$XDG_CACHE_HOME</span></code> when running inside a Flatpak application)</p></li>
<li><p>GSettings</p></li>
</ul>
<p>Both options have their own advantages and trade offs.</p>
<p>The first option requires you to write the serialization and deserialization
code, but it’s portable and does not require ancillary files to be present at
run time, like a GSettings schema. This means that you need to write more code,
but it allows, for instance, to run your application uninstalled.</p>
<p>The second option gives you the serialization and deserialization code, but it
requires you to define the setting keys schema and install it in a known
location. This means that you will keep your code to a minimum, but it will also
require installation.</p>
<p>It is generally preferred, everything being equal, to use GSettings over a
custom file. The GSettings API is nicer, more reliable, and faster.</p>
</section>
<section id="what-kind-of-state-should-be-saved">
<h2>What kind of state should be saved?<a class="headerlink" href="#what-kind-of-state-should-be-saved" title="Permalink to this headline">#</a></h2>
<p>There are few window states that should generally be saved:</p>
<ul class="simple">
<li><p>the window size</p></li>
<li><p>whether the window is maximized, if the window supports it</p></li>
<li><p>whether the window is full screen, if the window supports it</p></li>
</ul>
<p>The position of the window is best left to the window manager. Other states can
be saved along with the ones above, using the same technique, so they will be
left as an exercise for the reader.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>If your application uses a <code class="docutils literal notranslate"><span class="pre">GtkPaned</span></code> widget, you may also want to save the
position of the handle, by tracking the <code class="docutils literal notranslate"><span class="pre">GtkPaned:position</span></code> property.</p>
</div>
<p>The window geometry should be updated by getting notifications from the
<code class="docutils literal notranslate"><span class="pre">GtkWindow:default-width</span></code> and <code class="docutils literal notranslate"><span class="pre">GtkWindow:default-height</span></code> properties; window
states, like “maximized” and “fullscreen”, are also mapped to GtkWindow
properties.</p>
</section>
<section id="saving-and-restoring-state-into-gsettings">
<h2>Saving and restoring state into GSettings<a class="headerlink" href="#saving-and-restoring-state-into-gsettings" title="Permalink to this headline">#</a></h2>
<p>First of all, you will need a GSettings schema, to define the keys, the type of
the values, and default value for each key:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">&lt;</span><span class="n">schemalist</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">schema</span> <span class="nb">id</span><span class="o">=</span><span class="s2">&quot;com.example.YourApp.State&quot;</span> <span class="n">path</span><span class="o">=</span><span class="s2">&quot;/com/example/YourApp/State/&gt;</span>
<span class="o">&lt;</span><span class="n">key</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;width&quot;</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;i&quot;</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">default</span><span class="o">&gt;</span><span class="mi">640</span><span class="o">&lt;/</span><span class="n">default</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">key</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">key</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;height&quot;</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;i&quot;</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">default</span><span class="o">&gt;</span><span class="mi">480</span><span class="o">&lt;/</span><span class="n">default</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">key</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">key</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;is-maximized&quot;</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;b&quot;</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">default</span><span class="o">&gt;</span><span class="n">false</span><span class="o">&lt;/</span><span class="n">default</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">key</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">key</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;is-fullscreen&quot;</span> <span class="nb">type</span><span class="o">=</span><span class="s2">&quot;b&quot;</span><span class="o">&gt;</span>
<span class="o">&lt;</span><span class="n">default</span><span class="o">&gt;</span><span class="n">false</span><span class="o">&lt;/</span><span class="n">default</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">key</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">schema</span><span class="o">&gt;</span>
<span class="o">&lt;/</span><span class="n">schemalist</span><span class="o">&gt;</span>
</pre></div>
</div>
<p>Once you have a schema, you can map window properties to the GSettings keys
defined by that schema:</p>
<div class="sphinx-tabs docutils container">
<div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-Qw==" aria-selected="true" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-Qw==" name="Qw==" role="tab" tabindex="0">C</button><button aria-controls="panel-0-UHl0aG9u" aria-selected="false" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-UHl0aG9u" name="UHl0aG9u" role="tab" tabindex="-1">Python</button><button aria-controls="panel-0-VmFsYQ==" aria-selected="false" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-VmFsYQ==" name="VmFsYQ==" role="tab" tabindex="-1">Vala</button><button aria-controls="panel-0-SmF2YVNjcmlwdA==" aria-selected="false" class="sphinx-tabs-tab code-tab group-tab" id="tab-0-SmF2YVNjcmlwdA==" name="SmF2YVNjcmlwdA==" role="tab" tabindex="-1">JavaScript</button></div><div aria-labelledby="tab-0-Qw==" class="sphinx-tabs-panel code-tab group-tab" id="panel-0-Qw==" name="Qw==" role="tabpanel" tabindex="0"><div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">static</span><span class="w"> </span><span class="kt">void</span><span class="w"></span>
<span class="nf">my_application_window_init</span><span class="w"> </span><span class="p">(</span><span class="n">MyApplicationWindow</span><span class="w"> </span><span class="o">*</span><span class="n">self</span><span class="p">)</span><span class="w"></span>
<span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="n">GSettings</span><span class="w"> </span><span class="o">*</span><span class="n">settings</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">g_settings_new</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;com.example.YourApp.State&quot;</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="c1">// update the settings when the properties change and vice versa</span>
<span class="w"> </span><span class="n">g_settings_bind</span><span class="w"> </span><span class="p">(</span><span class="n">settings</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;width&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;default-width&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">G_SETTINGS_BIND_DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">g_settings_bind</span><span class="w"> </span><span class="p">(</span><span class="n">settings</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;height&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;default-height&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">G_SETTINGS_BIND_DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">g_settings_bind</span><span class="w"> </span><span class="p">(</span><span class="n">settings</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;is-maximized&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;maximized&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">G_SETTINGS_BIND_DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">g_settings_bind</span><span class="w"> </span><span class="p">(</span><span class="n">settings</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;is-fullscreen&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="s">&quot;fullscreened&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="n">G_SETTINGS_BIND_DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
</div><div aria-labelledby="tab-0-UHl0aG9u" class="sphinx-tabs-panel code-tab group-tab" hidden="true" id="panel-0-UHl0aG9u" name="UHl0aG9u" role="tabpanel" tabindex="0"><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyApplicationWindow</span><span class="p">(</span><span class="n">Gtk</span><span class="o">.</span><span class="n">ApplicationWindow</span><span class="p">):</span>
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">settings</span> <span class="o">=</span> <span class="n">Gio</span><span class="o">.</span><span class="n">Settings</span><span class="p">(</span><span class="n">schema_id</span><span class="o">=</span><span class="s2">&quot;com.example.YourApp.State&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s2">&quot;width&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;default-width&quot;</span><span class="p">,</span>
<span class="n">Gio</span><span class="o">.</span><span class="n">SettingsBindFlags</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s2">&quot;height&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;default-height&quot;</span><span class="p">,</span>
<span class="n">Gio</span><span class="o">.</span><span class="n">SettingsBindFlags</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s2">&quot;is-maximized&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;maximized&quot;</span><span class="p">,</span>
<span class="n">Gio</span><span class="o">.</span><span class="n">SettingsBindFlags</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">bind</span><span class="p">(</span><span class="s2">&quot;is-fullscreen&quot;</span><span class="p">,</span> <span class="bp">self</span><span class="p">,</span> <span class="s2">&quot;fullscreened&quot;</span><span class="p">,</span>
<span class="n">Gio</span><span class="o">.</span><span class="n">SettingsBindFlags</span><span class="o">.</span><span class="n">DEFAULT</span><span class="p">)</span>
</pre></div>
</div>
</div><div aria-labelledby="tab-0-VmFsYQ==" class="sphinx-tabs-panel code-tab group-tab" hidden="true" id="panel-0-VmFsYQ==" name="VmFsYQ==" role="tabpanel" tabindex="0"><div class="highlight-vala notranslate"><div class="highlight"><pre><span></span><span class="n">My</span><span class="p">.</span><span class="n">ApplicationWindow</span><span class="w"> </span><span class="o">:</span><span class="w"> </span><span class="n">Gtk</span><span class="p">.</span><span class="n">ApplicationWindow</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="kd">public</span><span class="w"> </span><span class="kt">void</span><span class="w"> </span><span class="n">init</span><span class="w"> </span><span class="p">()</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
<span class="w"> </span><span class="kd">var</span><span class="w"> </span><span class="n">settings</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">new</span><span class="w"> </span><span class="n">Settings</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;com.example.YourApp.State&quot;</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="c1">// update the settings when the properties change and vice versa</span>
<span class="w"> </span><span class="n">settings</span><span class="p">.</span><span class="n">bind</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;width&quot;</span><span class="p">,</span><span class="w"> </span><span class="k">this</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s">&quot;default-width&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">SettingsBindFlags</span><span class="p">.</span><span class="n">DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">settings</span><span class="p">.</span><span class="n">bind</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;height&quot;</span><span class="p">,</span><span class="w"> </span><span class="k">this</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s">&quot;default-height&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">SettingsBindFlags</span><span class="p">.</span><span class="n">DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">settings</span><span class="p">.</span><span class="n">bind</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;is-maximized&quot;</span><span class="p">,</span><span class="w"> </span><span class="k">this</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s">&quot;maximized&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">SettingsBindFlags</span><span class="p">.</span><span class="n">DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="n">settings</span><span class="p">.</span><span class="n">bind</span><span class="w"> </span><span class="p">(</span><span class="s">&quot;is-fullscreen&quot;</span><span class="p">,</span><span class="w"> </span><span class="k">this</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s">&quot;fullscreened&quot;</span><span class="p">,</span><span class="w"> </span><span class="n">SettingsBindFlags</span><span class="p">.</span><span class="n">DEFAULT</span><span class="p">);</span><span class="w"></span>
<span class="w"> </span><span class="p">}</span><span class="w"></span>
<span class="p">}</span><span class="w"></span>
</pre></div>
</div>
</div><div aria-labelledby="tab-0-SmF2YVNjcmlwdA==" class="sphinx-tabs-panel code-tab group-tab" hidden="true" id="panel-0-SmF2YVNjcmlwdA==" name="SmF2YVNjcmlwdA==" role="tabpanel" tabindex="0"><div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="kd">const</span><span class="w"> </span><span class="nx">settings</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">Gio</span><span class="p">.</span><span class="nx">Settings</span><span class="p">({</span><span class="w"></span>
<span class="w"> </span><span class="nx">schema</span><span class="o">:</span><span class="w"> </span><span class="s2">&quot;com.example.YourApp.State&quot;</span><span class="p">,</span><span class="w"></span>
<span class="p">});</span><span class="w"></span>
<span class="kd">const</span><span class="w"> </span><span class="nb">window</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="nx">Adw</span><span class="p">.</span><span class="nx">ApplicationWindow</span><span class="p">({</span><span class="w"> </span><span class="nx">application</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
<span class="c1">// update the settings when the properties change and vice versa</span><span class="w"></span>
<span class="nx">settings</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;width&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nb">window</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;default-width&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nx">Gio</span><span class="p">.</span><span class="nx">SettingsBindFlags</span><span class="p">.</span><span class="nx">DEFAULT</span><span class="p">,</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
<span class="nx">settings</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;height&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nb">window</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;default-height&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nx">Gio</span><span class="p">.</span><span class="nx">SettingsBindFlags</span><span class="p">.</span><span class="nx">DEFAULT</span><span class="p">,</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
<span class="nx">settings</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;is-maximized&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nb">window</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;maximized&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nx">Gio</span><span class="p">.</span><span class="nx">SettingsBindFlags</span><span class="p">.</span><span class="nx">DEFAULT</span><span class="p">,</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
<span class="nx">settings</span><span class="p">.</span><span class="nx">bind</span><span class="p">(</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;is-fullscreen&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nb">window</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="s2">&quot;fullscreened&quot;</span><span class="p">,</span><span class="w"></span>
<span class="w"> </span><span class="nx">Gio</span><span class="p">.</span><span class="nx">SettingsBindFlags</span><span class="p">.</span><span class="nx">DEFAULT</span><span class="p">,</span><span class="w"></span>
<span class="p">);</span><span class="w"></span>
</pre></div>
</div>
</div></div>
<p>The code above will automatically set the properties to the value in the
corresponding GSettings keys, and will update the GSettings keys with the value
of the properties whenever they change.</p>
</section>
</section>
</article>
<footer>
<div class="related-pages">
<a class="next-page" href="notifications.html">
<div class="page-info">
<div class="context">
<span>Next</span>
</div>
<div class="title">Using Notifications</div>
</div>
<svg><use href="#svg-arrow-right"></use></svg>
</a>
<a class="prev-page" href="application.html">
<svg><use href="#svg-arrow-right"></use></svg>
<div class="page-info">
<div class="context">
<span>Previous</span>
</div>
<div class="title">Using GtkApplication</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="#">Saving and Loading Window State</a><ul>
<li><a class="reference internal" href="#use-cases">Use cases</a></li>
<li><a class="reference internal" href="#where-should-the-state-be-stored">Where should the state be stored</a></li>
<li><a class="reference internal" href="#what-kind-of-state-should-be-saved">What kind of state should be saved?</a></li>
<li><a class="reference internal" href="#saving-and-restoring-state-into-gsettings">Saving and restoring state into GSettings</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>
<script src="../_static/tabs.js"></script>
</body>
</html>