use @a instead of @e where it makes sense

[wxWidgets.git] / interface / filedlg.h

diff --git a/interface/filedlg.h b/interface/filedlg.h
index 09d0caae3b4d45c8d914fef5c462bcbfe544f20b..5af07bd365e83b058f5989e897a5e39f5c6ca267 100644 (file)
--- a/interface/filedlg.h
+++ b/interface/filedlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        filedlg.h
-// Purpose:     documentation for wxFileDialog class
+// Purpose:     interface of wxFileDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -41,15 +41,15 @@
     @library{wxcore}
     @category{cmndlg}
 
-    @seealso
-    @ref overview_wxfiledialogoverview "wxFileDialog overview", wxFileSelector
+    @see @ref overview_wxfiledialogoverview "wxFileDialog overview",
+    wxFileSelector()
 */
 class wxFileDialog : public wxDialog
 {
 public:
     /**
         Constructor. Use ShowModal() to show the dialog.
-        
+
         @param parent
             Parent window.
         @param message
@@ -90,7 +90,7 @@ public:
     /**
         Returns the default directory.
     */
-    wxString GetDirectory();
+    wxString GetDirectory() const;
 
     /**
         If functions
@@ -98,12 +98,12 @@ public:
         and ShowModal() were called,
         returns the extra window. Otherwise returns @NULL.
     */
-    wxWindow* GetExtraControl();
+    wxWindow* GetExtraControl() const;
 
     /**
         Returns the default filename.
     */
-    wxString GetFilename();
+    wxString GetFilename() const;
 
     /**
         Fills the array @a filenames with the names of the files chosen. This
@@ -114,7 +114,7 @@ public:
         of each referenced file by appending the directory containing the shortcuts
         to the filename.
     */
-    void GetFilenames(wxArrayString& filenames);
+    void GetFilenames(wxArrayString& filenames) const;
 
     /**
         Returns the index into the list of filters supplied, optionally, in the
@@ -123,29 +123,29 @@ public:
         dialog is first displayed.
         After the dialog is shown, this is the index selected by the user.
     */
-    int GetFilterIndex();
+    int GetFilterIndex() const;
 
     /**
         Returns the message that will be displayed on the dialog.
     */
-    wxString GetMessage();
+    wxString GetMessage() const;
 
     /**
         Returns the full path (directory and filename) of the selected file.
     */
-    wxString GetPath();
+    wxString GetPath() const;
 
     /**
         Fills the array @a paths with the full paths of the files chosen. This
         function should only be used with the dialogs which have @c wxFD_MULTIPLE style,
         use GetPath() for the others.
     */
-    void GetPaths(wxArrayString& paths);
+    void GetPaths(wxArrayString& paths) const;
 
     /**
         Returns the file dialog wildcard.
     */
-    wxString GetWildcard();
+    wxString GetWildcard() const;
 
     /**
         Sets the default directory.
@@ -200,28 +200,34 @@ public:
 };
 
 
+
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
+/** @ingroup group_funcmacro_dialog */
+//@{
+
 /**
     Pops up a file selector box. In Windows, this is the common file selector
-    dialog. In X, this is a file selector box with the same functionality.
-    The path and filename are distinct elements of a full file pathname.
-    If path is empty, the current directory will be used. If filename is empty,
-    no default filename will be supplied. The wildcard determines what files
-    are displayed in the file selector, and file extension supplies a type
-    extension for the required filename. Flags may be a combination of wxFD_OPEN,
-    wxFD_SAVE, wxFD_OVERWRITE_PROMPT or wxFD_FILE_MUST_EXIST. Note that
-    wxFD_MULTIPLE
-    can only be used with wxFileDialog and not here as this
-    function only returns a single file name.
+    dialog. In X, this is a file selector box with the same functionality. The
+    path and filename are distinct elements of a full file pathname. If path
+    is empty, the current directory will be used. If filename is empty, no
+    default filename will be supplied. The wildcard determines what files are
+    displayed in the file selector, and file extension supplies a type
+    extension for the required filename. Flags may be a combination of
+    wxFD_OPEN, wxFD_SAVE, wxFD_OVERWRITE_PROMPT or wxFD_FILE_MUST_EXIST.
+
+    @note wxFD_MULTIPLE can only be used with wxFileDialog and not here since
+          this function only returns a single file name.
+
     Both the Unix and Windows versions implement a wildcard filter. Typing a
     filename containing wildcards (*, ?) in the filename text item, and
     clicking on Ok, will result in only those files matching the pattern being
     displayed.
-    The wildcard may be a specification for multiple types of file
-    with a description for each, such as:
+
+    The wildcard may be a specification for multiple types of file with a
+    description for each, such as:
 
     @code
     "BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
@@ -239,6 +245,8 @@ public:
     }
     //else: cancelled by user
     @endcode
+
+    @header{wx/filedlg.h}
 */
 wxString wxFileSelector(const wxString& message,
                         const wxString& default_path = "",
@@ -250,3 +258,5 @@ wxString wxFileSelector(const wxString& message,
                         int x = -1,
                         int y = -1);
 
+//@}
+