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