corrected comment

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

diff --git a/include/wx/log.h b/include/wx/log.h
index 94d0beb5b6aef4d2216cd34f054900efdbe3e571..6c2e4cdd51d0ffd160286d9f47f13ade2b53680a 100644 (file)
--- a/include/wx/log.h
+++ b/include/wx/log.h
@@ -135,9 +135,12 @@ public:
         // flush the active target if any
     static void FlushActive()
     {
-        wxLog *log = GetActiveTarget();
-        if ( log )
-            log->Flush();
+        if ( !ms_suspendCount )
+        {
+            wxLog *log = GetActiveTarget();
+            if ( log && log->HasPendingMessages() )
+                log->Flush();
+        }
     }
         // get current log target, will call wxApp::CreateLogTarget() to
         // create one if none exists
@@ -145,6 +148,13 @@ public:
         // change log target, pLogger may be NULL
     static wxLog *SetActiveTarget(wxLog *pLogger);
 
+        // suspend the message flushing of the main target until the next call
+        // to Resume() - this is mainly for internal use (to prevent wxYield()
+        // from flashing the messages)
+    static void Suspend() { ms_suspendCount++; }
+        // must be called for each Suspend()!
+    static void Resume() { ms_suspendCount--; }
+
     // functions controlling the default wxLog behaviour
         // verbose mode is activated by standard command-line '-verbose'
         // option
@@ -205,6 +215,8 @@ private:
     static bool        ms_doLog;        // FALSE => all logging disabled
     static bool        ms_bAutoCreate;  // create new log targets on demand?
 
+    static size_t      ms_suspendCount; // if positive, logs are not flushed
+
     // format string for strftime(), if NULL, time stamping log messages is
     // disabled
     static const wxChar *ms_timestamp;
@@ -309,15 +321,15 @@ public:
     ~wxLogWindow();
 
     // window operations
-    // show/hide the log window
+        // show/hide the log window
     void Show(bool bShow = TRUE);
-    // retrieve the pointer to the frame
+        // retrieve the pointer to the frame
     wxFrame *GetFrame() const;
 
     // accessors
-    // the previous log target (may be NULL)
+        // the previous log target (may be NULL)
     wxLog *GetOldLog() const { return m_pOldLog; }
-    // are we passing the messages to the previous log target?
+        // are we passing the messages to the previous log target?
     bool IsPassingMessages() const { return m_bPassMessages; }
 
     // we can pass the messages to the previous log target (we're in this mode by
@@ -326,14 +338,20 @@ public:
     void PassMessages(bool bDoPass) { m_bPassMessages = bDoPass; }
 
     // base class virtuals
-    // we don't need it ourselves, but we pass it to the previous logger
+        // 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
+        // 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
+        // called if the user closes the window interactively, will not be
+        // called if it is destroyed for another reason (such as when program
+        // exits) - return TRUE from here to allow the frame to close, FALSE
+        // to prevent this from happening
+    virtual bool OnFrameClose(wxFrame *frame);
+        // called right before the log frame is going to be deleted: will
+        // always be called unlike OnFrameClose()
     virtual void OnFrameDelete(wxFrame *frame);
 
 protected:
@@ -453,7 +471,7 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 
     // this second version will only log the message if the mask had been
     // added to the list of masks with AddTraceMask()
-    DECLARE_LOG_FUNCTION2(Trace, const char *mask);
+    DECLARE_LOG_FUNCTION2(Trace, const wxChar *mask);
 
     // the last one does nothing if all of level bits are not set
     // in wxLog::GetActive()->GetTraceMask() - it's deprecated in favour of
@@ -482,13 +500,13 @@ DECLARE_LOG_FUNCTION2(SysError, long lErrCode);
 #ifdef __VISUALC__
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("%s(%d): '%s' failed with error 0x%08lx (%s)."),       \
-                   __TFILE__, __LINE__, _T(api),                              \
+                   __TFILE__, __LINE__, api,                              \
                    rc, wxSysErrorMsg(rc))
 #else // !VC++
     #define wxLogApiError(api, rc)                                            \
         wxLogDebug(wxT("In file %s at line %d: '%s' failed with "             \
                       "error 0x%08lx (%s)."),                                 \
-                   __TFILE__, __LINE__, _T(api),                              \
+                   __TFILE__, __LINE__, api,                              \
                    rc, wxSysErrorMsg(rc))
 #endif // VC++/!VC++