Fl_Native_File_Chooser.H

Go to the documentation of this file.

//
// "$Id: Fl_Native_File_Chooser.H 9825 2013-02-19 15:19:58Z manolo $"
//
// FLTK native OS file chooser widget
//
// Copyright 1998-2010 by Bill Spitzak and others.
// Copyright 2004 Greg Ercolano.
//
// This library is free software. Distribution and use rights are outlined in
// the file "COPYING" which should have been included with this file.  If this
// file is missing or damaged, see the license at:
//
//     http://www.fltk.org/COPYING.php
//
// Please report all bugs and problems on the following page:
//
//     http://www.fltk.org/str.php
//

#ifndef FL_NATIVE_FILE_CHOOSER_H
#define FL_NATIVE_FILE_CHOOSER_H

/* \file
 Fl_Native_File_Chooser widget. */

// Use Windows' chooser
#ifdef WIN32
// #define _WIN32_WINNT 0x0501  // needed for OPENFILENAME's 'FlagsEx'
#include <stdio.h>
#include <stdlib.h>             // malloc
#include <windows.h>
#include <commdlg.h>            // OPENFILENAME, GetOpenFileName()
#include <shlobj.h>             // BROWSEINFO, SHBrowseForFolder()
#endif

// Use Apple's chooser
#ifdef __APPLE__
#define MAXFILTERS      80
#endif

// All else falls back to FLTK's own chooser
#if ! defined(__APPLE__) && !defined(WIN32)
#include <FL/Fl_File_Chooser.H>
#include <unistd.h>             // _POSIX_NAME_MAX
#else
#include <FL/filename.H>        // FL_EXPORT
#endif


class FL_EXPORT Fl_Native_File_Chooser {
public:
  enum Type {
    BROWSE_FILE = 0,                    
    BROWSE_DIRECTORY,                   
    BROWSE_MULTI_FILE,                  
    BROWSE_MULTI_DIRECTORY,             
    BROWSE_SAVE_FILE,                   
    BROWSE_SAVE_DIRECTORY               
  };
  enum Option {
    NO_OPTIONS     = 0x0000,            
    SAVEAS_CONFIRM = 0x0001,            
    NEW_FOLDER     = 0x0002,            
    PREVIEW        = 0x0004,            
    USE_FILTER_EXT = 0x0008             
  };
  static const char *file_exists_message;
  
public:
  Fl_Native_File_Chooser(int val=BROWSE_FILE);
  ~Fl_Native_File_Chooser();
  
  // Public methods
  void type(int);
  int type() const;
  void options(int);
  int options() const;
  int count() const;
  const char *filename() const;
  const char *filename(int i) const;
  void directory(const char *val);
  const char *directory() const;
  void title(const char *);
  const char* title() const;
  const char *filter() const;
  void filter(const char *);
  int filters() const;
  void filter_value(int i);
  int filter_value() const;
  void preset_file(const char*);
  const char* preset_file() const;
  const char *errmsg() const;
  int show();
  
#ifdef WIN32
private:
  int  _btype;                  // kind-of browser to show()
  int  _options;                // general options
  OPENFILENAMEW _ofn;           // GetOpenFileName() & GetSaveFileName() struct
  BROWSEINFO   _binf;           // SHBrowseForFolder() struct
  char  **_pathnames;           // array of pathnames
  int     _tpathnames;          // total pathnames
  char   *_directory;           // default pathname to use
  char   *_title;               // title for window
  char   *_filter;              // user-side search filter
  char   *_parsedfilt;          // filter parsed for Windows dialog
  int     _nfilters;            // number of filters parse_filter counted
  char   *_preset_file;         // the file to preselect
  char   *_errmsg;              // error message
  
  // Private methods
  void errmsg(const char *msg);
  
  void clear_pathnames();
  void set_single_pathname(const char *s);
  void add_pathname(const char *s);
  
  void FreePIDL(LPITEMIDLIST pidl);
  void ClearOFN();
  void ClearBINF();
  void Win2Unix(char *s);
  void Unix2Win(char *s);
  int showfile();
  static int CALLBACK Dir_CB(HWND win, UINT msg, LPARAM param, LPARAM data);
  int showdir();
  
  void parse_filter(const char *);
  void clear_filters();
  void add_filter(const char *, const char *);
#endif

#ifdef __APPLE__
private:
  int             _btype;               // kind-of browser to show()
  int             _options;             // general options
  void           *_panel;
  char          **_pathnames;           // array of pathnames
  int             _tpathnames;          // total pathnames
  char           *_directory;           // default pathname to use
  char           *_title;               // title for window
  char           *_preset_file;         // the 'save as' filename
  
  char           *_filter;              // user-side search filter, eg:
                                        // C Files\t*.[ch]\nText Files\t*.txt"
  
  char           *_filt_names;          // filter names (tab delimited)
                                        // eg. "C Files\tText Files"
  
  char           *_filt_patt[MAXFILTERS];
  // array of filter patterns, eg:
  //     _filt_patt[0]="*.{cxx,h}"
  //     _filt_patt[1]="*.txt"
  
  int             _filt_total;          // parse_filter() # of filters loaded
  int             _filt_value;          // index of the selected filter
  char           *_errmsg;              // error message
  
  // Private methods
  void errmsg(const char *msg);
  void clear_pathnames();
  void set_single_pathname(const char *s);
  int get_saveas_basename(void);
  void clear_filters();
  void add_filter(const char *, const char *);
  void parse_filter(const char *from);
  int post();
  int runmodal();
#endif

#if ! defined(__APPLE__) && !defined(WIN32)
private:
  int   _btype;                 // kind-of browser to show()
  int   _options;               // general options
  int   _nfilters;
  char *_filter;                // user supplied filter
  char *_parsedfilt;            // parsed filter
  int   _filtvalue;             // selected filter
  char *_preset_file;
  char *_prevvalue;             // Returned filename
  char *_directory;
  char *_errmsg;                // error message
  Fl_File_Chooser *_file_chooser;
  
  // Private methods
  void errmsg(const char *msg);
  int type_fl_file(int);
  void parse_filter();
  void keeplocation();
  int exist_dialog();
#endif
};


#endif /*FL_NATIVE_FILE_CHOOSER_H*/

//
// End of "$Id: Fl_Native_File_Chooser.H 9825 2013-02-19 15:19:58Z manolo $".
//