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 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) && !defined(__EMX__)
  20 // Some older compilers (such as EMX) cannot handle
  21 // #pragma interface/implementation correctly, iff
  22 // #pragma implementation is used in _two_ translation
  23 // units (as created by e.g. event.cpp compiled for
  24 // libwx_base and event.cpp compiled for libwx_gui_core).
  25 // So we must not use those pragmas for those compilers in
  26 // such files.
  27     #pragma interface "msgout.h"
  28 #endif
  29
  30 #include "wx/defs.h"
  31 #include "wx/wxchar.h"
  32
  33 // ----------------------------------------------------------------------------
  34 // wxMessageOutput is a class abstracting formatted output target, i.e.
  35 // something you can printf() to
  36 // ----------------------------------------------------------------------------
  37
  38 class WXDLLIMPEXP_BASE wxMessageOutput
  39 {
  40 public:
  41     virtual ~wxMessageOutput() { }
  42
  43     // show a message to the user
  44     virtual void Printf(const wxChar* format, ...)  ATTRIBUTE_PRINTF_2 = 0;
  45
  46     // gets the current wxMessageOutput object (may be NULL during
  47     // initialization or shutdown)
  48     static wxMessageOutput* Get();
  49
  50     // sets the global wxMessageOutput instance; returns the previous one
  51     static wxMessageOutput* Set(wxMessageOutput* msgout);
  52
  53 private:
  54     static wxMessageOutput* ms_msgOut;
  55 };
  56
  57 // ----------------------------------------------------------------------------
  58 // implementation showing the message to the user in "best" possible way: uses
  59 // native message box if available (currently only under Windows) and stderr
  60 // otherwise; unlike wxMessageOutputMessageBox this class is always safe to use
  61 // ----------------------------------------------------------------------------
  62
  63 #if wxABI_VERSION > 20601
  64
  65 class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutput
  66 {
  67 public:
  68     wxMessageOutputBest() { }
  69
  70     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  71 };
  72
  73 #endif // wxABI_VERSION
  74
  75 // ----------------------------------------------------------------------------
  76 // implementation which sends output to stderr
  77 // ----------------------------------------------------------------------------
  78
  79 class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
  80 {
  81 public:
  82     wxMessageOutputStderr() { }
  83
  84     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  85 };
  86
  87 // ----------------------------------------------------------------------------
  88 // implementation which shows output in a message box
  89 // ----------------------------------------------------------------------------
  90
  91 #if wxUSE_GUI
  92
  93 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
  94 {
  95 public:
  96     wxMessageOutputMessageBox() { }
  97
  98     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  99 };
 100
 101 #endif // wxUSE_GUI
 102
 103 // ----------------------------------------------------------------------------
 104 // implementation using the native way of outputting debug messages
 105 // ----------------------------------------------------------------------------
 106
 107 class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutput
 108 {
 109 public:
 110     wxMessageOutputDebug() { }
 111
 112     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
 113 };
 114
 115 // ----------------------------------------------------------------------------
 116 // implementation using wxLog (mainly for backwards compatibility)
 117 // ----------------------------------------------------------------------------
 118
 119 class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 120 {
 121 public:
 122     wxMessageOutputLog() { }
 123
 124     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
 125 };
 126
 127 #endif
 128     // _WX_MSGOUT_H_