← Back to branch summary

~ubuntu-branches/ubuntu/wily/atkmm1.6/wily

« back to all changes in this revision

Viewing changes to doc/reference/html/classAtk_1_1StateSet.html

  • Committer: Package Import Robot
  • Author(s): Michael Biebl
  • Date: 2011-11-17 02:28:10 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20111117022810-0fcs3rpkgi0zmofe
Tags: 2.22.6-1
* New upstream release.
* debian/watch:
  - Track .xz tarballs.
* Stop installing libtool .la files.
* Bump Standards-Version to 3.9.2. No further changes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/classAtk_1_1StateSet.html
7
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
8
8
</head>
9
9
<body>
10
 
<!-- Generated by Doxygen 1.7.2 -->
11
 
<div class="navigation" id="top">
12
 
  <div class="tabs">
 
10
<!-- Generated by Doxygen 1.7.4 -->
 
11
<div id="top">
 
12
<div id="titlearea">
 
13
<table cellspacing="0" cellpadding="0">
 
14
 <tbody>
 
15
 <tr style="height: 56px;">
 
16
  <td style="padding-left: 0.5em;">
 
17
   <div id="projectname">atkmm&#160;<span id="projectnumber">2.22.6</span></div>
 
18
  </td>
 
19
 </tr>
 
20
 </tbody>
 
21
</table>
 
22
</div>
 
23
  <div id="navrow1" class="tabs">
13
24
    <ul class="tablist">
14
25
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
15
26
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
18
29
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
19
30
    </ul>
20
31
  </div>
21
 
  <div class="tabs2">
 
32
  <div id="navrow2" class="tabs2">
22
33
    <ul class="tablist">
23
34
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
24
 
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
 
35
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
25
36
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
26
37
    </ul>
27
38
  </div>
28
 
  <div class="navpath">
 
39
  <div id="nav-path" class="navpath">
29
40
    <ul>
30
 
      <li><a class="el" href="namespaceAtk.html">Atk</a> </li>
31
 
      <li><a class="el" href="classAtk_1_1StateSet.html">StateSet</a> </li>
 
41
      <li class="navelem"><a class="el" href="namespaceAtk.html">Atk</a> </li>
 
42
      <li class="navelem"><a class="el" href="classAtk_1_1StateSet.html">StateSet</a> </li>
32
43
    </ul>
33
44
  </div>
34
45
</div>
37
48
<a href="#pub-methods">Public Member Functions</a> &#124;
38
49
<a href="#related">Related Functions</a> </div>
39
50
  <div class="headertitle">
40
 
<h1>Atk::StateSet Class Reference</h1> </div>
 
51
<div class="title">Atk::StateSet Class Reference</div> </div>
41
52
</div>
42
53
<div class="contents">
43
54
<!-- doxytag: class="Atk::StateSet" --><!-- doxytag: inherits="Glib::Object" -->
44
 
<p>An AtkStateSet determines a component's state set. <a href="#_details">More...</a></p>
 
55
<p>An AtkStateSet determines a component's state set.  <a href="classAtk_1_1StateSet.html#details">More...</a></p>
45
56
 
46
57
<p><code>#include &lt;atkmm/stateset.h&gt;</code></p>
47
 
<!-- startSectionHeader --><div class="dynheader">
48
 
Inheritance diagram for Atk::StateSet:<!-- endSectionHeader --></div>
49
 
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
 
58
<div class="dynheader">
 
59
Inheritance diagram for Atk::StateSet:</div>
 
60
<div class="dyncontent">
50
61
<div class="center"><img src="classAtk_1_1StateSet__inherit__graph.png" border="0" usemap="#Atk_1_1StateSet_inherit__map" alt="Inheritance graph"/></div>
51
62
<map name="Atk_1_1StateSet_inherit__map" id="Atk_1_1StateSet_inherit__map">
52
63
<area shape="rect" id="node2" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,160,115,189"/><area shape="rect" id="node4" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="5,83,131,112"/><area shape="rect" id="node6" doxygen="libsigc++-2.0.tag:http://library.gnome.org/devel/libsigc++/unstable/" href="http://library.gnome.org/devel/libsigc++/unstable/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="11,5,125,35"/></map>
53
 
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
64
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
54
65
 
55
66
<p><a href="classAtk_1_1StateSet-members.html">List of all members.</a></p>
56
67
<table class="memberdecls">
67
78
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <br/></td></tr>
68
79
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#ad60014ebc037244153ce812843ee4dd9">is_empty</a> () const </td></tr>
69
80
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the state set is empty, i.e. has no states set. <a href="#ad60014ebc037244153ce812843ee4dd9"></a><br/></td></tr>
70
 
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#aede4c4b8495f9772d35af9da9e77395d">add_state</a> (Atk::StateType <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01173.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
 
81
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#aede4c4b8495f9772d35af9da9e77395d">add_state</a> (Atk::StateType <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01603.html#ga79d96b6335c46a5a2a7386970a91cd9b">type</a>)</td></tr>
71
82
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Add a new state for the specified type to the current state set if it is not already present. <a href="#aede4c4b8495f9772d35af9da9e77395d"></a><br/></td></tr>
72
83
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7534af9c87a8e5af0c4033fafcb05f63"></a><!-- doxytag: member="Atk::StateSet::clear_states" ref="a7534af9c87a8e5af0c4033fafcb05f63" args="()" -->
73
84
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a7534af9c87a8e5af0c4033fafcb05f63">clear_states</a> ()</td></tr>
74
85
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes all states from the state set. <br/></td></tr>
75
 
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#ab49dcdfd6f09d04e5dd11fe66be83d27">contains_state</a> (Atk::StateType <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01173.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
 
86
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#ab49dcdfd6f09d04e5dd11fe66be83d27">contains_state</a> (Atk::StateType <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01603.html#ga79d96b6335c46a5a2a7386970a91cd9b">type</a>)</td></tr>
76
87
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the state for the specified type is in the specified set. <a href="#ab49dcdfd6f09d04e5dd11fe66be83d27"></a><br/></td></tr>
77
 
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a9f01863fb1490e645e58f1013496d7b9">remove_state</a> (Atk::StateType <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01173.html#ga2c2933c16c723af4d77eb939438617ca">type</a>)</td></tr>
 
88
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a9f01863fb1490e645e58f1013496d7b9">remove_state</a> (Atk::StateType <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01603.html#ga79d96b6335c46a5a2a7386970a91cd9b">type</a>)</td></tr>
78
89
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes the state for the specified type from the state set. <a href="#a9f01863fb1490e645e58f1013496d7b9"></a><br/></td></tr>
79
90
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#a770c542a9abc8e97e28e07772d2bf442">and_sets</a> (const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> &gt;&amp; compare_set)</td></tr>
80
91
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the intersection of the two sets, returning <code>0</code> if the intersection is empty. <a href="#a770c542a9abc8e97e28e07772d2bf442"></a><br/></td></tr>
84
95
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructs the exclusive-or of the two sets, returning <code>0</code> is empty. <a href="#a09d5c551ff86ff3f6b20de3bd746e87c"></a><br/></td></tr>
85
96
<tr><td colspan="2"><h2><a name="related"></a>
86
97
Related Functions</h2></td></tr>
87
 
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
88
 
<br/></td></tr>
 
98
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
 
99
</td></tr>
89
100
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1StateSet.html">Atk::StateSet</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1StateSet.html#ab23628405857278092f4fc24ddca4fe9">wrap</a> (AtkStateSet* object, bool take_copy=false)</td></tr>
90
101
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">A <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#ab23628405857278092f4fc24ddca4fe9"></a><br/></td></tr>
91
102
</table>
92
 
<hr/><a name="_details"></a><h2>Detailed Description</h2>
93
 
<p>An AtkStateSet determines a component's state set. </p>
 
103
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
 
104
<div class="textblock"><p>An AtkStateSet determines a component's state set. </p>
94
105
<p>It is composed of a set of Atk::States. </p>
95
 
<hr/><h2>Member Function Documentation</h2>
 
106
</div><hr/><h2>Member Function Documentation</h2>
96
107
<a class="anchor" id="aede4c4b8495f9772d35af9da9e77395d"></a><!-- doxytag: member="Atk::StateSet::add_state" ref="aede4c4b8495f9772d35af9da9e77395d" args="(Atk::StateType type)" -->
97
108
<div class="memitem">
98
109
<div class="memproto">
101
112
          <td class="memname">bool Atk::StateSet::add_state </td>
102
113
          <td>(</td>
103
114
          <td class="paramtype">Atk::StateType&#160;</td>
104
 
          <td class="paramname"> <em>type</em>&#160;)</td>
 
115
          <td class="paramname"><em>type</em></td><td>)</td>
105
116
          <td></td>
106
117
        </tr>
107
118
      </table>
127
138
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classAtk_1_1StateSet.html">StateSet</a>&gt; Atk::StateSet::and_sets </td>
128
139
          <td>(</td>
129
140
          <td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> &gt;&amp;&#160;</td>
130
 
          <td class="paramname"> <em>compare_set</em>&#160;)</td>
 
141
          <td class="paramname"><em>compare_set</em></td><td>)</td>
131
142
          <td></td>
132
143
        </tr>
133
144
      </table>
153
164
          <td class="memname">bool Atk::StateSet::contains_state </td>
154
165
          <td>(</td>
155
166
          <td class="paramtype">Atk::StateType&#160;</td>
156
 
          <td class="paramname"> <em>type</em>&#160;)</td>
 
167
          <td class="paramname"><em>type</em></td><td>)</td>
157
168
          <td></td>
158
169
        </tr>
159
170
      </table>
178
189
        <tr>
179
190
          <td class="memname">bool Atk::StateSet::is_empty </td>
180
191
          <td>(</td>
181
 
          <td class="paramname">&#160;)</td>
 
192
          <td class="paramname"></td><td>)</td>
182
193
          <td> const</td>
183
194
        </tr>
184
195
      </table>
198
209
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classAtk_1_1StateSet.html">StateSet</a>&gt; Atk::StateSet::or_sets </td>
199
210
          <td>(</td>
200
211
          <td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> &gt;&amp;&#160;</td>
201
 
          <td class="paramname"> <em>compare_set</em>&#160;)</td>
 
212
          <td class="paramname"><em>compare_set</em></td><td>)</td>
202
213
          <td></td>
203
214
        </tr>
204
215
      </table>
224
235
          <td class="memname">bool Atk::StateSet::remove_state </td>
225
236
          <td>(</td>
226
237
          <td class="paramtype">Atk::StateType&#160;</td>
227
 
          <td class="paramname"> <em>type</em>&#160;)</td>
 
238
          <td class="paramname"><em>type</em></td><td>)</td>
228
239
          <td></td>
229
240
        </tr>
230
241
      </table>
250
261
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt;<a class="el" href="classAtk_1_1StateSet.html">StateSet</a>&gt; Atk::StateSet::xor_sets </td>
251
262
          <td>(</td>
252
263
          <td class="paramtype">const <a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1StateSet.html">StateSet</a> &gt;&amp;&#160;</td>
253
 
          <td class="paramname"> <em>compare_set</em>&#160;)</td>
 
264
          <td class="paramname"><em>compare_set</em></td><td>)</td>
254
265
          <td></td>
255
266
        </tr>
256
267
      </table>
278
289
          <td class="memname"><a class="elRef" doxygen="glibmm-2.4.tag:http://library.gnome.org/devel/glibmm/unstable/" href="http://library.gnome.org/devel/glibmm/unstable/classGlib_1_1RefPtr.html">Glib::RefPtr</a>&lt; <a class="el" href="classAtk_1_1StateSet.html">Atk::StateSet</a> &gt; wrap </td>
279
290
          <td>(</td>
280
291
          <td class="paramtype">AtkStateSet *&#160;</td>
281
 
          <td class="paramname"> <em>object</em>, </td>
 
292
          <td class="paramname"><em>object</em>, </td>
282
293
        </tr>
283
294
        <tr>
284
295
          <td class="paramkey"></td>
285
296
          <td></td>
286
297
          <td class="paramtype">bool&#160;</td>
287
 
          <td class="paramname"> <em>take_copy</em> = <code>false</code>&#160;</td>
 
298
          <td class="paramname"><em>take_copy</em> = <code>false</code>&#160;</td>
288
299
        </tr>
289
300
        <tr>
290
301
          <td></td>
308
319
</div>
309
320
</div>
310
321
</div>
311
 
<hr class="footer"/><address class="footer"><small>Generated on Wed Mar 30 2011 09:27:41 for atkmm by&#160;
 
322
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 26 2011 13:06:40 for atkmm by&#160;
312
323
<a href="http://www.doxygen.org/index.html">
313
 
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 
324
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
314
325
</body>
315
326
</html>