make wxMouseState accessors const; document this class

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

diff --git a/include/wx/msgdlg.h b/include/wx/msgdlg.h
index 397642e1897b47b6c497605a503025c50f296b3c..b2701d28f76e0f0ae5152c40b103b42af6e2e9a4 100644 (file)
--- a/include/wx/msgdlg.h
+++ b/include/wx/msgdlg.h
@@ -1,23 +1,81 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        wx/msgdlgg.h
 // Purpose:     common header and base class for wxMessageDialog
-// Author:      wxWidgets Team
+// Author:      Julian Smart
 // Modified by:
 // Created:
 // RCS-ID:      $Id$
-// Copyright:   (c) wxWidgets
+// Copyright:   (c) Julian Smart
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef _WX_MSGDLG_H_BASE_
 #define _WX_MSGDLG_H_BASE_
 
-#include "wx/setup.h"
+#include "wx/defs.h"
 
 #if wxUSE_MSGDLG
 
-class WXDLLEXPORT wxMessageDialogBase
+#include "wx/dialog.h"
+
+WXDLLIMPEXP_DATA_CORE(extern const char) wxMessageBoxCaptionStr[];
+
+class WXDLLIMPEXP_CORE wxMessageDialogBase : public wxDialog
 {
+public:
+    // ctors
+    wxMessageDialogBase() { m_dialogStyle = 0; }
+    wxMessageDialogBase(wxWindow *parent,
+                        const wxString& message,
+                        const wxString& caption,
+                        long style)
+        : m_message(message),
+          m_caption(caption)
+    {
+        m_parent = parent;
+        SetMessageDialogStyle(style);
+    }
+
+    // virtual dtor for the base class
+    virtual ~wxMessageDialogBase() { }
+
+
+    // 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))
+    {
+        return false;
+    }
+
+    virtual bool SetYesNoCancelLabels(const wxString& WXUNUSED(yes),
+                                      const wxString& WXUNUSED(no),
+                                      const wxString& WXUNUSED(cancel))
+    {
+        return false;
+    }
+
+    virtual bool SetOKLabel(const wxString& WXUNUSED(ok))
+    {
+        return false;
+    }
+
+    virtual bool SetOKCancelLabels(const wxString& WXUNUSED(ok),
+                                   const wxString& WXUNUSED(cancel))
+    {
+        return false;
+    }
+
+    virtual void SetMessage(const wxString& message)
+    {
+        m_message = message;
+    }
+
+    virtual void SetExtendedMessage(const wxString& extendedMessage)
+    {
+        m_extendedMessage = extendedMessage;
+    }
+
 protected:
     // common validation of wxMessageDialog style
     void SetMessageDialogStyle(long style)
@@ -30,40 +88,54 @@ protected:
 
         m_dialogStyle = style;
     }
-    inline long GetMessageDialogStyle() const
+
+    long GetMessageDialogStyle() const { return m_dialogStyle; }
+
+
+    // for the platforms not supporting separate main and extended messages
+    // this function should be used to combine both of them in a single string
+    wxString GetFullMessage() const
     {
-        return m_dialogStyle;
+        wxString msg = m_message;
+        if ( !m_extendedMessage.empty() )
+            msg << "\n\n" << m_extendedMessage;
+
+        return msg;
     }
 
-private:
+    wxString m_message,
+             m_extendedMessage,
+             m_caption;
     long m_dialogStyle;
 };
 
-#if defined(__WXUNIVERSAL__) || defined(__WXGPE__)
-#include "wx/generic/msgdlgg.h"
+#if defined(__WX_COMPILING_MSGDLGG_CPP__) || \
+    defined(__WXUNIVERSAL__) || defined(__WXGPE__) || \
+    (defined(__WXGTK__) && !defined(__WXGTK20__))
+    #include "wx/generic/msgdlgg.h"
+
+    #define wxMessageDialog wxGenericMessageDialog
+#elif defined(__WXCOCOA__)
+       #include "wx/cocoa/msgdlg.h"
 #elif defined(__WXPALMOS__)
-#include "wx/palmos/msgdlg.h"
+    #include "wx/palmos/msgdlg.h"
 #elif defined(__WXMSW__)
-#include "wx/msw/msgdlg.h"
+    #include "wx/msw/msgdlg.h"
 #elif defined(__WXMOTIF__)
-#include "wx/motif/msgdlg.h"
-#elif defined(__WXGTK__) && defined(__WXGTK20__)
-#include "wx/gtk/msgdlg.h"
-#elif defined(__WXGTK__)
-#include "wx/generic/msgdlgg.h"
+    #include "wx/motif/msgdlg.h"
+#elif defined(__WXGTK20__)
+    #include "wx/gtk/msgdlg.h"
 #elif defined(__WXMAC__)
-#include "wx/mac/msgdlg.h"
-#elif defined(__WXCOCOA__)
-#include "wx/generic/msgdlgg.h"
+    #include "wx/mac/msgdlg.h"
 #elif defined(__WXPM__)
-#include "wx/os2/msgdlg.h"
+    #include "wx/os2/msgdlg.h"
 #endif
 
 // ----------------------------------------------------------------------------
 // wxMessageBox: the simplest way to use wxMessageDialog
 // ----------------------------------------------------------------------------
 
-int WXDLLEXPORT wxMessageBox(const wxString& message,
+int WXDLLIMPEXP_CORE wxMessageBox(const wxString& message,
                              const wxString& caption = wxMessageBoxCaptionStr,
                              long style = wxOK | wxCENTRE,
                              wxWindow *parent = NULL,
@@ -71,5 +143,4 @@ int WXDLLEXPORT wxMessageBox(const wxString& message,
 
 #endif // wxUSE_MSGDLG
 
-#endif
-    // _WX_MSGDLG_H_BASE_
+#endif // _WX_MSGDLG_H_BASE_