Fixed Get...String functions.

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

diff --git a/include/wx/log.h b/include/wx/log.h
index c4550d25fd2b8a6f6188d610b4fe3a28e285a738..feb245959af6ad7e356774d3deab963618a8d70d 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -9,15 +9,13 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-#ifndef   __LOGH__
-#define   __LOGH__
+#ifndef   _WX_LOG_H_
+#define   _WX_LOG_H_
 
 #ifdef    __GNUG__
 #pragma interface "log.h"
 #endif
 
-#include "wx/intl.h"
-
 // ----------------------------------------------------------------------------
 // constants
 // ----------------------------------------------------------------------------
@@ -51,6 +49,14 @@ enum
 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
@@ -122,6 +128,10 @@ protected:
     // you override DoLog() you might not need it at all
   virtual void DoLogString(const char *szString);
 
+  // helpers
+    // put the time stamp in the current format into the string
+  wxString TimeStamp() const;
+
 private:
   // static variables
   // ----------------
@@ -139,7 +149,7 @@ class WXDLLEXPORT wxLogStderr : public wxLog
 {
 public:
   // redirect log output to a FILE
-  wxLogStderr(FILE *fp = NULL);
+  wxLogStderr(FILE *fp = (FILE *) NULL);
 
 private:
   // implement sink function
@@ -149,11 +159,12 @@ private:
 };
 
 // log everything to an "ostream", cerr by default
+class 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
@@ -164,7 +175,6 @@ protected:
 };
 
 // log everything to a text window (GUI only of course)
-class wxTextCtrl;
 class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
 {
 public:
@@ -198,12 +208,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.
 // ----------------------------------------------------------------------------
-class wxLogFrame;
-class wxFrame;
 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();
@@ -211,7 +220,7 @@ public:
   // window operations
     // show/hide the log window
   void Show(bool bShow = TRUE);
-    // get the frame pointer (you shouldn't close it!)
+    // retrieve the pointer to the frame
   wxFrame *GetFrame() const;
 
   // accessors
@@ -225,6 +234,17 @@ public:
   // processing take place)
   void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 
+  // base class virtuals
+    // we don't need it ourselves, but we pass it to the previous logger
+  virtual void Flush();
+
+  // overridables
+    // called immediately after the log frame creation allowing for
+    // any extra initializations
+  virtual void OnFrameCreate(wxFrame *frame);
+    // called right before the log frame is going to be deleted
+  virtual void OnFrameDelete(wxFrame *frame);
+
 protected:
   virtual void DoLog(wxLogLevel level, const char *szString);
   virtual void DoLogString(const char *szString);
@@ -256,7 +276,7 @@ class WXDLLEXPORT wxLogNull
 {
 public:
   // ctor saves old log target, dtor restores it
-  wxLogNull() { m_pPrevLogger = wxLog::SetActiveTarget(NULL); }
+  wxLogNull() { m_pPrevLogger = wxLog::SetActiveTarget((wxLog *) NULL); }
  ~wxLogNull() { (void)wxLog::SetActiveTarget(m_pPrevLogger);  }
 
 private:
@@ -289,9 +309,16 @@ DECLARE_LOG_FUNCTION(Error);
 DECLARE_LOG_FUNCTION(Warning);
 DECLARE_LOG_FUNCTION(Message);
 DECLARE_LOG_FUNCTION(Info);
-DECLARE_LOG_FUNCTION(Status);
 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);
@@ -350,4 +377,4 @@ const char* WXDLLEXPORT wxSysErrorMsg(unsigned long nErrCode = 0);
   inline void wxLogLastError(const char *) { }
 #endif  //debug/!debug
 
-#endif  //__LOGH__
+#endif  // _WX_LOG_H_