home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 5 / FreshFish_July-August1994.bin / bbs / dev / mui-2.1.lha / MUI-2.1 / Developer / Autodocs / MUI_Dirlist.doc < prev    next >
Encoding:
Text File  |  1994-07-04  |  7.8 KB  |  313 lines
  1. TABLE OF CONTENTS
  2.  
  3. Dirlist.mui/Dirlist.mui
  4. Dirlist.mui/MUIM_Dirlist_ReRead
  5. Dirlist.mui/MUIA_Dirlist_AcceptPattern
  6. Dirlist.mui/MUIA_Dirlist_Directory
  7. Dirlist.mui/MUIA_Dirlist_DrawersOnly
  8. Dirlist.mui/MUIA_Dirlist_FilesOnly
  9. Dirlist.mui/MUIA_Dirlist_FilterDrawers
  10. Dirlist.mui/MUIA_Dirlist_FilterHook
  11. Dirlist.mui/MUIA_Dirlist_MultiSelDirs
  12. Dirlist.mui/MUIA_Dirlist_NumBytes
  13. Dirlist.mui/MUIA_Dirlist_NumDrawers
  14. Dirlist.mui/MUIA_Dirlist_NumFiles
  15. Dirlist.mui/MUIA_Dirlist_Path
  16. Dirlist.mui/MUIA_Dirlist_RejectIcons
  17. Dirlist.mui/MUIA_Dirlist_RejectPattern
  18. Dirlist.mui/MUIA_Dirlist_SortDirs
  19. Dirlist.mui/MUIA_Dirlist_SortHighLow
  20. Dirlist.mui/MUIA_Dirlist_SortType
  21. Dirlist.mui/MUIA_Dirlist_Status
  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/MUIM_Dirlist_ReRead
  52.  
  53.     NAME
  54.     MUIM_Dirlist_ReRead (V4)
  55.  
  56.     SYNOPSIS
  57.     DoMethod(obj,MUIM_Dirlist_ReRead,);
  58.  
  59.     FUNCTIONS
  60.     Force the dirlist object to reread the current
  61.     directory. 
  62.  
  63.     EXAMPLE
  64.     if (NewCallReceived())
  65.        DoMethod(dirlistobj,MUIM_Dirlist_ReRead);
  66.  
  67.     SEE ALSO
  68.     MUIA_Dirlist_Directory
  69. Dirlist.mui/MUIA_Dirlist_AcceptPattern
  70.  
  71.     NAME
  72.     MUIA_Dirlist_AcceptPattern -- (V4) [IS.], STRPTR
  73.  
  74.     FUNCTIONS
  75.     Entries not matching this pattern are rejected.
  76.     Note that the pattern has to be parsed with
  77.     dos.library/ParsePatternNoCase().
  78.  
  79.     SEE ALSO
  80.     MUIA_Dirlist_RejectPattern, MUIA_Dirlist_FilterDrawers
  81. Dirlist.mui/MUIA_Dirlist_Directory
  82.  
  83.     NAME
  84.     MUIA_Dirlist_Directory -- (V4) [IS.], STRPTR
  85.  
  86.     FUNCTION
  87.     Set a new directory for the dirlist object.
  88.     Since reading a directory can take a long long
  89.     time, MUI delegates this work to a sub task.
  90.  
  91.     Setting this attribute causes the object to clear
  92.     the current directory (if any) and start loading
  93.     a new one. MUIA_Dirlist_Status will be set to
  94.     MUIV_Dirlist_Status_Reading and the sub task will
  95.     be launched.
  96.  
  97.     By listening to MUIA_Dirlist_Status, you can learn
  98.     if the directory reading is completed or if something
  99.     went wrong.
  100.  
  101.     A value of NULL just clears the current directory and
  102.     sets MUIA_Dirlist_Status to MUIV_Dirlist_Status_Invalid.
  103.  
  104.     EXAMPLE
  105.     set(dirobj,MUIA_Dirlist_Directory,"zyxel:incoming");
  106.  
  107.     SEE ALSO
  108.     MUIA_Dirlist_Status
  109. Dirlist.mui/MUIA_Dirlist_DrawersOnly
  110.  
  111.     NAME
  112.     MUIA_Dirlist_DrawersOnly -- (V4) [IS.], BOOL
  113.  
  114.     FUNCTION
  115.     Indicate whether you only want drawers to be displayed.
  116.  
  117.     SEE ALSO
  118.     MUIA_Dirlist_Directory, MUIA_Dirlist_FilesOnly
  119. Dirlist.mui/MUIA_Dirlist_FilesOnly
  120.  
  121.     NAME
  122.     MUIA_Dirlist_FilesOnly -- (V4) [IS.], BOOL
  123.  
  124.     FUNCTION
  125.     Indicate whether you only want files to be displayed.
  126.  
  127.     SEE ALSO
  128.     MUIA_Dirlist_Directory, MUIA_Dirlist_DrawersOnly
  129. Dirlist.mui/MUIA_Dirlist_FilterDrawers
  130.  
  131.     NAME
  132.     MUIA_Dirlist_FilterDrawers -- (V4) [IS.], BOOL
  133.  
  134.     FUNCTION
  135.     Indicate whether you want drawers matched agains
  136.     MUIA_Dirlist_RejectPattern and
  137.     MUIA_Dirlist_AcceptPattern.
  138.  
  139.     Defaults to FALSE.
  140.  
  141.     SEE ALSO
  142.     MUIA_Dirlist_RejectPattern, MUIA_Dirlist_AcceptPattern
  143. Dirlist.mui/MUIA_Dirlist_FilterHook
  144.  
  145.     NAME
  146.     MUIA_Dirlist_FilterHook -- (V4) [IS.], struct Hook *
  147.  
  148.     FUNCTIONS
  149.     A hook to call for each file encountered. If the
  150.     function returns TRUE, the file is included in the
  151.     file list, otherwise it is rejected and not displayed.
  152.     The function receives the following parameters:
  153.  
  154.        A0 - (struct Hook *)      - the hook itself
  155.        A1 - (struct ExAllData *) - valid upto ed_Comment
  156.        A2 - (Object *)           - the dirlist object
  157.  
  158.     All other filter attributes are ignored when a
  159.     MUIA_Dirlist_FilterHook is set.
  160.  
  161.     SEE ALSO
  162.     MUIA_Dirlist_Directory
  163. Dirlist.mui/MUIA_Dirlist_MultiSelDirs
  164.  
  165.     NAME
  166.     MUIA_Dirlist_MultiSelDirs -- (V6) [IS.], BOOL
  167.  
  168.     FUNCTIONS
  169.     Allows multi selection of directories.
  170.     Defaults to FALSE.
  171.  
  172.     SEE ALSO
  173.     MUIA_Dirlist_FilterDrawers
  174. Dirlist.mui/MUIA_Dirlist_NumBytes
  175.  
  176.     NAME
  177.     MUIA_Dirlist_NumBytes -- (V4) [..G], LONG
  178.  
  179.     FUNCTION
  180.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can
  181.     obtain the number of bytes occupied by the directory
  182.     from this tag.
  183.  
  184.     SEE ALSO
  185.     MUIA_Dirlist_NumFiles, MUIA_Dirlist_NumDrawers
  186. Dirlist.mui/MUIA_Dirlist_NumDrawers
  187.  
  188.     NAME
  189.     MUIA_Dirlist_NumDrawers -- (V4) [..G], LONG
  190.  
  191.     FUNCTION
  192.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can
  193.     obtain the number of drawers in the displayed directory
  194.     from this tag.
  195.  
  196.     SEE ALSO
  197.     MUIA_Dirlist_NumFiles, MUIA_Dirlist_Status
  198. Dirlist.mui/MUIA_Dirlist_NumFiles
  199.  
  200.     NAME
  201.     MUIA_Dirlist_NumFiles -- (V4) [..G], LONG
  202.  
  203.     FUNCTION
  204.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can
  205.     obtain the number of files in the displayed directory
  206.     from this tag.
  207.  
  208.     SEE ALSO
  209.     MUIA_Dirlist_NumDrawers, MUIA_Dirlist_Status
  210. Dirlist.mui/MUIA_Dirlist_Path
  211.  
  212.     NAME
  213.     MUIA_Dirlist_Path -- (V4) [..G], STRPTR
  214.  
  215.     FUNCTION
  216.     When MUIA_Dirlist_Status is MUIV_Dirlist_Valid and
  217.     you have an active entry in the list (MUIA_List_Active
  218.     not equal MUIV_List_Active_Off), you will receive
  219.     a pointer to the complete path specification of
  220.     the selected file. Otherwise you get a NULL.
  221.  
  222.     SEE ALSO
  223.     MUIA_Dirlist_Status
  224. Dirlist.mui/MUIA_Dirlist_RejectIcons
  225.  
  226.     NAME
  227.     MUIA_Dirlist_RejectIcons -- (V4) [IS.], BOOL
  228.  
  229.     FUNCTION
  230.     Indicate whether you want icons (*.info files)
  231.     to be rejected.
  232.  
  233.     SEE ALSO
  234.     MUIA_Dirlist_Directory
  235. Dirlist.mui/MUIA_Dirlist_RejectPattern
  236.  
  237.     NAME
  238.     MUIA_Dirlist_RejectPattern -- (V4) [IS.], STRPTR
  239.  
  240.     FUNCTIONS
  241.     Entries matching this pattern are rejected.
  242.     Note that the pattern has to be parsed with
  243.     dos.library/ParsePatternNoCase().
  244.  
  245.     SEE ALSO
  246.     MUIA_Dirlist_AcceptPattern, MUIA_Dirlist_FilterDrawers
  247. Dirlist.mui/MUIA_Dirlist_SortDirs
  248.  
  249.     NAME
  250.     MUIA_Dirlist_SortDirs -- (V4) [IS.], LONG
  251.  
  252.     SPECIAL INPUTS
  253.     MUIV_Dirlist_SortDirs_First
  254.     MUIV_Dirlist_SortDirs_Last
  255.     MUIV_Dirlist_SortDirs_Mix
  256.  
  257.     FUNCTION
  258.     Adjust the place where directories shall be displayed.
  259.  
  260.     SEE ALSO
  261.     MUIA_Dirlist_SortHighLow, MUIA_Dirlist_SortType
  262. Dirlist.mui/MUIA_Dirlist_SortHighLow
  263.  
  264.     NAME
  265.     MUIA_Dirlist_SortHighLow -- (V4) [IS.], BOOL
  266.  
  267.     FUNCTION
  268.     Indicate if you want to sort your directory
  269.     reversely.
  270.  
  271.     SEE ALSO
  272.     MUIA_Dirlist_SortType, MUIA_Dirlist_SortDirs
  273. Dirlist.mui/MUIA_Dirlist_SortType
  274.  
  275.     NAME
  276.     MUIA_Dirlist_SortType -- (V4) [IS.], LONG
  277.  
  278.     SPECIAL INPUTS
  279.     MUIV_Dirlist_SortType_Name
  280.     MUIV_Dirlist_SortType_Date
  281.     MUIV_Dirlist_SortType_Size
  282.  
  283.     FUNCTION
  284.     Indicate what fields should be used as sort criteria.
  285.  
  286.     SEE ALSO
  287.     MUIA_Dirlist_SortDirs, MUIA_Dirlist_SortHighLow
  288. Dirlist.mui/MUIA_Dirlist_Status
  289.  
  290.     NAME
  291.     MUIA_Dirlist_Status -- (V4) [..G], LONG
  292.  
  293.     SPECIAL INPUTS
  294.     MUIV_Dirlist_Status_Invalid
  295.     MUIV_Dirlist_Status_Reading
  296.     MUIV_Dirlist_Status_Valid
  297.  
  298.     FUNCTION
  299.     Read the status of the dirlist object. The result is
  300.     one of
  301.  
  302.     MUIV_Dirlist_Status_Invalid:
  303.        object contains no valid directory.
  304.  
  305.     MUIV_Dirlist_Status_Reading 1:
  306.        object is currently reading a new directory.
  307.  
  308.     MUIV_Dirlist_Status_Valid 2
  309.        object contains a valid directory.
  310.  
  311.     SEE ALSO
  312.     MUIA_Dirlist_Directory
  313.