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{wxHELP}
  26         Puts a Help button to the message box. This button can have special
  27         appearance or be specially positioned if its label is not changed from
  28         the default one. Notice that using this button is not supported when
  29         showing a message box from non-main thread in wxOSX/Cocoa and it is not
  30         supported in wxOSX/Carbon at all. @since 2.9.3.
  31     @style{wxNO_DEFAULT}
  32         Makes the "No" button default, can only be used with @c wxYES_NO.
  33     @style{wxCANCEL_DEFAULT}
  34         Makes the "Cancel" button default, can only be used with @c wxCANCEL
  35     @style{wxYES_DEFAULT}
  36         Makes the "Yes" button default, this is the default behaviour and
  37         this flag exists solely for symmetry with @c wxNO_DEFAULT.
  38     @style{wxOK_DEFAULT}
  39         Makes the "OK" button default, this is the default behaviour and
  40         this flag exists solely for symmetry with @c wxCANCEL_DEFAULT.
  41     @style{wxICON_NONE}
  42         Displays no icon in the dialog if possible (an icon might still be
  43         displayed if the current platform mandates its use). This style may be
  44         used to prevent the dialog from using the default icon based on @c
  45         wxYES_NO presence as explained in @c wxICON_QUESTION and @c
  46         wxICON_INFORMATION documentation below.
  47     @style{wxICON_EXCLAMATION}
  48         Displays an exclamation, or warning, icon in the dialog.
  49     @style{wxICON_ERROR}
  50         Displays an error icon in the dialog.
  51     @style{wxICON_HAND}
  52         Displays an error symbol, this is a MSW-inspired synonym for @c wxICON_ERROR.
  53     @style{wxICON_QUESTION}
  54         Displays a question mark symbol. This icon is automatically used
  55         with @c wxYES_NO so it's usually unnecessary to specify it explicitly.
  56         This style is not supported for message dialogs under wxMSW when a task
  57         dialog is used to implement them (i.e. when running under Windows Vista
  58         or later) because <a href="http://msdn.microsoft.com/en-us/library/aa511273.aspx">Microsoft
  59         guidelines</a> indicate that no icon should be used for routine
  60         confirmations. If it is specified, no icon will be displayed.
  61     @style{wxICON_INFORMATION}
  62         Displays an information symbol. This icon is used by default if
  63         @c wxYES_NO is not given so it is usually unnecessary to specify it
  64         explicitly.
  65     @style{wxSTAY_ON_TOP}
  66         Makes the message box stay on top of all other windows and not only
  67         just its parent (currently implemented only under MSW and GTK).
  68     @style{wxCENTRE}
  69         Centre the message box on its parent or on the screen if parent is not
  70         specified.
  71         Setting this style under MSW makes no differences as the dialog is
  72         always centered on the parent.
  73     @endStyleTable
  74
  75     @library{wxcore}
  76     @category{cmndlg}
  77
  78     @see @ref overview_cmndlg_msg
  79     @see wxRichMessageDialog
  80 */
  81 class wxMessageDialog : public wxDialog
  82 {
  83 public:
  84     /**
  85         Helper class allowing to use either stock id or string labels.
  86
  87         This class should never be used explicitly and is not really part of
  88         wxWidgets API but rather is just an implementation helper allowing the
  89         methods such as SetYesNoLabels() and SetOKCancelLabels() below to be
  90         callable with either stock ids (e.g. ::wxID_CLOSE) or strings
  91         ("&Close").
  92      */
  93     class ButtonLabel
  94     {
  95     public:
  96         /// Construct the label from a stock id.
  97         ButtonLabel(int stockId);
  98
  99         /// Construct the label from the specified string.
 100         ButtonLabel(const wxString& label);
 101
 102         /**
 103             Return the associated label as string.
 104
 105             Get the string label, whether it was originally specified directly
 106             or as a stock id -- this is only useful for platforms without native
 107             stock items id support
 108          */
 109         wxString GetAsString() const;
 110
 111         /**
 112             Return the stock id or wxID_NONE if this is not a stock label.
 113          */
 114         int GetStockId() const;
 115     };
 116
 117     /**
 118         Constructor specifying the message box properties.
 119         Use ShowModal() to show the dialog.
 120
 121         @a style may be a bit list of the identifiers described above.
 122
 123         Notice that not all styles are compatible: only one of @c wxOK and
 124         @c wxYES_NO may be specified (and one of them must be specified) and at
 125         most one default button style can be used and it is only valid if the
 126         corresponding button is shown in the message box.
 127
 128         @param parent
 129             Parent window.
 130         @param message
 131             Message to show in the dialog.
 132         @param caption
 133             The dialog title.
 134         @param style
 135             Combination of style flags described above.
 136         @param pos
 137             Dialog position (ignored under MSW).
 138     */
 139     wxMessageDialog(wxWindow* parent, const wxString& message,
 140                     const wxString& caption = wxMessageBoxCaptionStr,
 141                     long style = wxOK | wxCENTRE,
 142                     const wxPoint& pos = wxDefaultPosition);
 143
 144     /**
 145         Sets the extended message for the dialog: this message is usually an
 146         extension of the short message specified in the constructor or set with
 147         SetMessage().
 148
 149         If it is set, the main message appears highlighted -- if supported --
 150         and this message appears beneath it in normal font. On the platforms
 151         which don't support extended messages, it is simply appended to the
 152         normal message with an empty line separating them.
 153
 154         @since 2.9.0
 155     */
 156     virtual void SetExtendedMessage(const wxString& extendedMessage);
 157
 158     /**
 159         Sets the label for the Help button.
 160
 161         Please see the remarks in SetYesNoLabels() documentation.
 162
 163         Notice that changing the label of the help button resets its special
 164         status (if any, this depends on the platform) and it will be treated
 165         just like another button in this case.
 166
 167         @since 2.9.3
 168      */
 169     virtual bool SetHelpLabel(const ButtonLabel& help);
 170
 171     /**
 172         Sets the message shown by the dialog.
 173
 174         @since 2.9.0
 175     */
 176     virtual void SetMessage(const wxString& message);
 177
 178     /**
 179         Overrides the default labels of the OK and Cancel buttons.
 180
 181         Please see the remarks in SetYesNoLabels() documentation.
 182
 183         @since 2.9.0
 184     */
 185     virtual bool SetOKCancelLabels(const ButtonLabel& ok,
 186                                    const ButtonLabel& cancel);
 187
 188     /**
 189         Overrides the default label of the OK button.
 190
 191         Please see the remarks in SetYesNoLabels() documentation.
 192
 193         @since 2.9.0
 194     */
 195     virtual bool SetOKLabel(const ButtonLabel& ok);
 196
 197     /**
 198         Overrides the default labels of the Yes, No and Cancel buttons.
 199
 200         Please see the remarks in SetYesNoLabels() documentation.
 201
 202         @since 2.9.0
 203     */
 204     virtual bool SetYesNoCancelLabels(const ButtonLabel& yes,
 205                                       const ButtonLabel& no,
 206                                       const ButtonLabel& cancel);
 207
 208     /**
 209         Overrides the default labels of the Yes and No buttons.
 210
 211         The arguments of this function can be either strings or one of the
 212         standard identifiers, such as @c wxID_APPLY or @c wxID_OPEN. Notice
 213         that even if the label is specified as an identifier, the return value
 214         of the dialog ShowModal() method still remains one of @c wxID_OK, @c
 215         wxID_CANCEL, @c wxID_YES or @c wxID_NO values, i.e. this identifier
 216         changes only the label appearance but not the return code generated by
 217         the button. It is possible to mix stock identifiers and string labels
 218         in the same function call, for example:
 219         @code
 220         wxMessageDialog dlg(...);
 221         dlg.SetYesNoLabels(wxID_SAVE, _("&Don't save"));
 222         @endcode
 223
 224         Also notice that this function is not currently available on all
 225         platforms (although as of wxWidgets 2.9.0 it is implemented in all
 226         major ports), so it may return @false to indicate that the labels
 227         couldn't be changed. If it returns @true, the labels were set
 228         successfully.
 229
 230         Typically, if the function was used successfully, the main dialog
 231         message may need to be changed, e.g.:
 232         @code
 233         wxMessageDialog dlg(...);
 234         if ( dlg.SetYesNoLabels(_("&Quit"), _("&Don't quit")) )
 235             dlg.SetMessage(_("What do you want to do?"));
 236         else // buttons have standard "Yes"/"No" values, so rephrase the question
 237             dlg.SetMessage(_("Do you really want to quit?"));
 238         @endcode
 239
 240         @since 2.9.0
 241     */
 242     virtual bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no);
 243
 244     /**
 245         Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES,
 246         wxID_NO or wxID_HELP.
 247
 248         Notice that this method returns the identifier of the button which was
 249         clicked unlike wxMessageBox() function.
 250     */
 251     virtual int ShowModal();
 252
 253
 254     wxString GetCaption() const;
 255     wxString GetMessage() const;
 256     wxString GetExtendedMessage() const;
 257     long GetMessageDialogStyle() const;
 258     bool HasCustomLabels() const;
 259     wxString GetYesLabel() const;
 260     wxString GetNoLabel() const;
 261     wxString GetOKLabel() const;
 262     wxString GetCancelLabel() const;
 263     wxString GetHelpLabel() const;
 264     long GetEffectiveIcon() const;
 265
 266 };
 267
 268
 269
 270 // ============================================================================
 271 // Global functions/macros
 272 // ============================================================================
 273
 274 /** @addtogroup group_funcmacro_dialog */
 275 //@{
 276
 277 /**
 278     Show a general purpose message dialog.
 279
 280     This is a convenient function which is usually used instead of using
 281     wxMessageDialog directly. Notice however that some of the features, such as
 282     extended text and custom labels for the message box buttons, are not
 283     provided by this function but only by wxMessageDialog.
 284
 285     The return value is one of: @c wxYES, @c wxNO, @c wxCANCEL, @c wxOK or @c
 286     wxHELP (notice that this return value is @b different from the return value
 287     of wxMessageDialog::ShowModal()).
 288
 289     For example:
 290     @code
 291     int answer = wxMessageBox("Quit program?", "Confirm",
 292                               wxYES_NO | wxCANCEL, main_frame);
 293     if (answer == wxYES)
 294         main_frame->Close();
 295     @endcode
 296
 297     @a message may contain newline characters, in which case the message will
 298     be split into separate lines, to cater for large messages.
 299
 300     @param message
 301         Message to show in the dialog.
 302     @param caption
 303         The dialog title.
 304     @param parent
 305         Parent window.
 306     @param style
 307         Combination of style flags described in wxMessageDialog documentation.
 308     @param x
 309         Horizontal dialog position (ignored under MSW). Use ::wxDefaultCoord
 310         for @a x and @a y to let the system position the window.
 311     @param y
 312         Vertical dialog position (ignored under MSW).
 313
 314     @header{wx/msgdlg.h}
 315 */
 316 int wxMessageBox(const wxString& message,
 317                  const wxString& caption = "Message",
 318                  int style = wxOK,
 319                  wxWindow* parent = NULL,
 320                  int x = wxDefaultCoord,
 321                  int y = wxDefaultCoord);
 322
 323 //@}
 324