include/wx/msgdlg.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msgdlgg.h
   3 // Purpose:     common header and base class for wxMessageDialog
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MSGDLG_H_BASE_
  13 #define _WX_MSGDLG_H_BASE_
  14
  15 #include "wx/defs.h"
  16
  17 #if wxUSE_MSGDLG
  18
  19 #include "wx/dialog.h"
  20 #include "wx/stockitem.h"
  21
  22 WXDLLIMPEXP_DATA_CORE(extern const char) wxMessageBoxCaptionStr[];
  23
  24 // ----------------------------------------------------------------------------
  25 // wxMessageDialogBase: base class defining wxMessageDialog interface
  26 // ----------------------------------------------------------------------------
  27
  28 class WXDLLIMPEXP_CORE wxMessageDialogBase : public wxDialog
  29 {
  30 public:
  31     // helper class for SetXXXLabels() methods: it makes it possible to pass
  32     // either a stock id (wxID_CLOSE) or a string ("&Close") to them
  33     class ButtonLabel
  34     {
  35     public:
  36         // ctors are not explicit, objects of this class can be implicitly
  37         // constructed from either stock ids or strings
  38         ButtonLabel(int stockId)
  39             : m_stockId(stockId)
  40         {
  41             wxASSERT_MSG( wxIsStockID(stockId), "invalid stock id" );
  42         }
  43
  44         ButtonLabel(const wxString& label)
  45             : m_label(label), m_stockId(wxID_NONE)
  46         {
  47         }
  48
  49         ButtonLabel(const char *label)
  50             : m_label(label), m_stockId(wxID_NONE)
  51         {
  52         }
  53
  54         ButtonLabel(const wchar_t *label)
  55             : m_label(label), m_stockId(wxID_NONE)
  56         {
  57         }
  58
  59         ButtonLabel(const wxCStrData& label)
  60             : m_label(label), m_stockId(wxID_NONE)
  61         {
  62         }
  63
  64         // default copy ctor and dtor are ok
  65
  66         // get the string label, whether it was originally specified directly
  67         // or as a stock id -- this is only useful for platforms without native
  68         // stock items id support
  69         wxString GetAsString() const
  70         {
  71             return m_stockId == wxID_NONE ? m_label
  72                                           : wxGetStockLabel(m_stockId);
  73         }
  74
  75         // return the stock id or wxID_NONE if this is not a stock label
  76         int GetStockId() const { return m_stockId; }
  77
  78     private:
  79         // the label if explicitly given or empty if this is a stock item
  80         const wxString m_label;
  81
  82         // the stock item id or wxID_NONE if m_label should be used
  83         const int m_stockId;
  84     };
  85
  86
  87     // ctors
  88     wxMessageDialogBase() { m_dialogStyle = 0; }
  89     wxMessageDialogBase(wxWindow *parent,
  90                         const wxString& message,
  91                         const wxString& caption,
  92                         long style)
  93         : m_message(message),
  94           m_caption(caption)
  95     {
  96         m_parent = parent;
  97         SetMessageDialogStyle(style);
  98     }
  99
 100     // virtual dtor for the base class
 101     virtual ~wxMessageDialogBase() { }
 102
 103
 104     // methods for setting up more custom message dialogs -- all functions
 105     // return false if they're not implemented
 106     virtual bool SetYesNoLabels(const ButtonLabel& WXUNUSED(yes),
 107                                 const ButtonLabel& WXUNUSED(no))
 108     {
 109         return false;
 110     }
 111
 112     virtual bool SetYesNoCancelLabels(const ButtonLabel& WXUNUSED(yes),
 113                                       const ButtonLabel& WXUNUSED(no),
 114                                       const ButtonLabel& WXUNUSED(cancel))
 115     {
 116         return false;
 117     }
 118
 119     virtual bool SetOKLabel(const ButtonLabel& WXUNUSED(ok))
 120     {
 121         return false;
 122     }
 123
 124     virtual bool SetOKCancelLabels(const ButtonLabel& WXUNUSED(ok),
 125                                    const ButtonLabel& WXUNUSED(cancel))
 126     {
 127         return false;
 128     }
 129
 130     virtual void SetMessage(const wxString& message)
 131     {
 132         m_message = message;
 133     }
 134
 135     virtual void SetExtendedMessage(const wxString& extendedMessage)
 136     {
 137         m_extendedMessage = extendedMessage;
 138     }
 139
 140     // change the dialog style flag
 141     void SetMessageDialogStyle(long style)
 142     {
 143 #ifdef __WXDEBUG__
 144         wxASSERT_MSG( ((style & wxYES_NO) == wxYES_NO) || !(style & wxYES_NO),
 145                       "wxYES and wxNO may only be used together" );
 146
 147         wxASSERT_MSG( !(style & wxYES) || !(style & wxOK),
 148                       "wxOK and wxYES/wxNO can't be used together" );
 149
 150         wxASSERT_MSG( (style & wxYES) || (style & wxOK),
 151                       "one of wxOK and wxYES/wxNO must be used" );
 152
 153         wxASSERT_MSG( (style & wxID_OK) != wxID_OK,
 154                       "wxMessageBox: Did you mean wxOK (and not wxID_OK)?" );
 155
 156         if ((style & wxNO_DEFAULT) != 0 && (style & wxNO) == 0)
 157             wxFAIL_MSG("wxNO_DEFAULT is invalid without wxNO");
 158
 159         if ((style & wxCANCEL_DEFAULT) != 0 && (style & wxCANCEL) == 0)
 160             wxFAIL_MSG("wxCANCEL_DEFAULT is invalid without wxCANCEL");
 161
 162         if ((style & wxCANCEL_DEFAULT) != 0 && (style & wxNO_DEFAULT) != 0)
 163             wxFAIL_MSG("only one default button can be specified");
 164 #endif
 165
 166         m_dialogStyle = style;
 167     }
 168
 169 protected:
 170     long GetMessageDialogStyle() const { return m_dialogStyle; }
 171
 172
 173     // for the platforms not supporting separate main and extended messages
 174     // this function should be used to combine both of them in a single string
 175     wxString GetFullMessage() const
 176     {
 177         wxString msg = m_message;
 178         if ( !m_extendedMessage.empty() )
 179             msg << "\n\n" << m_extendedMessage;
 180
 181         return msg;
 182     }
 183
 184     wxString m_message,
 185              m_extendedMessage,
 186              m_caption;
 187     long m_dialogStyle;
 188
 189     DECLARE_NO_COPY_CLASS(wxMessageDialogBase)
 190 };
 191
 192 // this is a helper class for native wxMessageDialog implementations which need
 193 // to store the custom button labels as member variables and then use them in
 194 // ShowModal() (there could conceivably be a port which would have some native
 195 // functions for setting these labels immediately and we also don't need to
 196 // store them at all if custom labels are not supported, which is why we do
 197 // this in a separate class and not wxMessageDialogBase itself)
 198 #if defined(__WXCOCOA__) || \
 199     defined(__WXGTK20__) || \
 200     defined(__WXMAC__) || \
 201     defined(__WXMSW__)
 202
 203 class WXDLLIMPEXP_CORE wxMessageDialogWithCustomLabels
 204     : public wxMessageDialogBase
 205 {
 206 public:
 207     // ctors
 208     wxMessageDialogWithCustomLabels() { }
 209     wxMessageDialogWithCustomLabels(wxWindow *parent,
 210                                     const wxString& message,
 211                                     const wxString& caption,
 212                                     long style)
 213         : wxMessageDialogBase(parent, message, caption, style)
 214     {
 215     }
 216
 217     // customization of the message box buttons
 218     virtual bool SetYesNoLabels(const ButtonLabel& yes,const ButtonLabel& no)
 219     {
 220         DoSetCustomLabel(m_yes, yes);
 221         DoSetCustomLabel(m_no, no);
 222         return true;
 223     }
 224
 225     virtual bool SetYesNoCancelLabels(const ButtonLabel& yes,
 226                                       const ButtonLabel& no,
 227                                       const ButtonLabel& cancel)
 228     {
 229         DoSetCustomLabel(m_yes, yes);
 230         DoSetCustomLabel(m_no, no);
 231         DoSetCustomLabel(m_cancel, cancel);
 232         return true;
 233     }
 234
 235     virtual bool SetOKLabel(const ButtonLabel& ok)
 236     {
 237         DoSetCustomLabel(m_ok, ok);
 238         return true;
 239     }
 240
 241     virtual bool SetOKCancelLabels(const ButtonLabel& ok,
 242                                    const ButtonLabel& cancel)
 243     {
 244         DoSetCustomLabel(m_ok, ok);
 245         DoSetCustomLabel(m_cancel, cancel);
 246         return true;
 247     }
 248
 249 protected:
 250     // test if any custom labels were set
 251     bool HasCustomLabels() const
 252     {
 253         return !(m_ok.empty() && m_cancel.empty() &&
 254                  m_yes.empty() && m_no.empty());
 255     }
 256
 257     // these functions return the label to be used for the button which is
 258     // either a custom label explicitly set by the user or the default label,
 259     // i.e. they always return a valid string
 260     wxString GetYesLabel() const
 261         { return m_yes.empty() ? GetDefaultYesLabel() : m_yes; }
 262     wxString GetNoLabel() const
 263         { return m_no.empty() ? GetDefaultNoLabel() : m_no; }
 264     wxString GetOKLabel() const
 265         { return m_ok.empty() ? GetDefaultOKLabel() : m_ok; }
 266     wxString GetCancelLabel() const
 267         { return m_cancel.empty() ? GetDefaultCancelLabel() : m_cancel; }
 268
 269     // this function is called by our public SetXXXLabels() and should assign
 270     // the value to var with possibly some transformation (e.g. Cocoa version
 271     // currently uses this to remove any accelerators from the button strings
 272     // while GTK+ one handles stock items specifically here)
 273     virtual void DoSetCustomLabel(wxString& var, const ButtonLabel& label)
 274     {
 275         var = label.GetAsString();
 276     }
 277
 278 private:
 279     // these functions may be overridden to provide different defaults for the
 280     // default button labels (this is used by wxGTK)
 281     virtual wxString GetDefaultYesLabel() const { return _("Yes"); }
 282     virtual wxString GetDefaultNoLabel() const { return _("No"); }
 283     virtual wxString GetDefaultOKLabel() const { return _("OK"); }
 284     virtual wxString GetDefaultCancelLabel() const { return _("Cancel"); }
 285
 286     // labels for the buttons, initially empty meaning that the defaults should
 287     // be used, use GetYes/No/OK/CancelLabel() to access them
 288     wxString m_yes,
 289              m_no,
 290              m_ok,
 291              m_cancel;
 292
 293     DECLARE_NO_COPY_CLASS(wxMessageDialogWithCustomLabels)
 294 };
 295
 296 #endif // ports needing wxMessageDialogWithCustomLabels
 297
 298 #if defined(__WX_COMPILING_MSGDLGG_CPP__) || \
 299     defined(__WXUNIVERSAL__) || defined(__WXGPE__) || \
 300     (defined(__WXGTK__) && !defined(__WXGTK20__))
 301     #include "wx/generic/msgdlgg.h"
 302
 303     #define wxMessageDialog wxGenericMessageDialog
 304 #elif defined(__WXCOCOA__)
 305     #include "wx/cocoa/msgdlg.h"
 306 #elif defined(__WXPALMOS__)
 307     #include "wx/palmos/msgdlg.h"
 308 #elif defined(__WXMSW__)
 309     #include "wx/msw/msgdlg.h"
 310 #elif defined(__WXMOTIF__)
 311     #include "wx/motif/msgdlg.h"
 312 #elif defined(__WXGTK20__)
 313     #include "wx/gtk/msgdlg.h"
 314 #elif defined(__WXMAC__)
 315     #include "wx/osx/msgdlg.h"
 316 #elif defined(__WXPM__)
 317     #include "wx/os2/msgdlg.h"
 318 #endif
 319
 320 // ----------------------------------------------------------------------------
 321 // wxMessageBox: the simplest way to use wxMessageDialog
 322 // ----------------------------------------------------------------------------
 323
 324 int WXDLLIMPEXP_CORE wxMessageBox(const wxString& message,
 325                              const wxString& caption = wxMessageBoxCaptionStr,
 326                              long style = wxOK | wxCENTRE,
 327                              wxWindow *parent = NULL,
 328                              int x = wxDefaultCoord, int y = wxDefaultCoord);
 329
 330 #endif // wxUSE_MSGDLG
 331
 332 #endif // _WX_MSGDLG_H_BASE_