/usr/share/gtk-doc/html/libdazzle/libdazzle-dzl-menu-manager.html is in libdazzle-doc 3.28.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>dzl-menu-manager: Dazzle Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Dazzle Reference Manual">
<link rel="up" href="dazzle-application.html" title="Part III. Applications">
<link rel="prev" href="DzlApplication.html" title="DzlApplication">
<link rel="next" href="libdazzle-dzl-theme-manager.html" title="dzl-theme-manager">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libdazzle-dzl-menu-manager.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#libdazzle-dzl-menu-manager.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="dazzle-application.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="DzlApplication.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libdazzle-dzl-theme-manager.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libdazzle-dzl-menu-manager"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libdazzle-dzl-menu-manager.top_of_page"></a>dzl-menu-manager</span></h2>
<p>dzl-menu-manager</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libdazzle-dzl-menu-manager.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="returnvalue">DzlMenuManager</span></a> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-menu-manager.html#dzl-menu-manager-new" title="dzl_menu_manager_new ()">dzl_menu_manager_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-menu-manager.html#dzl-menu-manager-add-filename" title="dzl_menu_manager_add_filename ()">dzl_menu_manager_add_filename</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-menu-manager.html#dzl-menu-manager-add-resource" title="dzl_menu_manager_add_resource ()">dzl_menu_manager_add_resource</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">guint</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-menu-manager.html#dzl-menu-manager-merge" title="dzl_menu_manager_merge ()">dzl_menu_manager_merge</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-menu-manager.html#dzl-menu-manager-remove" title="dzl_menu_manager_remove ()">dzl_menu_manager_remove</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GMenu</span> *
</td>
<td class="function_name">
<a class="link" href="libdazzle-dzl-menu-manager.html#dzl-menu-manager-get-menu-by-id" title="dzl_menu_manager_get_menu_by_id ()">dzl_menu_manager_get_menu_by_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<a name="DzlMenuManager"></a><div class="refsect1">
<a name="libdazzle-dzl-menu-manager.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libdazzle-dzl-menu-manager.html#DZL-TYPE-MENU-MANAGER:CAPS" title="DZL_TYPE_MENU_MANAGER">DZL_TYPE_MENU_MANAGER</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager-struct" title="DzlMenuManager">DzlMenuManager</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-menu-manager.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> GObject
<span class="lineart">╰──</span> DzlMenuManager
</pre>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-menu-manager.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-menu-manager.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="dzl-menu-manager-new"></a><h3>dzl_menu_manager_new ()</h3>
<pre class="programlisting"><a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="returnvalue">DzlMenuManager</span></a> *
dzl_menu_manager_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-menu-manager-add-filename"></a><h3>dzl_menu_manager_add_filename ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dzl_menu_manager_add_filename (<em class="parameter"><code><a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-menu-manager-add-resource"></a><h3>dzl_menu_manager_add_resource ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dzl_menu_manager_add_resource (<em class="parameter"><code><a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *resource</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-menu-manager-merge"></a><h3>dzl_menu_manager_merge ()</h3>
<pre class="programlisting"><span class="returnvalue">guint</span>
dzl_menu_manager_merge (<em class="parameter"><code><a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *menu_id</code></em>,
<em class="parameter"><code><span class="type">GMenuModel</span> *model</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="dzl-menu-manager-remove"></a><h3>dzl_menu_manager_remove ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
dzl_menu_manager_remove (<em class="parameter"><code><a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a> *self</code></em>,
<em class="parameter"><code><span class="type">guint</span> merge_id</code></em>);</pre>
<p>This removes items from menus that were added as part of a previous
menu merge. Use the value returned from <a class="link" href="libdazzle-dzl-menu-manager.html#dzl-menu-manager-merge" title="dzl_menu_manager_merge ()"><code class="function">dzl_menu_manager_merge()</code></a> as
the <em class="parameter"><code>merge_id</code></em>
.</p>
<div class="refsect3">
<a name="dzl-menu-manager-remove.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>merge_id</p></td>
<td class="parameter_description"><p>A previously registered merge id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: 3.26</p>
</div>
<hr>
<div class="refsect2">
<a name="dzl-menu-manager-get-menu-by-id"></a><h3>dzl_menu_manager_get_menu_by_id ()</h3>
<pre class="programlisting"><span class="returnvalue">GMenu</span> *
dzl_menu_manager_get_menu_by_id (<em class="parameter"><code><a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a> *self</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *menu_id</code></em>);</pre>
<div class="refsect3">
<a name="dzl-menu-manager-get-menu-by-id.returns"></a><h4>Returns</h4>
<p>A <span class="type">GMenu</span>. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libdazzle-dzl-menu-manager.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="DZL-TYPE-MENU-MANAGER:CAPS"></a><h3>DZL_TYPE_MENU_MANAGER</h3>
<pre class="programlisting">#define DZL_TYPE_MENU_MANAGER (dzl_menu_manager_get_type())
</pre>
</div>
<hr>
<div class="refsect2">
<a name="DzlMenuManager-struct"></a><h3>DzlMenuManager</h3>
<pre class="programlisting">typedef struct _DzlMenuManager DzlMenuManager;</pre>
<p>The goal of <a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a> is to simplify the process of merging multiple
GtkBuilder .ui files containing menus into a single representation of the
application menus. Additionally, it provides the ability to "unmerge"
previously merged menus.</p>
<p>This allows for an application to have plugins which seemlessly extends
the core application menus.</p>
<p>Implementation notes:</p>
<p>To make this work, we don't use the GMenu instances created by a GtkBuilder
instance. Instead, we create the menus ourself and recreate section and
submenu links. This allows the <a class="link" href="libdazzle-dzl-menu-manager.html#DzlMenuManager"><span class="type">DzlMenuManager</span></a> to be in full control of
the generated menus.</p>
<p>dzl_menu_manager_get_menu_by_id() will always return a <span class="type">GMenu</span>, however
that menu may contain no children until something has extended it later
on during the application process.</p>
<p class="since">Since: 3.26</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>
|