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