Dirlist.mui

DESCRIPTION

Dirlist.mui/Dirlist.mui

	Dirlist class provides a quick and easy way of showing
	entries in a directory. It features lots of control
	attributes, many of them known from the popular asl
	file requester.

	This class is *not* intended to replace asl.library!
	Nobody wants to see every MUI application coming with
	another selfmade file requester. Please continue using ASL
	for real file requesting purposes!

	However, sometimes it may be useful to have a little directory
	list placed somewhere in your user interface. Imagine an
	answering machine tool that stores incoming calls in a
	preconfigured directory. Using a dirlist object, you can
	include the GUI for selecting a call in your window with
	lots of other gadgets like "Play", "Delete", etc.

	Dirlist class offers all of a files attributes:
	name, size, date, time, flags and comment. Using the
	MUIA_List_Format attribute, you can control which of
	them shall be displayed.

	If you want to read the entries of your directory,
	just send the dirlist object a MUIM_List_GetEntry
	method. You will receive a pointer to a
	struct FileInfoBlock which remains valid until
	your next call to MUIM_List_GetEntry.

	Dirlist.mui has inline editing capabilities you can enable
	with setting MUIA_List_Editable attribute to TRUE

MUIA_Dirlist_AcceptPattern

(V4 ) [IS.], STRPTR, 0x8042760a

FUNCTIONS

	Entries not matching this pattern are rejected.
	Note that the pattern has to be parsed with
	dos.library/ParsePatternNoCase().
	Since V20 Empty strings are handled like no pattern string.

SEE ALSO

MUIA_Dirlist_Directory

(V4 ) [ISG], STRPTR, 0x8042ea41

DESCRIPTION

	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,"ftp:incoming

SEE ALSO

MUIA_Dirlist_DrawersOnly

(V4 ) [IS.], BOOL, 0x8042b379

DESCRIPTION

	Indicate whether you only want drawers to be displayed

SEE ALSO

MUIA_Dirlist_ExAllType

(V20) [I.G], ULONG, 0x8042cd7c

DESCRIPTION

	Set an ExAll() type to use. If you need the ExAllData structure
	in a Dirlist hook, set the type you need here, then get the
	attribute again to make sure your type is supported by MUI.
	Note that you might get a higher type back

EXAMPLE

	dirobj = DirlistObject, MUIA_Dirlist_ExAllType, ED_OWNER, End;

	if (xget(dirobj,MUIA_Dirlist_ExAllType) >= ED_OWNER)
	{
		/* all fine

SEE ALSO

MUIA_Dirlist_FilesOnly

(V4 ) [IS.], BOOL, 0x8042896a

DESCRIPTION

	Indicate whether you only want files to be displayed

SEE ALSO

MUIA_Dirlist_FilterDrawers

(V4 ) [IS.], BOOL, 0x80424ad2

DESCRIPTION

	Indicate whether you want drawers matched agains
	MUIA_Dirlist_RejectPattern and
	MUIA_Dirlist_AcceptPattern.

	Defaults to FALSE

SEE ALSO

MUIA_Dirlist_FilterHook

(V4 ) [IS.], struct Hook *, 0x8042ae19

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_MultiSelDirs

(V6 ) [IS.], BOOL, 0x80428653

FUNCTIONS

	Allows multi selection of directories.
	Defaults to FALSE.

SEE ALSO

MUIA_Dirlist_NumBytes

(V4 ) [..G], LONG, 0x80429e26

DESCRIPTION

	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_NumBytes64

(V20) [..G], QUAD *, 0x80428050

DESCRIPTION

	yet undocumented, please complain in mailinglist

MUIA_Dirlist_NumDrawers

(V4 ) [..G], LONG, 0x80429cb8

DESCRIPTION

	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

(V4 ) [..G], LONG, 0x8042a6f0

DESCRIPTION

	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_Path

(V4 ) [..G], STRPTR, 0x80426176

DESCRIPTION

	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_Pattern

(V20) [IS.], STRPTR, 0x8042c761

DESCRIPTION

	yet undocumented, please complain in mailinglist

MUIA_Dirlist_RejectIcons

(V4 ) [IS.], BOOL, 0x80424808

DESCRIPTION

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

SEE ALSO

MUIA_Dirlist_RejectPattern

(V4 ) [IS.], STRPTR, 0x804259c7

FUNCTIONS

	Entries matching this pattern are rejected.
	Note that the pattern has to be parsed with
	dos.library/ParsePatternNoCase().
	Since V20 Empty strings are handled like no pattern string.

SEE ALSO

MUIA_Dirlist_SortDirs

(V4 ) [IS.], LONG, 0x8042bbb9

DESCRIPTION

	Adjust the place where directories shall be displayed

SPECIAL INPUTS

	MUIV_Dirlist_SortDirs_First
	MUIV_Dirlist_SortDirs_Last
	MUIV_Dirlist_SortDirs_Mix

SEE ALSO

MUIA_Dirlist_SortHighLow

(V4 ) [IS.], BOOL, 0x80421896

DESCRIPTION

	Indicate if you want to sort your directory
	reversely

SEE ALSO

MUIA_Dirlist_SortType

(V4 ) [IS.], LONG, 0x804228bc

DESCRIPTION

	Indicate what fields should be used as sort criteria

SPECIAL INPUTS

	MUIV_Dirlist_SortType_Name
	MUIV_Dirlist_SortType_Date
	MUIV_Dirlist_SortType_Size
	MUIV_Dirlist_SortType_Comment
	MUIV_Dirlist_SortType_Flags
	MUIV_Dirlist_SortType_Type
	MUIV_Dirlist_SortType_Used
	MUIV_Dirlist_SortType_Count

SEE ALSO

MUIA_Dirlist_Status

(V4 ) [..G], LONG, 0x804240de

DESCRIPTION

	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

SPECIAL INPUTS

	MUIV_Dirlist_Status_Invalid
	MUIV_Dirlist_Status_Reading
	MUIV_Dirlist_Status_Valid

SEE ALSO

MUIM_Dirlist_Rename

MUIM_Dirlist_Rename (V21) 0x8042d336

SYNOPSIS

	DoMethod(obj,MUIM_Dirlist_Rename,LONG row, CONST_STRPTR newname);

RESULT

	error - 0 for success or IoErr() value if operation failed

FUNCTIONS

	Rename the file or directory from the specified dirlist entry
	to new name.

SEE ALSO

  • dos.library/IoErr
  • dos.library/Rename

MUIM_Dirlist_ReRead

MUIM_Dirlist_ReRead (V4 ) 0x80422d71

SYNOPSIS

	DoMethod(obj,MUIM_Dirlist_ReRead);

EXAMPLE

	if (NewCallReceived())
	   DoMethod(dirlistobj,MUIM_Dirlist_ReRead

FUNCTIONS

	Force the dirlist object to reread the current
	directory.

SEE ALSO

MUIM_Dirlist_SetComment

MUIM_Dirlist_SetComment (V21) 0x8042b378

SYNOPSIS

	DoMethod(obj,MUIM_Dirlist_SetComment,LONG row, CONST_STRPTR comment);

RESULT

	error - 0 for success or IoErr() value if operation failed

FUNCTIONS

	Sets a comment on a file or directory for the specified dirlist entry.

SEE ALSO

MUIM_Dirlist_SetProtection

MUIM_Dirlist_SetProtection (V21) 0x804202bb

SYNOPSIS

	DoMethod(obj,MUIM_Dirlist_SetProtection,LONG row, ULONG flags);

RESULT

	error - 0 for success or IoErr() value if operation failed

FUNCTIONS

	Sets the protection attributes on a file or directory for
	the specified dirlist entry.

SEE ALSO