Fl_Native_File_Chooser

Examples of Fl_Native_File_Chooser on different platforms.

class Fl_Native_File_Chooser

Class Hierarchy

  Fl_Native_File_Chooser
  

Include Files

  #include "FL/Fl_Native_File_Chooser.H"
  

Description

Methods

Fl_Native_File_Chooser::Fl_Native_File_Chooser()
Fl_Native_File_Chooser::Fl_Native_File_Chooser(type)

The constructor for the Fl_Native_File_Chooser.

If the optional type is not specified, BROWSE_FILE (browse to open a file) is assumed. The type can also be set later with type().

Fl_Native_File_Chooser::~Fl_Native_File_Chooser()

int Fl_Native_File_Chooser::count() const

Returns the number of filenames (or directory names) the user selected. These are zero-indexed. See this example of how to retrieve multiple filenames.

void Fl_Native_File_Chooser::directory(const char*)
const char* Fl_Native_File_Chooser::directory() const;

Sets the directory with which to start the chooser. If NULL is passed, or if no directory is specified, the chooser will attempt to use the last non-cancelled folder.

const char *Fl_Native_File_Chooser::errmsg() const

Returns a system dependent error message for the last method that failed. This message should at least be flagged to the user in a dialog box, or to some kind of error log.

const char *Fl_Native_File_Chooser::filename() const
const char *Fl_Native_File_Chooser::filename(int) const

The first form returns the single filename selected by the user from the browser. (In a multiple browser context, this returns the first filename the user selected).

The second form should be used to return multiple filenames, and is normally used inside a loop to retrieve all the files the user selected, eg:

        if ( chooser->show() == 0 ) {
            // HANDLE MULTIPLE FILENAMES
            for (int n = 0; n < chooser->count(); n++ ) {
      	        fprintf(stderr, "%d) '%s'\n", n, chooser->filename(n));
            }
	}
    

You can preset the directory with directory() method, and the filename using the preset_file() method.

const char *Fl_Native_File_Chooser::filter() const
void Fl_Native_File_Chooser::filter(const char*)

Gets or sets the filename filters used for browsing. The default is NULL, which browses all files.

The filter string can be any of:

• A single wildcard (eg. "*.txt")
• Multiple wildcards (eg. "*.{cxx,h,H})
• A descriptive name followed by a '\t' and a wildcard (eg. "Text Files\t*.txt")
• A list of separate wildcards with a \n between each (eg. "*.{cxx,H}\n*.txt")
• A list of descriptive names and wildcards (eg. "C++ Files\t*.{cxx,H}\nTxt Files\t*.txt")

The format of each filter is a wildcard, or an optional user description followed by '\t' and the wildcard.

On most platforms, each filter is available to the user via a pulldown menu in the file chooser. The 'All Files' option is always available to the user.

void Fl_Native_File_Chooser::filter_value(int)
int Fl_Native_File_Chooser::filter_value()

The first form sets which filter will be initially selected.
The second returns which filter was chosen. This is only valid if the chooser returns success.


The first filter is indexed as 0. If filter_value()==filters(), then "All Files" was chosen. If filter_value() > filters(), then a custom filter was set.

int Fl_Native_File_Chooser::filters()

Gets how many filters were available, not including "All Files"

void Fl_Native_File_Chooser::preset_file(const char*)
const char* Fl_Native_File_Chooser::preset_file()

Sets a default filename for the chooser. (Use directory() to set the default directory)
Mainly used to preset the filename for save dialogs, and on most platforms can be used for opening files as well.

int Fl_Native_File_Chooser::show() const

Opens the current file chooser on the screen. This method will block until the user has chosen something, or cancelled.

Return value:

• 0 - user picked a file, filename() will have the result
• 1 - user hit 'cancel'
• -1 - failed; errmsg() has reason

const char *Fl_Native_File_Chooser::title() const
void Fl_Native_File_Chooser::title(const char*)

Gets or sets the title of the file chooser's window.

The default title varies according to the platform, so you are advised to set the title explicitly.

Fl_Native_File_Chooser::Type Fl_Native_File_Chooser::type() const
Fl_Native_File_Chooser::type(Fl_Native_File_Chooser::Type)

Gets or sets the current type of browser. Possible choices are:
• Fl_Native_File_Chooser::BROWSE_FILE - browse for a file
• Fl_Native_File_Chooser::BROWSE_DIRECTORY - browse for a directory
• Fl_Native_File_Chooser::BROWSE_MULTI_FILE - browse for multiple files
• Fl_Native_File_Chooser::BROWSE_MULTI_DIRECTORY - browse for multiple directories (implementation varies)
• Fl_Native_File_Chooser::BROWSE_SAVE_FILE - browse to save a file
• Fl_Native_File_Chooser::BROWSE_SAVE_DIRECTORY - browse for a directory, allowing creation
These may be changed in future versions of Fl_Native_File_Chooser.

Typical Platform Independent Usage

// EXAMPLE OPEN FILE BROWSER
#include "Fl_Native_File_Chooser.H"
:
Fl_Native_File_Chooser *chooser = new Fl_Native_File_Chooser();
chooser->type(Fl_Native_File_Chooser::BROWSE_FILE);   // let user browse a single file
chooser->title("Open a file");                        // optional title for chooser window
chooser->directory("/var/tmp");                       // optional starting directory
chooser->filter("Text Files\t*.txt");                 // optional filter
switch ( chooser->show() ) {
    case -1:    // ERROR
	fprintf(stderr, "*** ERROR show() failed:%s\n", chooser->errmsg());
	break;
    case 1:     // CANCEL
	fprintf(stderr, "*** CANCEL\n");
	break;
    default:    // USER PICKED A FILE
        fprintf(stderr, "Filename was '%s'\n", chooser->filename());
	break;
}

// EXAMPLE 'SAVEAS' FILE BROWSER
#include "Fl_Native_File_Chooser.H"
:
Fl_Native_File_Chooser *chooser = new Fl_Native_File_Chooser();
chooser->type(Fl_Native_File_Chooser::BROWSE_SAVE_FILE);   // 'saveas' browser
chooser->title("Save As..");                               // optional title for chooser window
chooser->directory("/var/tmp");                            // optional starting directory
chooser->preset_file("untitled.txt");                      // optional default filename
chooser->filter("Text Files\t*.txt");                      // optional filter
switch ( chooser->show() ) {
    case -1:    // ERROR
	fprintf(stderr, "*** ERROR show() failed:%s\n", chooser->errmsg());
	break;
    case 1:     // CANCEL
	fprintf(stderr, "*** CANCEL\n");
	break;
    default:    // USER PICKED A FILE
        fprintf(stderr, "Filename was '%s'\n", chooser->filename());
	break;
}