/usr/share/doc/python-kiwi/api/kiwi.interfaces.IEasyCombo.html is in python-kiwi 1.9.22-4.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | <?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>kiwi.interfaces.IEasyCombo : API documentation</title>
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<link type="text/css" rel="stylesheet" href="bootstrap.min.css" />
<link type="text/css" rel="stylesheet" href="apidocs.css" />
</head>
<body>
<nav class="navbar navbar-default">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="index.html">
Kiwi API Documentation
</a>
</div>
</div>
</nav>
<div id="showPrivate">
<button class="btn btn-link" onclick="togglePrivate()">Toggle Private API</button>
</div>
<div class="container">
<div class="page-header">
<h1 class="class"><code>kiwi.interfaces.IEasyCombo(<a href="kiwi.component.Interface.html" data-type="Class" class="code">Interface</a>)</code> <small>class documentation</small></h1>
<span id="partOf">
Part of <code><a href="kiwi.html" data-type="Package" class="code">kiwi</a>.<a href="kiwi.interfaces.html" data-type="Module" class="code">interfaces</a></code>
<a href="classIndex.html#kiwi.interfaces.IEasyCombo">(View In Hierarchy)</a>
</span>
</div>
<div class="extrasDocstring">
</div>
<div class="moduleDocstring">
<div class="undocumented">No class docstring</div>
</div>
<div id="splitTables">
<table class="children sortable" id="id105">
<tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#prefill" data-type="Method" class="code">prefill</a></td>
<td><span>Fills the Combo with listitems corresponding to the itemdata
provided.</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#append_item" data-type="Method" class="code">append_item</a></td>
<td><span>Adds a single item to the Combo. @param label: a string with the text to
be added @param data: the data to be associated with that item</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#clear" data-type="Method" class="code">clear</a></td>
<td><span>Removes all items from the widget</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#select" data-type="Method" class="code">select</a></td>
<td><span>Select an item giving data which could be an object or text. @param
data: data or text to select</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#select_item_by_position" data-type="Method" class="code">select_item_by_position</a></td>
<td><span>Selects an item in the combo from a integer where 0 represents the first
item. @param position: an integer</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#select_item_by_label" data-type="Method" class="code">select_item_by_label</a></td>
<td><span>Select item given text. @param text: text to select</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#select_item_by_data" data-type="Method" class="code">select_item_by_data</a></td>
<td><span>Select item given data. @param data: object to select</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#get_selected_label" data-type="Method" class="code">get_selected_label</a></td>
<td><span>Gets the label of the currently selected item. @returns: the selected
label.</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#get_selected_data" data-type="Method" class="code">get_selected_data</a></td>
<td><span>Gets the data of the the currently selected item. @returns: the selected
data.</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#get_selected" data-type="Method" class="code">get_selected</a></td>
<td><span>Get the text or item of the currently selected item or None if nothing
is selected. @returns: selected text or item or None.</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#get_model_strings" data-type="Method" class="code">get_model_strings</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.interfaces.IEasyCombo.html#get_model_items" data-type="Method" class="code">get_model_items</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
<p class="inheritedFrom">
Inherited from <a href="kiwi.component.Interface.html" data-type="Class" class="code">Interface</a>:
</p>
<table class="children sortable" id="id106">
<tr class="baseclassmethod">
<td>Class Method</td>
<td><a href="kiwi.component.Interface.html#providedBy" data-type="Class Method" class="code">providedBy</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div id="childList">
<div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.prefill">
</a>
<a name="prefill">
</a>
<div class="functionHeader">
def
prefill(itemdata, sort=False):
</div>
<div class="docstring functionBody">
<div><p>Fills the Combo with listitems corresponding to the itemdata
provided.</p>
<p>Parameters:</p>
<ul>
<li>
itemdata is a list of strings or tuples, each item corresponding to a
listitem. The simple list format is as follows:
<pre class="literalblock">
</pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>[ label0, label1, label2 ]</pre>
<p>If you require a data item to be specified for each item, use a
2-item tuple for each element. The format is as follows:</p>
<pre class="literalblock">
</pre>
<pre class="py-doctest">
<span class="py-prompt">>>> </span>[ ( label0, data0 ), (label1, data1), ... ]</pre>
</li>
<li>
Sort is a boolean that specifies if the list is to be sorted by label
or not. By default it is not sorted
</li>
</ul><table class="fieldTable"></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.append_item">
</a>
<a name="append_item">
</a>
<div class="functionHeader">
def
append_item(label, data=None):
</div>
<div class="docstring functionBody">
<div><p>Adds a single item to the Combo.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">label</td><td>a string with the text to be added</td></tr><tr><td></td><td class="fieldArg">data</td><td>the data to be associated with that item</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.clear">
</a>
<a name="clear">
</a>
<div class="functionHeader">
def
clear():
</div>
<div class="docstring functionBody">
<div><p>Removes all items from the widget</p><table class="fieldTable"></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.select">
</a>
<a name="select">
</a>
<div class="functionHeader">
def
select(data):
</div>
<div class="docstring functionBody">
<div><p>Select an item giving data which could be an object or text.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">data</td><td>data or text to select</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.select_item_by_position">
</a>
<a name="select_item_by_position">
</a>
<div class="functionHeader">
def
select_item_by_position(position):
</div>
<div class="docstring functionBody">
<div><p>Selects an item in the combo from a integer where 0 represents the first
item.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">position</td><td>an integer</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.select_item_by_label">
</a>
<a name="select_item_by_label">
</a>
<div class="functionHeader">
def
select_item_by_label(text):
</div>
<div class="docstring functionBody">
<div><p>Select item given text.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">text</td><td>text to select</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.select_item_by_data">
</a>
<a name="select_item_by_data">
</a>
<div class="functionHeader">
def
select_item_by_data(data):
</div>
<div class="docstring functionBody">
<div><p>Select item given data.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">data</td><td>object to select</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.get_selected_label">
</a>
<a name="get_selected_label">
</a>
<div class="functionHeader">
def
get_selected_label():
</div>
<div class="docstring functionBody">
<div><p>Gets the label of the currently selected item.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the selected label.</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.get_selected_data">
</a>
<a name="get_selected_data">
</a>
<div class="functionHeader">
def
get_selected_data():
</div>
<div class="docstring functionBody">
<div><p>Gets the data of the the currently selected item.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the selected data.</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.get_selected">
</a>
<a name="get_selected">
</a>
<div class="functionHeader">
def
get_selected():
</div>
<div class="docstring functionBody">
<div><p>Get the text or item of the currently selected item or None if nothing
is selected.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">selected text or item or None.</td></tr></table></div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.get_model_strings">
</a>
<a name="get_model_strings">
</a>
<div class="functionHeader">
def
get_model_strings():
</div>
<div class="docstring functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="basemethod">
<a name="kiwi.interfaces.IEasyCombo.get_model_items">
</a>
<a name="get_model_items">
</a>
<div class="functionHeader">
def
get_model_items():
</div>
<div class="docstring functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div>
</div>
<address>
<a href="index.html">API Documentation</a> for Kiwi, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> at 2015-12-15 11:23:22.
</address>
</div>
<script type="text/javascript" src="pydoctor.js"></script>
</body>
</html>
|