~ubuntu-branches/ubuntu/quantal/gtkmm3.0/quantal

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Sebastien Bacher
  • Date: 2012-03-01 23:42:36 UTC
  • mfrom: (1.1.8)
  • Revision ID: package-import@ubuntu.com-20120301234236-12w6m0hkomhi7h53
Tags: 3.3.16-0ubuntu1
* New upstream version
* debian/control.in: updated the glib requirement

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">gtkmm&#160;<span id="projectnumber">3.3.14</span></div>
 
17
   <div id="projectname">gtkmm&#160;<span id="projectnumber">3.3.16</span></div>
18
18
  </td>
19
19
 </tr>
20
20
 </tbody>
125
125
<div class="textblock"><p>This represents a widget hierarchy from the topmost widget, typically a toplevel, to any child. </p>
126
126
<p>This widget path abstraction is used in <a class="el" href="classGtk_1_1StyleContext.html" title="This object stores styling information affecting a widget defined by WidgetPath.">StyleContext</a> on behalf of the real widget in order to query style information.</p>
127
127
<p>If you are using gtkmm widgets, you probably will not need to use this API directly, as there is <a class="el" href="classGtk_1_1Widget.html#ae6516cb8f433920314f7e3f853875535" title="Returns the Gtk::WidgetPath representing widget, if the widget is not connected to a toplevel widget...">Widget::get_path()</a>, and the style context returned by <a class="el" href="classGtk_1_1Widget.html#af76fdca337696a969d0c6080ac5995e2" title="Returns the style context associated to widget.">Widget::get_style_context()</a> will be automatically updated on widget hierarchy changes.</p>
128
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000301">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
128
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000304">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
129
129
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
130
130
<a class="anchor" id="a531f2c45d75acb958a684c6545fadf82"></a><!-- doxytag: member="Gtk::WidgetPath::WidgetPath" ref="a531f2c45d75acb958a684c6545fadf82" args="()" -->
131
131
<div class="memitem">
219
219
<div class="memdoc">
220
220
 
221
221
<p>Returns the topmost object type, that is, the object type this path is representing. </p>
222
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000317">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
222
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000320">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
223
223
<dl class="return"><dt><b>Returns:</b></dt><dd>The object type. </dd></dl>
224
224
 
225
225
</div>
294
294
<div class="memdoc">
295
295
 
296
296
<p>Returns <code>true</code> if any of the parents of the widget represented in <em>path</em> is of type <em>type</em>, or any subtype of it. </p>
297
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000319">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
297
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000322">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
298
298
<dl><dt><b>Parameters:</b></dt><dd>
299
299
  <table class="params">
300
300
    <tr><td class="paramname">type</td><td><a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Widget</a> type to check in parents. </td></tr>
321
321
<div class="memdoc">
322
322
 
323
323
<p>Returns <code>true</code> if the widget type represented by this path is <em>type</em>, or a subtype of it. </p>
324
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000318">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
324
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000321">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
325
325
<dl><dt><b>Parameters:</b></dt><dd>
326
326
  <table class="params">
327
327
    <tr><td class="paramname">type</td><td><a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Widget</a> type to match. </td></tr>
359
359
 
360
360
<p>Adds the class <em>name</em> to the widget at position <em>pos</em> in the hierarchy defined in <em>path</em>. </p>
361
361
<p>See <a class="el" href="classGtk_1_1StyleContext.html#a13f8b00a08ef17de1b95be09fb3d8963" title="Adds a style class to context, so posterior calls to get() or any of the gtk_render_*() functions wil...">Gtk::StyleContext::add_class()</a>.</p>
362
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000309">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
362
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000312">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
363
363
<dl><dt><b>Parameters:</b></dt><dd>
364
364
  <table class="params">
365
365
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
404
404
<p>Adds the region <em>name</em> to the widget at position <em>pos</em> in the hierarchy defined in <em>path</em>. </p>
405
405
<p>See <a class="el" href="classGtk_1_1StyleContext.html#a71047910de26a545dea448ac1a6deea4" title="Adds a region to context, so posterior calls to get() or any of the gtk_render_*() functions will mak...">Gtk::StyleContext::add_region()</a>.</p>
406
406
<p>&lt;note&gt;Region names must only contain lowercase letters and '-', starting always with a lowercase letter.&lt;/note&gt;</p>
407
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000313">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
407
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000316">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
408
408
<dl><dt><b>Parameters:</b></dt><dd>
409
409
  <table class="params">
410
410
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
432
432
<div class="memdoc">
433
433
 
434
434
<p>Removes all classes from the widget at position <em>pos</em> in the hierarchy defined in <em>path</em>. </p>
435
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000311">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
435
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000314">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
436
436
<dl><dt><b>Parameters:</b></dt><dd>
437
437
  <table class="params">
438
438
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
458
458
<div class="memdoc">
459
459
 
460
460
<p>Removes all regions from the widget at position <em>pos</em> in the hierarchy defined in <em>path</em>. </p>
461
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000315">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
461
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000318">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
462
462
<dl><dt><b>Parameters:</b></dt><dd>
463
463
  <table class="params">
464
464
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
510
510
<div class="memdoc">
511
511
 
512
512
<p>Returns the object Type that is at position <em>pos</em> in the widget hierarchy defined in <em>path</em>. </p>
513
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000305">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
513
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000308">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
514
514
<dl><dt><b>Parameters:</b></dt><dd>
515
515
  <table class="params">
516
516
    <tr><td class="paramname">pos</td><td>Position to get the object type for, -1 for the path head. </td></tr>
547
547
<div class="memdoc">
548
548
 
549
549
<p>Returns <code>true</code> if the widget at position <em>pos</em> has the class <em>name</em> defined, <code>false</code> otherwise. </p>
550
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000312">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
550
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000315">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
551
551
<dl><dt><b>Parameters:</b></dt><dd>
552
552
  <table class="params">
553
553
    <tr><td class="paramname">pos</td><td>Position to query, -1 for the path head. </td></tr>
585
585
<div class="memdoc">
586
586
 
587
587
<p>Returns <code>true</code> if the widget at position <em>pos</em> has the name <em>name</em>, <code>false</code> otherwise. </p>
588
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000308">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
588
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000311">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
589
589
<dl><dt><b>Parameters:</b></dt><dd>
590
590
  <table class="params">
591
591
    <tr><td class="paramname">pos</td><td>Position to query, -1 for the path head. </td></tr>
629
629
<div class="memdoc">
630
630
 
631
631
<p>Returns <code>true</code> if the widget at position <em>pos</em> has the class <em>name</em> defined, <code>false</code> otherwise. </p>
632
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000316">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
632
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000319">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
633
633
<dl><dt><b>Parameters:</b></dt><dd>
634
634
  <table class="params">
635
635
    <tr><td class="paramname">pos</td><td>Position to query, -1 for the path head. </td></tr>
668
668
<div class="memdoc">
669
669
 
670
670
<p>Removes the class <em>name</em> from the widget at position <em>pos</em> in the hierarchy defined in <em>path</em>. </p>
671
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000310">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
671
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000313">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
672
672
<dl><dt><b>Parameters:</b></dt><dd>
673
673
  <table class="params">
674
674
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
705
705
<div class="memdoc">
706
706
 
707
707
<p>Removes the region <em>name</em> from the widget at position <em>pos</em> in the hierarchy defined in <em>path</em>. </p>
708
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000314">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
708
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000317">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
709
709
<dl><dt><b>Parameters:</b></dt><dd>
710
710
  <table class="params">
711
711
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
742
742
<div class="memdoc">
743
743
 
744
744
<p>Sets the widget name for the widget found at position <em>pos</em> in the widget hierarchy defined by <em>path</em>. </p>
745
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000307">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
745
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000310">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
746
746
<dl><dt><b>Parameters:</b></dt><dd>
747
747
  <table class="params">
748
748
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
779
779
<div class="memdoc">
780
780
 
781
781
<p>Sets the object type for a given position in the widget hierarchy defined by <em>path</em>. </p>
782
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000306">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
782
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000309">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
783
783
<dl><dt><b>Parameters:</b></dt><dd>
784
784
  <table class="params">
785
785
    <tr><td class="paramname">pos</td><td>Position to modify, -1 for the path head. </td></tr>
823
823
<div class="memdoc">
824
824
 
825
825
<p>Appends a widget type to the widget hierarchy represented by <em>path</em>. </p>
826
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000303">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
826
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000306">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
827
827
<dl><dt><b>Parameters:</b></dt><dd>
828
828
  <table class="params">
829
829
    <tr><td class="paramname">type</td><td><a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Widget</a> type to append. </td></tr>
849
849
<div class="memdoc">
850
850
 
851
851
<p>Returns the number of <a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Gtk::Widget</a> Types between the represented widget and its topmost container. </p>
852
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000302">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
852
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000305">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
853
853
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of elements in the path. </dd></dl>
854
854
 
855
855
</div>
870
870
<div class="memdoc">
871
871
 
872
872
<p>Prepends a widget type to the widget hierachy represented by <em>path</em>. </p>
873
 
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000304">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
 
873
<dl class="since_3_0"><dt><b><a class="el" href="since_3_0.html#_since_3_0000307">Since gtkmm 3.0:</a></b></dt><dd></dd></dl>
874
874
<dl><dt><b>Parameters:</b></dt><dd>
875
875
  <table class="params">
876
876
    <tr><td class="paramname">type</td><td><a class="el" href="classGtk_1_1Widget.html" title="Abstract Widget (Base class for all widgets)">Widget</a> type to prepend. </td></tr>
987
987
<li>gtkmm/widgetpath.h</li>
988
988
</ul>
989
989
</div>
990
 
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 7 2012 10:44:10 for gtkmm by&#160;
 
990
<hr class="footer"/><address class="footer"><small>Generated on Tue Feb 28 2012 10:01:57 for gtkmm by&#160;
991
991
<a href="http://www.doxygen.org/index.html">
992
992
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
993
993
</body>