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/wxchar.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     virtual void DoPrintf(const wxChar* format, ...)  ATTRIBUTE_PRINTF_2 = 0;
  44 };
  45
  46 #ifdef __VISUALC__
  47     // "non dll-interface class 'wxStringPrintfMixin' used as base interface
  48     // for dll-interface class 'wxString'" -- this is OK in our case
  49     #pragma warning (disable:4275)
  50 #endif
  51
  52 class WXDLLIMPEXP_BASE wxMessageOutput : public wxMessageOutputBase
  53 {
  54 public:
  55     virtual ~wxMessageOutput() { }
  56
  57     // gets the current wxMessageOutput object (may be NULL during
  58     // initialization or shutdown)
  59     static wxMessageOutput* Get();
  60
  61     // sets the global wxMessageOutput instance; returns the previous one
  62     static wxMessageOutput* Set(wxMessageOutput* msgout);
  63
  64 private:
  65     static wxMessageOutput* ms_msgOut;
  66 };
  67
  68 #ifdef __VISUALC__
  69     #pragma warning (default:4275)
  70 #endif
  71
  72 // ----------------------------------------------------------------------------
  73 // implementation showing the message to the user in "best" possible way: uses
  74 // native message box if available (currently only under Windows) and stderr
  75 // otherwise; unlike wxMessageOutputMessageBox this class is always safe to use
  76 // ----------------------------------------------------------------------------
  77
  78 class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutput
  79 {
  80 public:
  81     wxMessageOutputBest() { }
  82
  83 protected:
  84     virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  85 };
  86
  87 // ----------------------------------------------------------------------------
  88 // implementation which sends output to stderr
  89 // ----------------------------------------------------------------------------
  90
  91 class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
  92 {
  93 public:
  94     wxMessageOutputStderr() { }
  95
  96 protected:
  97     virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  98 };
  99
 100 // ----------------------------------------------------------------------------
 101 // implementation which shows output in a message box
 102 // ----------------------------------------------------------------------------
 103
 104 #if wxUSE_GUI
 105
 106 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
 107 {
 108 public:
 109     wxMessageOutputMessageBox() { }
 110
 111 protected:
 112     virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
 113 };
 114
 115 #endif // wxUSE_GUI
 116
 117 // ----------------------------------------------------------------------------
 118 // implementation using the native way of outputting debug messages
 119 // ----------------------------------------------------------------------------
 120
 121 class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutput
 122 {
 123 public:
 124     wxMessageOutputDebug() { }
 125
 126 protected:
 127     virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
 128 };
 129
 130 // ----------------------------------------------------------------------------
 131 // implementation using wxLog (mainly for backwards compatibility)
 132 // ----------------------------------------------------------------------------
 133
 134 class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 135 {
 136 public:
 137     wxMessageOutputLog() { }
 138
 139 protected:
 140     virtual void DoPrintf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
 141 };
 142
 143 #endif
 144     // _WX_MSGOUT_H_