audacity/lib-src/FileDialog/generic/FileDialogPrivate.h

/////////////////////////////////////////////////////////////////////////////
// Name:        filedlgg.h
// Purpose:     wxGenericFileDialog
// Author:      Robert Roebling
// Modified by: Leland Lucius
// Created:     8/17/99
// Copyright:   (c) Robert Roebling
// RCS-ID:      $Id: FileDialogPrivate.h,v 1.2 2008-05-24 02:57:39 llucius Exp $
// Licence:     wxWindows licence
//
// Modified for Audacity to support an additional button on Save dialogs
//
/////////////////////////////////////////////////////////////////////////////

#ifndef _FILEDIALOGGENERICH_
#define _FILEDIALOGGENERICH_

#include "wx/listctrl.h"
#include "wx/datetime.h"
#include "wx/sizer.h"

//-----------------------------------------------------------------------------
// classes
//-----------------------------------------------------------------------------

class wxBitmapButton;
class wxCheckBox;
class wxChoice;
class wxFileData;
class FileCtrl;
class wxListEvent;
class wxListItem;
class wxStaticText;
class wxTextCtrl;

//-------------------------------------------------------------------------
// FileDialog
//-------------------------------------------------------------------------

#if defined(GENERIC_FILEDIALOG)
#define FILEDIALOG GenericFileDialog
#else
#define FILEDIALOG FileDialog
#endif


class FILEDIALOG: public wxFileDialogBase
{
public:
   FILEDIALOG() : wxFileDialogBase() { Init(); }
   
   FILEDIALOG(wxWindow *parent,
              const wxString& message = wxFileSelectorPromptStr,
              const wxString& defaultDir = wxEmptyString,
              const wxString& defaultFile = wxEmptyString,
              const wxString& wildCard = wxFileSelectorDefaultWildcardStr,
              long style = 0,
              const wxPoint& pos = wxDefaultPosition,
              const wxSize& sz = wxDefaultSize,
              const wxString& name = wxFileDialogNameStr,                        
              bool bypassGenericImpl = false );
   
   bool Create( wxWindow *parent,
               const wxString& message = wxFileSelectorPromptStr,
               const wxString& defaultDir = wxEmptyString,
               const wxString& defaultFile = wxEmptyString,
               const wxString& wildCard = wxFileSelectorDefaultWildcardStr,
               long style = 0,
               const wxPoint& pos = wxDefaultPosition,
               const wxSize& sz = wxDefaultSize,
               const wxString& name = wxFileDialogNameStr,                        
               bool bypassGenericImpl = false );
   
   virtual ~FILEDIALOG();
   
   virtual void SetMessage(const wxString& message) { SetTitle(message); }
   virtual void SetPath(const wxString& path);
   virtual void SetFilterIndex(int filterIndex);
   virtual void SetWildcard(const wxString& wildCard);
   
   // for multiple file selection
   virtual void GetPaths(wxArrayString& paths) const;
   virtual void GetFilenames(wxArrayString& files) const;

#if !defined(GENERIC_FILEDIALOG)   
   virtual void EnableButton(wxString label, fdCallback cb, void *cbdata);
   virtual void ClickButton(int index);
#endif
   
   // implementation only from now on
   // -------------------------------
   
   virtual int ShowModal();
   virtual bool Show( bool show = true );
   
   void OnSelected( wxListEvent &event );
   void OnActivated( wxListEvent &event );
   void OnList( wxCommandEvent &event );
   void OnReport( wxCommandEvent &event );
   void OnUp( wxCommandEvent &event );
   void OnHome( wxCommandEvent &event );
   void OnListOk( wxCommandEvent &event );
   void OnNew( wxCommandEvent &event );
   void OnChoiceFilter( wxCommandEvent &event );
   void OnTextEnter( wxCommandEvent &event );
   void OnTextChange( wxCommandEvent &event );
   void OnCheck( wxCommandEvent &event );
   void OnExtra( wxCommandEvent &event );
   
   virtual void HandleAction( const wxString &fn );
   
   virtual void UpdateControls();
   
private:
   // Don't use this implementation at all :-)
   bool m_bypassGenericImpl;
   
protected:
   // use the filter with the given index
   void DoSetFilterIndex(int filterindex);
   
   wxString       m_filterExtension;
   wxChoice      *m_choice;
   wxTextCtrl    *m_text;
   FileCtrl      *m_list;
   wxCheckBox    *m_check;
   wxStaticText  *m_static;
   wxBitmapButton *m_upDirButton;
   wxBitmapButton *m_newDirButton;
   
private:
   void Init();
   DECLARE_DYNAMIC_CLASS(FILEDIALOG)
   DECLARE_EVENT_TABLE()
   
   // these variables are preserved between FileDialog calls
   static long ms_lastViewStyle;     // list or report?
   static bool ms_lastShowHidden;    // did we show hidden files?
   
   long m_dialogStyle;
   wxBoxSizer *m_choicesizer;
   wxString m_buttonlabel;
   fdCallback m_callback;
   void *m_cbdata;
};

//-----------------------------------------------------------------------------
//  FileData - a class to hold the file info for the FileCtrl
//-----------------------------------------------------------------------------

class FileData
{
public:
   enum fileType
   {
      is_file  = 0x0000,
      is_dir   = 0x0001,
      is_link  = 0x0002,
      is_exe   = 0x0004,
      is_drive = 0x0008
   };
   
   FileData() { Init(); }
   // Full copy constructor
   FileData( const FileData& fileData ) { Copy(fileData); }
   // Create a filedata from this information
   FileData( const wxString &filePath, const wxString &fileName,
            fileType type, int image_id );
   
   // make a full copy of the other FileData
   void Copy( const FileData &other );
   
   // (re)read the extra data about the file from the system
   void ReadData();
   
   // get the name of the file, dir, drive
   wxString GetFileName() const { return m_fileName; }
   // get the full path + name of the file, dir, path
   wxString GetFilePath() const { return m_filePath; }
   // Set the path + name and name of the item
   void SetNewName( const wxString &filePath, const wxString &fileName );
   
   // Get the size of the file in bytes
   long GetSize() const { return m_size; }
   // Get the type of file, either file extension or <DIR>, <LINK>, <DRIVE>
   wxString GetFileType() const;
   // get the last modification time
   wxDateTime GetDateTime() const { return m_dateTime; }
   // Get the time as a formatted string
   wxString GetModificationTime() const;
   // in UNIX get rwx for file, in MSW get attributes ARHS
   wxString GetPermissions() const { return m_permissions; }
   // Get the id of the image used in a wxImageList
   int GetImageId() const { return m_image; }
   
   bool IsFile() const  { return !IsDir() && !IsLink() && !IsDrive(); }
   bool IsDir() const   { return (m_type & is_dir  ) != 0; }
   bool IsLink() const  { return (m_type & is_link ) != 0; }
   bool IsExe() const   { return (m_type & is_exe  ) != 0; }
   bool IsDrive() const { return (m_type & is_drive) != 0; }
   
   // Get/Set the type of file, file/dir/drive/link
   int GetType() const { return m_type; }
   
   // the FileCtrl fields in report view
   enum fileListFieldType
   {
      FileList_Name,
      FileList_Size,
      FileList_Type,
      FileList_Time,
#if defined(__UNIX__) || defined(__WIN32__)
      FileList_Perm,
#endif // defined(__UNIX__) || defined(__WIN32__)
      FileList_Max
   };
   
   // Get the entry for report view of FileCtrl
   wxString GetEntry( fileListFieldType num ) const;
   
   // Get a string representation of the file info
   wxString GetHint() const;
   // initialize a wxListItem attributes
   void MakeItem( wxListItem &item );
   
   // operators
   FileData& operator = (const FileData& fd) { Copy(fd); return *this; }
   
protected:
   wxString m_fileName;
   wxString   m_filePath;
   long     m_size;
   wxDateTime m_dateTime;
   wxString m_permissions;
   int      m_type;
   int        m_image;
   
private:
   void Init();
};

//-----------------------------------------------------------------------------
//  FileCtrl
//-----------------------------------------------------------------------------

class FileCtrl : public wxListCtrl
{
public:
   FileCtrl();
   FileCtrl( wxWindow *win,
            wxWindowID id,
            const wxString &wild,
            bool showHidden,
            const wxPoint &pos = wxDefaultPosition,
            const wxSize &size = wxDefaultSize,
            long style = wxLC_LIST,
            const wxValidator &validator = wxDefaultValidator,
            const wxString &name = wxT("filelist") );
   virtual ~FileCtrl();
   
   virtual void ChangeToListMode();
   virtual void ChangeToReportMode();
   virtual void ChangeToSmallIconMode();
   virtual void ShowHidden( bool show = true );
   bool GetShowHidden() const { return m_showHidden; }
   
   virtual long Add( FileData *fd, wxListItem &item );
   virtual void UpdateItem(const wxListItem &item);
   virtual void UpdateFiles();
   virtual void MakeDir();
   virtual void GoToParentDir();
   virtual void GoToHomeDir();
   virtual void GoToDir( const wxString &dir );
   virtual void SetWild( const wxString &wild );
   wxString GetWild() const { return m_wild; }
   wxString GetDir() const { return m_dirName; }
   
   void OnListDeleteItem( wxListEvent &event );
   void OnListDeleteAllItems( wxListEvent &event );
   void OnListEndLabelEdit( wxListEvent &event );
   void OnListColClick( wxListEvent &event );
   
   virtual void SortItems(FileData::fileListFieldType field, bool foward);
   bool GetSortDirection() const { return m_sort_foward; }
   FileData::fileListFieldType GetSortField() const { return m_sort_field; }
   
protected:
   void FreeItemData(wxListItem& item);
   void FreeAllItemsData();
   
   wxString      m_dirName;
   bool          m_showHidden;
   wxString      m_wild;
   
   bool m_sort_foward;
   FileData::fileListFieldType m_sort_field;
   
private:
   DECLARE_DYNAMIC_CLASS(FileCtrl)
   DECLARE_EVENT_TABLE()
};

#endif // _FILEDIALOGGENERICH_