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
  21 WXDLLEXPORT_DATA(extern const wxChar) wxMessageBoxCaptionStr[];
  22
  23 class WXDLLEXPORT wxMessageDialogBase : public wxDialog
  24 {
  25 public:
  26     // ctors
  27     wxMessageDialogBase() { m_dialogStyle = 0; }
  28     wxMessageDialogBase(wxWindow *parent,
  29                         const wxString& message,
  30                         const wxString& caption,
  31                         long style)
  32         : m_message(message),
  33           m_caption(caption)
  34     {
  35         m_parent = parent;
  36         SetMessageDialogStyle(style);
  37     }
  38
  39     // virtual dtor for the base class
  40     virtual ~wxMessageDialogBase() { }
  41
  42
  43     // methods for setting up more custom message dialogs -- all functions
  44     // return false if they're not implemented
  45     virtual bool SetYesNoLabels(const wxString& WXUNUSED(yes),
  46                                 const wxString& WXUNUSED(no))
  47     {
  48         return false;
  49     }
  50
  51     virtual bool SetYesNoCancelLabels(const wxString& WXUNUSED(yes),
  52                                       const wxString& WXUNUSED(no),
  53                                       const wxString& WXUNUSED(cancel))
  54     {
  55         return false;
  56     }
  57
  58     virtual bool SetOKLabel(const wxString& WXUNUSED(ok))
  59     {
  60         return false;
  61     }
  62
  63     virtual bool SetOKCancelLabels(const wxString& WXUNUSED(ok),
  64                                    const wxString& WXUNUSED(cancel))
  65     {
  66         return false;
  67     }
  68
  69     virtual void SetMessage(const wxString& message)
  70     {
  71         m_message = message;
  72     }
  73
  74     virtual void SetExtendedMessage(const wxString& extendedMessage)
  75     {
  76         m_extendedMessage = extendedMessage;
  77     }
  78
  79 protected:
  80     // common validation of wxMessageDialog style
  81     void SetMessageDialogStyle(long style)
  82     {
  83         wxASSERT_MSG( ((style & wxYES_NO) == wxYES_NO) || ((style & wxYES_NO) == 0),
  84                       _T("wxYES and wxNO may only be used together in wxMessageDialog") );
  85
  86         wxASSERT_MSG( (style & wxID_OK) != wxID_OK,
  87                       _T("wxMessageBox: Did you mean wxOK (and not wxID_OK)?") );
  88
  89         m_dialogStyle = style;
  90     }
  91
  92     long GetMessageDialogStyle() const { return m_dialogStyle; }
  93
  94
  95     // for the platforms not supporting separate main and extended messages
  96     // this function should be used to combine both of them in a single string
  97     wxString GetFullMessage() const
  98     {
  99         wxString msg = m_message;
 100         if ( !m_extendedMessage.empty() )
 101             msg << "\n\n" << m_extendedMessage;
 102
 103         return msg;
 104     }
 105
 106     wxString m_message,
 107              m_extendedMessage,
 108              m_caption;
 109     long m_dialogStyle;
 110 };
 111
 112 #if defined(__WX_COMPILING_MSGDLGG_CPP__) || \
 113     defined(__WXUNIVERSAL__) || defined(__WXGPE__) || \
 114     defined(__WXCOCOA__) || \
 115     (defined(__WXGTK__) && !defined(__WXGTK20__))
 116     #include "wx/generic/msgdlgg.h"
 117
 118     #define wxMessageDialog wxGenericMessageDialog
 119 #elif defined(__WXPALMOS__)
 120     #include "wx/palmos/msgdlg.h"
 121 #elif defined(__WXMSW__)
 122     #include "wx/msw/msgdlg.h"
 123 #elif defined(__WXMOTIF__)
 124     #include "wx/motif/msgdlg.h"
 125 #elif defined(__WXGTK20__)
 126     #include "wx/gtk/msgdlg.h"
 127 #elif defined(__WXMAC__)
 128     #include "wx/mac/msgdlg.h"
 129 #elif defined(__WXPM__)
 130     #include "wx/os2/msgdlg.h"
 131 #endif
 132
 133 // ----------------------------------------------------------------------------
 134 // wxMessageBox: the simplest way to use wxMessageDialog
 135 // ----------------------------------------------------------------------------
 136
 137 int WXDLLEXPORT wxMessageBox(const wxString& message,
 138                              const wxString& caption = wxMessageBoxCaptionStr,
 139                              long style = wxOK | wxCENTRE,
 140                              wxWindow *parent = NULL,
 141                              int x = wxDefaultCoord, int y = wxDefaultCoord);
 142
 143 #endif // wxUSE_MSGDLG
 144
 145 #endif // _WX_MSGDLG_H_BASE_