Dirlist.mui Class Reference

BOOPSI custom class Dirlist.mui (MUI 3.8 dev). Each ### sub-section below documents one of the class's attributes or methods. Sub-classes of Dirlist.mui are listed at the end under Sub-classes; the class hierarchy itself is documented in the MUI classes index.

Function index

Class definition

Attributes

Methods

Dirlist.mui

MUIA_Dirlist_AcceptPattern

MUIA_Dirlist_AcceptPattern -- (V4 ) [IS.], STRPTR — FUNCTIONS — Entries not matching this pattern are rejected. — Note that the pattern has to be parsed with — dos.library/ParsePatternNoCase().

See also

MUIA_Dirlist_RejectPattern, MUIA_Dirlist_FilterDrawers

MUIA_Dirlist_Directory

MUIA_Dirlist_Directory -- (V4 ) [ISG], STRPTR

Function

Set a new directory for the dirlist object. Since reading a directory can take a long long time, MUI delegates this work to a sub task. Setting this attribute causes the object to clear the current directory (if any) and start loading a new one. MUIA_Dirlist_Status will be set to MUIV_Dirlist_Status_Reading and the sub task will be launched. By listening to MUIA_Dirlist_Status, you can learn if the directory reading is completed or if something went wrong. A value of NULL just clears the current directory and sets MUIA_Dirlist_Status to MUIV_Dirlist_Status_Invalid.

Example

set(dirobj,MUIA_Dirlist_Directory,"zyxel:incoming");

See also

MUIA_Dirlist_Status

MUIA_Dirlist_DrawersOnly

MUIA_Dirlist_DrawersOnly -- (V4 ) [IS.], BOOL

Function

Indicate whether you only want drawers to be displayed.

See also

MUIA_Dirlist_Directory, MUIA_Dirlist_FilesOnly

MUIA_Dirlist_FilesOnly

MUIA_Dirlist_FilesOnly -- (V4 ) [IS.], BOOL

Function

Indicate whether you only want files to be displayed.

See also

MUIA_Dirlist_Directory, MUIA_Dirlist_DrawersOnly

MUIA_Dirlist_FilterDrawers

MUIA_Dirlist_FilterDrawers -- (V4 ) [IS.], BOOL

Function

Indicate whether you want drawers matched agains MUIA_Dirlist_RejectPattern and MUIA_Dirlist_AcceptPattern. Defaults to FALSE.

See also

MUIA_Dirlist_RejectPattern, MUIA_Dirlist_AcceptPattern

MUIA_Dirlist_FilterHook

MUIA_Dirlist_FilterHook -- (V4 ) [IS.], struct Hook * — FUNCTIONS — A hook to call for each file encountered. If the — function returns TRUE, the file is included in the — file list, otherwise it is rejected and not displayed. — The function receives the following parameters: — A0 - (struct Hook ) - the hook itself — A1 - (struct ExAllData ) - valid upto ed_Comment — A2 - (Object *) - the dirlist object — All other filter attributes are ignored when a — MUIA_Dirlist_FilterHook is set.

See also

MUIA_Dirlist_Directory

MUIA_Dirlist_MultiSelDirs

MUIA_Dirlist_MultiSelDirs -- (V6 ) [IS.], BOOL — FUNCTIONS — Allows multi selection of directories. — Defaults to FALSE.

See also

MUIA_Dirlist_FilterDrawers

MUIA_Dirlist_NumBytes

MUIA_Dirlist_NumBytes -- (V4 ) [..G], LONG

Function

When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can obtain the number of bytes occupied by the directory from this tag.

See also

MUIA_Dirlist_NumFiles, MUIA_Dirlist_NumDrawers

MUIA_Dirlist_NumDrawers

MUIA_Dirlist_NumDrawers -- (V4 ) [..G], LONG

Function

When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can obtain the number of drawers in the displayed directory from this tag.

See also

MUIA_Dirlist_NumFiles, MUIA_Dirlist_Status

MUIA_Dirlist_NumFiles

MUIA_Dirlist_NumFiles -- (V4 ) [..G], LONG

Function

When MUIA_Dirlist_Status is MUIV_Dirlist_Valid, you can obtain the number of files in the displayed directory from this tag.

See also

MUIA_Dirlist_NumDrawers, MUIA_Dirlist_Status

MUIA_Dirlist_Path

MUIA_Dirlist_Path -- (V4 ) [..G], STRPTR

Function

When MUIA_Dirlist_Status is MUIV_Dirlist_Valid and you have an active entry in the list (MUIA_List_Active not equal MUIV_List_Active_Off), you will receive a pointer to the complete path specification of the selected file. Otherwise you get a NULL.

See also

MUIA_Dirlist_Status

MUIA_Dirlist_RejectIcons

MUIA_Dirlist_RejectIcons -- (V4 ) [IS.], BOOL

Function

Indicate whether you want icons (*.info files) to be rejected.

See also

MUIA_Dirlist_Directory

MUIA_Dirlist_RejectPattern

MUIA_Dirlist_RejectPattern -- (V4 ) [IS.], STRPTR — FUNCTIONS — Entries matching this pattern are rejected. — Note that the pattern has to be parsed with — dos.library/ParsePatternNoCase().

See also

MUIA_Dirlist_AcceptPattern, MUIA_Dirlist_FilterDrawers

MUIA_Dirlist_SortDirs

MUIA_Dirlist_SortDirs -- (V4 ) [IS.], LONG — SPECIAL INPUTS — MUIV_Dirlist_SortDirs_First — MUIV_Dirlist_SortDirs_Last — MUIV_Dirlist_SortDirs_Mix

Function

Adjust the place where directories shall be displayed.

See also

MUIA_Dirlist_SortHighLow, MUIA_Dirlist_SortType

MUIA_Dirlist_SortHighLow

MUIA_Dirlist_SortHighLow -- (V4 ) [IS.], BOOL

Function

Indicate if you want to sort your directory reversely.

See also

MUIA_Dirlist_SortType, MUIA_Dirlist_SortDirs

MUIA_Dirlist_SortType

MUIA_Dirlist_SortType -- (V4 ) [IS.], LONG — SPECIAL INPUTS — MUIV_Dirlist_SortType_Name — MUIV_Dirlist_SortType_Date — MUIV_Dirlist_SortType_Size

Function

Indicate what fields should be used as sort criteria.

See also

MUIA_Dirlist_SortDirs, MUIA_Dirlist_SortHighLow

MUIA_Dirlist_Status

MUIA_Dirlist_Status -- (V4 ) [..G], LONG — SPECIAL INPUTS — MUIV_Dirlist_Status_Invalid — MUIV_Dirlist_Status_Reading — MUIV_Dirlist_Status_Valid

Function

Read the status of the dirlist object. The result is one of MUIV_Dirlist_Status_Invalid: object contains no valid directory. MUIV_Dirlist_Status_Reading 1: object is currently reading a new directory. MUIV_Dirlist_Status_Valid 2 object contains a valid directory.

See also

MUIA_Dirlist_Directory

MUIM_Dirlist_ReRead

MUIM_Dirlist_ReRead (V4 ) — SYNOPSIS — DoMethod(obj,MUIM_Dirlist_ReRead); — FUNCTIONS — Force the dirlist object to reread the current — directory.

Example

if (NewCallReceived())
DoMethod(dirlistobj,MUIM_Dirlist_ReRead);

See also

MUIA_Dirlist_Directory