// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
-#ifndef __LOGH__
-#define __LOGH__
+#ifndef _WX_LOG_H_
+#define _WX_LOG_H_
#ifdef __GNUG__
#pragma interface "log.h"
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
// (FILE and iostream logs don't need it, but wxGuiLog does to avoid
// showing 17 modal dialogs one after another)
virtual void Flush();
- // call to Flush() may be optimized: call it only if this function
+ // call to Flush() may be optimized: call it only if this function
// returns true (although Flush() also returns immediately if there
// is no messages, this functions is more efficient because inline)
bool HasPendingMessages() const { return m_bHasMessages; }
// 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();
- // 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
- 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
// default DoLogString does nothing but is not pure virtual because if
// 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
// ----------------
{
public:
// redirect log output to a FILE
- wxLogStderr(FILE *fp = NULL);
+ wxLogStderr(FILE *fp = (FILE *) NULL);
private:
// implement sink function
};
// 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
};
// log everything to a text window (GUI only of course)
-class wxTextCtrl;
class WXDLLEXPORT wxLogTextCtrl : public wxLogStream
{
public:
// 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 WXDLLEXPORT wxLogWindow : public wxLog
{
public:
- wxLogWindow(const char *szTitle, bool bShow = TRUE);
+ 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();
-
- // show/hide the log window
+
+ // window operations
+ // show/hide the log window
void Show(bool bShow = TRUE);
+ // retrieve the pointer to the frame
+ wxFrame *GetFrame() const;
// accessors
+ // the previous log target (may be NULL)
wxLog *GetOldLog() const { return m_pOldLog; }
+ // 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
+ // default: we collect all messages in the window, but also let the default
+ // 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);
-
+
private:
- wxLog *m_pOldLog; // previous log target
- wxLogFrame *m_pLogFrame; // the log frame
+ bool m_bPassMessages; // pass messages to m_pOldLog?
+ wxLog *m_pOldLog; // previous log target
+ wxLogFrame *m_pLogFrame; // the log frame
};
// ----------------------------------------------------------------------------
{
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:
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);
inline void wxLogLastError(const char *) { }
#endif //debug/!debug
-#endif //__LOGH__
+#endif // _WX_LOG_H_
projects / wxWidgets.git / blobdiff