wiki:Documentation/API/MUI_Filepanel

Filepanel.mui

Super class

Panel.mui

Background

Filepanel class offers a full featured replacement for ASL file requesters. As a replacement it understands most of ASL's file requester attributes or it offers suitable own attributes.

In addition to ASL requesters it offers a directory history and additional navigation buttons to quickly jump from one directory to a parent or previously child directory.

Attributes

Attribute Version ISG Type
MUIA_Filepanel_AcceptPattern V20I.GSTRPTR
MUIA_Filepanel_DoMultiSelect V20I.GBOOL
MUIA_Filepanel_DoPatterns V20I.GBOOL
MUIA_Filepanel_DoSaveMode V20I.GBOOL
MUIA_Filepanel_Drawer V20ISGSTRPTR
MUIA_Filepanel_DrawersOnly V20I.GBOOL
MUIA_Filepanel_File V20ISGSTRPTR
MUIA_Filepanel_FilterDrawers V20I.GBOOL
MUIA_Filepanel_FilterFunc V20I.Gstruct Hook *
MUIA_Filepanel_Pattern V20ISGSTRPTR
MUIA_Filepanel_RejectIcons V20I.GBOOL
MUIA_Filepanel_RejectPattern V20I.GSTRPTR


MUIA_Filepanel_AcceptPattern

NAME

MUIA_Filepanel_AcceptPattern — V20 [I.G], STRPTR, 0x80426f3b

FUNCTION

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

SEE ALSO

MUIA_Filepanel_RejectPattern, MUIA_Filepanel_FilterDrawers

MUIA_Filepanel_DoMultiSelect

NAME

MUIA_Filepanel_DoMultiSelect — V20 [I.G], BOOL, 0x8042fd78

FUNCTION

Set this attribute to TRUE to let the user select multiple files at once. This attribute excludes MUIA_Filepanel_DoSaveMode.

Defaults to FALSE.

MUIA_Filepanel_DoPatterns

NAME

MUIA_Filepanel_DoPatterns — V20 [I.G], BOOL, 0x80420b3b

FUNCTION

Set this attribute to TRUE to case a pattern gadget to be displays.

Defaults to FALSE.

MUIA_Filepanel_DoSaveMode

NAME

MUIA_Filepanel_DoSaveMode — V20 [I.G], BOOL, 0x80429022

FUNCTION

Set this attribute to TRUE when the file panel is being used for saving.

Defaults to FALSE.

MUIA_Filepanel_Drawer

NAME

MUIA_Filepanel_Drawer — V20 [ISG], STRPTR, 0x8042e802

FUNCTION

Initial contents of the panel's Drawer string object.

SEE ALSO

MUIA_Filepanel_File

MUIA_Filepanel_DrawersOnly

NAME

MUIA_Filepanel_DrawersOnly — V20 [I.G], BOOL, 0x80427726

FUNCTION

Indicate whether you only want drawers to be displayed.

MUIA_Filepanel_File

NAME

MUIA_Filepanel_File — V20 [ISG], STRPTR, 0x80427acf

FUNCTION

Initial contents of the panel's File string object.

SEE ALSO

MUIA_Filepanel_Drawer

MUIA_Filepanel_FilterDrawers

NAME

MUIA_Filepanel_FilterDrawers — V20 [I.G], BOOL, 0x804298a1

FUNCTION

Set this attribute to TRUE if you want the MUIA_Filepanel_AcceptPattern, MUIA_Filepanel_RejectPattern and the Pattern string object to apply to drawer names as well. Normally drawers are always displayed.

Defaults to FALSE.

SEE ALSO

MUIA_Filepanel_AcceptPattern, MUIA_Filepanel_RejectPattern, MUIA_Filepanel_Pattern

MUIA_Filepanel_FilterFunc

NAME

MUIA_Filepanel_FilterFunc — V20 [I.G], struct Hook *, 0x80429c9d

FUNCTION

A hook to call for each file encountered. If the hook function returns TRUE, the file is included in the file list, otherwise it is rejected and not displayed. The function receives the following parameters:

struct Hook *hook (in A0)
the hook itself.
Object *obj (in A2)
a pointer to an ASL FileRequester structure.
struct AnchorPath *ap (in A1)
a pointer to an initialized AnchorPath structure.

All other filter attributes are ignored when a MUIA_Filepanel_FilterFunc is set.

SEE ALSO

MUIA_Filepanel_AcceptPattern, MUIA_Filepanel_RejectPattern, MUIA_Filepanel_Pattern

MUIA_Filepanel_Pattern

NAME

MUIA_Filepanel_Pattern — V20 [ISG], STRPTR, 0x8042c330

FUNCTION

Set a DOS pattern to match all found file names against. The given pattern string will be used in a case insensitive way if neither the accept nor the reject pattern excluded the file from exclusion.

EXAMPLE

set(panel, MUIA_Filepanel_Pattern, "#?.png");

SEE ALSO

MUIA_Filepanel_AcceptPattern, MUIA_Filepanel_RejectPattern

MUIA_Filepanel_RejectIcons

NAME

MUIA_Filepanel_RejectIcons — V20 [I.G], BOOL, 0x80423450

FUNCTION

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

MUIA_Filepanel_RejectPattern

NAME

MUIA_Filepanel_RejectPattern — V20 [I.G], STRPTR, 0x804281ab

FUNCTION

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

SEE ALSO

MUIA_Filepanel_AcceptPattern, MUIA_Filepanel_FilterDrawers


Copyright © 1992-2006 by Stefan Stuntz
Copyright © 2006-2017 by Thore Böckelmann, Jens Maus

MUI for AmigaOS - MUI-Autodocs

Updated: 13-Jul-2017

Last modified 4 months ago Last modified on Apr 4, 2017, 4:17:40 PM