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
  22 // ----------------------------------------------------------------------------
  23 // wxMessageOutput is a class abstracting formatted output target, i.e.
  24 // something you can printf() to
  25 // ----------------------------------------------------------------------------
  26
  27 class WXDLLIMPEXP_BASE wxMessageOutput
  28 {
  29 public:
  30     virtual ~wxMessageOutput() { }
  31
  32     // show a message to the user
  33     virtual void Printf(const wxChar* format, ...)  ATTRIBUTE_PRINTF_2 = 0;
  34
  35     // gets the current wxMessageOutput object (may be NULL during
  36     // initialization or shutdown)
  37     static wxMessageOutput* Get();
  38
  39     // sets the global wxMessageOutput instance; returns the previous one
  40     static wxMessageOutput* Set(wxMessageOutput* msgout);
  41
  42 private:
  43     static wxMessageOutput* ms_msgOut;
  44 };
  45
  46 // ----------------------------------------------------------------------------
  47 // implementation showing the message to the user in "best" possible way: uses
  48 // native message box if available (currently only under Windows) and stderr
  49 // otherwise; unlike wxMessageOutputMessageBox this class is always safe to use
  50 // ----------------------------------------------------------------------------
  51
  52 #if wxABI_VERSION > 20601
  53
  54 class WXDLLIMPEXP_BASE wxMessageOutputBest : public wxMessageOutput
  55 {
  56 public:
  57     wxMessageOutputBest() { }
  58
  59     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  60 };
  61
  62 #endif // wxABI_VERSION
  63
  64 // ----------------------------------------------------------------------------
  65 // implementation which sends output to stderr
  66 // ----------------------------------------------------------------------------
  67
  68 class WXDLLIMPEXP_BASE wxMessageOutputStderr : public wxMessageOutput
  69 {
  70 public:
  71     wxMessageOutputStderr() { }
  72
  73     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  74 };
  75
  76 // ----------------------------------------------------------------------------
  77 // implementation which shows output in a message box
  78 // ----------------------------------------------------------------------------
  79
  80 #if wxUSE_GUI
  81
  82 class WXDLLIMPEXP_CORE wxMessageOutputMessageBox : public wxMessageOutput
  83 {
  84 public:
  85     wxMessageOutputMessageBox() { }
  86
  87     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
  88 };
  89
  90 #endif // wxUSE_GUI
  91
  92 // ----------------------------------------------------------------------------
  93 // implementation using the native way of outputting debug messages
  94 // ----------------------------------------------------------------------------
  95
  96 class WXDLLIMPEXP_BASE wxMessageOutputDebug : public wxMessageOutput
  97 {
  98 public:
  99     wxMessageOutputDebug() { }
 100
 101     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
 102 };
 103
 104 // ----------------------------------------------------------------------------
 105 // implementation using wxLog (mainly for backwards compatibility)
 106 // ----------------------------------------------------------------------------
 107
 108 class WXDLLIMPEXP_BASE wxMessageOutputLog : public wxMessageOutput
 109 {
 110 public:
 111     wxMessageOutputLog() { }
 112
 113     virtual void Printf(const wxChar* format, ...) ATTRIBUTE_PRINTF_2;
 114 };
 115
 116 #endif
 117     // _WX_MSGOUT_H_