← Back to branch summary

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

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Klimonda
  • Date: 2010-11-02 20:35:53 UTC
  • Revision ID: james.westby@ubuntu.com-20101102203553-syno2w6yedmcdgk8
Tags: upstream-2.22.1
Import upstream version 2.22.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/classAtk_1_1Relation.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>atkmm: Atk::Relation Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.2 -->
 
11
<div class="navigation" id="top">
 
12
  <div class="tabs">
 
13
    <ul class="tablist">
 
14
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
15
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
16
      <li><a href="modules.html"><span>Modules</span></a></li>
 
17
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
18
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
19
    </ul>
 
20
  </div>
 
21
  <div class="tabs2">
 
22
    <ul class="tablist">
 
23
      <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>
 
25
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
26
    </ul>
 
27
  </div>
 
28
  <div class="navpath">
 
29
    <ul>
 
30
      <li><a class="el" href="namespaceAtk.html">Atk</a> </li>
 
31
      <li><a class="el" href="classAtk_1_1Relation.html">Relation</a> </li>
 
32
    </ul>
 
33
  </div>
 
34
</div>
 
35
<div class="header">
 
36
  <div class="summary">
 
37
<a href="#pub-methods">Public Member Functions</a> &#124;
 
38
<a href="#related">Related Functions</a> </div>
 
39
  <div class="headertitle">
 
40
<h1>Atk::Relation Class Reference</h1> </div>
 
41
</div>
 
42
<div class="contents">
 
43
<!-- doxytag: class="Atk::Relation" --><!-- doxytag: inherits="Glib::Object" -->
 
44
<p>An <a class="el" href="classAtk_1_1Relation.html" title="An Atk::Relation describes a relation between an object and one or more other objects.">Atk::Relation</a> describes a relation between an object and one or more other objects. <a href="#_details">More...</a></p>
 
45
 
 
46
<p><code>#include &lt;atkmm/relation.h&gt;</code></p>
 
47
<!-- startSectionHeader --><div class="dynheader">
 
48
Inheritance diagram for Atk::Relation:<!-- endSectionHeader --></div>
 
49
<!-- startSectionSummary --><!-- endSectionSummary --><!-- startSectionContent --><div class="dyncontent">
 
50
<div class="center"><img src="classAtk_1_1Relation__inherit__graph.png" border="0" usemap="#Atk_1_1Relation_inherit__map" alt="Inheritance graph"/></div>
 
51
<map name="Atk_1_1Relation_inherit__map" id="Atk_1_1Relation_inherit__map">
 
52
<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>
 
54
 
 
55
<p><a href="classAtk_1_1Relation-members.html">List of all members.</a></p>
 
56
<table class="memberdecls">
 
57
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
58
Public Member Functions</h2></td></tr>
 
59
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0f2045c77cc80a3a33234c0b24502b5"></a><!-- doxytag: member="Atk::Relation::gobj" ref="ab0f2045c77cc80a3a33234c0b24502b5" args="()" -->
 
60
AtkRelation*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#ab0f2045c77cc80a3a33234c0b24502b5">gobj</a> ()</td></tr>
 
61
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
62
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adf1190c7f5b9bd05a2df6326de3be904"></a><!-- doxytag: member="Atk::Relation::gobj" ref="adf1190c7f5b9bd05a2df6326de3be904" args="() const " -->
 
63
const AtkRelation*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#adf1190c7f5b9bd05a2df6326de3be904">gobj</a> () const </td></tr>
 
64
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Provides access to the underlying C GObject. <br/></td></tr>
 
65
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a60670602a86a4812af0af5886c9845f7"></a><!-- doxytag: member="Atk::Relation::gobj_copy" ref="a60670602a86a4812af0af5886c9845f7" args="()" -->
 
66
AtkRelation*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a60670602a86a4812af0af5886c9845f7">gobj_copy</a> ()</td></tr>
 
67
<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
<tr><td class="memItemLeft" align="right" valign="top">RelationType&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a12a77bd41e0944dcd3092dd44b04a0c6">get_relation_type</a> () const </td></tr>
 
69
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the type of <em>relation</em>. <a href="#a12a77bd41e0944dcd3092dd44b04a0c6"></a><br/></td></tr>
 
70
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a4f4ad2f69975201108d77bc34d4337f8">add_target</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_1Object.html">Atk::Object</a> &gt;&amp; target)</td></tr>
 
71
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds the specified AtkObject to the target for the relation, if it is not already present. <a href="#a4f4ad2f69975201108d77bc34d4337f8"></a><br/></td></tr>
 
72
<tr><td colspan="2"><h2><a name="related"></a>
 
73
Related Functions</h2></td></tr>
 
74
<tr><td colspan="2"><p>(Note that these are not member functions.) </p>
 
75
<br/></td></tr>
 
76
<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_1Relation.html">Atk::Relation</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAtk_1_1Relation.html#a48d5c60d3a30600bdf456761fc34ef1f">wrap</a> (AtkRelation* object, bool take_copy=false)</td></tr>
 
77
<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="#a48d5c60d3a30600bdf456761fc34ef1f"></a><br/></td></tr>
 
78
</table>
 
79
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
80
<p>An <a class="el" href="classAtk_1_1Relation.html" title="An Atk::Relation describes a relation between an object and one or more other objects.">Atk::Relation</a> describes a relation between an object and one or more other objects. </p>
 
81
<p>The actual relations that an object has with other objects are defined as an <a class="el" href="classAtk_1_1RelationSet.html" title="A set of Atk::Relations, normally the set of AtkRelations which an Atk::Object has.">Atk::RelationSet</a>, which is a set of Atk::Relations. </p>
 
82
<hr/><h2>Member Function Documentation</h2>
 
83
<a class="anchor" id="a4f4ad2f69975201108d77bc34d4337f8"></a><!-- doxytag: member="Atk::Relation::add_target" ref="a4f4ad2f69975201108d77bc34d4337f8" args="(const Glib::RefPtr&lt; Atk::Object &gt; &amp;target)" -->
 
84
<div class="memitem">
 
85
<div class="memproto">
 
86
      <table class="memname">
 
87
        <tr>
 
88
          <td class="memname">void Atk::Relation::add_target </td>
 
89
          <td>(</td>
 
90
          <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_1Object.html">Atk::Object</a> &gt;&amp;&#160;</td>
 
91
          <td class="paramname"> <em>target</em>&#160;)</td>
 
92
          <td></td>
 
93
        </tr>
 
94
      </table>
 
95
</div>
 
96
<div class="memdoc">
 
97
 
 
98
<p>Adds the specified AtkObject to the target for the relation, if it is not already present. </p>
 
99
<p>See also <a class="el" href="classAtk_1_1Object.html#a8ccf42eed0a5625d4c46444c73412daa" title="Adds a relationship of the specified type with the specified target.">Atk::Object::add_relationship()</a>.</p>
 
100
<dl class="since_1_9"><dt><b><a class="el" href="since_1_9.html#_since_1_9000001">Since atkmm 1.9:</a></b></dt><dd></dd></dl>
 
101
<dl><dt><b>Parameters:</b></dt><dd>
 
102
  <table class="params">
 
103
    <tr><td class="paramname">target</td><td>An <a class="el" href="classAtk_1_1Object.html" title="The base object class for the Accessibility Toolkit API.">Atk::Object</a>. </td></tr>
 
104
  </table>
 
105
  </dd>
 
106
</dl>
 
107
 
 
108
</div>
 
109
</div>
 
110
<a class="anchor" id="a12a77bd41e0944dcd3092dd44b04a0c6"></a><!-- doxytag: member="Atk::Relation::get_relation_type" ref="a12a77bd41e0944dcd3092dd44b04a0c6" args="() const " -->
 
111
<div class="memitem">
 
112
<div class="memproto">
 
113
      <table class="memname">
 
114
        <tr>
 
115
          <td class="memname">RelationType Atk::Relation::get_relation_type </td>
 
116
          <td>(</td>
 
117
          <td class="paramname">&#160;)</td>
 
118
          <td> const</td>
 
119
        </tr>
 
120
      </table>
 
121
</div>
 
122
<div class="memdoc">
 
123
 
 
124
<p>Gets the type of <em>relation</em>. </p>
 
125
<dl class="return"><dt><b>Returns:</b></dt><dd>The type of <em>relation</em>. </dd></dl>
 
126
 
 
127
</div>
 
128
</div>
 
129
<hr/><h2>Friends And Related Function Documentation</h2>
 
130
<a class="anchor" id="a48d5c60d3a30600bdf456761fc34ef1f"></a><!-- doxytag: member="Atk::Relation::wrap" ref="a48d5c60d3a30600bdf456761fc34ef1f" args="(AtkRelation *object, bool take_copy=false)" -->
 
131
<div class="memitem">
 
132
<div class="memproto">
 
133
      <table class="memname">
 
134
        <tr>
 
135
          <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_1Relation.html">Atk::Relation</a> &gt; wrap </td>
 
136
          <td>(</td>
 
137
          <td class="paramtype">AtkRelation *&#160;</td>
 
138
          <td class="paramname"> <em>object</em>, </td>
 
139
        </tr>
 
140
        <tr>
 
141
          <td class="paramkey"></td>
 
142
          <td></td>
 
143
          <td class="paramtype">bool&#160;</td>
 
144
          <td class="paramname"> <em>take_copy</em> = <code>false</code>&#160;</td>
 
145
        </tr>
 
146
        <tr>
 
147
          <td></td>
 
148
          <td>)</td>
 
149
          <td></td><td><code> [related]</code></td>
 
150
        </tr>
 
151
      </table>
 
152
</div>
 
153
<div class="memdoc">
 
154
 
 
155
<p>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. </p>
 
156
<dl><dt><b>Parameters:</b></dt><dd>
 
157
  <table class="params">
 
158
    <tr><td class="paramname">object</td><td>The C instance. </td></tr>
 
159
    <tr><td class="paramname">take_copy</td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
 
160
  </table>
 
161
  </dd>
 
162
</dl>
 
163
<dl class="return"><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
 
164
 
 
165
</div>
 
166
</div>
 
167
</div>
 
168
<hr class="footer"/><address class="footer"><small>Generated on Sat Nov 20 2010 13:35:45 for atkmm by&#160;
 
169
<a href="http://www.doxygen.org/index.html">
 
170
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 
171
</body>
 
172
</html>