HelpSource/Classes/QTreeViewItem.schelp

   1 CLASS:: QTreeViewItem
   2 summary:: An item in QTreeView
   3 categories:: GUI>Kits>Qt
   4
   5 DESCRIPTION::
   6
   7 An instance of QTreeViewItem represents an item in QTreeView. There may be multiple instances representing the same item, e.g. after calling link::Classes/TreeView#-currentItem:: multiple times.
   8
   9 INSTANCEMETHODS::
  10
  11 PRIVATE:: prValidItem
  12
  13 METHOD:: index
  14         RETURNS:: An integer position of this item among its siblings.
  15
  16 METHOD:: parent
  17         RETURNS:: An new instance of QTreeViewItem representing the parent item.
  18
  19 METHOD:: childAt
  20         RETURNS:: A new instance of QTreeViewItem representing the child item at code::index::.
  21
  22 METHOD:: addChild
  23         Appends a new child to this item.
  24
  25         ARGUMENT:: strings
  26                 An array of Strings (or nil), each for the text of one data field.
  27         RETURNS::
  28                 An instance of QTreeViewItem representing the new item.
  29
  30 METHOD:: insertChild
  31         Inserts a new child to this item at code::index::.
  32
  33         ARGUMENT:: index
  34                 The position at which to insert the child.
  35         ARGUMENT:: strings
  36                 An array of Strings (or nil), each for the text of one data field.
  37         RETURNS::
  38                 An instance of QTreeViewItem representing the new item.
  39
  40 METHOD:: strings
  41         The text in the data fields.
  42
  43         ARGUMENT:: strings
  44                 An array of Strings (or nil), each for the text of one data field.
  45
  46 METHOD:: setString
  47         Sets the text in the given data field.
  48
  49         ARGUMENT:: column
  50                 An integer index of a data field.
  51         ARGUMENT:: string
  52                 A String or nil.
  53
  54 METHOD:: colors
  55         The background colors of the data fields.
  56
  57         ARGUMENT:: colors
  58                 An array of Colors, each for the color of one data field.
  59
  60 METHOD:: setColor
  61         Sets the background color of the given data field.
  62
  63         ARGUMENT:: column
  64                 An integer index of a data field.
  65         ARGUMENT:: color
  66                 A Color.
  67
  68 METHOD:: textColors
  69         The text colors of the data fields.
  70
  71         ARGUMENT:: colors
  72                 An array of Colors, each for the color of one data field.
  73
  74 METHOD:: setTextColor
  75         Sets the text color of the given data field.
  76
  77         ARGUMENT:: column
  78                 An integer index of a data field.
  79         ARGUMENT:: color
  80                 A Color.
  81
  82 METHOD:: setView
  83         Places another view into the given data field. Only one view can be placed into a data field at once. If a view is already present, it will be removed and destroyed.
  84
  85         If the number of data fields decreases due to a call to link::Classes/TreeView#-columns::, the views contained in removed data fields will also be removed and destroyed.
  86
  87         ARGUMENT:: column
  88                 An integer index of a data field.
  89         ARGUMENT:: view
  90                 A View.
  91
  92 METHOD:: removeView
  93         Removes the view from the given data field, if any.
  94
  95         ARGUMENT:: column
  96                 An integer index of a data field.
  97
  98 METHOD:: view
  99         The view in the given data field.
 100
 101         ARGUMENT:: column
 102                 An integer index of a data field.
 103
 104 METHOD:: ==
 105         Implements equality comparison between two QTreeViewItem instances. Two instances are equal if they represent the same item in QTreeView.
 106
 107         RETURNS:: A Boolean.
 108
 109 METHOD:: isNull
 110         Whether the item is invalid. After an item is removed, all related QTreeViewItem instances become invalid.
 111
 112         RETURNS:: A Boolean.