~ubuntu-branches/ubuntu/vivid/glib2.0/vivid-proposed

<a name="GMenuAttributeIter"></a><a name="GMenuLinkIter"></a><pre class="synopsis"> <a class="link" href="GMenuModel.html#GMenuModel-struct" title="GMenuModel">GMenuModel</a>;

<a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-model-is-mutable" title="g_menu_model_is_mutable ()">g_menu_model_is_mutable</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);

<a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> <a class="link" href="GMenuModel.html#g-menu-model-get-n-items" title="g_menu_model_get_n_items ()">g_menu_model_get_n_items</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-model-is-mutable" title="g_menu_model_is_mutable ()">g_menu_model_is_mutable</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);

<a href="../glib/glib-Basic-Types.html#gint">gint</a> <a class="link" href="GMenuModel.html#g-menu-model-get-n-items" title="g_menu_model_get_n_items ()">g_menu_model_get_n_items</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);

#define <a class="link" href="GMenuModel.html#G-MENU-ATTRIBUTE-ACTION:CAPS" title="G_MENU_ATTRIBUTE_ACTION">G_MENU_ATTRIBUTE_ACTION</a>

#define <a class="link" href="GMenuModel.html#G-MENU-ATTRIBUTE-LABEL:CAPS" title="G_MENU_ATTRIBUTE_LABEL">G_MENU_ATTRIBUTE_LABEL</a>

#define <a class="link" href="GMenuModel.html#G-MENU-LINK-SECTION:CAPS" title="G_MENU_LINK_SECTION">G_MENU_LINK_SECTION</a>

#define <a class="link" href="GMenuModel.html#G-MENU-LINK-SUBMENU:CAPS" title="G_MENU_LINK_SUBMENU">G_MENU_LINK_SUBMENU</a>

<a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> * <a class="link" href="GMenuModel.html#g-menu-model-get-item-attribute-value" title="g_menu_model_get_item_attribute_value ()">g_menu_model_get_item_attribute_value</a>

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> * <a class="link" href="GMenuModel.html#g-menu-model-get-item-attribute-value" title="g_menu_model_get_item_attribute_value ()">g_menu_model_get_item_attribute_value</a>

(<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

<code>const <a href="./../glib/glib/glib-GVariantType.html#GVariantType">GVariantType</a> *expected_type</code>);

<a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-model-get-item-attribute" title="g_menu_model_get_item_attribute ()">g_menu_model_get_item_attribute</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *format_string</code>,

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

<code>const <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> *expected_type</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-model-get-item-attribute" title="g_menu_model_get_item_attribute ()">g_menu_model_get_item_attribute</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *format_string</code>,

<code>...</code>);

<a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> * <a class="link" href="GMenuModel.html#g-menu-model-get-item-link" title="g_menu_model_get_item_link ()">g_menu_model_get_item_link</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *link</code>);

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *link</code>);

<a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> * <a class="link" href="GMenuModel.html#g-menu-model-iterate-item-attributes" title="g_menu_model_iterate_item_attributes ()">g_menu_model_iterate_item_attributes</a>

(<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);

<a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> * <a class="link" href="GMenuModel.html#g-menu-model-iterate-item-links" title="g_menu_model_iterate_item_links ()">g_menu_model_iterate_item_links</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);

void <a class="link" href="GMenuModel.html#g-menu-model-items-changed" title="g_menu_model_items_changed ()">g_menu_model_items_changed</a> (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> position</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> removed</code>,

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> added</code>);

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> position</code>,

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> removed</code>,

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> added</code>);

struct <a class="link" href="GMenuModel.html#GMenuAttributeIter-struct" title="struct GMenuAttributeIter">GMenuAttributeIter</a>;

<a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-next" title="g_menu_attribute_iter_get_next ()">g_menu_attribute_iter_get_next</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>,

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> **out_name</code>,

<code><a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> **value</code>);

const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-name" title="g_menu_attribute_iter_get_name ()">g_menu_attribute_iter_get_name</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);

<a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> * <a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-value" title="g_menu_attribute_iter_get_value ()">g_menu_attribute_iter_get_value</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);

<a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-attribute-iter-next" title="g_menu_attribute_iter_next ()">g_menu_attribute_iter_next</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-next" title="g_menu_attribute_iter_get_next ()">g_menu_attribute_iter_get_next</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>,

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **out_name</code>,

<code><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> **value</code>);

const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-name" title="g_menu_attribute_iter_get_name ()">g_menu_attribute_iter_get_name</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> * <a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-value" title="g_menu_attribute_iter_get_value ()">g_menu_attribute_iter_get_value</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-attribute-iter-next" title="g_menu_attribute_iter_next ()">g_menu_attribute_iter_next</a> (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);

struct <a class="link" href="GMenuModel.html#GMenuLinkIter-struct" title="struct GMenuLinkIter">GMenuLinkIter</a>;

const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="GMenuModel.html#g-menu-link-iter-get-name" title="g_menu_link_iter_get_name ()">g_menu_link_iter_get_name</a> (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);

<a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-link-iter-get-next" title="g_menu_link_iter_get_next ()">g_menu_link_iter_get_next</a> (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>,

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> **out_link</code>,

const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * <a class="link" href="GMenuModel.html#g-menu-link-iter-get-name" title="g_menu_link_iter_get_name ()">g_menu_link_iter_get_name</a> (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-link-iter-get-next" title="g_menu_link_iter_get_next ()">g_menu_link_iter_get_next</a> (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>,

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **out_link</code>,

<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> **value</code>);

<a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> * <a class="link" href="GMenuModel.html#g-menu-link-iter-get-value" title="g_menu_link_iter_get_value ()">g_menu_link_iter_get_value</a> (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);

<a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-link-iter-next" title="g_menu_link_iter_next ()">g_menu_link_iter_next</a> (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);

<a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> <a class="link" href="GMenuModel.html#g-menu-link-iter-next" title="g_menu_link_iter_next ()">g_menu_link_iter_next</a> (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);

</pre>

</div>

<a name="GMenuModel.object-hierarchy"></a><h2>Object Hierarchy</h2>

<a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

<a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

+----GMenuModel

100

+----<a class="link" href="GDBusMenuModel.html" title="GDBusMenuModel">GDBusMenuModel</a>

101

+----<a class="link" href="GMenu.html" title="GMenu">GMenu</a>

102

</pre>

103

104

<a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

104

<a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

105

+----GMenuAttributeIter

106

</pre>

107

108

<a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

108

<a href="../gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>

109

+----GMenuLinkIter

110

</pre>

111

</div>

112

113

<a name="GMenuModel.signals"></a><h2>Signals</h2>

114

115

"<a class="link" href="GMenuModel.html#GMenuModel-items-changed" title='The "items-changed" signal'>items-changed</a>" : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

115

"<a class="link" href="GMenuModel.html#GMenuModel-items-changed" title='The "items-changed" signal'>items-changed</a>" : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>

116

</pre>

117

</div>

118

150

There are 8 "menus" visible in the screenshot: one menubar, two

151

submenus and 5 sections:

152

153

153

154

<li class="listitem">the toplevel menubar (containing 4 items)</li>

155

<li class="listitem">the View submenu (containing 3 sections)</li>

156

<li class="listitem">the first section of the View submenu (containing 2 items)</li>

214

identifies an action in an action group. Which action group(s) provide

215

actions depends on the context in which the menu model is used.

216

E.g. when the model is exported as the application menu of a

217

<a href="http://developer.gnome.org/gtk2/GtkApplication.html">GtkApplication</a>, actions can be application-wide or window-specific

217

GtkApplication, actions can be application-wide or window-specific

218

(and thus come from two different action groups). By convention, the

219

application-wide actions have names that start with "app.", while the

220

names of window-specific actions start with "win.".

224

is the minimum that is expected to be supported by all users of exported

225

menu information:

226

227

227

228

<li class="listitem">an action with no parameter type and no state</li>

229

<li class="listitem">an action with no parameter type and boolean state</li>

230

<li class="listitem">an action with string parameter type and string state</li>

283

<hr>

284

285

<a name="g-menu-model-is-mutable"></a><h3>g_menu_model_is_mutable ()</h3>

286

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_model_is_mutable (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);</pre>

286

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_model_is_mutable (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);</pre>

287

288

Queries if <code>model</code> is mutable.

289

291

An immutable <a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> will never emit the <a class="link" href="GMenuModel.html#GMenuModel-items-changed" title='The "items-changed" signal'>"items-changed"</a>

292

signal. Consumers of the model may make optimisations accordingly.

293

294

294

295

295

296

297

<col>

298

</colgroup>

296

299

<tbody>

297

300

<tr>

298

301

<td><code>model</code> :</td>

302

305

<tr>

303

306

<td>Returns :</td>

304

307

<td>

305

<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the model is mutable (ie: "items-changed" may be

308

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the model is mutable (ie: "items-changed" may be

306

309

emitted).</td>

307

310

</tr>

308

311

</tbody>

312

315

<hr>

313

316

314

317

<a name="g-menu-model-get-n-items"></a><h3>g_menu_model_get_n_items ()</h3>

315

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> g_menu_model_get_n_items (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);</pre>

318

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gint">gint</a> g_menu_model_get_n_items (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>);</pre>

316

319

317

320

Query the number of items in <code>model</code>.

318

321

319

322

323

320

324

325

<col>

326

</colgroup>

321

327

<tbody>

322

328

<tr>

323

329

<td><code>model</code> :</td>

403

409

<hr>

404

410

405

411

<a name="g-menu-model-get-item-attribute-value"></a><h3>g_menu_model_get_item_attribute_value ()</h3>

406

<pre class="programlisting"><a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> * g_menu_model_get_item_attribute_value

412

<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> * g_menu_model_get_item_attribute_value

407

413

(<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

408

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

409

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

410

<code>const <a href="./../glib/glib/glib-GVariantType.html#GVariantType">GVariantType</a> *expected_type</code>);</pre>

414

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

415

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

416

<code>const <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> *expected_type</code>);</pre>

411

417

412

418

Queries the item at position <code>item_index</code> in <code>model</code> for the attribute

413

419

specified by <code>attribute</code>.

414

420

415

421

416

If <code>expected_type</code> is non-<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it specifies the expected type of

417

the attribute. If it is <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then any type will be accepted.

422

If <code>expected_type</code> is non-<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then it specifies the expected type of

423

the attribute. If it is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> then any type will be accepted.

418

424

419

425

420

426

If the attribute exists and matches <code>expected_type</code> (or if the

422

428

423

429

424

430

If the attribute does not exist, or does not match the expected type

425

then <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.

431

then <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.

426

432

427

433

434

428

435

436

<col>

437

</colgroup>

429

438

<tbody>

430

439

<tr>

431

440

<td><code>model</code> :</td>

443

452

<tr>

444

453

<td><code>expected_type</code> :</td>

445

454

<td>the expected type of the attribute, or

446

<a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

455

<a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="NULL is ok, both for passing and for returning.">allow-none</acronym>]

447

456

</td>

448

457

</tr>

449

458

<tr>

458

467

<hr>

459

468

460

469

<a name="g-menu-model-get-item-attribute"></a><h3>g_menu_model_get_item_attribute ()</h3>

461

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_model_get_item_attribute (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

462

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

463

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

464

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *format_string</code>,

470

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_model_get_item_attribute (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

471

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

472

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *attribute</code>,

473

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *format_string</code>,

465

474

466

475

467

476

Queries item at position <code>item_index</code> in <code>model</code> for the attribute

468

477

specified by <code>attribute</code>.

469

478

470

479

471

If the attribute exists and matches the <a href="./../glib/glib/glib-GVariantType.html#GVariantType">GVariantType</a> corresponding

480

If the attribute exists and matches the <a href="../glib/glib-GVariantType.html#GVariantType">GVariantType</a> corresponding

472

481

to <code>format_string</code> then <code>format_string</code> is used to deconstruct the

473

value into the positional parameters and <a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.

482

value into the positional parameters and <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned.

474

483

475

484

476

485

If the attribute does not exist, or it does exist but has the wrong

477

type, then the positional parameters are ignored and <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is

486

type, then the positional parameters are ignored and <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is

478

487

returned.

479

488

480

489

481

490

This function is a mix of <a class="link" href="GMenuModel.html#g-menu-model-get-item-attribute-value" title="g_menu_model_get_item_attribute_value ()"><code class="function">g_menu_model_get_item_attribute_value()</code></a> and

482

<a href="./../glib/glib/glib-GVariant.html#g-variant-get"><code class="function">g_variant_get()</code></a>, followed by a <a href="./../glib/glib/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>. As such,

491

<a href="../glib/glib-GVariant.html#g-variant-get"><code class="function">g_variant_get()</code></a>, followed by a <a href="../glib/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>. As such,

483

492

<code>format_string</code> must make a complete copy of the data (since the

484

<a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> may go away after the call to <a href="./../glib/glib/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>). In

493

<a href="../glib/glib-GVariant.html#GVariant">GVariant</a> may go away after the call to <a href="../glib/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a>). In

485

494

particular, no '&' characters are allowed in <code>format_string</code>.

486

495

487

496

497

488

498

499

<col>

500

</colgroup>

489

501

<tbody>

490

502

<tr>

491

503

<td><code>model</code> :</td>

502

514

</tr>

503

515

<tr>

504

516

<td><code>format_string</code> :</td>

505

<td>a <a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> format string</td>

517

<td>a <a href="../glib/glib-GVariant.html#GVariant">GVariant</a> format string</td>

506

518

</tr>

507

519

<tr>

508

520

512

524

<tr>

513

525

<td>Returns :</td>

514

526

<td>

515

<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the named attribute was found with the expected

527

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the named attribute was found with the expected

516

528

type</td>

517

529

</tr>

518

530

</tbody>

523

535

524

536

<a name="g-menu-model-get-item-link"></a><h3>g_menu_model_get_item_link ()</h3>

525

537

<pre class="programlisting"><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> * g_menu_model_get_item_link (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

526

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

527

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> *link</code>);</pre>

538

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>,

539

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> *link</code>);</pre>

528

540

529

541

Queries the item at position <code>item_index</code> in <code>model</code> for the link

530

542

specified by <code>link</code>.

531

543

532

544

533

545

If the link exists, the linked <a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> is returned. If the link

534

does not exist, <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.

546

does not exist, <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is returned.

535

547

536

548

549

537

550

551

<col>

552

</colgroup>

538

553

<tbody>

539

554

<tr>

540

555

<td><code>model</code> :</td>

551

566

</tr>

552

567

<tr>

553

568

<td>Returns :</td>

554

<td>the linked <a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a>, or <a href="./../glib/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="Free data after the code is done.">transfer full</acronym>]

569

<td>the linked <a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. [<acronym title="Free data after the code is done.">transfer full</acronym>]

555

570

</td>

556

571

</tr>

557

572

</tbody>

563

578

<a name="g-menu-model-iterate-item-attributes"></a><h3>g_menu_model_iterate_item_attributes ()</h3>

564

579

<pre class="programlisting"><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> * g_menu_model_iterate_item_attributes

565

580

(<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

566

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);</pre>

581

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);</pre>

567

582

568

583

Creates a <a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> to iterate over the attributes of

569

584

the item at position <code>item_index</code> in <code>model</code>.

570

585

571

586

572

You must free the iterator with <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when you are done.

587

You must free the iterator with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when you are done.

573

588

574

589

590

575

591

592

<col>

593

</colgroup>

576

594

<tbody>

577

595

<tr>

578

596

<td><code>model</code> :</td>

596

614

597

615

<a name="g-menu-model-iterate-item-links"></a><h3>g_menu_model_iterate_item_links ()</h3>

598

616

<pre class="programlisting"><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> * g_menu_model_iterate_item_links (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

599

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);</pre>

617

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> item_index</code>);</pre>

600

618

601

619

Creates a <a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> to iterate over the links of the item at

602

620

position <code>item_index</code> in <code>model</code>.

603

621

604

622

605

You must free the iterator with <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when you are done.

623

You must free the iterator with <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when you are done.

606

624

607

625

626

608

627

628

<col>

629

</colgroup>

609

630

<tbody>

610

631

<tr>

611

632

<td><code>model</code> :</td>

629

650

630

651

<a name="g-menu-model-items-changed"></a><h3>g_menu_model_items_changed ()</h3>

631

652

<pre class="programlisting">void g_menu_model_items_changed (<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model</code>,

632

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> position</code>,

633

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> removed</code>,

634

<code><a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> added</code>);</pre>

653

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> position</code>,

654

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> removed</code>,

655

<code><a href="../glib/glib-Basic-Types.html#gint">gint</a> added</code>);</pre>

635

656

636

657

Requests emission of the <a class="link" href="GMenuModel.html#GMenuModel-items-changed" title='The "items-changed" signal'>"items-changed"</a> signal on <code>model</code>.

637

658

652

673

<a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> API. Said another way: the menu must not change while

653

674

user code is running without returning to the mainloop.

654

675

655

676

677

656

678

679

<col>

680

</colgroup>

657

681

<tbody>

658

682

<tr>

659

683

<td><code>model</code> :</td>

689

713

<hr>

690

714

691

715

<a name="g-menu-attribute-iter-get-next"></a><h3>g_menu_attribute_iter_get_next ()</h3>

692

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_attribute_iter_get_next (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>,

693

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> **out_name</code>,

694

<code><a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> **value</code>);</pre>

716

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_attribute_iter_get_next (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>,

717

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **out_name</code>,

718

<code><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> **value</code>);</pre>

695

719

696

720

This function combines <a class="link" href="GMenuModel.html#g-menu-attribute-iter-next" title="g_menu_attribute_iter_next ()"><code class="function">g_menu_attribute_iter_next()</code></a> with

697

721

<a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-name" title="g_menu_attribute_iter_get_name ()"><code class="function">g_menu_attribute_iter_get_name()</code></a> and <a class="link" href="GMenuModel.html#g-menu-attribute-iter-get-value" title="g_menu_attribute_iter_get_value ()"><code class="function">g_menu_attribute_iter_get_value()</code></a>.

698

722

699

723

700

724

First the iterator is advanced to the next (possibly first) attribute.

701

If that fails, then <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and there are no other

725

If that fails, then <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and there are no other

702

726

effects.

703

727

704

728

710

734

711

735

The value returned in <code>name</code> remains valid for as long as the iterator

712

736

remains at the current position. The value returned in <code>value</code> must

713

be unreffed using <a href="./../glib/glib/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a> when it is no longer in use.

737

be unreffed using <a href="../glib/glib-GVariant.html#g-variant-unref"><code class="function">g_variant_unref()</code></a> when it is no longer in use.

714

738

715

739

740

716

741

742

<col>

743

</colgroup>

717

744

<tbody>

718

745

<tr>

719

746

733

760

<tr>

734

761

<td>Returns :</td>

735

762

<td>

736

<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, or <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there is no additional

763

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there is no additional

737

764

attribute</td>

738

765

</tr>

739

766

</tbody>

743

770

<hr>

744

771

745

772

<a name="g-menu-attribute-iter-get-name"></a><h3>g_menu_attribute_iter_get_name ()</h3>

746

<pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> * g_menu_attribute_iter_get_name (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);</pre>

773

<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * g_menu_attribute_iter_get_name (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);</pre>

747

774

748

775

Gets the name of the attribute at the current iterator position, as

749

776

a string.

751

778

752

779

The iterator is not advanced.

753

780

754

781

782

755

783

784

<col>

785

</colgroup>

756

786

<tbody>

757

787

<tr>

758

788

770

800

<hr>

771

801

772

802

<a name="g-menu-attribute-iter-get-value"></a><h3>g_menu_attribute_iter_get_value ()</h3>

773

<pre class="programlisting"><a href="./../glib/glib/glib-GVariant.html#GVariant">GVariant</a> * g_menu_attribute_iter_get_value (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);</pre>

803

<pre class="programlisting"><a href="../glib/glib-GVariant.html#GVariant">GVariant</a> * g_menu_attribute_iter_get_value (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);</pre>

774

804

775

805

Gets the value of the attribute at the current iterator position.

776

806

777

807

778

808

The iterator is not advanced.

779

809

780

810

811

781

812

813

<col>

814

</colgroup>

782

815

<tbody>

783

816

<tr>

784

817

797

830

<hr>

798

831

799

832

<a name="g-menu-attribute-iter-next"></a><h3>g_menu_attribute_iter_next ()</h3>

800

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_attribute_iter_next (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);</pre>

833

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_attribute_iter_next (<code><a class="link" href="GMenuModel.html#GMenuAttributeIter">GMenuAttributeIter</a> *iter</code>);</pre>

801

834

802

835

Attempts to advance the iterator to the next (possibly first)

803

836

attribute.

804

837

805

838

806

<a href="./../glib/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned on success, or <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there are no more

839

<a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> is returned on success, or <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if there are no more

807

840

attributes.

808

841

809

842

811

844

to advance it to the first attribute (and determine if the first

812

845

attribute exists at all).

813

846

814

847

848

815

849

850

<col>

851

</colgroup>

816

852

<tbody>

817

853

<tr>

818

854

822

858

<tr>

823

859

<td>Returns :</td>

824

860

<td>

825

861

826

862

</tr>

827

863

</tbody>

828

864

</table></div>

841

877

<hr>

842

878

843

879

844

<pre class="programlisting">const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> * g_menu_link_iter_get_name (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);</pre>

880

<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> * g_menu_link_iter_get_name (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);</pre>

845

881

846

882

Gets the name of the link at the current iterator position.

847

883

848

884

849

885

The iterator is not advanced.

850

886

851

887

888

852

889

890

<col>

891

</colgroup>

853

892

<tbody>

854

893

<tr>

855

894

867

906

<hr>

868

907

869

908

870

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_link_iter_get_next (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>,

871

<code>const <a href="./../glib/glib/glib-Basic-Types.html#gchar">gchar</a> **out_link</code>,

909

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_link_iter_get_next (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>,

910

<code>const <a href="../glib/glib-Basic-Types.html#gchar">gchar</a> **out_link</code>,

872

911

<code><a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> **value</code>);</pre>

873

912

874

913

This function combines <a class="link" href="GMenuModel.html#g-menu-link-iter-next" title="g_menu_link_iter_next ()"><code class="function">g_menu_link_iter_next()</code></a> with

876

915

877

916

878

917

First the iterator is advanced to the next (possibly first) link.

879

If that fails, then <a href="./../glib/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and there are no other effects.

918

If that fails, then <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> is returned and there are no other effects.

880

919

881

920

882

921

If successful, <code>out_link</code> and <code>value</code> are set to the name and <a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a>

887

926

888

927

The value returned in <code>out_link</code> remains valid for as long as the iterator

889

928

remains at the current position. The value returned in <code>value</code> must

890

be unreffed using <a href="./../gobject/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when it is no longer in use.

929

be unreffed using <a href="../gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a> when it is no longer in use.

891

930

892

931

932

893

933

934

<col>

935

</colgroup>

894

936

<tbody>

895

937

<tr>

896

938

910

952

<tr>

911

953

<td>Returns :</td>

912

954

<td>

913

955

914

956

</tr>

915

957

</tbody>

916

958

</table></div>

926

968

927

969

The iterator is not advanced.

928

970

929

971

972

930

973

974

<col>

975

</colgroup>

931

976

<tbody>

932

977

<tr>

933

978

946

991

<hr>

947

992

948

993

949

<pre class="programlisting"><a href="./../glib/glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_link_iter_next (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);</pre>

994

<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean">gboolean</a> g_menu_link_iter_next (<code><a class="link" href="GMenuModel.html#GMenuLinkIter">GMenuLinkIter</a> *iter</code>);</pre>

950

995

951

996

Attempts to advance the iterator to the next (possibly first)

952

997

link.

953

998

954

999

955

1000

956

1001

957

1002

958

1003

You must call this function when you first acquire the iterator to

959

1004

advance it to the first link (and determine if the first link exists

960

1005

at all).

961

1006

962

1007

1008

963

1009

1010

<col>

1011

</colgroup>

964

1012

<tbody>

965

1013

<tr>

966

1014

970

1018

<tr>

971

1019

<td>Returns :</td>

972

1020

<td>

973

1021

974

1022

</tr>

975

1023

</tbody>

976

1024

</table></div>

982

1030

983

1031

<a name="GMenuModel-items-changed"></a><h3>The <code class="literal">"items-changed"</code> signal</h3>

984

1032

<pre class="programlisting">void user_function (<a class="link" href="GMenuModel.html" title="GMenuModel">GMenuModel</a> *model,

985

<a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> position,

986

<a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> removed,

987

<a href="./../glib/glib/glib-Basic-Types.html#gint">gint</a> added,

988

<a href="./../glib/glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="./../gobject/gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

1033

<a href="../glib/glib-Basic-Types.html#gint">gint</a> position,

1034

<a href="../glib/glib-Basic-Types.html#gint">gint</a> removed,

1035

<a href="../glib/glib-Basic-Types.html#gint">gint</a> added,

1036

<a href="../glib/glib-Basic-Types.html#gpointer">gpointer</a> user_data) : <a href="../gobject/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>

989

1037

990

1038

Emitted when a change has occured to the menu.

991

1039

1012

1060

and expect to see the results of the modification that is being

1013

1061

reported. The signal is emitted after the modification.

1014

1062

1015

1063

1064

1016

1065

1066

<col>

1067

</colgroup>

1017

1068

<tbody>

1018

1069

<tr>

1019

1070

<td><code>model</code> :</td>

1046

1097

</div>

1047

1098

1048

1099

<hr>

1049

Generated by GTK-Doc V1.18</div>

1100

Generated by GTK-Doc V1.18.1</div>

1050

1101

</body>

1051

1102

</html>

b'\\ No newline at end of file'

Older »