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