Added variant.h/cpp; changed variable names in object.h; added some

[wxWidgets.git] / include / wx / log.h

diff --git a/include/wx/log.h b/include/wx/log.h
index 22acfb9e512d0f95cea6474fcf38670f923b72f8..00b4cdd1d1ed65dc1dc70ee12b7a785dedfdb928 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -9,8 +9,8 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 

-#ifndef   __LOGH__
-#define   __LOGH__
+#ifndef   _WX_LOG_H_
+#define   _WX_LOG_H_

 
 #ifdef    __GNUG__
 #pragma interface "log.h"
 
 #ifdef    __GNUG__
 #pragma interface "log.h"


@@ -49,6 +49,14 @@ enum
 typedef unsigned long wxTraceMask;
 typedef unsigned long wxLogLevel;
 
 typedef unsigned long wxTraceMask;
 typedef unsigned long wxLogLevel;
 

+// ----------------------------------------------------------------------------
+// forward declarations
+// ----------------------------------------------------------------------------
+class wxTextCtrl;
+class wxLogFrame;
+class wxFrame;
+class ostream;
+

 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages
 // normally, only a single instance of this class exists but it's not enforced
 // ----------------------------------------------------------------------------
 // derive from this class to redirect (or suppress, or ...) log messages
 // normally, only a single instance of this class exists but it's not enforced


@@ -75,11 +83,12 @@ public:
 
   // only one sink is active at each moment
     // get current log target, will call wxApp::CreateLogTarget() to create one
 
   // only one sink is active at each moment
     // get current log target, will call wxApp::CreateLogTarget() to create one

-    // if 
+    // if none exists

   static wxLog *GetActiveTarget();
   static wxLog *GetActiveTarget();

-    // change log target, pLogger = NULL disables logging,
+    // change log target, pLogger = NULL disables logging. if bNoFlashOld is true,
+    // the old log target isn't flashed which might lead to loss of messages!

     // returns the previous log target
     // returns the previous log target

-  static wxLog *SetActiveTarget(wxLog *pLogger);
+  static wxLog *SetActiveTarget(wxLog *pLogger, bool bNoFlashOld = FALSE);

 
   // functions controlling the default wxLog behaviour
     // verbose mode is activated by standard command-line '-verbose' option
 
   // functions controlling the default wxLog behaviour
     // verbose mode is activated by standard command-line '-verbose' option


@@ -141,7 +150,7 @@ class WXDLLEXPORT wxLogStderr : public wxLog
 {
 public:
   // redirect log output to a FILE
 {
 public:
   // redirect log output to a FILE

-  wxLogStderr(FILE *fp = NULL);
+  wxLogStderr(FILE *fp = (FILE *) NULL);

 
 private:
   // implement sink function
 
 private:
   // implement sink function


@@ -151,11 +160,12 @@ private:
 };
 
 // log everything to an "ostream", cerr by default
 };
 
 // log everything to an "ostream", cerr by default

+class ostream;

 class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:
   // redirect log output to an ostream
 class WXDLLEXPORT wxLogStream : public wxLog
 {
 public:
   // redirect log output to an ostream

-  wxLogStream(ostream *ostr = NULL);
+  wxLogStream(ostream *ostr = (ostream *) NULL);

 
 protected:
   // implement sink function
 
 protected:
   // implement sink function


@@ -166,7 +176,6 @@ protected:
 };
 
 // log everything to a text window (GUI only of course)
 };
 
 // log everything to a text window (GUI only of course)

-class wxTextCtrl;

 class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
 {
 public:
 class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
 {
 public:


@@ -200,12 +209,11 @@ protected:
 // to the log window. This window has it's own menu which allows the user to
 // close it, clear the log contents or save it to the file.
 // ----------------------------------------------------------------------------
 // to the log window. This window has it's own menu which allows the user to
 // close it, clear the log contents or save it to the file.
 // ----------------------------------------------------------------------------

-class wxLogFrame;
-class wxFrame;

 class WXDLLEXPORT wxLogWindow : public wxLog
 {
 public:
 class WXDLLEXPORT wxLogWindow : public wxLog
 {
 public:

-  wxLogWindow(const char *szTitle,      // the title of the frame
+  wxLogWindow(wxFrame *pParent,         // the parent frame (can be NULL)
+              const char *szTitle,      // the title of the frame

               bool bShow = TRUE,        // show window immediately?
               bool bPassToOld = TRUE);  // pass log messages to the old target?
   ~wxLogWindow();
               bool bShow = TRUE,        // show window immediately?
               bool bPassToOld = TRUE);  // pass log messages to the old target?
   ~wxLogWindow();


@@ -269,7 +277,7 @@ class WXDLLEXPORT wxLogNull
 {
 public:
   // ctor saves old log target, dtor restores it
 {
 public:
   // ctor saves old log target, dtor restores it

-  wxLogNull() { m_pPrevLogger = wxLog::SetActiveTarget(NULL); }
+  wxLogNull() { m_pPrevLogger = wxLog::SetActiveTarget((wxLog *)NULL, TRUE); }

  ~wxLogNull() { (void)wxLog::SetActiveTarget(m_pPrevLogger);  }
 
 private:
  ~wxLogNull() { (void)wxLog::SetActiveTarget(m_pPrevLogger);  }
 
 private:


@@ -302,9 +310,16 @@ DECLARE_LOG_FUNCTION(Error);
 DECLARE_LOG_FUNCTION(Warning);
 DECLARE_LOG_FUNCTION(Message);
 DECLARE_LOG_FUNCTION(Info);
 DECLARE_LOG_FUNCTION(Warning);
 DECLARE_LOG_FUNCTION(Message);
 DECLARE_LOG_FUNCTION(Info);

-DECLARE_LOG_FUNCTION(Status);

 DECLARE_LOG_FUNCTION(Verbose);
 
 DECLARE_LOG_FUNCTION(Verbose);
 

+// this function sends the log message to the status line of the top level
+// application frame, if any
+DECLARE_LOG_FUNCTION(Status);
+
+// this one is the same as previous except that it allows to explicitly 
+// specify the frame to which the output should go
+DECLARE_LOG_FUNCTION2(Status, wxFrame *pFrame);
+

 // additional one: as wxLogError, but also logs last system call error code
 // and the corresponding error message if available
 DECLARE_LOG_FUNCTION(SysError);
 // additional one: as wxLogError, but also logs last system call error code
 // and the corresponding error message if available
 DECLARE_LOG_FUNCTION(SysError);


@@ -363,4 +378,4 @@ const char* WXDLLEXPORT wxSysErrorMsg(unsigned long nErrCode = 0);
   inline void wxLogLastError(const char *) { }
 #endif  //debug/!debug
 
   inline void wxLogLastError(const char *) { }
 #endif  //debug/!debug
 

-#endif  //__LOGH__
+#endif  // _WX_LOG_H_