home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_listview.doc < prev    next >
Text File  |  1997-03-10  |  5KB  |  196 lines
  1. TABLE OF CONTENTS
  2.  
  3. Listview.mui/Listview.mui
  4. Listview.mui/MUIA_Listview_ClickColumn
  5. Listview.mui/MUIA_Listview_DefClickColumn
  6. Listview.mui/MUIA_Listview_DoubleClick
  7. Listview.mui/MUIA_Listview_DragType
  8. Listview.mui/MUIA_Listview_Input
  9. Listview.mui/MUIA_Listview_List
  10. Listview.mui/MUIA_Listview_MultiSelect
  11. Listview.mui/MUIA_Listview_ScrollerPos
  12. Listview.mui/MUIA_Listview_SelectChange
  13. Listview.mui/Listview.mui
  14.  
  15.     It's important to know that MUI makes a difference
  16.     between a list and a listview. A list is just a
  17.     collection of some entries and is part of a listview,
  18.     which attaches a scrollbar and input handling to
  19.     the list.
  20.  
  21.     During object creation time, you have to be careful
  22.     not specifying listview tags for the list object
  23.     or list tags for the listview object, both versions
  24.     won't work. Once the objects are setup, you can
  25.     of course talk to the listview as if it was the
  26.     list directly.
  27. Listview.mui/MUIA_Listview_ClickColumn
  28.  
  29.     NAME
  30.     MUIA_Listview_ClickColumn -- (V7 ) [..G], LONG
  31.  
  32.     FUNCTION
  33.     When using a multi column list, this attribute contains the number of
  34.     the column where the user clicked.
  35.  
  36.     SEE ALSO
  37.     MUIA_Listview_DefClickColumn
  38. Listview.mui/MUIA_Listview_DefClickColumn
  39.  
  40.     NAME
  41.     MUIA_Listview_DefClickColumn -- (V7 ) [ISG], LONG
  42.  
  43.     FUNCTION
  44.     When the listview is controlled with the keyboard and the user
  45.     presses RETURN, the value given here will be used as default
  46.     for MUIA_Listview_ClickColumn.
  47.  
  48.     SEE ALSO
  49.     MUIA_Listview_ClickColumn
  50. Listview.mui/MUIA_Listview_DoubleClick
  51.  
  52.     NAME
  53.     MUIA_Listview_DoubleClick -- (V4 ) [I.G], BOOL
  54.  
  55.     FUNCTION
  56.     This attribute is set to TRUE whenever the user
  57.     double clicks on an entry in the list.
  58.  
  59.     SEE ALSO
  60.     MUIA_Listview_SelectChange
  61. Listview.mui/MUIA_Listview_DragType
  62.  
  63.     NAME
  64.     MUIA_Listview_DragType -- (V11) [ISG], LONG
  65.  
  66.     SPECIAL INPUTS
  67.     MUIV_Listview_DragType_None
  68.     MUIV_Listview_DragType_Immediate
  69.  
  70.     FUNCTION
  71.     If you want the user to be able to drag items out of
  72.     your list, you must set this for the listview class.
  73.     Currently, only one drag type is defined.
  74. Listview.mui/MUIA_Listview_Input
  75.  
  76.     NAME
  77.     MUIA_Listview_Input -- (V4 ) [I..], BOOL
  78.  
  79.     FUNCTION
  80.     Setting this to FALSE will result in a read only
  81.     list view. Defaults to TRUE.
  82.  
  83.     SEE ALSO
  84.     MUIA_Listview_MultiSelect
  85. Listview.mui/MUIA_Listview_List
  86.  
  87.     NAME
  88.     MUIA_Listview_List -- (V4 ) [I.G], Object *
  89.  
  90.     FUNCTION
  91.     Every listview needs a list object as child.
  92.     Specify it here.
  93.  
  94.     As every other child, it will get disposes when
  95.     its parent object is disposed.
  96.  
  97.     EXAMPLE
  98.     ListviewObject,
  99.        MUIA_Listview_Input, FALSE,
  100.        MUIA_Listview_List , ListObject,
  101.           ReadListFrame,
  102.           MUIA_List_Format       , ",,",
  103.           End,
  104.        End;
  105.  
  106.     SEE ALSO
  107.     MUIA_Listview_Input
  108. Listview.mui/MUIA_Listview_MultiSelect
  109.  
  110.     NAME
  111.     MUIA_Listview_MultiSelect -- (V7 ) [I..], LONG
  112.  
  113.     SPECIAL INPUTS
  114.     MUIV_Listview_MultiSelect_None
  115.     MUIV_Listview_MultiSelect_Default
  116.     MUIV_Listview_MultiSelect_Shifted
  117.     MUIV_Listview_MultiSelect_Always
  118.  
  119.     FUNCTION
  120.     Four possibilities exist for a listviews multi select
  121.     capabilities:
  122.  
  123.     MUIV_Listview_MultiSelect_None:
  124.        The listview cannot multiselect at all.
  125.  
  126.     MUIV_Listview_MultiSelect_Default:
  127.        The multi select type (with or without shift) depends on
  128.        the users preferences setting.
  129.  
  130.     MUIV_Listview_MultiSelect_Shifted:
  131.        Overrides the users prefs, multi selecting only together
  132.        with shift key.
  133.  
  134.     MUIV_Listview_MultiSelect_Always:
  135.        Overrides the users prefs, multi selecting without shift key.
  136.  
  137.     Please do *not* override the users prefs unless you have a
  138.     good reason!
  139.  
  140.     SEE ALSO
  141.     MUIA_List_MultiTestHook
  142. Listview.mui/MUIA_Listview_ScrollerPos
  143.  
  144.     NAME
  145.     MUIA_Listview_ScrollerPos -- (V10) [I..], BOOL
  146.  
  147.     SPECIAL INPUTS
  148.     MUIV_Listview_ScrollerPos_Default
  149.     MUIV_Listview_ScrollerPos_Left
  150.     MUIV_Listview_ScrollerPos_Right
  151.     MUIV_Listview_ScrollerPos_None
  152.  
  153.     FUNCTION
  154.     Specifies the position of a listviews scrollbar.
  155.     Don't use this tag unless it's absolutely required!
  156.  
  157.     If you specify MUIV_Listview_ScrollerPos_None, your listview
  158.     wont get a scroller at all and look much like a list object
  159.     alone. However, listviews without scroller are still more
  160.     powerful than list objects as they feature e.g. drag&drop
  161.     possibilities.
  162.  
  163.     Creating listviews without a scrollbar makes sense if you
  164.     want to have the scrollbar somewhere else, e.g. outside
  165.     of a horizontal virtual group where the listview resides.
  166.     This technique allows the creation of horizontally
  167.     scrollable listviews.
  168.  
  169.     When you create the scrollbar on your own, connect it
  170.     to the list object (not listview object!) like this:
  171.  
  172.     DoMethod(sbar,MUIM_Notify,MUIA_Prop_First       ,MUIV_EveryTime,
  173.         list,3,MUIM_Set,MUIA_List_TopPixel,MUIV_TriggerValue);
  174.  
  175.     DoMethod(list,MUIM_Notify,MUIA_List_TotalPixel  ,MUIV_EveryTime,
  176.         sbar,3,MUIM_Set,MUIA_Prop_Entries ,MUIV_TriggerValue);
  177.  
  178.     DoMethod(list,MUIM_Notify,MUIA_List_VisiblePixel,MUIV_EveryTime,
  179.         sbar,3,MUIM_Set,MUIA_Prop_Visible ,MUIV_TriggerValue);
  180.  
  181.     DoMethod(list,MUIM_Notify,MUIA_List_TopPixel    ,MUIV_EveryTime,
  182.         sbar,3,MUIM_Set,MUIA_Prop_First   ,MUIV_TriggerValue);
  183. Listview.mui/MUIA_Listview_SelectChange
  184.  
  185.     NAME
  186.     MUIA_Listview_SelectChange -- (V4 ) [..G], BOOL
  187.  
  188.     FUNCTION
  189.     This attribute is set to TRUE whenever the selection state
  190.     of one or more items in the list is changing. You can
  191.     use this e.g. if you want to display the number of
  192.     selected items in a status line.
  193.  
  194.     SEE ALSO
  195.     MUIA_Listview_MultiSelect
  196.