workbench/classes/zune/nlist/docs/MCC_NListview.doc

   1 TABLE OF CONTENTS
   2
   3 NListview.mcc/NListview.mcc
   4 NListview.mcc/MUIA_NListview_Horiz_ScrollBar
   5 NListview.mcc/MUIA_NListview_HSB_Height
   6 NListview.mcc/MUIA_NListview_NList
   7 NListview.mcc/MUIA_NListview_Vert_ScrollBar
   8 NListview.mcc/MUIA_NListview_VSB_Width
   9 \fNListview.mcc/NListview.mcc
  10
  11         That MCC public custom class give scrollers for a
  12         NList public custom class to make NList/NListview
  13         work near the same way as List/Listview.
  14
  15         Most things that were handled by Listview are now
  16         handled by NList, so NListview is quite simple,
  17         anyway it's very easier to use NList with NListview
  18         than without.
  19
  20         Anyway, use NList without NListview if you don't
  21         want to get attached scrollers (or want to attach
  22         your own scrollers to NList - see Demo).
  23
  24         Note: NListview class can't use List as child but
  25               only NList, NFloattext, or a NList subclass,
  26               and NList class will not work with Listview
  27               without some conflict.
  28
  29 \fNListview.mcc/MUIA_NListview_Horiz_ScrollBar
  30
  31     NAME
  32         MUIA_NListview_Horiz_ScrollBar -- [ISG], Object *
  33
  34     SPECIAL INPUTS
  35         MUIV_NListview_HSB_Always      1
  36         MUIV_NListview_HSB_Auto        2
  37         MUIV_NListview_HSB_FullAuto    3
  38         MUIV_NListview_HSB_None        4
  39         MUIV_NListview_HSB_Default     5
  40
  41     SPECIAL SPECIAL INPUTS
  42         MUIV_NListview_HSB_On          0x0300
  43         MUIV_NListview_HSB_Off         0x0100
  44
  45     FUNCTION
  46         With it you can tell if you want the scrollbar to be here
  47         always, never, automatic (not at start and appear forever if
  48         needed) or full automatic (appear and disappear when needed).
  49
  50         Never is interesting if you want only one scrollbar of both
  51         or if you want to attach your own one only for one scrollbar.
  52
  53         With Auto and FullAuto modes, scrollbars will not appear at
  54         first draw of the window. If you want it to appear when the
  55         window will be opened, you can set after creation time (not
  56         at init) MUIA_NListview_Horiz_ScrollBar
  57         to (MUIV_NListview_HSB_XXX|MUIV_NListview_HSB_On) where XXX
  58         is Default, FullAuto ...
  59
  60         MUIV_NListview_HSB_On, MUIV_NListview_HSB_Off are used by the
  61         NList object to make scrollbars appear/disappear.
  62
  63         The default is set by prefs. When prefs have not been set
  64         it is MUIV_NListview_HSB_Auto.
  65
  66     SEE ALSO
  67         MUIA_NListview_Vert_ScrollBar
  68 \fNListview.mcc/MUIA_NListview_HSB_Height
  69
  70     NAME
  71         MUIA_NListview_HSB_Height -- [..G], LONG
  72
  73     FUNCTION
  74         Return the height of the horizontal scrollbar.
  75
  76         Return 0 when no horizontal scrollbar is visible.
  77
  78     SEE ALSO
  79         MUIA_NListview_VSB_Width
  80 \fNListview.mcc/MUIA_NListview_NList
  81
  82     NAME
  83         MUIA_NListview_NList -- [I.G], Object *
  84
  85     FUNCTION
  86         Same function as Listview.mui/MUIA_Listview_List.
  87
  88         Every NListview needs a NList (or subclass) object as child.
  89         You should specify it here.
  90
  91         If you don't specify one, NListview will create a NList object
  92         as child, giving it the same taglist as itself.
  93         It's the only case where NList tags given to NListview will be
  94         taken into account.
  95
  96         As every other child, it will get disposes when
  97         its parent object is disposed.
  98
  99     SEE ALSO
 100         NList.mcc
 101 \fNListview.mcc/MUIA_NListview_Vert_ScrollBar
 102
 103     NAME
 104         MUIA_NListview_Vert_ScrollBar -- [ISG], Object *
 105
 106     SPECIAL INPUTS
 107         MUIV_NListview_VSB_Always      1
 108         MUIV_NListview_VSB_Auto        2
 109         MUIV_NListview_VSB_FullAuto    3
 110         MUIV_NListview_VSB_None        4
 111         MUIV_NListview_VSB_Default     5
 112         MUIV_NListview_VSB_Left        6
 113
 114     SPECIAL SPECIAL INPUTS
 115         MUIV_NListview_VSB_On          0x0030
 116         MUIV_NListview_VSB_Off         0x0010
 117
 118     FUNCTION
 119         Same as MUIA_NListview_Horiz_ScrollBar but for vertical
 120         scrollbar.
 121
 122         The default is set by prefs. When prefs have not been set
 123         it is MUIV_NListview_VSB_Always.
 124
 125     SEE ALSO
 126         MUIA_NListview_Horiz_ScrollBar
 127 \fNListview.mcc/MUIA_NListview_VSB_Width
 128
 129     NAME
 130         MUIA_NListview_VSB_Width -- [..G], LONG
 131
 132     FUNCTION
 133         Return the width of the vertical scrollbar.
 134
 135         Return 0 when no vertical scrollbar is visible.
 136
 137     SEE ALSO
 138         MUIA_NListview_HSB_Height
 139 \f