Rebake from clean wx tree.

[wxWidgets.git] / include / wx / msgdlg.h

diff --git a/include/wx/msgdlg.h b/include/wx/msgdlg.h
index 1dbd69e3afe7a2aeb0182fcba26c1833c4ad11b3..1f69aba4f984dc45a1af87407273c6f251e330d9 100644 (file)
--- a/include/wx/msgdlg.h
+++ b/include/wx/msgdlg.h
@@ -17,12 +17,74 @@
 #if wxUSE_MSGDLG
 
 #include "wx/dialog.h"
 #if wxUSE_MSGDLG
 
 #include "wx/dialog.h"

+#include "wx/stockitem.h"

 
 WXDLLIMPEXP_DATA_CORE(extern const char) wxMessageBoxCaptionStr[];
 
 
 WXDLLIMPEXP_DATA_CORE(extern const char) wxMessageBoxCaptionStr[];
 

+// ----------------------------------------------------------------------------
+// wxMessageDialogBase: base class defining wxMessageDialog interface
+// ----------------------------------------------------------------------------
+

 class WXDLLIMPEXP_CORE wxMessageDialogBase : public wxDialog
 {
 public:
 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, wxSTOCK_FOR_BUTTON);
+        }
+
+        // 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,
     // ctors
     wxMessageDialogBase() { m_dialogStyle = 0; }
     wxMessageDialogBase(wxWindow *parent,


@@ -42,26 +104,26 @@ public:
 
     // methods for setting up more custom message dialogs -- all functions
     // return false if they're not implemented
 
     // 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;
     }
 
     {
         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;
     }
 
     {
         return false;
     }
 

-    virtual bool SetOKLabel(const wxString& WXUNUSED(ok))
+    virtual bool SetOKLabel(const ButtonLabel& WXUNUSED(ok))

     {
         return false;
     }
 
     {
         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;
     }
     {
         return false;
     }


@@ -76,19 +138,34 @@ public:
         m_extendedMessage = extendedMessage;
     }
 
         m_extendedMessage = extendedMessage;
     }
 

-protected:
-    // common validation of wxMessageDialog style
+    // change the dialog style flag

     void SetMessageDialogStyle(long style)
     {
     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,
 
         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;
     }
 
 
         m_dialogStyle = style;
     }
 

+protected:

     long GetMessageDialogStyle() const { return m_dialogStyle; }
 
 
     long GetMessageDialogStyle() const { return m_dialogStyle; }
 
 


@@ -108,7 +185,7 @@ protected:
              m_caption;
     long m_dialogStyle;
 
              m_caption;
     long m_dialogStyle;
 

-    DECLARE_NO_COPY_CLASS(wxMessageDialogBase)
+    wxDECLARE_NO_COPY_CLASS(wxMessageDialogBase);

 };
 
 // this is a helper class for native wxMessageDialog implementations which need
 };
 
 // this is a helper class for native wxMessageDialog implementations which need


@@ -137,16 +214,16 @@ public:
     }
 
     // customization of the message box buttons
     }
 
     // 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;
     }
 
     {
         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);
     {
         DoSetCustomLabel(m_yes, yes);
         DoSetCustomLabel(m_no, no);


@@ -154,13 +231,14 @@ public:
         return true;
     }
 
         return true;
     }
 

-    virtual bool SetOKLabel(const wxString& ok)
+    virtual bool SetOKLabel(const ButtonLabel& ok)

     {
         DoSetCustomLabel(m_ok, ok);
         return true;
     }
 
     {
         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);
     {
         DoSetCustomLabel(m_ok, ok);
         DoSetCustomLabel(m_cancel, cancel);


@@ -187,21 +265,22 @@ protected:
     wxString GetCancelLabel() const
         { return m_cancel.empty() ? GetDefaultCancelLabel() : m_cancel; }
 
     wxString GetCancelLabel() const
         { 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
     // 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)
     // 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"); }
+    virtual wxString GetDefaultYesLabel() const { return wxGetTranslation("Yes"); }
+    virtual wxString GetDefaultNoLabel() const { return wxGetTranslation("No"); }
+    virtual wxString GetDefaultOKLabel() const { return wxGetTranslation("OK"); }
+    virtual wxString GetDefaultCancelLabel() const { return wxGetTranslation("Cancel"); }

 
     // labels for the buttons, initially empty meaning that the defaults should
     // be used, use GetYes/No/OK/CancelLabel() to access them
 
     // labels for the buttons, initially empty meaning that the defaults should
     // be used, use GetYes/No/OK/CancelLabel() to access them


@@ -210,7 +289,7 @@ private:
              m_ok,
              m_cancel;
 
              m_ok,
              m_cancel;
 

-    DECLARE_NO_COPY_CLASS(wxMessageDialogWithCustomLabels)
+    wxDECLARE_NO_COPY_CLASS(wxMessageDialogWithCustomLabels);

 };
 
 #endif // ports needing wxMessageDialogWithCustomLabels
 };
 
 #endif // ports needing wxMessageDialogWithCustomLabels