HelpSource/Classes/TreeView.schelp

   1 CLASS:: TreeView
   2 redirect:: implClass
   3 summary:: A view displaying a tree of items with columns
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7
   8 A view that displays a hierarchy of items. It is divided into rows and column: each row represents an item, and each column represents a different data field of the items.
   9
  10 The items are represented in code by instances of link::Classes/QTreeViewItem::, returned by the various TreeView methods. Top level items are added via the TreeView interface, while child items are added via the QTreeViewItem interface, which also allows to manipulate items in more detail after their creation.
  11
  12 Items can be visually sorted with link::#-sort::, or by clicking on one of the column headers, if link::#-canSort:: is enabled.
  13
  14 Each item can hold other views in each of its data fields, which allows for rich graphical interaction. See link::Classes/QTreeViewItem#-setView::.
  15
  16
  17 CLASSMETHODS::
  18
  19 PRIVATE:: key
  20
  21 INSTANCEMETHODS::
  22
  23 PRIVATE:: prForEachColumnDataPair
  24 PRIVATE:: prValidItem
  25
  26
  27 SUBSECTION:: Data
  28
  29 METHOD:: columns
  30         Gets or sets the number of columns (data fields) and their names. When setting a smaller number of columns than the current the extra columns will be removed, and hence all the data stored stored in those columns.
  31
  32         ARGUMENT::
  33                 An array of Strings for column names.
  34
  35 METHOD:: numColumns
  36         The total number of columns (data fields).
  37
  38 METHOD:: addItem
  39         Append a new top-level item.
  40
  41         ARGUMENT:: strings
  42                 An array of Strings (or nil), each for the text of one data field.
  43         RETURNS::
  44                 An instance of QTreeViewItem representing the new item.
  45
  46 METHOD:: insertItem
  47         Insert a new top-level item at code::index::.
  48
  49         ARGUMENT:: index
  50                 The position at which to insert the item.
  51         ARGUMENT:: strings
  52                 An array of Strings (or nil), each for the text of one data field.
  53         RETURNS::
  54                 An instance of QTreeViewItem representing the new item.
  55
  56 METHOD:: removeItem
  57         Remove the given code::item::. After the item is removed, any usage of the related QTreeViewItems will have no effect.
  58
  59         ARGUMENT::
  60                 An instance of QTreeViewItem.
  61
  62 METHOD:: numItems
  63         The total number of items.
  64
  65 METHOD:: currentItem
  66         Gets or sets the currently selected item.
  67
  68         ARGUMENT::
  69                 An instance of QTreeViewItem.
  70         RETURNS::
  71                 An instance of QTreeViewItem or nil, if no current item.
  72
  73 METHOD:: itemAt
  74         The item at code::index::.
  75
  76
  77
  78 SUBSECTION:: Appearance
  79
  80 METHOD:: sort
  81         Sort items by data in code::column::. This works regardless of link::#-canSort::.
  82
  83         NOTE:: Sorting has no effect on the logical order of the items, it only affects how they are displayed. ::
  84
  85         ARGUMENT:: column
  86                 The integer column index to sort by.
  87         ARGUMENT:: descending
  88                 Whether to sort in descending or ascending fashion. The default is ascending.
  89
  90 PRIVATE:: background
  91
  92
  93 SUBSECTION:: Interaction
  94
  95 METHOD:: canSort
  96         Whether the user can sort the items by clicking on a column header.
  97
  98         When setting to code::true::, the items will be sorted immediately according to the current sorting column. While code::true::, the view will also automatically sort new items.
  99
 100         The default is code::false::.
 101
 102         See also: link::#-sort::.
 103
 104
 105
 106
 107 SUBSECTION:: Actions
 108
 109 METHOD:: itemPressedAction
 110         The object to be evaluated when a mouse button is pressed on an item, passing this view as the argument.
 111
 112 METHOD:: onItemChanged
 113         The object to be evaluated whenever the current item changes, passing this view as the argument.