interface/wx/textdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        textdlg.h
   3 // Purpose:     interface of wxPasswordEntryDialog
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     Default text dialog style.
  11 */
  12 #define wxTextEntryDialogStyle (wxOK | wxCANCEL | wxCENTRE | wxWS_EX_VALIDATE_RECURSIVELY)
  13
  14 /// Default text dialog caption.
  15 const char wxGetTextFromUserPromptStr[] = "Input Text";
  16
  17 /// Default password dialog caption.
  18 const char wxGetPasswordFromUserPromptStr[] = "Enter Password";
  19
  20
  21 /**
  22     @class wxPasswordEntryDialog
  23
  24     This class represents a dialog that requests a one-line password string from
  25     the user.
  26
  27     It is implemented as a generic wxWidgets dialog.
  28
  29     @library{wxcore}
  30     @category{cmndlg}
  31
  32     @see @ref overview_cmndlg_password
  33 */
  34 class wxPasswordEntryDialog : public wxTextEntryDialog
  35 {
  36 public:
  37     /**
  38         Constructor.
  39
  40         Use wxTextEntryDialog::ShowModal to show the dialog.
  41
  42         @param parent
  43             Parent window.
  44         @param message
  45             Message to show on the dialog.
  46         @param caption
  47             The caption of the dialog.
  48         @param defaultValue
  49             The default value, which may be the empty string.
  50         @param style
  51             A dialog style, specifying the buttons (wxOK, wxCANCEL) and an
  52             optional wxCENTRE style. You do not need to specify the wxTE_PASSWORD style,
  53             it is always applied.
  54         @param pos
  55             Dialog position.
  56     */
  57     wxPasswordEntryDialog(wxWindow* parent, const wxString& message,
  58                           const wxString& caption = wxGetPasswordFromUserPromptStr,
  59                           const wxString& defaultValue = wxEmptyString,
  60                           long style = wxTextEntryDialogStyle,
  61                           const wxPoint& pos = wxDefaultPosition);
  62 };
  63
  64
  65
  66 /**
  67     @class wxTextEntryDialog
  68
  69     This class represents a dialog that requests a one-line text string from the user.
  70     It is implemented as a generic wxWidgets dialog.
  71
  72     @library{wxcore}
  73     @category{cmndlg}
  74
  75     @see @ref overview_cmndlg_textentry
  76 */
  77 class wxTextEntryDialog : public wxDialog
  78 {
  79 public:
  80     /**
  81         Constructor. Use ShowModal() to show the dialog.
  82
  83         @param parent
  84             Parent window.
  85         @param message
  86             Message to show on the dialog.
  87         @param caption
  88             The caption of the dialog.
  89         @param value
  90             The default value, which may be the empty string.
  91         @param style
  92             A dialog style, specifying the buttons (wxOK, wxCANCEL)
  93             and an optional wxCENTRE style. Additionally, wxTextCtrl styles
  94             (such as @c wxTE_PASSWORD or @c wxTE_MULTILINE) may be specified
  95             here.
  96         @param pos
  97             Dialog position.
  98     */
  99     wxTextEntryDialog(wxWindow* parent, const wxString& message,
 100                       const wxString& caption = wxGetTextFromUserPromptStr,
 101                       const wxString& value = wxEmptyString,
 102                       long style = wxTextEntryDialogStyle,
 103                       const wxPoint& pos = wxDefaultPosition);
 104
 105     /**
 106         Destructor.
 107     */
 108     virtual ~wxTextEntryDialog();
 109
 110     /**
 111         Returns the text that the user has entered if the user has pressed OK, or the
 112         original value if the user has pressed Cancel.
 113     */
 114     wxString GetValue() const;
 115
 116     /**
 117         Sets the default text value.
 118     */
 119     void SetValue(const wxString& value);
 120
 121     /**
 122         Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
 123         otherwise.
 124     */
 125     int ShowModal();
 126 };
 127
 128
 129
 130 // ============================================================================
 131 // Global functions/macros
 132 // ============================================================================
 133
 134 /** @addtogroup group_funcmacro_dialog */
 135 //@{
 136
 137 /**
 138     Pop up a dialog box with title set to @e caption, @c message, and a
 139     @c default_value. The user may type in text and press OK to return this
 140     text, or press Cancel to return the empty string.
 141
 142     If @c centre is @true, the message text (which may include new line
 143     characters) is centred; if @false, the message is left-justified.
 144
 145     This function is a wrapper around wxTextEntryDialog and while it is usually
 146     more convenient to use, using the dialog directly is more flexible, e.g. it
 147     allows you to specify the @c wxTE_MULTILINE to allow the user enter
 148     multiple lines of text while this function is limited to single line entry
 149     only.
 150
 151     @header{wx/textdlg.h}
 152 */
 153 wxString wxGetTextFromUser(const wxString& message,
 154                            const wxString& caption = wxGetTextFromUserPromptStr,
 155                            const wxString& default_value = wxEmptyString,
 156                            wxWindow* parent = NULL,
 157                            int x = wxDefaultCoord,
 158                            int y = wxDefaultCoord,
 159                            bool centre = true);
 160
 161 /**
 162     Similar to wxGetTextFromUser() but the text entered in the dialog is not
 163     shown on screen but replaced with stars. This is intended to be used for
 164     entering passwords as the function name implies.
 165
 166     @header{wx/textdlg.h}
 167 */
 168 wxString wxGetPasswordFromUser(const wxString& message,
 169                                const wxString& caption = wxGetPasswordFromUserPromptStr,
 170                                const wxString& default_value = wxEmptyString,
 171                                wxWindow* parent = NULL,
 172                                int x = wxDefaultCoord,
 173                                int y = wxDefaultCoord,
 174                                bool centre = true);
 175
 176 //@}
 177