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         Constructor specifying the message box properties.
  86         Use ShowModal() to show the dialog.
  87
  88         @a style may be a bit list of the identifiers described above.
  89
  90         Notice that not all styles are compatible: only one of @c wxOK and
  91         @c wxYES_NO may be specified (and one of them must be specified) and at
  92         most one default button style can be used and it is only valid if the
  93         corresponding button is shown in the message box.
  94
  95         @param parent
  96             Parent window.
  97         @param message
  98             Message to show in the dialog.
  99         @param caption
 100             The dialog title.
 101         @param style
 102             Combination of style flags described above.
 103         @param pos
 104             Dialog position (ignored under MSW).
 105     */
 106     wxMessageDialog(wxWindow* parent, const wxString& message,
 107                     const wxString& caption = wxMessageBoxCaptionStr,
 108                     long style = wxOK | wxCENTRE,
 109                     const wxPoint& pos = wxDefaultPosition);
 110
 111     /**
 112         Sets the extended message for the dialog: this message is usually an
 113         extension of the short message specified in the constructor or set with
 114         SetMessage().
 115
 116         If it is set, the main message appears highlighted -- if supported --
 117         and this message appears beneath it in normal font. On the platforms
 118         which don't support extended messages, it is simply appended to the
 119         normal message with an empty line separating them.
 120
 121         @since 2.9.0
 122     */
 123     virtual void SetExtendedMessage(const wxString& extendedMessage);
 124
 125     /**
 126         Sets the label for the Help button.
 127
 128         Please see the remarks in SetYesNoLabels() documentation.
 129
 130         Notice that changing the label of the help button resets its special
 131         status (if any, this depends on the platform) and it will be treated
 132         just like another button in this case.
 133
 134         @since 2.9.3
 135      */
 136     virtual bool SetHelpLabel(const ButtonLabel& help);
 137
 138     /**
 139         Sets the message shown by the dialog.
 140
 141         @since 2.9.0
 142     */
 143     virtual void SetMessage(const wxString& message);
 144
 145     /**
 146         Overrides the default labels of the OK and Cancel buttons.
 147
 148         Please see the remarks in SetYesNoLabels() documentation.
 149
 150         @since 2.9.0
 151     */
 152     virtual bool SetOKCancelLabels(const ButtonLabel& ok,
 153                                    const ButtonLabel& cancel);
 154
 155     /**
 156         Overrides the default label of the OK button.
 157
 158         Please see the remarks in SetYesNoLabels() documentation.
 159
 160         @since 2.9.0
 161     */
 162     virtual bool SetOKLabel(const ButtonLabel& ok);
 163
 164     /**
 165         Overrides the default labels of the Yes, No and Cancel buttons.
 166
 167         Please see the remarks in SetYesNoLabels() documentation.
 168
 169         @since 2.9.0
 170     */
 171     virtual bool SetYesNoCancelLabels(const ButtonLabel& yes,
 172                                       const ButtonLabel& no,
 173                                       const ButtonLabel& cancel);
 174
 175     /**
 176         Overrides the default labels of the Yes and No buttons.
 177
 178         The arguments of this function can be either strings or one of the
 179         standard identifiers, such as @c wxID_APPLY or @c wxID_OPEN. Notice
 180         that even if the label is specified as an identifier, the return value
 181         of the dialog ShowModal() method still remains one of @c wxID_OK, @c
 182         wxID_CANCEL, @c wxID_YES or @c wxID_NO values, i.e. this identifier
 183         changes only the label appearance but not the return code generated by
 184         the button. It is possible to mix stock identifiers and string labels
 185         in the same function call, for example:
 186         @code
 187         wxMessageDialog dlg(...);
 188         dlg.SetYesNoLabels(wxID_SAVE, _("&Don't save"));
 189         @endcode
 190
 191         Also notice that this function is not currently available on all
 192         platforms (although as of wxWidgets 2.9.0 it is implemented in all
 193         major ports), so it may return @false to indicate that the labels
 194         couldn't be changed. If it returns @true, the labels were set
 195         successfully.
 196
 197         Typically, if the function was used successfully, the main dialog
 198         message may need to be changed, e.g.:
 199         @code
 200         wxMessageDialog dlg(...);
 201         if ( dlg.SetYesNoLabels(_("&Quit"), _("&Don't quit")) )
 202             dlg.SetMessage(_("What do you want to do?"));
 203         else // buttons have standard "Yes"/"No" values, so rephrase the question
 204             dlg.SetMessage(_("Do you really want to quit?"));
 205         @endcode
 206
 207         @since 2.9.0
 208     */
 209     virtual bool SetYesNoLabels(const ButtonLabel& yes, const ButtonLabel& no);
 210
 211     /**
 212         Shows the dialog, returning one of wxID_OK, wxID_CANCEL, wxID_YES,
 213         wxID_NO or wxID_HELP.
 214
 215         Notice that this method returns the identifier of the button which was
 216         clicked unlike wxMessageBox() function.
 217     */
 218     virtual int ShowModal();
 219
 220
 221     wxString GetCaption() const;
 222     wxString GetMessage() const;
 223     wxString GetExtendedMessage() const;
 224     long GetMessageDialogStyle() const;
 225     bool HasCustomLabels() const;
 226     wxString GetYesLabel() const;
 227     wxString GetNoLabel() const;
 228     wxString GetOKLabel() const;
 229     wxString GetCancelLabel() const;
 230     wxString GetHelpLabel() const;
 231     long GetEffectiveIcon() const;
 232
 233 };
 234
 235
 236
 237 // ============================================================================
 238 // Global functions/macros
 239 // ============================================================================
 240
 241 /** @addtogroup group_funcmacro_dialog */
 242 //@{
 243
 244 /**
 245     Show a general purpose message dialog.
 246
 247     This is a convenient function which is usually used instead of using
 248     wxMessageDialog directly. Notice however that some of the features, such as
 249     extended text and custom labels for the message box buttons, are not
 250     provided by this function but only by wxMessageDialog.
 251
 252     The return value is one of: @c wxYES, @c wxNO, @c wxCANCEL, @c wxOK or @c
 253     wxHELP (notice that this return value is @b different from the return value
 254     of wxMessageDialog::ShowModal()).
 255
 256     For example:
 257     @code
 258     int answer = wxMessageBox("Quit program?", "Confirm",
 259                               wxYES_NO | wxCANCEL, main_frame);
 260     if (answer == wxYES)
 261         main_frame->Close();
 262     @endcode
 263
 264     @a message may contain newline characters, in which case the message will
 265     be split into separate lines, to cater for large messages.
 266
 267     @param message
 268         Message to show in the dialog.
 269     @param caption
 270         The dialog title.
 271     @param parent
 272         Parent window.
 273     @param style
 274         Combination of style flags described in wxMessageDialog documentation.
 275     @param x
 276         Horizontal dialog position (ignored under MSW). Use ::wxDefaultCoord
 277         for @a x and @a y to let the system position the window.
 278     @param y
 279         Vertical dialog position (ignored under MSW).
 280
 281     @header{wx/msgdlg.h}
 282 */
 283 int wxMessageBox(const wxString& message,
 284                  const wxString& caption = "Message",
 285                  int style = wxOK,
 286                  wxWindow* parent = NULL,
 287                  int x = wxDefaultCoord,
 288                  int y = wxDefaultCoord);
 289
 290 //@}
 291