X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..42013f4c2866589e8a0ce6eba992f6745aebb857:/interface/filepicker.h diff --git a/interface/filepicker.h b/interface/filepicker.h index fdca7c023f..2a2d610fc6 100644 --- a/interface/filepicker.h +++ b/interface/filepicker.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: filepicker.h -// Purpose: documentation for wxFilePickerCtrl class +// Purpose: interface of wxFilePickerCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -45,8 +45,7 @@ @category{miscpickers} @appearance{filepickerctrl.png} - @seealso - wxFileDialog, wxFileDirPickerEvent + @see wxFileDialog, wxFileDirPickerEvent */ class wxFilePickerCtrl : public wxPickerBase { @@ -88,7 +87,7 @@ public: Validator which can be used for additional date checks. @param name Control name. - + @returns @true if the control was successfully created or @false if creation failed. */ @@ -106,12 +105,12 @@ public: Similar to GetPath() but returns the path of the currently selected file as a wxFileName object. */ - wxFileName GetFileName(); + wxFileName GetFileName() const; /** Returns the absolute path of the currently selected file. */ - wxString GetPath(); + wxString GetPath() const; /** This method does the same thing as SetPath() but @@ -128,6 +127,7 @@ public: }; + /** @class wxDirPickerCtrl @wxheader{filepicker.h} @@ -163,8 +163,7 @@ public: @category{miscpickers} @appearance{dirpickerctrl.png} - @seealso - wxDirDialog, wxFileDirPickerEvent + @see wxDirDialog, wxFileDirPickerEvent */ class wxDirPickerCtrl : public wxPickerBase { @@ -202,7 +201,7 @@ public: Validator which can be used for additional date checks. @param name Control name. - + @returns @true if the control was successfully created or @false if creation failed. */ @@ -220,12 +219,12 @@ public: object. This function is equivalent to GetPath() */ - wxFileName GetDirName(); + wxFileName GetDirName() const; /** Returns the absolute path of the currently selected directory. */ - wxString GetPath(); + wxString GetPath() const; /** Just like SetPath() but this function takes a @@ -242,6 +241,7 @@ public: }; + /** @class wxFileDirPickerEvent @wxheader{filepicker.h} @@ -252,8 +252,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxfilepickerctrl + @see wxfilepickerctrl() */ class wxFileDirPickerEvent : public wxCommandEvent { @@ -268,10 +267,11 @@ public: /** Retrieve the absolute path of the file/directory the user has just selected. */ - wxString GetPath(); + wxString GetPath() const; /** Set the absolute path of the file/directory associated with the event. */ void SetPath(const wxString& path); }; +