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