include/wx/msgout.h

   1 ///////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/msgout.h
   3 // Purpose:     wxMessageOutput class. Shows a message to the user
   4 // Author:      Mattia Barbon
   5 // Modified by:
   6 // Created:     17.07.02
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Mattia Barbon
   9 // Licence:     wxWindows licence
  10 ///////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef _WX_MSGOUT_H_
  13 #define _WX_MSGOUT_H_
  14
  15 // ----------------------------------------------------------------------------
  16 // headers
  17 // ----------------------------------------------------------------------------
  18
  19 #include "wx/defs.h"
  20 #include "wx/chartype.h"
  21 #include "wx/strvararg.h"
  22
  23 // ----------------------------------------------------------------------------
  24 // wxMessageOutput is a class abstracting formatted output target, i.e.
  25 // something you can printf() to
  26 // ----------------------------------------------------------------------------
  27
  28 // NB: VC6 has a bug that causes linker errors if you have template methods
  29 //     in a class using __declspec(dllimport). The solution is to split such
  30 //     class into two classes, one that contains the template methods and does
  31 //     *not* use WXDLLIMPEXP_BASE and another class that contains the rest
  32 //     (with DLL linkage).
  33 class wxMessageOutputBase
  34 {
  35 public:
  36     virtual ~wxMessageOutputBase() { }
  37
  38     // show a message to the user
  39     // void Printf(const wxChar* format, ...)  ATTRIBUTE_PRINTF_2 = 0;
  40     WX_DEFINE_VARARG_FUNC_VOID(Printf, DoPrintf)
  41
  42 protected:
  43     // NB: this is pure virtual so that it can be implemented in dllexported
  44     //     wxMessagOutput class
  45     virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2 = 0;
  46
  47     // called by DoPrintf() to output formatted string
  48     virtual void Output(const wxString& str) = 0;
  49 };
  50
  51 #ifdef __VISUALC__
  52     // "non dll-interface class 'wxStringPrintfMixin' used as base interface
  53     // for dll-interface class 'wxString'" -- this is OK in our case
  54     #pragma warning (disable:4275)
  55 #endif
  56
  57 class WXDLLIMPEXP_BASE wxMessageOutput : public wxMessageOutputBase
  58 {
  59 public:
  60     virtual ~wxMessageOutput() { }
  61
  62     // gets the current wxMessageOutput object (may be NULL during
  63     // initialization or shutdown)
  64     static wxMessageOutput* Get();
  65
  66     // sets the global wxMessageOutput instance; returns the previous one
  67     static wxMessageOutput* Set(wxMessageOutput* msgout);
  68
  69 protected:
  70     virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  71     virtual void Output(const wxString& str) = 0;
  72
  73 private:
  74     static wxMessageOutput* ms_msgOut;
  75 };
  76
  77 #ifdef __VISUALC__
  78     #pragma warning (default:4275)
  79 #endif
  80
  81 // ----------------------------------------------------------------------------
  82 // implementation showing the message to the user in "best" possible way: uses
  83 // native message box if available (currently only under Windows) and stderr
  84 // otherwise; unlike wxMessageOutputMessageBox this class is always safe to use
  85 // ----------------------------------------------------------------------------
  86
  87 class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutput
  88 {
  89 public:
  90     wxMessageOutputBest() { }
  91
  92 protected:
  93     virtual void Output(const wxString& str);
  94 };
  95
  96 // ----------------------------------------------------------------------------
  97 // implementation which sends output to stderr
  98 // ----------------------------------------------------------------------------
  99
 100 class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
 101 {
 102 public:
 103     wxMessageOutputStderr() { }
 104
 105 protected:
 106     virtual void Output(const wxString& str);
 107 };
 108
 109 // ----------------------------------------------------------------------------
 110 // implementation which shows output in a message box
 111 // ----------------------------------------------------------------------------
 112
 113 #if wxUSE_GUI
 114
 115 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
 116 {
 117 public:
 118     wxMessageOutputMessageBox() { }
 119
 120 protected:
 121     virtual void Output(const wxString& str);
 122 };
 123
 124 #endif // wxUSE_GUI
 125
 126 // ----------------------------------------------------------------------------
 127 // implementation using the native way of outputting debug messages
 128 // ----------------------------------------------------------------------------
 129
 130 class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutput
 131 {
 132 public:
 133     wxMessageOutputDebug() { }
 134
 135 protected:
 136     virtual void Output(const wxString& str);
 137 };
 138
 139 // ----------------------------------------------------------------------------
 140 // implementation using wxLog (mainly for backwards compatibility)
 141 // ----------------------------------------------------------------------------
 142
 143 class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 144 {
 145 public:
 146     wxMessageOutputLog() { }
 147
 148 protected:
 149     virtual void Output(const wxString& str);
 150 };
 151
 152 #endif
 153     // _WX_MSGOUT_H_