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