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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>API docs for “kiwi.utils”</title>
<meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
<link href="apidocs.css" type="text/css" rel="stylesheet" />
</head>
<body>
<h1 class="module">Module k.utils</h1>
<p>
<span id="part">Part of <a href="kiwi.html">kiwi</a></span>
</p>
<div>
</div>
<div>GObject utilities and addons
<table class="fieldTable"></table></div>
<div id="splitTables">
<table class="children sortable" id="id358">
<tr class="function">
<td>Function</td>
<td><a href="kiwi.utils.html#list_properties">list_properties</a></td>
<td><span>Return a list of all properties for GType gtype, excluding
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.utils.html#type_register">type_register</a></td>
<td><span>Register the type, but only if it's not already registered
</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.utils._GObjectClassInittableMetaType.html">_GObjectClassInittableMetaType</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.utils._GobjectClassInittableObject.html">_GobjectClassInittableObject</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.utils.PropertyMeta.html">PropertyMeta</a></td>
<td><span>Metaclass that takes into account properties and signals
</span></td>
</tr><tr class="class">
<td>Class</td>
<td><a href="kiwi.utils.PropertyObject.html">PropertyObject</a></td>
<td><span>I am an object which maps GObject properties to attributes
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.utils.html#gsignal">gsignal</a></td>
<td><span>Add a GObject signal to the current object.
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.utils.html#_max">_max</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.utils.html#gproperty">gproperty</a></td>
<td><span>Add a GObject property to the current object.
</span></td>
</tr><tr class="function">
<td>Function</td>
<td><a href="kiwi.utils.html#quote">quote</a></td>
<td><span>Similar to urllib.quote but for glibs GMarkup
</span></td>
</tr>
</table>
</div>
<div class="function">
<a name="kiwi.utils.list_properties"></a>
<a name="list_properties"></a>
<div class="functionHeader">
def list_properties(gtype, parent=True):
</div>
<div class="functionBody">
<div>Return a list of all properties for GType gtype, excluding properties in
parent classes
<table class="fieldTable"></table></div>
</div>
</div><div class="function">
<a name="kiwi.utils.type_register"></a>
<a name="type_register"></a>
<div class="functionHeader">
def type_register(gtype):
</div>
<div class="functionBody">
<div>Register the type, but only if it's not already registered
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">gtype</td><td>the class to register
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.utils.gsignal"></a>
<a name="gsignal"></a>
<div class="functionHeader">
def gsignal(name, *args, **kwargs):
</div>
<div class="functionBody">
<div>Add a GObject signal to the current object. It current supports the
following types:
<ul>
<li>
str, int, float, long, object, enum
</li>
</ul>
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">name</td><td>name of the signal
(type: string
)</td></tr><tr><td></td><td class="fieldArg">args</td><td>types for signal parameters, if the first one is a string 'override',
the signal will be overridden and must therefor exists in the parent
GObject.
</td></tr><tr class="fieldStart"><td class="fieldName">Notes</td><td colspan="2">flags: A combination of;
<ul>
<li>
gobject.SIGNAL_RUN_FIRST
</li>
<li>
gobject.SIGNAL_RUN_LAST
</li>
<li>
gobject.SIGNAL_RUN_CLEANUP
</li>
<li>
gobject.SIGNAL_NO_RECURSE
</li>
<li>
gobject.SIGNAL_DETAILED
</li>
<li>
gobject.SIGNAL_ACTION
</li>
<li>
gobject.SIGNAL_NO_HOOKS
</li>
</ul>
</td></tr><tr><td></td><td colspan="2">retval: return value in signal callback
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.utils._max"></a>
<a name="_max"></a>
<div class="functionHeader">
def _max(c):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.utils.gproperty"></a>
<a name="gproperty"></a>
<div class="functionHeader">
def gproperty(name, ptype, default=None, nick='', blurb='', flags=gobject.PARAM_READWRITE, **kwargs):
</div>
<div class="functionBody">
<div>Add a GObject property to the current object.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">name</td><td>name of property
(type: string
)</td></tr><tr><td></td><td class="fieldArg">ptype</td><td>type of property
(type: type
)</td></tr><tr><td></td><td class="fieldArg">default</td><td>default value
</td></tr><tr><td></td><td class="fieldArg">nick</td><td>short description
</td></tr><tr><td></td><td class="fieldArg">blurb</td><td>long description
</td></tr><tr><td></td><td class="fieldArg">flags</td><td>parameter flags, a combination of:
<ul>
<li>
PARAM_READABLE
</li>
<li>
PARAM_READWRITE
</li>
<li>
PARAM_WRITABLE
</li>
<li>
PARAM_CONSTRUCT
</li>
<li>
PARAM_CONSTRUCT_ONLY
</li>
<li>
PARAM_LAX_VALIDATION
</li>
</ul>
Optional, only for int, float, long types:
</td></tr><tr class="fieldStart"><td class="fieldName">Notes</td><td colspan="2">minimum: minimum allowed value
</td></tr><tr><td></td><td colspan="2">maximum: maximum allowed value
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.utils.quote"></a>
<a name="quote"></a>
<div class="functionHeader">
def quote(msg):
</div>
<div class="functionBody">
<div>Similar to urllib.quote but for glibs GMarkup
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">msg</td><td>string to quote
</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">quoted string
</td></tr></table></div>
</div>
</div>
<address>
<a href="index.html">API Documentation</a> for Kiwi, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2008-05-29 16:06:17.
</address>
</body>
</html>
|
