*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->HP-UX 11i man pages -> XmFileSelectionBox (3)              
Title
Content
Arch
Section
 

Contents


 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




 NAME    [Toc]    [Back]
      XmFileSelectionBox - The FileSelectionBox widget class

 SYNOPSIS    [Toc]    [Back]
      #include <Xm/FileSB.h>

 DESCRIPTION    [Toc]    [Back]
      FileSelectionBox traverses through directories, views the files and
      subdirectories in them, and then selects files.

      A FileSelectionBox has five main areas:

         +  A text input field for displaying and editing a directory mask
            used to select the files to be displayed

         +  An optional text input field for displaying and editing a filter
            mask used to select the files to be displayed.

         +  A scrollable list of filenames

         +  A scrollable list of subdirectories

         +  A text input field for displaying and editing a filename

         +  A group of PushButtons, labeled OK, Filter, Cancel, and Help.
            The layout direction of the buttons depends on the
            XmNlayoutDirection resource.

      ####Additional children may be added to the FileSelectionBox after
      creation.  FileSelectionBox inherits the layout functionality provided
      by SelectionBox for any additional children.  To remove the list of
      filenames, the list of subdirectories, or both from the
      FileSelectionBox after creation, unmanage the appropriate widgets and
      their labels.  The list and label widgets are obtained through a call
      to the XmFileSelectionBoxGetChild function.  To remove either the
      directory list or the file list, unmanage the parent of the
      appropriate list widget and unmanage the corresponding label.

      The user can specify resources in a resource file for the
      automatically created widgets and gadgets of FileSelectionBox. The
      following list identifies the names of these widgets (or gadgets) and
      the associated FileSelectionBox areas:

      FilterLabel
                FilterText

      Filter Text
                TextField

      Directory List
                DirList



                                    - 1 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




      Directory List Label
                Dir

      DirL      Label

      DirText   TextField

      The directory mask is a string specifying the base directory to be
      examined and a search pattern.  Ordinarily, the directory list
      displays the subdirectories of the base directory, as well as the base
      directory itself and its parent directory.  The file list ordinarily
      displays all files and/or subdirectories in the base directory that
      match the search pattern.

      Optionally, the search pattern mask and the base directory can be
      displayed in two separate text fields. This option is controlled by
      the XmNpathMode resource. Using this alternate display does not change
      the meaning of resources that control the content of these fields:
      XmNdirectory, XmNdirMask, XmNpattern.

      A procedure specified by the XmNqualifySearchDataProc resource
      extracts the base directory and search pattern from the directory
      mask.  If the directory specification is empty, the current working
      directory is used.  If the search pattern is empty, a pattern that
      matches all files is used.

      An application can supply its own XmNqualifySearchDataProc as well as
      its own procedures to search for subdirectories and files.  The
      default XmNqualifySearchDataProc works as follows: The directory mask
      is a pathname that can contain zero or more wildcard characters in its
      directory portion, its file portion, or both.  The directory
      components of the directory mask - up to, but not including, the first
      component with a wildcard character - specify the directory to be
      searched, relative to the current working directory.  The remaining
      components specify the search pattern.  If the directory mask is empty
      or if its first component contains a wildcard character, the current
      working directory is searched.  If no component of the directory mask
      contains a wildcard character, the entire directory mask is the
      directory specification, and all files in that directory are matched.

      The user can select a new directory to examine by scrolling through
      the list of directories and selecting the desired directory or by
      editing the directory mask.  Selecting a new directory from the
      directory list does not change the search pattern.  A user can select
      a new search pattern by editing the directory mask or, when the
      FileSelectionBox has the optional XmNpathMode XmPATH_MODE_RELATIVE
      display, the filter text field.  Double clicking or pressing KActivate
      on a directory in the directory list initiates a search for files and
      subdirectories in the new directory, using the current search pattern.





                                    - 2 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




      The user can select a file by scrolling through the list of filenames
      and selecting the desired file or by entering the filename directly
      into the text edit area.  Selecting a file from the list causes that
      filename to appear in the file selection text edit area.

      The user may select a new file as many times as desired.  The
      application is not notified until the user takes one of the following
      actions:

         +  Selects the OK PushButton

         +  Presses KActivate while the selection text edit area has the
            keyboard focus

         +  Double clicks or presses KActivate on an item in the file list

      FileSelectionBox initiates a directory and file search when any of the
      following occurs:

         +  The FileSelectionBox is initialized

         +  The function XtSetValues is used to change XmNdirMask,
            XmNdirectory, XmNpattern, or XmNfileTypeMask

         +  The user activates the Filter PushButton

         +  The user double clicks or presses KActivate on an item in the
            directory list

         +  The application calls XmFileSelectionDoSearch

         +  The user presses KActivate while the directory mask text edit
            area has the keyboard focus

      When a file search is initiated, the FileSelectionBox takes the
      following actions:

         +  Constructs an XmFileSelectionBoxCallbackStruct structure with
            values appropriate for the action that initiated the search

         +  Calls the XmNqualifySearchDataProc with the callback structure
            as the data input argument

         +  Sets XmNdirectoryValid and XmNlistUpdated to False

         +  Calls the XmNdirSearchProc with the qualified data returned by
            the XmNqualifySearchDataProc

      If XmNdirectoryValid is True, the FileSelectionBox takes the following
      additional actions:




                                    - 3 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




         +  Sets XmNlistUpdated to False

         +  Calls the XmNfileSearchProc with the qualified data returned by
            the XmNqualifySearchDataProc (and possibly modified by the
            XmNdirSearchProc)

         +  If XmNlistUpdated is True and the file list is empty, displays
            the XmNnoMatchString in the file list and clears the selection
            text and XmNdirSpec

         +  If XmNlistUpdated is True and the file list is not empty, sets
            the selection text and XmNdirSpec to the qualified dir returned
            by the XmNqualifySearchDataProc (and possibly modified by the
            XmNdirSearchProc)

         +  Sets the directory mask text and XmNdirMask to the qualified
            mask returned by the XmNqualifySearchDataProc (and possibly
            modified by the XmNdirSearchProc)

         +  Sets XmNdirectory to the qualified dir returned by the
            XmNqualifySearchDataProc (and possibly modified by the
            XmNdirSearchProc)

         +  Sets XmNpattern to the qualified pattern returned by the
            XmNqualifySearchDataProc (and possibly modified by the
            XmNdirSearchProc)

      FileSelectionBox uses the XmQTactivatable trait.

    Data Transfer Behavior    [Toc]    [Back]
      Child widgets of a FileSelectionBox support the data transfer
      operations and targets associated with their widget classes.

      In addition, if the source of a data transfer is the directory list
      and if XmNdirSearchProc has its default value, the directory list
      supports the FILE and FILE_NAME targets.

      If the source of a data transfer is the file list and if
      XmNfileSearchProc has its default value, the file list supports the
      FILE and FILE_NAME targets.

      In either case, FileSelectionBox adds an XmNconvertCallback procedure
      to the appropriate list.  This procedure adds FILE and FILE_NAME to
      the TARGETS returned by the list.  It treats requests for conversion
      of a selection to FILE and FILE_NAME exactly like requests for
      conversion to TEXT.

      If an application changes XmNdirSearchProc or XmNfileSearchProc and
      wants to support the FILE and FILE_NAME targets on the corresponding
      list, it must provide support itself by adding a procedure to the
      list's XmNconvertCallback list.



                                    - 4 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




    Descendants    [Toc]    [Back]
      FileSelectionBox automatically creates the descendants shown in the
      following table.  An application can use XtNameToWidget to gain access
      to the named descendant. In addition, a user or an application can use
      the named descendant when specifying resource values.
      _______________________________________________________________________________
      |Named Descendant | Class                 | Identity                           |
      |_________________|_______________________|____________________________________|
      |_________________|_______________________|____________________________________|
      |_________________|_______________________|____________________________________|
      |Apply            | XmPushButtonGadget    | Apply button                       |
      |_________________|_______________________|____________________________________|
      |Cancel           | XmPushButtonGadget    | Cancel button                      |
      |_________________|_______________________|____________________________________|
      |Dir              | XmLabelGadget         | title above list of directories    |
      |_________________|_______________________|____________________________________|
      |DirList          | XmList                | list of directories                |
      |_________________|_______________________|____________________________________|
      |DirListSW        | XmScrolledWindow      | ScrolledWindow parent of DirList   |
      |_________________|_______________________|____________________________________|
      |FilterLabel      | XmLabelGadget         | title above filter box             |
      |_________________|_______________________|____________________________________|
      |FilterText       | XmText or XmTextField | text within filter box             |
      |_________________|_______________________|____________________________________|
      |Help             | XmPushButtonGadget    | Help button                        |
      |_________________|_______________________|____________________________________|
      |Items            | XmLabelGadget         | title above list of filenames      |
      |_________________|_______________________|____________________________________|
      |ItemsList        | XmList                | list of filenames                  |
      |_________________|_______________________|____________________________________|
      |ItemsListSW      | XmScrolledWindow      | ScrolledWindow parent of ItemsList |
      |_________________|_______________________|____________________________________|
      |OK               | XmPushButtonGadget    | OK button                          |
      |_________________|_______________________|____________________________________|
      |Selection        | XmLabelGadget         | title above selection box          |
      |_________________|_______________________|____________________________________|
      |Separator        | XmSeparatorGadget     | optional dividing line             |
      |_________________|_______________________|____________________________________|
      |Text             | XmText or XmTextField | text within selection box          |
      |_________________|_______________________|____________________________________|
      |_________________|_______________________|____________________________________|

    Classes    [Toc]    [Back]
      FileSelectionBox inherits behavior, resources, and traits from Core,
      Composite, Constraint, XmManager, XmBulletinBoard, and XmSelectionBox.

      The class pointer is xmFileSelectionBoxWidgetClass.

      The class name is XmFileSelectionBox.





                                    - 5 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




    New Resources    [Toc]    [Back]
      The following table defines a set of widget resources used by the
      programmer to specify data. The programmer can also set the resource
      values for the inherited classes to set attributes for this widget. To
      reference a resource by name or by class in a .Xdefaults file, remove
      the XmN or XmC prefix and use the remaining letters. To specify one of
      the defined values for a resource in a .Xdefaults file, remove the Xm
      prefix and use the remaining letters (in either lowercase or
      uppercase, but include any underscores between words).  The codes in
      the access column indicate if the given resource can be set at
      creation time (C), set by using XtSetValues (S), retrieved by using
      XtGetValues (G), or is not applicable (N/A).










































                                    - 6 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




      __________________________________________________________________________________________________
      |                                XmFileSelectionBox Resource Set                                  |
      |Name                       Class                      Type            Default             Access |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirectory             | XmCDirectory             | XmString      | dynamic           | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirectoryValid        | XmCDirectoryValid        | Boolean       | dynamic           | SG     |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirListItems          | XmCDirListItems          | XmStringTable | dynamic           | SG     |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirListItemCount      | XmCDirListItemCount      | int           | dynamic           | SG     |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirListLabelString    | XmCDirListLabelString    | XmString      | dynamic           | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirMask               | XmCDirMask               | XmString      | dynamic           | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirSearchProc         | XmCDirSearchProc         | XmSearchProc  | default procedure | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirSpec               | XmCDirSpec               | XmString      | dynamic           | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNdirTextLabelString    | XmCDirTextLabelString    | XmString      | NULL              | C      |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNfileFilterStyle       | XmCFileFilterStyle       | XtEnum        | XmFILTER_NONE     | C      |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNfileListItems         | XmCItems                 | XmStringTable | dynamic           | SG     |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNfileListItemCount     | XmCItemCount             | int           | dynamic           | SG     |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNfileListLabelString   | XmCFileListLabelString   | XmString      | dynamic           | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNfileSearchProc        | XmCFileSearchProc        | XmSearchProc  | default procedure | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNfileTypeMask          | XmCFileTypeMask          | unsigned char | XmFILE_REGULAR    | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNfilterLabelString     | XmCFilterLabelString     | XmString      | dynamic           | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNlistUpdated           | XmCListUpdated           | Boolean       | dynamic           | SG     |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNnoMatchString         | XmCNoMatchString         | XmString      | " [    ] "        | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNpathMode              | XmCPathMode              | XtEnum        | XmPATH_MODE_FULL  | C      |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNpattern               | XmCPattern               | XmString      | dynamic           | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |XmNqualifySearchDataProc | XmCQualifySearchDataProc | XmQualifyProc | default procedure | CSG    |
      |_________________________|__________________________|_______________|___________________|________|
      |_________________________|__________________________|_______________|___________________|________|

      XmNdirectory    [Toc]    [Back]
                Specifies the base directory used in combination with
                XmNpattern in determining the files and directories to be



                                    - 7 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




                displayed.  The default value is determined by the
                XmNqualifySearchDataProc and depends on the initial values
                of XmNdirMask, XmNdirectory, and XmNpattern.  If the default
                is NULL or empty, the current working directory is used.

      XmNdirectoryValid    [Toc]    [Back]
                Specifies an attribute that is set only by the directory
                search procedure.  The value is set to True if the directory
                passed to the directory search procedure can actually be
                searched.  If this value is False the file search procedure
                is not called, and XmNdirMask, XmNdirectory, and XmNpattern
                are not changed.

      XmNdirListItems    [Toc]    [Back]
                Specifies the items in the directory list.  XtGetValues for
                this resource returns the list items themselves, not a copy
                of the list items.  The application must not free the
                returned items.

      XmNdirListItemCount    [Toc]    [Back]
                Specifies the number of items in the directory list.  The
                value must not be negative.

      XmNdirListLabelString    [Toc]    [Back]
                Specifies the label string of the directory list.  The
                default for this resource depends on the locale.  In the C
                locale the default is Directories.

                Now that some default localized label strings are provided
                through message catalogs for the children of composite
                widgets, the labelString resources cannot be set on the
                child through default resource files.  Instead, the resource
                provided at the parent level must be used.

      XmNdirMask    [Toc]    [Back]
                Specifies the directory mask used in determining the files
                and directories to be displayed.  The default value is
                determined by the XmNqualifySearchDataProc and depends on
                the initial values of XmNdirMask, XmNdirectory, and
                XmNpattern.

      XmNdirSearchProc    [Toc]    [Back]
                Specifies a directory search procedure to replace the
                default directory search procedure.  FileSelectionBox's
                default directory search procedure fulfills the needs of
                most applications.  Because it is impossible to cover the
                requirements of all applications, you can replace the
                default search procedure.

                The directory search procedure is called with two arguments:
                the FileSelectionBox widget and a pointer to an



                                    - 8 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




                XmFileSelectionBoxCallbackStruct structure.  The callback
                structure is generated by the XmNqualifySearchDataProc and
                contains all information required to conduct a directory
                search, including the directory mask and a qualified base
                directory and search pattern.  Once called, it is up to the
                search routine to generate a new list of directories and
                update the FileSelectionBox widget by using XtSetValues.

                The search procedure must set XmNdirectoryValid and
                XmNlistUpdated.  If it generates a new list of directories,
                it must also set XmNdirListItems and XmNdirListItemCount.

                If the search procedure cannot search the specified
                directory, it must warn the user and set XmNdirectoryValid
                and XmNlistUpdated to False, unless it prompts and
                subsequently obtains a valid directory.  If the directory is
                valid but is the same as the current XmNdirectory, the
                search procedure must set XmNdirectoryValid to True, but it
                may elect not to generate a new list of directories.  In
                this case, it must set XmNlistUpdated to False.

                If the search procedure generates a new list of directories,
                it must set XmNdirListItems to the new list of directories
                and XmNdirListItemCount to the number of items in the list.
                If there are no directories, it sets XmNdirListItems to NULL
                and XmNdirListItemCount to 0 (zero).  In either case, it
                must set XmNdirectoryValid and XmNlistUpdated to True.

                The search procedure ordinarily should not change the
                callback structure.  But if the original directory is not
                valid, the search procedure may obtain a new directory from
                the user.  In this case, it should set the dir member of the
                callback structure to the new directory, call the
                XmNqualifySearchDataProc with the callback struct as the
                input argument, and copy the qualified data returned by the
                XmNqualifySearchDataProc into the callback struct.

      XmNdirSpec    [Toc]    [Back]
                Specifies the full file path specification.  This is the
                XmNtextString resource in SelectionBox, renamed for
                FileSelectionBox.  The default value is determined by the
                FileSelectionBox after conducting the initial directory and
                file search.

      XmNdirTextLabelString    [Toc]    [Back]
                Uses the specified XmString as the label above the TextField
                directory. The resource takes effect when the XmNpathMode
                resource has a value of XmPATH_MODE_RELATIVE. It is ignored
                when the XmNpathMode resource has a value of
                XmPATH_MODE_FULL.




                                    - 9 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




                Now that some default localized label strings are provided
                through message catalogs for the children of composite
                widgets, the labelString resources cannot be set on the
                child through default resource files.  Instead, the resource
                provided at the parent level must be used.

      XmNfileFilterStyle    [Toc]    [Back]
                Specifies whether or not the "hidden" files (those whose
                names begin with . (period) in POSIX systems) will be listed
                in the file and directory scrolling lists (where the default
                directory search procedure is used).  The possible values
                are:

                XmFILTER_NONE    [Toc]    [Back]
                          Does not filter hidden files.

                XmFILTER_HIDDEN_FILES    [Toc]    [Back]
                          Restricts the list of possible file names, such as
                          those beginning with . (period).

      XmNfileListItems    [Toc]    [Back]
                Specifies the items in the file list.  This is the
                XmNlistItems resource in SelectionBox, renamed for
                FileSelectionBox.  XtGetValues for this resource returns the
                list items themselves, not a copy of the list items.  The
                application must not free the returned items.

      XmNfileListItemCount    [Toc]    [Back]
                Specifies the number of items in the file list.  This is the
                XmNlistItemCount resource in SelectionBox, renamed for
                FileSelectionBox.  The value must not be negative.

      XmNfileListLabelString    [Toc]    [Back]
                Specifies the label string of the file list.  This is the
                XmNlistLabelString resource in SelectionBox, renamed for
                FileSelectionBox.  The default for this resource depends on
                the locale.  In the C locale the default is Files.

                Now that some default localized label strings are provided
                through message catalogs for the children of composite
                widgets, the labelString resources cannot be set on the
                child through default resource files.  Instead, the resource
                provided at the parent level must be used.

      XmNfileSearchProc    [Toc]    [Back]
                Specifies a file search procedure to replace the default
                file search procedure.  FileSelectionBox's default file
                search procedure fulfills the needs of most applications.
                Because it is impossible to cover the requirements of all
                applications, you can replace the default search procedure.




                                   - 10 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




                The file search procedure is called with two arguments: the
                FileSelectionBox widget and a pointer to an
                XmFileSelectionBoxCallbackStruct structure.  The callback
                structure is generated by the XmNqualifySearchDataProc (and
                possibly modified by the XmNdirSearchProc).  It contains all
                information required to conduct a file search, including the
                directory mask and a qualified base directory and search
                pattern.  Once this procedure is called, it is up to the
                search routine to generate a new list of files and update
                the FileSelectionBox widget by using XtSetValues.

                The search procedure must set XmNlistUpdated.  If it
                generates a new list of files, it must also set
                XmNfileListItems and XmNfileListItemCount.

                It is recommended that the search procedure always generate
                a new list of files.  If the mask member of the callback
                structure is the same as the mask member of the callback
                struct in the preceding call to the search procedure, the
                procedure may elect not to generate a new list of files.  In
                this case it must set XmNlistUpdated to False.

                If the search procedure generates a new list of files, it
                must set XmNfileListItems to the new list of files and
                XmNfileListItemCount to the number of items in the list.  If
                there are no files, it sets XmNfileListItems to NULL and
                XmNfileListItemCount to 0 (zero).  In either case it must
                set XmNlistUpdated to True.

                In constructing the list of files, the search procedure
                should include only files of the types specified by the
                widget's XmNfileTypeMask.

                Setting XmNdirSpec is optional, but recommended.  Set this
                attribute to the full file specification of the directory
                searched.  The directory specification is displayed below
                the directory and file lists.

      XmNfileTypeMask    [Toc]    [Back]
                Specifies the type of files listed in the file list.  The
                possible values are

                XmFILE_REGULAR    [Toc]    [Back]
                          Restricts the file list to contain only regular
                          files.

                XmFILE_DIRECTORY    [Toc]    [Back]
                          Restricts the file list to contain only
                          directories.





                                   - 11 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




                XmFILE_ANY_TYPE    [Toc]    [Back]
                          Allows the list to contain all file types
                          including directories.

      XmNfilterLabelString    [Toc]    [Back]
                Specifies the label string for the text entry field for the
                directory mask.  The default for this resource depends on
                the locale.  In the C locale the default is Filter.

                Now that some default localized label strings are provided
                through message catalogs for the children of composite
                widgets, the labelString resources cannot be set on the
                child through default resource files.  Instead, the resource
                provided at the parent level must be used.

      XmNlistUpdated    [Toc]    [Back]
                Specifies an attribute that is set only by the directory and
                file search procedures.  This resource is set to True if the
                search procedure updated the directory or file list.

      XmNnoMatchString    [Toc]    [Back]
                Specifies a string to be displayed in the file list if the
                list of files is empty.

      XmNpattern    [Toc]    [Back]
                Specifies the search pattern used in combination with
                XmNdirectory in determining the files and directories to be
                displayed.  The default value is determined by
                XmNqualifySearchDataProc and depends on the initial values
                of XmNdirMask, XmNdirectory, and XmNpattern.  If the default
                is NULL or empty, a pattern that matches all files is used.

      XmNpathMode    [Toc]    [Back]
                Specifies whether or not an additional text field will be
                used to display and edit the filter. The possible values are

                XmPATH_MODE_FULL    [Toc]    [Back]
                          Specifies that no additional text field will be
                          used to display the filter. There will just be a
                          single text field to display XmNdirMask.

                XmPATH_MODE_RELATIVE    [Toc]    [Back]
                          Specifies that there will be two text field
                          displays, one to display the XmNdirectory and one
                          to display the XmNpattern. In this instance, the
                          XmNfilterLabelString resource applies to the text
                          field for XmNpattern and XmNdirTextLabelString
                          applies to the text field for XmNdirectory.

      XmNqualifySearchDataProc    [Toc]    [Back]
                Specifies a search data qualification procedure to replace



                                   - 12 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




                the default data qualification procedure.
                FileSelectionBox's default data qualification procedure
                fulfills the needs of most applications.  Because it is
                impossible to cover the requirements of all applications,
                you can replace the default procedure.

                The data qualification procedure is called to generate a
                qualified directory mask, base directory, and search pattern
                for use by the directory and file search procedures.  It is
                called with three arguments: the FileSelectionBox widget and
                pointers to two XmFileSelectionBoxCallbackStruct structures.
                The first callback structure contains the input data.  The
                second callback structure contains the output data, to be
                filled in by the data qualification procedure.

                If the input dir and pattern members are not NULL, the
                procedure must copy them to the corresponding members of the
                output callback structure.

                If the input dir is NULL, the procedure constructs the
                output dir as follows: If the input mask member is NULL, the
                procedure uses the widget's XmNdirectory as the output dir;
                otherwise, it extracts the output dir from the input mask.
                If the resulting output dir is empty, the procedure uses the
                current working directory instead.

                If the input pattern is NULL, the procedure constructs the
                output pattern as follows: If the input mask member is NULL,
                the procedure uses the widget's XmNpattern as the output
                pattern; otherwise, it extracts the output pattern from the
                input mask.  If the resulting output pattern is empty, the
                procedure uses a pattern that matches all files instead.

                The data qualification procedure constructs the output mask
                from the output dir and pattern.  The procedure must ensure
                that the output dir, pattern, and mask are fully qualified.

                If the input value member is not NULL, the procedure must
                copy it to the output value member; otherwise, the procedure
                must copy the widget's XmNdirSpec to the output value.

                The data qualification procedure must calculate the lengths
                of the output value, mask, dir, and pattern members and must
                fill in the corresponding length members of the output
                callback struct.

                The data qualification procedure must copy the input reason
                and event members to the corresponding output members.

      The values of the XmNdirSearchProc and XmNfileSearchProc are procedure
      pointers of type XmSearchProc, defined as follows:



                                   - 13 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




      void (* XmSearchProc) (w, search_data)
              Widget w;
              XtPointer search_data;

      w         The FileSelectionBox widget

      search_data
                Pointer to an XmFileSelectionBoxCallbackStruct containing
                information for conducting a search

      The value of the XmNqualifySearchDataProc resource is a procedure
      pointer of type XmQualifyProc, defined as follows:

      void (* XmQualifyProc) (w, input_data, output_data)
              Widget w;
              XtPointer input_data;
              XtPointer output_data;

      w         The FileSelectionBox widget

      input_data
                Pointer to an XmFileSelectionBoxCallbackStruct containing
                input data to be qualified

      output_data
                Pointer to an XmFileSelectionBoxCallbackStruct containing
                output data to be filled in by the qualification procedure

    Inherited Resources    [Toc]    [Back]
      FileSelectionBox inherits behavior and resources from the superclasses
      described in the following tables.  For a complete description of each
      resource, refer to the reference page for that superclass.






















                                   - 14 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




      _______________________________________________________________________________________________________
      |                                     XmSelectionBox Resource Set                                      |
      |Name                      Class                     Type             Default                   Access |
      |________________________|_________________________|________________|_________________________|________|
      |XmNapplyCallback        | XmCCallback             | XtCallbackList | NULL                    | C      |
      |________________________|_________________________|________________|_________________________|________|
      |XmNapplyLabelString     | XmCApplyLabelString     | XmString       | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNcancelCallback       | XmCCallback             | XtCallbackList | NULL                    | C      |
      |________________________|_________________________|________________|_________________________|________|
      |XmNcancelLabelString    | XmCCancelLabelString    | XmString       | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNchildPlacement       | XmCChildPlacement       | unsigned char  | XmPLACE_ABOVE_SELECTION | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNdialogType           | XmCDialogType           | unsigned char  | XmDIALOG_FILE_SELECTION | G      |
      |________________________|_________________________|________________|_________________________|________|
      |XmNhelpLabelString      | XmCHelpLabelString      | XmString       | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNlistItemCount        | XmCItemCount            | int            | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNlistItems            | XmCItems                | XmStringTable  | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNlistLabelString      | XmCListLabelString      | XmString       | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNlistVisibleItemCount | XmCVisibleItemCount     | int            | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNminimizeButtons      | XmCMinimizeButtons      | Boolean        | False                   | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNmustMatch            | XmCMustMatch            | Boolean        | False                   | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNnoMatchCallback      | XmCCallback             | XtCallbackList | NULL                    | C      |
      |________________________|_________________________|________________|_________________________|________|
      |XmNokCallback           | XmCCallback             | XtCallbackList | NULL                    | C      |
      |________________________|_________________________|________________|_________________________|________|
      |XmNokLabelString        | XmCOkLabelString        | XmString       | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNselectionLabelString | XmCSelectionLabelString | XmString       | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNtextAccelerators     | XmCTextAccelerators     | XtAccelerators | default                 | C      |
      |________________________|_________________________|________________|_________________________|________|
      |XmNtextColumns          | XmCColumns              | short          | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |XmNtextString           | XmCTextString           | XmString       | dynamic                 | CSG    |
      |________________________|_________________________|________________|_________________________|________|
      |________________________|_________________________|________________|_________________________|________|









                                   - 15 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




      _______________________________________________________________________________________
      |                            XmBulletinBoard Resource Set                              |
      |Name                   Class                  Type             Default         Access |
      |_____________________|______________________|________________|_______________|________|
      |XmNallowOverlap      | XmCAllowOverlap      | Boolean        | True          | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNautoUnmanage      | XmCAutoUnmanage      | Boolean        | False         | CG     |
      |_____________________|______________________|________________|_______________|________|
      |XmNbuttonFontList    | XmCButtonFontList    | XmFontList     | dynamic       | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNbuttonRenderTable | XmCButtonRenderTable | XmRenderTable  | dynamic       | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNcancelButton      | XmCWidget            | Widget         | Cancel button | SG     |
      |_____________________|______________________|________________|_______________|________|
      |XmNdefaultButton     | XmCWidget            | Widget         | OK button     | SG     |
      |_____________________|______________________|________________|_______________|________|
      |XmNdefaultPosition   | XmCDefaultPosition   | Boolean        | True          | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNdialogStyle       | XmCDialogStyle       | unsigned char  | dynamic       | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNdialogTitle       | XmCDialogTitle       | XmString       | NULL          | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNfocusCallback     | XmCCallback          | XtCallbackList | NULL          | C      |
      |_____________________|______________________|________________|_______________|________|
      |XmNlabelFontList     | XmCLabelFontList     | XmFontList     | dynamic       | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNlabelRenderTable  | XmCLabelRenderTable  | XmRenderTable  | dynamic       | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNmapCallback       | XmCCallback          | XtCallbackList | NULL          | C      |
      |_____________________|______________________|________________|_______________|________|
      |XmNmarginHeight      | XmCMarginHeight      | Dimension      | 10            | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNmarginWidth       | XmCMarginWidth       | Dimension      | 10            | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNnoResize          | XmCNoResize          | Boolean        | False         | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNresizePolicy      | XmCResizePolicy      | unsigned char  | XmRESIZE_ANY  | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNshadowType        | XmCShadowType        | unsigned char  | XmSHADOW_OUT  | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNtextFontList      | XmCTextFontList      | XmFontList     | dynamic       | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNtextRenderTable   | XmCTextRenderTable   | XmRenderTable  | dynamic       | CSG    |
      |_____________________|______________________|________________|_______________|________|
      |XmNtextTranslations  | XmCTranslations      | XtTranslations | NULL          | C      |
      |_____________________|______________________|________________|_______________|________|
      |XmNunmapCallback     | XmCCallback          | XtCallbackList | NULL          | C      |
      |_____________________|______________________|________________|_______________|________|
      |_____________________|______________________|________________|_______________|________|





                                   - 16 -       Formatted:  January 24, 2005






 XmFileSelectionBox(library call)           XmFileSelectionBox(library call)




      _____________________________________________________________________________________________________
      |                                      XmManager Resource Set                                        |
      |Name                      Class                   Type                Default                Access |
      |________________________|_______________________|___________________|______________________|________|
      |XmNbottomShadowColor    | XmCBottomShadowColor  | Pixel             | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNbottomShadowPixmap   | XmCBottomShadowPixmap | Pixmap            | XmUNSPECIFIED_PIXMAP | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNforeground           | XmCForeground         | Pixel             | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNhelpCallback         | XmCCallback           | XtCallbackList    | NULL                 | C      |
      |________________________|_______________________|___________________|______________________|________|
      |XmNhighlightColor       | XmCHighlightColor     | Pixel             | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNhighlightPixmap      | XmCHighlightPixmap    | Pixmap            | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNinitialFocus         | XmCInitialFocus       | Widget            | dynamic              | CSG    |
      |________________________|_______________________|___________________|______________________|________|
      |XmNlayoutDirection      | XmCLayoutDirection    | XmDirection       | dynamic              | CG     |
      |________________________|_______________________|___________________|______________________|________|
      |XmNnavigationType       | XmCNavigationType     | XmNavigationType  | XmTAB_GROUP          | CSG    |
      

 Similar pages
Name OS Title
SgFileSelectionBox IRIX The enhanced FileSelectionBox widget
XmCreateFileSelectionBox IRIX The FileSelectionBox widget creation function
XmCreateFileSelectionBox HP-UX The FileSelectionBox widget creation function
XmCreateFileSelectionBox Tru64 The FileSelectionBox widget creation function
SgCreateFileSelectionBox IRIX The FileSelectionBox widget creation function
XmCommand IRIX The Command widget class
tmarrowbutton IRIX the ArrowButton widget class
XmText HP-UX The Text widget class
SgGrid IRIX The SgGrid widget class
XmSpinBox HP-UX The SpinBox widget class
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service