~ubuntu-branches/ubuntu/trusty/glibmm2.4/trusty

« back to all changes in this revision

Viewing changes to docs/reference/html/classGio_1_1MenuModel.html

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-03-08 11:46:37 UTC
  • mfrom: (1.2.70)
  • Revision ID: package-import@ubuntu.com-20120308114637-igm0brktjj83b03b
Tags: 2.31.20-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
14
14
 <tbody>
15
15
 <tr style="height: 56px;">
16
16
  <td style="padding-left: 0.5em;">
17
 
   <div id="projectname">glibmm&#160;<span id="projectnumber">2.31.18.1</span></div>
 
17
   <div id="projectname">glibmm&#160;<span id="projectnumber">2.31.20</span></div>
18
18
  </td>
19
19
 </tr>
20
20
 </tbody>
123
123
<p><b>Boolean State.</b> An action with a boolean state will most typically be used with a "toggle" or "switch" menu item. The state can be set directly, but activating the action (with no parameter) results in the state being toggled. Selecting a toggle menu item will activate the action. The menu item should be rendered as "checked" when the state is true.</p>
124
124
<p><b>String Parameter and State.</b> Actions with string parameters and state will most typically be used to represent an enumerated choice over the items available for a group of radio menu items. Activating the action with a string parameter is equivalent to setting that parameter as the state. Radio menu items, in addition to being associated with the action, will have a target value. Selecting that menu item will result in activation of the action with the target value as the parameter. The menu item should be rendered as "selected" when the state of the action is equal to the target value of the menu item.</p>
125
125
<p>See the C API docs for a graphical example. </p>
126
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000033">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
126
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000034">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
127
127
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
128
128
<a class="anchor" id="aa50e7a927c5798cfa94d38a50b919c64"></a><!-- doxytag: member="Gio::MenuModel::~MenuModel" ref="aa50e7a927c5798cfa94d38a50b919c64" args="()" -->
129
129
<div class="memitem">
197
197
<p>If <em>expected_type</em> is non-<code>0</code> then it specifies the expected type of the attribute. If it is <code>0</code> then any type will be accepted.</p>
198
198
<p>If the attribute exists and matches <em>expected_type</em> (or if the expected type is unspecified) then the value is returned.</p>
199
199
<p>If the attribute does not exist, or does not match the expected type then <code>0</code> is returned.</p>
200
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000034">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
200
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000035">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
201
201
<dl><dt><b>Parameters:</b></dt><dd>
202
202
  <table class="params">
203
203
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
245
245
<p>If <em>expected_type</em> is non-<code>0</code> then it specifies the expected type of the attribute. If it is <code>0</code> then any type will be accepted.</p>
246
246
<p>If the attribute exists and matches <em>expected_type</em> (or if the expected type is unspecified) then the value is returned.</p>
247
247
<p>If the attribute does not exist, or does not match the expected type then <code>0</code> is returned.</p>
248
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000035">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
248
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000036">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
249
249
<dl><dt><b>Parameters:</b></dt><dd>
250
250
  <table class="params">
251
251
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
285
285
 
286
286
<p>Queries the item at position <em>item_index</em> in <em>model</em> for the link specified by <em>link</em>. </p>
287
287
<p>If the link exists, the linked <a class="el" href="classGio_1_1MenuModel.html" title="MenuModel - An abstract class representing the contents of a menu.">MenuModel</a> is returned. If the link does not exist, <code>0</code> is returned.</p>
288
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000036">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
288
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000037">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
289
289
<dl><dt><b>Parameters:</b></dt><dd>
290
290
  <table class="params">
291
291
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
324
324
 
325
325
<p>Queries the item at position <em>item_index</em> in <em>model</em> for the link specified by <em>link</em>. </p>
326
326
<p>If the link exists, the linked <a class="el" href="classGio_1_1MenuModel.html" title="MenuModel - An abstract class representing the contents of a menu.">MenuModel</a> is returned. If the link does not exist, <code>0</code> is returned.</p>
327
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000037">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
327
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000038">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
328
328
<dl><dt><b>Parameters:</b></dt><dd>
329
329
  <table class="params">
330
330
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
435
435
<p>This function should never be called except by <a class="el" href="classGio_1_1MenuModel.html" title="MenuModel - An abstract class representing the contents of a menu.">MenuModel</a> subclasses. Any other calls to this function will very likely lead to a violation of the interface of the model.</p>
436
436
<p>The implementation should update its internal representation of the menu before emitting the signal. The implementation should further expect to receive queries about the new state of the menu (and particularly added menu items) while signal handlers are running.</p>
437
437
<p>The implementation must dispatch this call directly from a mainloop entry and not in response to calls -- particularly those from the <a class="el" href="classGio_1_1MenuModel.html" title="MenuModel - An abstract class representing the contents of a menu.">MenuModel</a> API. Said another way: the menu must not change while user code is running without returning to the mainloop.</p>
438
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000042">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
438
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000043">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
439
439
<dl><dt><b>Parameters:</b></dt><dd>
440
440
  <table class="params">
441
441
    <tr><td class="paramname">position</td><td>The position of the change. </td></tr>
464
464
 
465
465
<p>Creates a <a class="el" href="classGio_1_1MenuAttributeIter.html" title="MenuAttributeIter - A menu attribute iterator.">MenuAttributeIter</a> to iterate over the attributes of the item at position <em>item_index</em> in <em>model</em>. </p>
466
466
<p>You must free the iterator with Glib::object_unref() when you are done.</p>
467
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000039">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
467
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000040">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
468
468
<dl><dt><b>Parameters:</b></dt><dd>
469
469
  <table class="params">
470
470
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
492
492
 
493
493
<p>Creates a <a class="el" href="classGio_1_1MenuAttributeIter.html" title="MenuAttributeIter - A menu attribute iterator.">MenuAttributeIter</a> to iterate over the attributes of the item at position <em>item_index</em> in <em>model</em>. </p>
494
494
<p>You must free the iterator with Glib::object_unref() when you are done.</p>
495
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000038">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
495
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000039">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
496
496
<dl><dt><b>Parameters:</b></dt><dd>
497
497
  <table class="params">
498
498
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
520
520
 
521
521
<p>Creates a <a class="el" href="classGio_1_1MenuLinkIter.html" title="MenuLinkIter - A menu link iterator.">MenuLinkIter</a> to iterate over the links of the item at position <em>item_index</em> in <em>model</em>. </p>
522
522
<p>You must free the iterator with Glib::object_unref() when you are done.</p>
523
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000041">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
523
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000042">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
524
524
<dl><dt><b>Parameters:</b></dt><dd>
525
525
  <table class="params">
526
526
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
548
548
 
549
549
<p>Creates a <a class="el" href="classGio_1_1MenuLinkIter.html" title="MenuLinkIter - A menu link iterator.">MenuLinkIter</a> to iterate over the links of the item at position <em>item_index</em> in <em>model</em>. </p>
550
550
<p>You must free the iterator with Glib::object_unref() when you are done.</p>
551
 
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000040">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
 
551
<dl class="since_2_32"><dt><b><a class="el" href="since_2_32.html#_since_2_32000041">Since glibmm 2.32:</a></b></dt><dd></dd></dl>
552
552
<dl><dt><b>Parameters:</b></dt><dd>
553
553
  <table class="params">
554
554
    <tr><td class="paramname">item_index</td><td>The index of the item. </td></tr>
598
598
</div>
599
599
</div>
600
600
</div>
601
 
<hr class="footer"/><address class="footer"><small>Generated on Mon Feb 27 2012 11:57:35 for glibmm by&#160;
 
601
<hr class="footer"/><address class="footer"><small>Generated on Tue Mar 6 2012 11:36:17 for glibmm by&#160;
602
602
<a href="http://www.doxygen.org/index.html">
603
603
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
604
604
</body>