]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/msgdlg.h
take old (wx 2.2? older?) wxGrid compatibility functions inside WXWIN_COMPATIBILITY_2...
[wxWidgets.git] / include / wx / msgdlg.h
index be89f2ce3428757c9ed6970056c6559430feeb92..0b9de3f1f788c613ec2cec4f9ed0a18ae9b7af27 100644 (file)
 #if wxUSE_MSGDLG
 
 #include "wx/dialog.h"
+#include "wx/stockitem.h"
 
 WXDLLIMPEXP_DATA_CORE(extern const char) wxMessageBoxCaptionStr[];
 
+// ----------------------------------------------------------------------------
+// wxMessageDialogBase: base class defining wxMessageDialog interface
+// ----------------------------------------------------------------------------
+
 class WXDLLIMPEXP_CORE wxMessageDialogBase : public wxDialog
 {
 public:
+    // helper class for SetXXXLabels() methods: it makes it possible to pass
+    // either a stock id (wxID_CLOSE) or a string ("&Close") to them
+    class ButtonLabel
+    {
+    public:
+        // ctors are not explicit, objects of this class can be implicitly
+        // constructed from either stock ids or strings
+        ButtonLabel(int stockId)
+            : m_stockId(stockId)
+        {
+            wxASSERT_MSG( wxIsStockID(stockId), "invalid stock id" );
+        }
+
+        ButtonLabel(const wxString& label)
+            : m_label(label), m_stockId(wxID_NONE)
+        {
+        }
+
+        ButtonLabel(const char *label)
+            : m_label(label), m_stockId(wxID_NONE)
+        {
+        }
+
+        ButtonLabel(const wchar_t *label)
+            : m_label(label), m_stockId(wxID_NONE)
+        {
+        }
+
+        ButtonLabel(const wxCStrData& label)
+            : m_label(label), m_stockId(wxID_NONE)
+        {
+        }
+
+        // default copy ctor and dtor are ok
+
+        // get the string label, whether it was originally specified directly
+        // or as a stock id -- this is only useful for platforms without native
+        // stock items id support
+        wxString GetAsString() const
+        {
+            return m_stockId == wxID_NONE ? m_label
+                                          : wxGetStockLabel(m_stockId);
+        }
+
+        // return the stock id or wxID_NONE if this is not a stock label
+        int GetStockId() const { return m_stockId; }
+
+    private:
+        // the label if explicitly given or empty if this is a stock item
+        const wxString m_label;
+
+        // the stock item id or wxID_NONE if m_label should be used
+        const int m_stockId;
+    };
+
+
     // ctors
     wxMessageDialogBase() { m_dialogStyle = 0; }
     wxMessageDialogBase(wxWindow *parent,
@@ -42,26 +103,26 @@ public:
 
     // methods for setting up more custom message dialogs -- all functions
     // return false if they're not implemented
-    virtual bool SetYesNoLabels(const wxString& WXUNUSED(yes),
-                                const wxString& WXUNUSED(no))
+    virtual bool SetYesNoLabels(const ButtonLabel& WXUNUSED(yes),
+                                const ButtonLabel& WXUNUSED(no))
     {
         return false;
     }
 
-    virtual bool SetYesNoCancelLabels(const wxString& WXUNUSED(yes),
-                                      const wxString& WXUNUSED(no),
-                                      const wxString& WXUNUSED(cancel))
+    virtual bool SetYesNoCancelLabels(const ButtonLabel& WXUNUSED(yes),
+                                      const ButtonLabel& WXUNUSED(no),
+                                      const ButtonLabel& WXUNUSED(cancel))
     {
         return false;
     }
 
-    virtual bool SetOKLabel(const wxString& WXUNUSED(ok))
+    virtual bool SetOKLabel(const ButtonLabel& WXUNUSED(ok))
     {
         return false;
     }
 
-    virtual bool SetOKCancelLabels(const wxString& WXUNUSED(ok),
-                                   const wxString& WXUNUSED(cancel))
+    virtual bool SetOKCancelLabels(const ButtonLabel& WXUNUSED(ok),
+                                   const ButtonLabel& WXUNUSED(cancel))
     {
         return false;
     }
@@ -76,19 +137,34 @@ public:
         m_extendedMessage = extendedMessage;
     }
 
-protected:
-    // common validation of wxMessageDialog style
+    // change the dialog style flag
     void SetMessageDialogStyle(long style)
     {
-        wxASSERT_MSG( ((style & wxYES_NO) == wxYES_NO) || ((style & wxYES_NO) == 0),
-                      _T("wxYES and wxNO may only be used together in wxMessageDialog") );
+        wxASSERT_MSG( ((style & wxYES_NO) == wxYES_NO) || !(style & wxYES_NO),
+                      "wxYES and wxNO may only be used together" );
+
+        wxASSERT_MSG( !(style & wxYES) || !(style & wxOK),
+                      "wxOK and wxYES/wxNO can't be used together" );
+
+        wxASSERT_MSG( (style & wxYES) || (style & wxOK),
+                      "one of wxOK and wxYES/wxNO must be used" );
 
         wxASSERT_MSG( (style & wxID_OK) != wxID_OK,
-                      _T("wxMessageBox: Did you mean wxOK (and not wxID_OK)?") );
+                      "wxMessageBox: Did you mean wxOK (and not wxID_OK)?" );
+
+        wxASSERT_MSG( !(style & wxNO_DEFAULT) || (style & wxNO),
+                      "wxNO_DEFAULT is invalid without wxNO" );
+
+        wxASSERT_MSG( !(style & wxCANCEL_DEFAULT) || (style & wxCANCEL),
+                      "wxCANCEL_DEFAULT is invalid without wxCANCEL" );
+
+        wxASSERT_MSG( !(style & wxCANCEL_DEFAULT) || !(style & wxNO_DEFAULT),
+                      "only one default button can be specified" );
 
         m_dialogStyle = style;
     }
 
+protected:
     long GetMessageDialogStyle() const { return m_dialogStyle; }
 
 
@@ -117,7 +193,10 @@ protected:
 // functions for setting these labels immediately and we also don't need to
 // store them at all if custom labels are not supported, which is why we do
 // this in a separate class and not wxMessageDialogBase itself)
-#if defined(__WXCOCOA__) || defined(__WXMAC__) || defined(__WXMSW__)
+#if defined(__WXCOCOA__) || \
+    defined(__WXGTK20__) || \
+    defined(__WXMAC__) || \
+    defined(__WXMSW__)
 
 class WXDLLIMPEXP_CORE wxMessageDialogWithCustomLabels
     : public wxMessageDialogBase
@@ -134,16 +213,16 @@ public:
     }
 
     // customization of the message box buttons
-    virtual bool SetYesNoLabels(const wxString& yes,const wxString& no)
+    virtual bool SetYesNoLabels(const ButtonLabel& yes,const ButtonLabel& no)
     {
         DoSetCustomLabel(m_yes, yes);
         DoSetCustomLabel(m_no, no);
         return true;
     }
 
-    virtual bool SetYesNoCancelLabels(const wxString& yes,
-                                      const wxString& no,
-                                      const wxString& cancel)
+    virtual bool SetYesNoCancelLabels(const ButtonLabel& yes,
+                                      const ButtonLabel& no,
+                                      const ButtonLabel& cancel)
     {
         DoSetCustomLabel(m_yes, yes);
         DoSetCustomLabel(m_no, no);
@@ -151,13 +230,14 @@ public:
         return true;
     }
 
-    virtual bool SetOKLabel(const wxString& ok)
+    virtual bool SetOKLabel(const ButtonLabel& ok)
     {
         DoSetCustomLabel(m_ok, ok);
         return true;
     }
 
-    virtual bool SetOKCancelLabels(const wxString& ok, const wxString& cancel)
+    virtual bool SetOKCancelLabels(const ButtonLabel& ok,
+                                   const ButtonLabel& cancel)
     {
         DoSetCustomLabel(m_ok, ok);
         DoSetCustomLabel(m_cancel, cancel);
@@ -175,21 +255,32 @@ protected:
     // these functions return the label to be used for the button which is
     // either a custom label explicitly set by the user or the default label,
     // i.e. they always return a valid string
-    wxString GetYesLabel() const { return m_yes.empty() ? _("Yes") : m_yes; }
-    wxString GetNoLabel() const { return m_no.empty() ? _("No") : m_no; }
-    wxString GetOKLabel() const { return m_ok.empty() ? _("OK") : m_ok; }
+    wxString GetYesLabel() const
+        { return m_yes.empty() ? GetDefaultYesLabel() : m_yes; }
+    wxString GetNoLabel() const
+        { return m_no.empty() ? GetDefaultNoLabel() : m_no; }
+    wxString GetOKLabel() const
+        { return m_ok.empty() ? GetDefaultOKLabel() : m_ok; }
     wxString GetCancelLabel() const
-        { return m_cancel.empty() ? _("Cancel") : m_cancel; }
+        { return m_cancel.empty() ? GetDefaultCancelLabel() : m_cancel; }
 
-private:
     // this function is called by our public SetXXXLabels() and should assign
     // the value to var with possibly some transformation (e.g. Cocoa version
-    // currently uses this to remove any accelerators from the button strings)
-    virtual void DoSetCustomLabel(wxString& var, const wxString& value)
+    // currently uses this to remove any accelerators from the button strings
+    // while GTK+ one handles stock items specifically here)
+    virtual void DoSetCustomLabel(wxString& var, const ButtonLabel& label)
     {
-        var = value;
+        var = label.GetAsString();
     }
 
+private:
+    // these functions may be overridden to provide different defaults for the
+    // default button labels (this is used by wxGTK)
+    virtual wxString GetDefaultYesLabel() const { return _("Yes"); }
+    virtual wxString GetDefaultNoLabel() const { return _("No"); }
+    virtual wxString GetDefaultOKLabel() const { return _("OK"); }
+    virtual wxString GetDefaultCancelLabel() const { return _("Cancel"); }
+
     // labels for the buttons, initially empty meaning that the defaults should
     // be used, use GetYes/No/OK/CancelLabel() to access them
     wxString m_yes,