interface/wx/msgdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        msgdlg.h
   3 // Purpose:     interface of wxMessageDialog
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxMessageDialog
  11
  12     This class represents a dialog that shows a single or multi-line message,
  13     with a choice of OK, Yes, No and Cancel buttons.
  14
  15     @library{wxcore}
  16     @category{cmndlg}
  17
  18     @see @ref overview_wxmessagedialogoverview "wxMessageDialog overview"
  19 */
  20 class wxMessageDialog : public wxDialog
  21 {
  22 public:
  23     /**
  24         Constructor specifying the message box properties.
  25
  26         Use ShowModal() to show the dialog.
  27
  28         @a style may be a bit list of the following identifiers:
  29
  30         @beginStyleTable
  31         @style{wxOK}
  32             Puts an Ok button in the message box. May be combined with @c
  33             wxCANCEL.
  34         @style{wxCANCEL}
  35             Puts a Cancel button in the message box. Must be combined with
  36             either @c wxOK or @c wxYES_NO.
  37         @style{wxYES_NO}
  38             Puts Yes and No buttons in the message box. May be combined with
  39             @c wxCANCEL.
  40         @style{wxNO_DEFAULT}
  41             Makes the "No" button default, can only be used with @c wxYES_NO.
  42         @style{wxYES_DEFAULT}
  43             Makes the "Yes" button default, this is the default behaviour and
  44             this flag exists solely for symmetry with @c wxNO_DEFAULT.
  45         @style{wxICON_EXCLAMATION}
  46             Displays an exclamation mark symbol.
  47         @style{wxICON_ERROR}
  48             Displays an error symbol.
  49         @style{wxICON_HAND}
  50             Displays an error symbol, this is a MSW-inspired synonym for @c
  51             wxICON_ERROR.
  52         @style{wxICON_QUESTION}
  53             Displays a question mark symbol. This icon is automatically used
  54             with @c wxYES_NO so it's usually unnecessary to specify it
  55             explicitly.
  56         @style{wxICON_INFORMATION}
  57             Displays an information symbol. This icon is used by default if @c
  58             wxYES_NO is not given so it is usually unnecessary to specify it
  59             explicitly.
  60         @style{wxSTAY_ON_TOP}
  61             Makes the message box stay on top of all other windows (currently
  62             implemented only under MSW).
  63         @endStyleTable
  64
  65         @param parent
  66             Parent window.
  67         @param message
  68             Message to show in the dialog.
  69         @param caption
  70             The dialog title.
  71         @param style
  72             Combination of style flags described above.
  73         @param pos
  74             Dialog position (ignored under MSW).
  75     */
  76     wxMessageDialog(wxWindow* parent, const wxString& message,
  77                     const wxString& caption = "Message box",
  78                     long style = wxOK | wxCANCEL,
  79                     const wxPoint& pos = wxDefaultPosition);
  80
  81     /**
  82         Sets the extended message for the dialog: this message is usually an
  83         extension of the short message specified in the constructor or set with
  84         SetMessage().
  85
  86         If it is set, the main message appears highlighted -- if supported --
  87         and this message appears beneath it in normal font. On the platforms
  88         which don't support extended messages, it is simply appended to the
  89         normal message with a new line separating them.
  90     */
  91     void SetExtendedMessage(const wxString extendedMessage);
  92
  93     /**
  94         Sets the message shown by the dialog.
  95     */
  96     void SetMessage(const wxString msg);
  97
  98     /**
  99         Overrides the default labels of the OK and Cancel buttons.
 100
 101         Please see the remarks in SetYesNoLabels() documentation.
 102     */
 103     bool SetOKCancelLabels(const ButtonLabel& ok, const ButtonLabel& cancel);
 104
 105     /**
 106         Overrides the default label of the OK button.
 107
 108         Please see the remarks in SetYesNoLabels() documentation.
 109     */
 110     bool SetOKLabel(const ButtonLabel& ok);
 111
 112     /**
 113         Overrides the default labels of the Yes, No and Cancel buttons.
 114
 115         Please see the remarks in SetYesNoLabels() documentation.
 116     */
 117     bool SetYesNoCancelLabels(const ButtonLabel& yes, const ButtonLabel& no,
 118                               const ButtonLabel& cancel);
 119
 120     /**
 121         Overrides the default labels of the Yes and No buttons.
 122
 123         The arguments of this function can be either strings or one of the
 124         standard identifiers, such as @c wxID_APPLY or @c wxID_OPEN. Notice
 125         that even if the label is specified as an identifier, the return value
 126         of the dialog ShowModal() method still remains one of @c wxID_OK, @c
 127         wxID_CANCEL, @c wxID_YES or @c wxID_NO values, i.e. this identifier
 128         changes only the label appearance but not the return code generated by
 129         the button. It is possible to mix stock identifiers and string labels
 130         in the same function call, for example:
 131         @code
 132         wxMessageDialog dlg(...);
 133         dlg.SetYesNoLabels(wxID_SAVE, _("&Don't save"));
 134         @endcode
 135
 136         Also notice that this function is not currently available on all
 137         platforms (although as of wxWidgets 2.9.0 it is implemented in all
 138         major ports), so it may return @false to indicate that the labels
 139         couldn't be changed. If it returns @true (currently only under wxMac),
 140         the labels were set successfully. Typically, if the function was used
 141         successfully, the main dialog message may need to be changed, e.g.:
 142         @code
 143         wxMessageDialog dlg(...);
 144         if ( dlg.SetYesNoLabels(_("&Quit"), _("&Don't quit")) )
 145             dlg.SetMessage(_("What do you want to do?"));
 146         else // buttons have standard "Yes"/"No" values, so rephrase the question
 147             dlg.SetMessage(_("Do you really want to quit?"));
 148         @endcode
 149     */
 150     bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no);
 151
 152     /**
 153         Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES,
 154         wxID_NO.
 155
 156         Notice that this method returns the identifier of the button which was
 157         clicked unlike wxMessageBox() function.
 158     */
 159     int ShowModal();
 160 };
 161
 162
 163
 164 // ============================================================================
 165 // Global functions/macros
 166 // ============================================================================
 167
 168 /** @ingroup group_funcmacro_dialog */
 169 //@{
 170
 171 /**
 172     Show a general purpose message dialog.
 173
 174     This is a convenient function which is usually used instead of using
 175     wxMessageDialog directly. Notice however that some of the features, such as
 176     extended text and custom labels for the message box buttons, are not
 177     provided by this function but only by wxMessageDialog.
 178
 179     The return value is one of: @c wxYES, @c wxNO, @c wxCANCEL or @c wxOK
 180     (notice that this return value is @b different from the return value of
 181     wxMessageDialog::ShowModal()).
 182
 183     For example:
 184     @code
 185     int answer = wxMessageBox("Quit program?", "Confirm",
 186                               wxYES_NO | wxCANCEL, main_frame);
 187     if (answer == wxYES)
 188         main_frame->Close();
 189     @endcode
 190
 191     @a message may contain newline characters, in which case the message will
 192     be split into separate lines, to cater for large messages.
 193
 194     @param message
 195         Message to show in the dialog.
 196     @param caption
 197         The dialog title.
 198     @param parent
 199         Parent window.
 200     @param style
 201         Combination of style flags described in wxMessageDialog documentation.
 202     @param x
 203         Horizontal dialog position (ignored under MSW). Use @c wxDefaultCoord
 204         for @a x and @a y to let the system position the window.
 205     @param y
 206         Vertical dialog position (ignored under MSW).
 207     @header{wx/msgdlg.h}
 208 */
 209 int wxMessageBox(const wxString& message,
 210                  const wxString& caption = "Message",
 211                  int style = wxOK,
 212                  wxWindow* parent = NULL,
 213                  int x = wxDefaultCoord,
 214                  int y = wxDefaultCoord);
 215
 216 //@}
 217