HelpSource/Classes/ListView.schelp

   1 CLASS:: ListView
   2 redirect:: implClass
   3 summary:: A view displaying a list of text items.
   4 categories:: GUI>Views
   5
   6 DESCRIPTION::
   7
   8 A view that displays a list of text items and allows one of them to be selected.
   9
  10 An item can be selected by clicking on it. Pressing the up or down arrow keys while an item is selected will select the previous or next item respectively (if available).
  11
  12 CLASSMETHODS::
  13
  14 PRIVATE:: key
  15
  16
  17
  18
  19 INSTANCEMETHODS::
  20
  21
  22
  23 SUBSECTION:: Data
  24
  25 METHOD:: items
  26         The list of items displayed by the view.
  27
  28         argument::
  29                 An Array of Strings, each String defining the text to represent an item.
  30
  31 METHOD:: value
  32         The index of the currently selected item, or nil when no item is selected.
  33
  34         argument::
  35                 An Integer or nil.
  36
  37 METHOD:: valueAction
  38         Sets link::#-value:: and triggers the link::#-action::.
  39
  40
  41
  42 SUBSECTION:: Appearance
  43
  44 METHOD:: colors
  45         The background colors of the items.
  46
  47         argument::
  48                 An Array of Colors, one Color for each item.
  49
  50 METHOD:: stringColor
  51         The color used to display all the text of all unselected items.
  52
  53         argument::
  54                 A Color.
  55
  56 METHOD:: selectedStringColor
  57         The color used to display the selected item's text.
  58
  59         argument::
  60                 A Color.
  61
  62 METHOD:: hiliteColor
  63         The color used to indicate the selected item (aside from the color of its text).
  64
  65         argument::
  66                 A Color.
  67
  68
  69
  70
  71 SUBSECTION:: Interaction
  72
  73 METHOD:: selectionMode
  74         note:: Only available in Qt GUI ::
  75
  76         The allowed mode of item selection, according to the following table:
  77
  78         table::
  79         ## strong::Value::  || strong::Meaning::
  80         ## \none            || No item can be selected.
  81         ## \single          || Only a single item can be selected at once.
  82         ## \multi           || Multiple items can be selected. An item's selection is toggled when clicked.
  83         ## \extended        || Multiple items can be selected, individually by holding the Ctrl key, and in a batch by holding the Shift key.
  84         ## \contiguous      || Mutliple neighbouring items can be selected by holding the Shift key.
  85         ::
  86
  87         arguments::
  88                 One of the Symbols listed in the table above.
  89
  90
  91
  92 SUBSECTION:: Actions
  93
  94 METHOD:: action
  95         The action object evaluated whenever the user changes the item selection.
  96
  97 METHOD:: enterKeyAction
  98         The action object evaluated whenever the user presses the Enter (Return) key.
  99
 100 METHOD:: defaultKeyDownAction
 101
 102         Implements the default effects of key presses as follows:
 103
 104         table::
 105         ## strong::Key::   || strong::Effect::
 106         ## space           || select next item and trigger action
 107         ## r               || trigger enterKeyAction
 108         ## n               || trigger enterKeyAction
 109         ## a number        || trigger enterKeyAction
 110         ## up arrow        || select previous item and trigger action
 111         ## down arrow      || select next item and trigger action
 112         ## left arrow      || select previous item and trigger action
 113         ## right arrow     || select next item and trigger action
 114         ::
 115
 116
 117
 118 SUBSECTION:: Drag and drop
 119
 120 METHOD:: defaultGetDrag
 121         returns::
 122                 The link::#-value::.
 123
 124 METHOD:: defaultCanReceiveDrag
 125         returns::
 126                 True if the current drag data is a number.
 127
 128 METHOD:: defaultReceiveDrag
 129         Sets link::#-valueAction:: to the current drag data.