More interface header reviews by Azriel Fasten, and added skeleton docs for wxBookCtr...

[wxWidgets.git] / interface / textdlg.h

diff --git a/interface/textdlg.h b/interface/textdlg.h
index 1b50a8b5cb90754a36677b63a99433361d08309a..dc7245790d846aa9b40d049d6ec363b2b9c5d837 100644 (file)
--- a/interface/textdlg.h
+++ b/interface/textdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        textdlg.h
-// Purpose:     documentation for wxPasswordEntryDialog class
+// Purpose:     interface of wxPasswordEntryDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,65 +9,61 @@
 /**
     @class wxPasswordEntryDialog
     @wxheader{textdlg.h}
-    
+
     This class represents a dialog that requests a one-line password string from
     the user.
     It is implemented as a generic wxWidgets dialog.
-    
+
     @library{wxbase}
     @category{cmndlg}
-    
-    @seealso
-    @ref overview_wxpasswordentrydialogoverview "wxPassowrdEntryDialog overview"
+
+    @see @ref overview_wxpasswordentrydialogoverview "wxPassowrdEntryDialog
+    overview"
 */
 class wxPasswordEntryDialog : public wxTextEntryDialog
 {
 public:
-    
+
 };
 
 
+
 /**
     @class wxTextEntryDialog
     @wxheader{textdlg.h}
-    
+
     This class represents a dialog that requests a one-line text string from the
     user.
     It is implemented as a generic wxWidgets dialog.
-    
+
     @library{wxbase}
     @category{cmndlg}
-    
-    @seealso
-    @ref overview_wxtextentrydialogoverview "wxTextEntryDialog overview"
+
+    @see @ref overview_wxtextentrydialogoverview "wxTextEntryDialog overview"
 */
 class wxTextEntryDialog : public wxDialog
 {
 public:
     /**
         Constructor. Use ShowModal() to show the dialog.
-        
-        @param parent 
-        Parent window.
-        
-        @param message 
-        Message to show on the dialog.
-        
-        @param defaultValue 
-        The default value, which may be the empty string.
-        
-        @param style 
-        A dialog style, specifying the buttons (wxOK, wxCANCEL)
-        and an optional wxCENTRE style. Additionally, wxTextCtrl styles (such as
-        wxTE_PASSWORD) may be specified here.
-        
-        @param pos 
-        Dialog position.
+
+        @param parent
+            Parent window.
+        @param message
+            Message to show on the dialog.
+        @param defaultValue
+            The default value, which may be the empty string.
+        @param style
+            A dialog style, specifying the buttons (wxOK, wxCANCEL)
+            and an optional wxCENTRE style. Additionally, wxTextCtrl styles (such as
+            wxTE_PASSWORD) may be specified here.
+        @param pos
+            Dialog position.
     */
     wxTextEntryDialog(wxWindow* parent, const wxString& message,
                       const wxString& caption = "Please enter text",
                       const wxString& defaultValue = "",
-                      long style = wxOK |  wxCANCEL |  wxCENTRE,
+                      long style = wxOK | wxCANCEL | wxCENTRE,
                       const wxPoint& pos = wxDefaultPosition);
 
     /**
@@ -80,7 +76,7 @@ public:
         original value
         if the user has pressed Cancel.
     */
-    wxString GetValue();
+    wxString GetValue() const;
 
     /**
         Sets the default text value.
@@ -95,36 +91,46 @@ public:
 };
 
 
+
 // ============================================================================
 // Global functions/macros
 // ============================================================================
 
+/** @ingroup group_funcmacro_dialog */
+//@{
+
 /**
-    Pop up a dialog box with title set to @e caption, @e message, and a
-    @e default_value.  The user may type in text and press OK to return this text,
-    or press Cancel to return the empty string.
-    
-    If @e centre is @true, the message text (which may include new line characters)
-    is centred; if @false, the message is left-justified.
+    Pop up a dialog box with title set to @e caption, @c message, and a
+    @c default_value. The user may type in text and press OK to return this
+    text, or press Cancel to return the empty string.
+
+    If @c centre is @true, the message text (which may include new line
+    characters) is centred; if @false, the message is left-justified.
+
+    @header{wx/textdlg.h}
 */
 wxString wxGetTextFromUser(const wxString& message,
                            const wxString& caption = "Input text",
                            const wxString& default_value = "",
-                           wxWindow * parent = @NULL,
+                           wxWindow* parent = NULL,
                            int x = wxDefaultCoord,
                            int y = wxDefaultCoord,
-                           bool centre = @true);
+                           bool centre = true);
 
 /**
-    Similar to wxGetTextFromUser but the text entered
-    in the dialog is not shown on screen but replaced with stars. This is intended
-    to be used for entering passwords as the function name implies.
+    Similar to wxGetTextFromUser() but the text entered in the dialog is not
+    shown on screen but replaced with stars. This is intended to be used for
+    entering passwords as the function name implies.
+
+    @header{wx/textdlg.h}
 */
 wxString wxGetPasswordFromUser(const wxString& message,
                                const wxString& caption = "Input text",
                                const wxString& default_value = "",
-                               wxWindow * parent = @NULL,
+                               wxWindow* parent = NULL,
                                int x = wxDefaultCoord,
                                int y = wxDefaultCoord,
-                               bool centre = @true);
+                               bool centre = true);
+
+//@}