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