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 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
|
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html>
<head>
<title>API docs for “kiwi.ui.objectlist.ObjectTree”</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="class">Class k.u.o.ObjectTree(<a href="kiwi.ui.objectlist.ObjectList.html">ObjectList</a>):</h1>
<p>
<span id="part">Part of <a href="kiwi.html">kiwi</a>.<a href="kiwi.ui.html">ui</a>.<a href="kiwi.ui.objectlist.html">objectlist</a></span>
<a href="classIndex.html#kiwi.ui.objectlist.ObjectTree">View In Hierarchy</a>
</p>
<div>
</div>
<div><h1 class="heading">Signals</h1>
<ul>
<li>
<b>row-expanded</b> (list, object):
<ul>
<li>
Emitted when a row is "expanded", eg the littler
arrow to the left is opened. See the GtkTreeView documentation
for more information.
</li>
</ul>
</li>
</ul>
<table class="fieldTable"></table></div>
<div id="splitTables">
<table class="children sortable" id="id256">
<tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#__init__">__init__</a></td>
<td><span>Create a new ObjectList object.
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#_append_internal">_append_internal</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#append">append</a></td>
<td><span>Append the selected row in an instance.
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#prepend">prepend</a></td>
<td><span>Prepend the selected row in an instance.
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#expand">expand</a></td>
<td><span>This method opens the row specified by path so its children
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#collapse">collapse</a></td>
<td><span>This method collapses the row specified by path
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#get_root">get_root</a></td>
<td><span>This method returns the root object of a certain instance. If
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#get_descendants">get_descendants</a></td>
<td><span>This method returns the descendants objects of a certain instance.
</span></td>
</tr><tr class="method">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectTree.html#_on_treeview__row_expanded">_on_treeview__row_expanded</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
<p>
Inherited from <a href="kiwi.ui.objectlist.ObjectList.html">ObjectList</a>:
</p>
<table class="children sortable" id="id257">
<tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#__len__">__len__</a></td>
<td><span>len(list)
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#__nonzero__">__nonzero__</a></td>
<td><span>if list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#__contains__">__contains__</a></td>
<td><span>item in list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#__iter__">__iter__</a></td>
<td><span>for item in list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#__getitem__">__getitem__</a></td>
<td><span>list[n]
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#__setitem__">__setitem__</a></td>
<td><span>list[n] = m
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#extend">extend</a></td>
<td><span>Extend list by appending elements from the iterable
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#index">index</a></td>
<td><span>Return first index of value
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#count">count</a></td>
<td><span>L.count(item) -> integer -- return number of occurrences of value
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#insert">insert</a></td>
<td><span>Inserts an instance to the list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#pop">pop</a></td>
<td><span>Remove and return item at index (default last)
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#reverse">reverse</a></td>
<td><span>L.reverse() -- reverse *IN PLACE*
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#sort">sort</a></td>
<td><span>L.sort(cmp=None, key=None, reverse=False) -- stable sort *IN PLACE*;
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#sort_by_attribute">sort_by_attribute</a></td>
<td><span>Sort by an attribute in the object model.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#set_context_menu">set_context_menu</a></td>
<td><span>Sets a context-menu (eg, when you right click) for the list.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#prop_set_selection_mode">prop_set_selection_mode</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#prop_get_selection_mode">prop_get_selection_mode</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_load">_load</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_setup_columns">_setup_columns</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_attach_column">_attach_column</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_select_and_focus_row">_select_and_focus_row</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_model__row_inserted">_on_model__row_inserted</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_model__row_deleted">_on_model__row_deleted</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_model_sort_func">_model_sort_func</a></td>
<td><span>This method is used to sort the GtkTreeModel
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_selection__changed">_on_selection__changed</a></td>
<td><span>This method is used to proxy selection::changed to selection-changed
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_scrolled_window__realize">_on_scrolled_window__realize</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_scrolled_window__size_allocate">_on_scrolled_window__size_allocate</a></td>
<td><span>Resize the Vertical Scrollbar to make it smaller and let space
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_treeview_search_equal_func">_treeview_search_equal_func</a></td>
<td><span>for searching inside the treeview, case-insensitive by default
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_treeview_header__button_release_event">_on_treeview_header__button_release_event</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_after_treeview__row_activated">_after_treeview__row_activated</a></td>
<td><span>After activated (double clicked or pressed enter) on a row
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_get_selection_or_selected_rows">_get_selection_or_selected_rows</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_emit_button_press_signal">_emit_button_press_signal</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_treeview__button_press_event">_on_treeview__button_press_event</a></td>
<td><span>Generic button-press-event handler to be able to catch double clicks
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_on_treeview__source_drag_data_get">_on_treeview__source_drag_data_get</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_get_column_button">_get_column_button</a></td>
<td><span>Return the button widget of a particular TreeViewColumn.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_setup_popup_button">_setup_popup_button</a></td>
<td><span>Put a button on top of the vertical scrollbar to show the popup
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_find_vertical_scrollbar">_find_vertical_scrollbar</a></td>
<td><span>This method is called from a .forall() method in the ScrolledWindow.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_get_header_height">_get_header_height</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_model">get_model</a></td>
<td><span>Return treemodel of the current list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_treeview">get_treeview</a></td>
<td><span>Return treeview of the current list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_columns">get_columns</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_column_by_name">get_column_by_name</a></td>
<td><span>Returns the name of a column
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_treeview_column">get_treeview_column</a></td>
<td><span>Get the treeview column given an objectlist column
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#set_spinbutton_digits">set_spinbutton_digits</a></td>
<td><span>Set the number of precision digits used by the spinbutton in
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#grab_focus">grab_focus</a></td>
<td><span>Grabs the focus of the ObjectList
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_clear_columns">_clear_columns</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#set_columns">set_columns</a></td>
<td><span>Set columns.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#_remove">_remove</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#remove">remove</a></td>
<td><span>Remove an instance from the list.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#update">update</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#refresh">refresh</a></td>
<td><span>Reloads the values from all objects.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#set_column_visibility">set_column_visibility</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_selection_mode">get_selection_mode</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#set_selection_mode">set_selection_mode</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#unselect_all">unselect_all</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#select_paths">select_paths</a></td>
<td><span>Selects a number of rows corresponding to paths
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#select">select</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_selected">get_selected</a></td>
<td><span>Returns the currently selected object
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_selected_rows">get_selected_rows</a></td>
<td><span>Returns a list of currently selected objects
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#add_list">add_list</a></td>
<td><span>Allows a list to be loaded, by default clearing it first.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#clear">clear</a></td>
<td><span>Removes all the instances of the list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_next">get_next</a></td>
<td><span>Returns the item after instance in the list.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_previous">get_previous</a></td>
<td><span>Returns the item before instance in the list.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_selected_row_number">get_selected_row_number</a></td>
<td><span>Get the selected row number or None if no rows were selected
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#double_click">double_click</a></td>
<td><span>Same as double clicking on the row rowno
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#set_headers_visible">set_headers_visible</a></td>
<td><span>Show or hide the headers.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#set_visible_rows">set_visible_rows</a></td>
<td><span>Sets the number of visible rows of the treeview. This is useful to
use
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#enable_dnd">enable_dnd</a></td>
<td><span>Enables Drag and Drop from this object list
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.ui.objectlist.ObjectList.html#get_dnd_targets">get_dnd_targets</a></td>
<td><span>Get a list of dnd targets ObjectList supports
</span></td>
</tr>
</table>
<p>
Inherited from <a href="kiwi.utils.PropertyObject.html">PropertyObject</a> (via <a href="kiwi.ui.objectlist.ObjectList.html">ObjectList</a>):
</p>
<table class="children sortable" id="id258">
<tr class="baseclassmethod">
<td>Class Method</td>
<td><a href="kiwi.utils.PropertyObject.html#__class_init__">__class_init__</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.utils.PropertyObject.html#__post_init__">__post_init__</a></td>
<td><span>A hook which is called after the constructor is called.
</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.utils.PropertyObject.html#_set">_set</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.utils.PropertyObject.html#_get">_get</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.utils.PropertyObject.html#get_attribute_names">get_attribute_names</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.utils.PropertyObject.html#is_default_value">is_default_value</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.utils.PropertyObject.html#do_set_property">do_set_property</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr><tr class="basemethod">
<td>Method</td>
<td><a href="kiwi.utils.PropertyObject.html#do_get_property">do_get_property</a></td>
<td><span class="undocumented">Undocumented</span></td>
</tr>
</table>
</div>
<div class="function">
<a name="kiwi.ui.objectlist.ObjectTree.__init__"></a>
<a name="__init__"></a>
<div class="functionHeader">
def __init__(self, columns=, objects=None, mode=gtk.SELECTION_BROWSE, sortable=False, model=None):
</div>
<div class="functionBody">
<div class="interfaceinfo">overrides <a href="kiwi.ui.objectlist.ObjectList.html#__init__">kiwi.ui.objectlist.ObjectList.__init__</a></div>
<div>Create a new ObjectList object.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">columns</td><td>a list of <a
href="kiwi.ui.objectlist.Column.html"><code>Column</code></a>s
</td></tr><tr><td></td><td class="fieldArg">objects</td><td>a list of objects to be inserted or None
</td></tr><tr><td></td><td class="fieldArg">mode</td><td>selection mode
</td></tr><tr><td></td><td class="fieldArg">sortable</td><td>whether the user can sort the list
</td></tr><tr><td></td><td class="fieldArg">model</td><td>gtk.TreeModel to use or None to create one
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree._append_internal"></a>
<a name="_append_internal"></a>
<div class="functionHeader">
def _append_internal(self, parent, instance, select, prepend):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree.append"></a>
<a name="append"></a>
<div class="functionHeader">
def append(self, parent, instance, select=False):
</div>
<div class="functionBody">
<div class="interfaceinfo">overrides <a href="kiwi.ui.objectlist.ObjectList.html#append">kiwi.ui.objectlist.ObjectList.append</a></div>
<div>Append the selected row in an instance.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">parent</td><td>Object or None, representing the parent
</td></tr><tr><td></td><td class="fieldArg">instance</td><td>the instance to be added
</td></tr><tr><td></td><td class="fieldArg">select</td><td>select the row
</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the appended object
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree.prepend"></a>
<a name="prepend"></a>
<div class="functionHeader">
def prepend(self, parent, instance, select=False):
</div>
<div class="functionBody">
<div>Prepend the selected row in an instance.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">parent</td><td>Object or None, representing the parent
</td></tr><tr><td></td><td class="fieldArg">instance</td><td>the instance to be added
</td></tr><tr><td></td><td class="fieldArg">select</td><td>select the row
</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">the prepended object
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree.expand"></a>
<a name="expand"></a>
<div class="functionHeader">
def expand(self, instance, open_all=True):
</div>
<div class="functionBody">
<div>This method opens the row specified by path so its children are
visible.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">instance</td><td>an instance to expand at
</td></tr><tr><td></td><td class="fieldArg">open_all</td><td>If True, expand all rows, otherwise just the immediate children
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree.collapse"></a>
<a name="collapse"></a>
<div class="functionHeader">
def collapse(self, instance):
</div>
<div class="functionBody">
<div>This method collapses the row specified by path (hides its child rows,
if they exist).
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">instance</td><td>an instance to collapse
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree.get_root"></a>
<a name="get_root"></a>
<div class="functionHeader">
def get_root(self, instance):
</div>
<div class="functionBody">
<div>This method returns the root object of a certain instance. If the
instance is the root, then returns the given instance.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">instance</td><td>an instance which we want the root object
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree.get_descendants"></a>
<a name="get_descendants"></a>
<div class="functionHeader">
def get_descendants(self, root_instance):
</div>
<div class="functionBody">
<div>This method returns the descendants objects of a certain instance. If
the given instance is a leaf, then return an empty sequence.
<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">root_instance</td><td>an instance which we want the descendants
</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">a sequence of descendants objects
</td></tr></table></div>
</div>
</div><div class="function">
<a name="kiwi.ui.objectlist.ObjectTree._on_treeview__row_expanded"></a>
<a name="_on_treeview__row_expanded"></a>
<div class="functionHeader">
def _on_treeview__row_expanded(self, treeview, treeiter, treepath):
</div>
<div class="functionBody">
<div class="undocumented">Undocumented</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>
|