blob: c03214aa4bad1108f5f04e1a88a39dcb221c2a4e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtktreerowreference">
<refnamediv>
<refname>gtk.TreeRowReference</refname>
<refpurpose>an object maintaining a persistent reference to a <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
row (new in PyGTK 2.4)</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.TreeRowReference</classname></ooclass>
<ooclass><classname>gobject.GBoxed</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-gtktreerowreference">gtk.TreeRowReference</link></methodname>
<methodparam><parameter role="keyword">model</parameter></methodparam>
<methodparam><parameter role="keyword">path</parameter></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktreerowreference--get-path">get_path</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktreerowreference--get-model">get_model</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktreerowreference--valid">valid</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktreerowreference--copy">copy</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link linkend="method-gtktreerowreference--free">free</link></methodname>
<methodparam></methodparam>
</methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Description</title>
<note>
<para>This object is available in PyGTK 2.4 and above.</para>
</note>
<para>A <link
linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link>
is an object that points to a row in a <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link>
similar to a <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>. A
<link
linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link>,
unlike a <link
linkend="class-gtktreeiter"><classname>gtk.TreeIter</classname></link>,
maintains a persistent reference in spite of changes in the model.</para>
</refsect1>
<refsect1 id="constructor-gtktreerowreference">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.TreeRowReference</methodname>
<methodparam><parameter role="keyword">model</parameter></methodparam>
<methodparam><parameter role="keyword">path</parameter></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">model</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gtktreemodel"><classname>gtk.TreeModel</classname></link></simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">path</parameter> :</term>
<listitem><simpara>a valid tree path to monitor</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gtktreerowreference"><classname>gtk.TreeRowReference</classname></link>,
or <literal>None</literal></simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This constructor is available in PyGTK 2.4 and above.</para>
</note>
<para>Creates a row reference pointing to the treemodel row specified by
<parameter>model</parameter> and <parameter>path</parameter>. This reference
will continue pointing to the node in spite of changes in
<parameter>model</parameter>. It listens to all signals emitted by
<parameter>model</parameter>, and updates its path appropriately. If
<parameter>path</parameter> isn't a valid path in
<parameter>model</parameter>, <literal>None</literal> is returned.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtktreerowreference--get-path">
<title>gtk.TreeRowReference.get_path</title>
<programlisting><methodsynopsis language="python">
<methodname>get_path</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>A current path, or
<literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>get_path</methodname>() method returns the path
that the row reference currently points to, or <literal>None</literal> if
the path pointed to is no longer valid.</para>
</refsect2>
<refsect2 id="method-gtktreerowreference--get-model">
<title>gtk.TreeRowReference.get_model</title>
<programlisting><methodsynopsis language="python">
<methodname>get_model</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>the model, or
<literal>None</literal>.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.8 and above.</para>
</note>
<para>The <methodname>get_model</methodname>() method returns the
model that the row reference currently monitors, or <literal>None</literal>
if the model is not set.</para>
</refsect2>
<refsect2 id="method-gtktreerowreference--valid">
<title>gtk.TreeRowReference.valid</title>
<programlisting><methodsynopsis language="python">
<methodname>valid</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the row reference
points to a valid path.</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>valid</methodname>() method returns
<literal>True</literal> if the row reference is not <literal>None</literal>
and refers to a current valid path.</para>
</refsect2>
<refsect2 id="method-gtktreerowreference--copy">
<title>gtk.TreeRowReference.copy</title>
<programlisting><methodsynopsis language="python">
<methodname>copy</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a copy of the row reference</simpara></listitem>
</varlistentry>
</variablelist>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<para>The <methodname>copy</methodname>() method returns a copy of the
tree row reference.</para>
</refsect2>
<refsect2 id="method-gtktreerowreference--free">
<title>gtk.TreeRowReference.free</title>
<programlisting><methodsynopsis language="python">
<methodname>free</methodname>
<methodparam></methodparam>
</methodsynopsis></programlisting>
<note>
<para>This method is available in PyGTK 2.4 and above.</para>
</note>
<warning>
<para>This method is deprecated and should not be used since it may
crash your application.</para>
</warning>
<para>The free() method frees the tree row reference. The row
reference may be <literal>None</literal>.</para>
</refsect2>
</refsect1>
</refentry>
|
