X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..97d13342cc2ac77e21c38115cc6ebecac930f92a:/interface/wx/filectrl.h diff --git a/interface/wx/filectrl.h b/interface/wx/filectrl.h index dfbc382192..56be6351e8 100644 --- a/interface/wx/filectrl.h +++ b/interface/wx/filectrl.h @@ -8,7 +8,6 @@ /** @class wxFileCtrl - @wxheader{filectrl.h} This control allows the user to select a file. @@ -31,8 +30,7 @@ Hides the "Show Hidden Files" checkbox (Generic only) @endStyleTable - - @beginEventTable{wxFileCtrlEvent} + @beginEventEmissionTable{wxFileCtrlEvent} @event{EVT_FILECTRL_FILEACTIVATED(id, func)} The user activated a file(by double-clicking or pressing Enter) @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)} @@ -41,14 +39,15 @@ The current folder of the file control has been changed @endEventTable - @nativeimpl{gtk} - @library{wxbase} - @category{miscwnd} + @category{ctrl} + @appearance{filectrl.png} + + @nativeimpl{wxgtk} @see wxGenericDirCtrl */ -class wxFileCtrl : public wxWindow +class wxFileCtrl : public wxControl { public: wxFileCtrl(); @@ -61,12 +60,12 @@ public: @param id The identifier for the control. @param defaultDirectory - The initial directory shown in the control. Must be - a valid path to a directory or the empty string. + The initial directory shown in the control. + Must be a valid path to a directory or the empty string. In case it is the empty string, the current working directory is used. @param defaultFilename The default filename, or the empty string. - @param wildcard + @param wildCard A wildcard specifying which files can be selected, such as "*.*" or "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif". @param style @@ -89,7 +88,7 @@ public: long style = wxFC_DEFAULT_STYLE, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - const wxString& name = "filectrl"); + const wxString& name = wxFileCtrlNameStr); /** Create function for two-step construction. See wxFileCtrl() for details. @@ -97,23 +96,22 @@ public: bool Create(wxWindow* parent, wxWindowID id, const wxString& defaultDirectory = wxEmptyString, const wxString& defaultFilename = wxEmptyString, - const wxPoint& wildCard = wxFileSelectorDefaultWildcardStr, - long style = wxFC_DEFAULT_STYLE, - const wxPoint& pos = wxDefaultPosition, + const wxString& wildCard = wxFileSelectorDefaultWildcardStr, + long style = wxFC_DEFAULT_STYLE, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, - const wxString& name = "filectrl"); + const wxString& name = wxFileCtrlNameStr); /** Returns the current directory of the file control (i.e. the directory shown by it). */ - wxString GetDirectory() const; + virtual wxString GetDirectory() const; /** Returns the currently selected filename. For the controls having the @c wxFC_MULTIPLE style, use GetFilenames() instead. */ - wxString GetFilename() const; + virtual wxString GetFilename() const; /** Fills the array @a filenames with the filenames only of selected items. @@ -123,18 +121,18 @@ public: @remarks filenames is emptied first. */ - void GetFilenames(wxArrayString& filenames) const; + virtual void GetFilenames(wxArrayString& filenames) const; /** Returns the zero-based index of the currently selected filter. */ - int GetFilterIndex() const; + virtual int GetFilterIndex() const; /** Returns the full path (directory and filename) of the currently selected file. For the controls having the @c wxFC_MULTIPLE style, use GetPaths() instead. */ - wxString GetPath() const; + virtual wxString GetPath() const; /** Fills the array @a paths with the full paths of the files chosen. @@ -144,49 +142,48 @@ public: @remarks paths is emptied first. */ - void GetPaths(wxArrayString& paths) const; + virtual void GetPaths(wxArrayString& paths) const; /** Returns the current wildcard. */ - wxString GetWildcard() const; + virtual wxString GetWildcard() const; /** Sets(changes) the current directory displayed in the control. @return Returns @true on success, @false otherwise. */ - bool SetDirectory(const wxString& directory); + virtual bool SetDirectory(const wxString& directory); /** Selects a certain file. @return Returns @true on success, @false otherwise */ - bool SetFilename(const wxString& filename); + virtual bool SetFilename(const wxString& filename); /** Sets the current filter index, starting from zero. */ - void SetFilterIndex(int filterIndex); + virtual void SetFilterIndex(int filterIndex); /** Sets the wildcard, which can contain multiple file types, for example: "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif" */ - void SetWildcard(const wxString& wildCard); + virtual void SetWildcard(const wxString& wildCard); /** Sets whether hidden files and folders are shown or not. */ - void ShowHidden(const bool show); + virtual void ShowHidden(bool show); }; /** @class wxFileCtrlEvent - @wxheader{filectrl.h} A file control event holds information about events associated with wxFileCtrl objects. @@ -209,7 +206,7 @@ public: /** Constructor. */ - wxFileCtrlEvent(wxEventType type, wxObject evtObject, int id); + wxFileCtrlEvent(wxEventType type, wxObject *evtObject, int id); /** Returns the current directory. @@ -235,7 +232,7 @@ public: /** Sets the files changed by this event. */ - void SetFiles(const wxArrayString files); + void SetFiles(const wxArrayString& files); /**