synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / textdlg.h

diff --git a/interface/wx/textdlg.h b/interface/wx/textdlg.h
index dc7245790d846aa9b40d049d6ec363b2b9c5d837..043145ca8964b8170c4e2dab7d3d4292c6eb8d1e 100644 (file)
--- a/interface/wx/textdlg.h
+++ b/interface/wx/textdlg.h
@@ -3,43 +3,76 @@
 // Purpose:     interface of wxPasswordEntryDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxPasswordEntryDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+/**
+    Default text dialog style.
+*/
+#define wxTextEntryDialogStyle (wxOK | wxCANCEL | wxCENTRE | wxWS_EX_VALIDATE_RECURSIVELY)
+
+/// Default text dialog caption.
+const char wxGetTextFromUserPromptStr[] = "Input Text";
+
+/// Default password dialog caption.
+const char wxGetPasswordFromUserPromptStr[] = "Enter Password";
+
+

 /**
     @class wxPasswordEntryDialog
 /**
     @class wxPasswordEntryDialog

-    @wxheader{textdlg.h}

 
     This class represents a dialog that requests a one-line password string from
     the user.
 
     This class represents a dialog that requests a one-line password string from
     the user.

+

     It is implemented as a generic wxWidgets dialog.
 
     It is implemented as a generic wxWidgets dialog.
 

-    @library{wxbase}
+    @library{wxcore}

     @category{cmndlg}
 
     @category{cmndlg}
 

-    @see @ref overview_wxpasswordentrydialogoverview "wxPassowrdEntryDialog
-    overview"
+    @see @ref overview_cmndlg_password

 */
 class wxPasswordEntryDialog : public wxTextEntryDialog
 {
 public:
 */
 class wxPasswordEntryDialog : public wxTextEntryDialog
 {
 public:

+    /**
+        Constructor.
+
+        Use wxTextEntryDialog::ShowModal to show the dialog.

 
 

+        @param parent
+            Parent window.
+        @param message
+            Message to show on the dialog.
+        @param caption
+            The caption of 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. You do not need to specify the wxTE_PASSWORD style,
+            it is always applied.
+        @param pos
+            Dialog position.
+    */
+    wxPasswordEntryDialog(wxWindow* parent, const wxString& message,
+                          const wxString& caption = wxGetPasswordFromUserPromptStr,
+                          const wxString& defaultValue = wxEmptyString,
+                          long style = wxTextEntryDialogStyle,
+                          const wxPoint& pos = wxDefaultPosition);

 };
 
 
 
 /**
     @class wxTextEntryDialog
 };
 
 
 
 /**
     @class wxTextEntryDialog

-    @wxheader{textdlg.h}

 
 

-    This class represents a dialog that requests a one-line text string from the
-    user.
+    This class represents a dialog that requests a one-line text string from the user.

     It is implemented as a generic wxWidgets dialog.
 
     It is implemented as a generic wxWidgets dialog.
 

-    @library{wxbase}
+    @library{wxcore}

     @category{cmndlg}
 
     @category{cmndlg}
 

-    @see @ref overview_wxtextentrydialogoverview "wxTextEntryDialog overview"
+    @see @ref overview_cmndlg_textentry

 */
 class wxTextEntryDialog : public wxDialog
 {
 */
 class wxTextEntryDialog : public wxDialog
 {


@@ -51,30 +84,32 @@ public:
             Parent window.
         @param message
             Message to show on the dialog.
             Parent window.
         @param message
             Message to show on the dialog.

-        @param defaultValue
+        @param caption
+            The caption of the dialog.
+        @param value

             The default value, which may be the empty string.
         @param style
             A dialog style, specifying the buttons (wxOK, wxCANCEL)
             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.
+            and an optional wxCENTRE style. Additionally, wxTextCtrl styles
+            (such as @c wxTE_PASSWORD or @c wxTE_MULTILINE) may be specified
+            here.

         @param pos
             Dialog position.
     */
     wxTextEntryDialog(wxWindow* parent, const wxString& message,
         @param pos
             Dialog position.
     */
     wxTextEntryDialog(wxWindow* parent, const wxString& message,

-                      const wxString& caption = "Please enter text",
-                      const wxString& defaultValue = "",
-                      long style = wxOK | wxCANCEL | wxCENTRE,
+                      const wxString& caption = wxGetTextFromUserPromptStr,
+                      const wxString& value = wxEmptyString,
+                      long style = wxTextEntryDialogStyle,

                       const wxPoint& pos = wxDefaultPosition);
 
     /**
         Destructor.
     */
                       const wxPoint& pos = wxDefaultPosition);
 
     /**
         Destructor.
     */

-    ~wxTextEntryDialog();
+    virtual ~wxTextEntryDialog();

 
     /**
         Returns the text that the user has entered if the user has pressed OK, or the
 
     /**
         Returns the text that the user has entered if the user has pressed OK, or the

-        original value
-        if the user has pressed Cancel.
+        original value if the user has pressed Cancel.

     */
     wxString GetValue() const;
 
     */
     wxString GetValue() const;
 


@@ -96,7 +131,7 @@ public:
 // Global functions/macros
 // ============================================================================
 
 // Global functions/macros
 // ============================================================================
 

-/** @ingroup group_funcmacro_dialog */
+/** @addtogroup group_funcmacro_dialog */

 //@{
 
 /**
 //@{
 
 /**


@@ -107,11 +142,17 @@ public:
     If @c centre is @true, the message text (which may include new line
     characters) is centred; if @false, the message is left-justified.
 
     If @c centre is @true, the message text (which may include new line
     characters) is centred; if @false, the message is left-justified.
 

+    This function is a wrapper around wxTextEntryDialog and while it is usually
+    more convenient to use, using the dialog directly is more flexible, e.g. it
+    allows you to specify the @c wxTE_MULTILINE to allow the user enter
+    multiple lines of text while this function is limited to single line entry
+    only.
+

     @header{wx/textdlg.h}
 */
 wxString wxGetTextFromUser(const wxString& message,
     @header{wx/textdlg.h}
 */
 wxString wxGetTextFromUser(const wxString& message,

-                           const wxString& caption = "Input text",
-                           const wxString& default_value = "",
+                           const wxString& caption = wxGetTextFromUserPromptStr,
+                           const wxString& default_value = wxEmptyString,

                            wxWindow* parent = NULL,
                            int x = wxDefaultCoord,
                            int y = wxDefaultCoord,
                            wxWindow* parent = NULL,
                            int x = wxDefaultCoord,
                            int y = wxDefaultCoord,


@@ -125,8 +166,8 @@ wxString wxGetTextFromUser(const wxString& message,
     @header{wx/textdlg.h}
 */
 wxString wxGetPasswordFromUser(const wxString& message,
     @header{wx/textdlg.h}
 */
 wxString wxGetPasswordFromUser(const wxString& message,

-                               const wxString& caption = "Input text",
-                               const wxString& default_value = "",
+                               const wxString& caption = wxGetPasswordFromUserPromptStr,
+                               const wxString& default_value = wxEmptyString,

                                wxWindow* parent = NULL,
                                int x = wxDefaultCoord,
                                int y = wxDefaultCoord,
                                wxWindow* parent = NULL,
                                int x = wxDefaultCoord,
                                int y = wxDefaultCoord,