home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 13 / amigaformatcd13.iso / mui / mui_developer / autodocs / mui_dirlist.doc < prev    next >
Text File  |  1997-03-10  |  8KB  |  313 lines
  1. TABLE OF CONTENTS
  2.  
  3. Dirlist.mui/Dirlist.mui
  4. Dirlist.mui/MUIA_Dirlist_AcceptPattern
  5. Dirlist.mui/MUIA_Dirlist_Directory
  6. Dirlist.mui/MUIA_Dirlist_DrawersOnly
  7. Dirlist.mui/MUIA_Dirlist_FilesOnly
  8. Dirlist.mui/MUIA_Dirlist_FilterDrawers
  9. Dirlist.mui/MUIA_Dirlist_FilterHook
  10. Dirlist.mui/MUIA_Dirlist_MultiSelDirs
  11. Dirlist.mui/MUIA_Dirlist_NumBytes
  12. Dirlist.mui/MUIA_Dirlist_NumDrawers
  13. Dirlist.mui/MUIA_Dirlist_NumFiles
  14. Dirlist.mui/MUIA_Dirlist_Path
  15. Dirlist.mui/MUIA_Dirlist_RejectIcons
  16. Dirlist.mui/MUIA_Dirlist_RejectPattern
  17. Dirlist.mui/MUIA_Dirlist_SortDirs
  18. Dirlist.mui/MUIA_Dirlist_SortHighLow
  19. Dirlist.mui/MUIA_Dirlist_SortType
  20. Dirlist.mui/MUIA_Dirlist_Status
  21. Dirlist.mui/MUIM_Dirlist_ReRead
  22. Dirlist.mui/Dirlist.mui
  23.  
  24.     Dirlist class provides a quick and easy way of showing
  25.     entries in a directory. It features lots of control
  26.     attributes, many of them known from the popular asl
  27.     file requester.
  28.  
  29.     This class is *not* intended to replace asl.library!
  30.     Nobody wants to see every MUI application coming with
  31.     another selfmade file requester. Please continue using ASL
  32.     for real file requesting purposes!
  33.  
  34.     However, sometimes it may be useful to have a little directory
  35.     list placed somewhere in your user interface. Imagine an
  36.     answering machine tool that stores incoming calls in a
  37.     preconfigured directory. Using a dirlist object, you can
  38.     include the GUI for selecting a call in your window with
  39.     lots of other gadgets like "Play", "Delete", etc.
  40.  
  41.     Dirlist class offers all of a files attributes:
  42.     name, size, date, time, flags and comment. Using the
  43.     MUIA_List_Format attribute, you can control which of
  44.     them shall be displayed.
  45.  
  46.     If you want to read the entries of your directory,
  47.     just send the dirlist object a MUIM_List_GetEntry
  48.     method. You will receive a pointer to a
  49.     struct FileInfoBlock which remains valid until
  50.     your next call to MUIM_List_GetEntry.
  51. Dirlist.mui/MUIA_Dirlist_AcceptPattern
  52.  
  53.     NAME
  54.     MUIA_Dirlist_AcceptPattern -- (V4 ) [IS.], STRPTR
  55.  
  56.     FUNCTIONS
  57.     Entries not matching this pattern are rejected.
  58.     Note that the pattern has to be parsed with
  59.     dos.library/ParsePatternNoCase().
  60.  
  61.     SEE ALSO
  62.     MUIA_Dirlist_RejectPattern, MUIA_Dirlist_FilterDrawers
  63. Dirlist.mui/MUIA_Dirlist_Directory
  64.  
  65.     NAME
  66.     MUIA_Dirlist_Directory -- (V4 ) [ISG], STRPTR
  67.  
  68.     FUNCTION
  69.     Set a new directory for the dirlist object.
  70.     Since reading a directory can take a long long
  71.     time, MUI delegates this work to a sub task.
  72.  
  73.     Setting this attribute causes the object to clear
  74.     the current directory (if any) and start loading
  75.     a new one. MUIA_Dirlist_Status will be set to
  76.     MUIV_Dirlist_Status_Reading and the sub task will
  77.     be launched.
  78.  
  79.     By listening to MUIA_Dirlist_Status, you can learn
  80.     if the directory reading is completed or if something
  81.     went wrong.
  82.  
  83.     A value of NULL just clears the current directory and
  84.     sets MUIA_Dirlist_Status to MUIV_Dirlist_Status_Invalid.
  85.  
  86.     EXAMPLE
  87.     set(dirobj,MUIA_Dirlist_Directory,"zyxel:incoming");
  88.  
  89.     SEE ALSO
  90.     MUIA_Dirlist_Status
  91. Dirlist.mui/MUIA_Dirlist_DrawersOnly
  92.  
  93.     NAME
  94.     MUIA_Dirlist_DrawersOnly -- (V4 ) [IS.], BOOL
  95.  
  96.     FUNCTION
  97.     Indicate whether you only want drawers to be displayed.
  98.  
  99.     SEE ALSO
  100.     MUIA_Dirlist_Directory, MUIA_Dirlist_FilesOnly
  101. Dirlist.mui/MUIA_Dirlist_FilesOnly
  102.  
  103.     NAME
  104.     MUIA_Dirlist_FilesOnly -- (V4 ) [IS.], BOOL
  105.  
  106.     FUNCTION
  107.     Indicate whether you only want files to be displayed.
  108.  
  109.     SEE ALSO
  110.     MUIA_Dirlist_Directory, MUIA_Dirlist_DrawersOnly
  111. Dirlist.mui/MUIA_Dirlist_FilterDrawers
  112.  
  113.     NAME
  114.     MUIA_Dirlist_FilterDrawers -- (V4 ) [IS.], BOOL
  115.  
  116.     FUNCTION
  117.     Indicate whether you want drawers matched agains
  118.     MUIA_Dirlist_RejectPattern and
  119.     MUIA_Dirlist_AcceptPattern.
  120.  
  121.     Defaults to FALSE.
  122.  
  123.     SEE ALSO
  124.     MUIA_Dirlist_RejectPattern, MUIA_Dirlist_AcceptPattern
  125. Dirlist.mui/MUIA_Dirlist_FilterHook
  126.  
  127.     NAME
  128.     MUIA_Dirlist_FilterHook -- (V4 ) [IS.], struct Hook *
  129.  
  130.     FUNCTIONS
  131.     A hook to call for each file encountered. If the
  132.     function returns TRUE, the file is included in the
  133.     file list, otherwise it is rejected and not displayed.
  134.     The function receives the following parameters:
  135.  
  136.        A0 - (struct Hook *)      - the hook itself
  137.        A1 - (struct ExAllData *) - valid upto ed_Comment
  138.        A2 - (Object *)           - the dirlist object
  139.  
  140.     All other filter attributes are ignored when a
  141.     MUIA_Dirlist_FilterHook is set.
  142.  
  143.     SEE ALSO
  144.     MUIA_Dirlist_Directory
  145. Dirlist.mui/MUIA_Dirlist_MultiSelDirs
  146.  
  147.     NAME
  148.     MUIA_Dirlist_MultiSelDirs -- (V6 ) [IS.], BOOL
  149.  
  150.     FUNCTIONS
  151.     Allows multi selection of directories.
  152.     Defaults to FALSE.
  153.  
  154.     SEE ALSO
  155.     MUIA_Dirlist_FilterDrawers
  156. Dirlist.mui/MUIA_Dirlist_NumBytes
  157.  
  158.     NAME
  159.     MUIA_Dirlist_NumBytes -- (V4 ) [..G], LONG
  160.  
  161.     FUNCTION
  162.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can
  163.     obtain the number of bytes occupied by the directory
  164.     from this tag.
  165.  
  166.     SEE ALSO
  167.     MUIA_Dirlist_NumFiles, MUIA_Dirlist_NumDrawers
  168. Dirlist.mui/MUIA_Dirlist_NumDrawers
  169.  
  170.     NAME
  171.     MUIA_Dirlist_NumDrawers -- (V4 ) [..G], LONG
  172.  
  173.     FUNCTION
  174.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can
  175.     obtain the number of drawers in the displayed directory
  176.     from this tag.
  177.  
  178.     SEE ALSO
  179.     MUIA_Dirlist_NumFiles, MUIA_Dirlist_Status
  180. Dirlist.mui/MUIA_Dirlist_NumFiles
  181.  
  182.     NAME
  183.     MUIA_Dirlist_NumFiles -- (V4 ) [..G], LONG
  184.  
  185.     FUNCTION
  186.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can
  187.     obtain the number of files in the displayed directory
  188.     from this tag.
  189.  
  190.     SEE ALSO
  191.     MUIA_Dirlist_NumDrawers, MUIA_Dirlist_Status
  192. Dirlist.mui/MUIA_Dirlist_Path
  193.  
  194.     NAME
  195.     MUIA_Dirlist_Path -- (V4 ) [..G], STRPTR
  196.  
  197.     FUNCTION
  198.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid and
  199.     you have an active entry in the list (MUIA_List_Active
  200.     not equal MUIV_List_Active_Off), you will receive
  201.     a pointer to the complete path specification of
  202.     the selected file. Otherwise you get a NULL.
  203.  
  204.     SEE ALSO
  205.     MUIA_Dirlist_Status
  206. Dirlist.mui/MUIA_Dirlist_RejectIcons
  207.  
  208.     NAME
  209.     MUIA_Dirlist_RejectIcons -- (V4 ) [IS.], BOOL
  210.  
  211.     FUNCTION
  212.     Indicate whether you want icons (*.info files)
  213.     to be rejected.
  214.  
  215.     SEE ALSO
  216.     MUIA_Dirlist_Directory
  217. Dirlist.mui/MUIA_Dirlist_RejectPattern
  218.  
  219.     NAME
  220.     MUIA_Dirlist_RejectPattern -- (V4 ) [IS.], STRPTR
  221.  
  222.     FUNCTIONS
  223.     Entries matching this pattern are rejected.
  224.     Note that the pattern has to be parsed with
  225.     dos.library/ParsePatternNoCase().
  226.  
  227.     SEE ALSO
  228.     MUIA_Dirlist_AcceptPattern, MUIA_Dirlist_FilterDrawers
  229. Dirlist.mui/MUIA_Dirlist_SortDirs
  230.  
  231.     NAME
  232.     MUIA_Dirlist_SortDirs -- (V4 ) [IS.], LONG
  233.  
  234.     SPECIAL INPUTS
  235.     MUIV_Dirlist_SortDirs_First
  236.     MUIV_Dirlist_SortDirs_Last
  237.     MUIV_Dirlist_SortDirs_Mix
  238.  
  239.     FUNCTION
  240.     Adjust the place where directories shall be displayed.
  241.  
  242.     SEE ALSO
  243.     MUIA_Dirlist_SortHighLow, MUIA_Dirlist_SortType
  244. Dirlist.mui/MUIA_Dirlist_SortHighLow
  245.  
  246.     NAME
  247.     MUIA_Dirlist_SortHighLow -- (V4 ) [IS.], BOOL
  248.  
  249.     FUNCTION
  250.     Indicate if you want to sort your directory
  251.     reversely.
  252.  
  253.     SEE ALSO
  254.     MUIA_Dirlist_SortType, MUIA_Dirlist_SortDirs
  255. Dirlist.mui/MUIA_Dirlist_SortType
  256.  
  257.     NAME
  258.     MUIA_Dirlist_SortType -- (V4 ) [IS.], LONG
  259.  
  260.     SPECIAL INPUTS
  261.     MUIV_Dirlist_SortType_Name
  262.     MUIV_Dirlist_SortType_Date
  263.     MUIV_Dirlist_SortType_Size
  264.  
  265.     FUNCTION
  266.     Indicate what fields should be used as sort criteria.
  267.  
  268.     SEE ALSO
  269.     MUIA_Dirlist_SortDirs, MUIA_Dirlist_SortHighLow
  270. Dirlist.mui/MUIA_Dirlist_Status
  271.  
  272.     NAME
  273.     MUIA_Dirlist_Status -- (V4 ) [..G], LONG
  274.  
  275.     SPECIAL INPUTS
  276.     MUIV_Dirlist_Status_Invalid
  277.     MUIV_Dirlist_Status_Reading
  278.     MUIV_Dirlist_Status_Valid
  279.  
  280.     FUNCTION
  281.     Read the status of the dirlist object. The result is
  282.     one of
  283.  
  284.     MUIV_Dirlist_Status_Invalid:
  285.        object contains no valid directory.
  286.  
  287.     MUIV_Dirlist_Status_Reading 1:
  288.        object is currently reading a new directory.
  289.  
  290.     MUIV_Dirlist_Status_Valid 2
  291.        object contains a valid directory.
  292.  
  293.     SEE ALSO
  294.     MUIA_Dirlist_Directory
  295. Dirlist.mui/MUIM_Dirlist_ReRead
  296.  
  297.     NAME
  298.     MUIM_Dirlist_ReRead (V4 )
  299.  
  300.     SYNOPSIS
  301.     DoMethod(obj,MUIM_Dirlist_ReRead);
  302.  
  303.     FUNCTIONS
  304.     Force the dirlist object to reread the current
  305.     directory. 
  306.  
  307.     EXAMPLE
  308.     if (NewCallReceived())
  309.        DoMethod(dirlistobj,MUIM_Dirlist_ReRead);
  310.  
  311.     SEE ALSO
  312.     MUIA_Dirlist_Directory
  313.