getfile.gadget Reference¶

Comprehensive function reference for getfile.gadget, synthesised from the AmigaOS NDK 3.2 Release 4 (Autodocs/getfile).

This page documents 2 functions of getfile.gadget. Each function entry follows the canonical autodoc format. struct Name, union Name, enum Name are clickable links to the type definition in the types reference.

`getfile_gc()`¶

**getfile_gc -- create getfile BOOPSI objects

SUPERCLASS gadgetclass

DESCRIPTION The getfile gadget class is used to get files and drawers from a file requester in an easy and consistent way. It consists of two button gadgets, one read-only and one popfile/popdrawer button, that are used to select the file(s)/drawer and show the result.

   Advantages that this class provides:

   > Consistent behaviour and look in all applications using this class
     instead of doing their own file and drawer routines.

   > Easy to use.


METHODS
   OM_NEW -- Passed to superclass, defaults set, then OM_SET. Children
             created.

   OM_SET -- Passed to superclass, custom tags set.

   OM_GET -- Custom tag returned or passed to superclass.

   OM_UPDATE -- Passed to superclass, options set then rendered.

   OM_DISPOSE -- Children disposed of, then passed to superclass.

   GM_RENDER -- Passed to superclass, then children are rendered.

   GM_HITTEST -- Overrides superclass, returns GMR_GADGETHIT if within
             the popfile/drawer button.

   GM_HELPTEST -- Overrides superclass, returns GMR_HELPHIT if within
             the domain of the gadget.

   GM_GOACTIVE -- Passed to superclass, passed to popfile/drawer button.

   GM_HANDLEINPUT -- Overrides superclass, all input processed.

   GM_GOINACTIVE -- Passed to superclass, popfile/drawer button deactivat

ed.

   GM_DOMAIN -- Returns GDOMAIN_MINIMUM and GDOMAIN_MAXIMUM dimensions.

   GM_KEYACTIVE -- Private method for keyboard control.

   GM_KEYINACTIVE -- Private method for keyboard control.

   GFILE_REQUEST -- getfile gadget method for invoking the file requester

   GFILE_FREELIST -- getfile gadget method for freeing allocated list
               of files.

ATTRIBUTES
   Most of these tags operate the same as the ASLFR_#? tags in ASL librar

y. See for detailed descriptions.

   GETFILE_TitleText (STRPTR)
       Requester title text.

      Defaults to NULL.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_LeftEdge (WORD)
   GETFILE_TopEdge  (WORD)
      Requester placement coordinates.

      Default to ~0, meaning use default ASL placement.

      Applicability is (OM_NEW, OM_SET, OM_GET).

   GETFILE_Width  (WORD)
   GETFILE_Height (WORD)
      Requester dimensions.

      Default to ~0, meaning use default ASL size.

      Applicability is (OM_NEW, OM_SET, OM_GET).

   GETFILE_File (STRPTR)
      Contents of file gadget.

      Defaults to NULL.

      Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).

   GETFILE_Drawer (STRPTR)
      Contents of drawer gadget.

      Defaults to NULL.

      Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).

   GETFILE_FullFile (STRPTR)
      Complete qualified file name. Replaces GETFILE_Drawer and GETFILE_F

ile.

      Defaults to NULL.

      Applicability is (OM_NEW, OM_SET, OM_GET, OM_NOTIFY).

   GETFILE_FullFileExpand (BOOL)
      GETFILE_FullFile will give complete file name(s) expanded with
      NameFromLock() to remove relative paths.

      Defaults to TRUE.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_Pattern (STRPTR)
      Contents of pattern gadget.

      Defaults to "#?".

      Applicability is (OM_NEW, OM_SET, OM_GET).

   GETFILE_DoSaveMode (BOOL)
      Being used for saving?

      Defaults to FALSE.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_DoMultiSelect (BOOL)
      Do multi-select of files?

      Defaults to FALSE.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_DoPatterns (BOOL)
      Display a Pattern gadget?

      Defaults to FALSE.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_DrawersOnly  (BOOL)
      Don't display files?

      Defaults to FALSE.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_FilterFunc (struct Hook *)
      Function to filter files.

      Defaults to none.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_RejectIcons  (BOOL)
      Display .info files?

      Defaults to FALSE.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_RejectPattern    (UBYTE *)
      Don't display files matching pattern.

      Defaults to none.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_AcceptPattern (UBYTE *)
      Accept only files matching pattern.

      Defaults to none.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_FilterDrawers (BOOL)
      Also filter drawers with pattern.

      Defaults to FALSE.

      Applicability is (OM_NEW, OM_SET).

   GETFILE_Filelist (struct List *)
      If the GETFILE_DoMultiSelect tags was used, you can get a pointer
      to the list of selected files/drawers using this tag. The ln_Name
      part of each node will contain the filename/drawername for each
      selected file with a fully qualified path, even if you didn't use
      the GETFILE_FullFileExpand.
      In single-selected mode, the list will contain the single selected
      file for notification purposes. Don't forget to free the list using
      the GFILE_FREELIST method! This list is not suitable to be shown
      directly in a listbrowser gadget without conversion as default, use
      GETFILE_LBNodeStruct for that.

      Applicability is (OM_GET, OM_NOTIFY).

   GETFILE_LBNodeStruct (BOOL)
      GETFILE_Filelist will give a list with ListBrowserNodes instead of
      normal struct Node node structures. NOTE: This tag requires that
      listbrowser.gadget is installed.

      Defaults to FALSE.

      Applicability is (OM_NEW).

   GETFILE_ReadOnly (BOOL)
      If TRUE, a read-only recessed button gadget is used to present the
      file/drawer information. If FALSE, an editable string gadget is use

d. The gadget will send the supported attributes in a OM_NOTIFY when a this tag is FALSE and the user is finished editing the content of t he string gadget. The application can be aware of all changes to the string gadget by setting ICA_TARGET to TARGET_IDCMP for this getfile gadget instance and watching IDCMP_IDCMPUPDATE messages. See the provided example program for an example on how this can be done. V44 - note, IDCMP Code will be set equal to the GadgetID if the popup button was clicked, and zero if the string was active.

      Defaults to FALSE.

      Applicability is (OM_NEW).**

`GETFILE_GetClass()`¶

GETFILE_GetClass -- Gets the pointer to the file requester class

Synopsis

getfile_class = GETFILE_GetClass();
D0

Class * GETFILE_GetClass( void );

Function

   Obtains the pointer to the getfile gadget class for use with
   NewObject().  This function always returns a valid pointer so
   you do not need to check it.  The reason is that if the library
   opens fine, then the pointer returned is already setup.  (Of course
   this implies that if opening the library fails, you shouldn't be
   calling this.)

   Note that this function does not create the class, that is done
   when the class library is opened.

Inputs

RESULT getfile_class - Pointer to the getfile gadget class.

EXAMPLE

Notes

   The GFILE_REQUEST method will return 0 if no file is selected and
   the GETFILE_DrawersOnly tag is not used, even is the user selected
   the positive response in the requester. If a file is selected (the
   file gadget in the file requester is not empty), it will return 1.

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search

getfile.gadget Reference¶

Function index¶

getfile_gc()¶

GETFILE_GetClass()¶

`getfile_gc()`¶

`GETFILE_GetClass()`¶