]>
Commit | Line | Data |
---|---|---|
7e8c564c VS |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: wx/generic/logg.h | |
3 | // Purpose: Assorted wxLogXXX functions, and wxLog (sink for logs) | |
4 | // Author: Vadim Zeitlin | |
5 | // Modified by: | |
6 | // Created: 29/01/98 | |
7 | // RCS-ID: $Id$ | |
8 | // Copyright: (c) 1998 Vadim Zeitlin <zeitlin@dptmaths.ens-cachan.fr> | |
65571936 | 9 | // Licence: wxWindows licence |
7e8c564c VS |
10 | ///////////////////////////////////////////////////////////////////////////// |
11 | ||
12 | #ifndef _WX_LOGG_H_ | |
13 | #define _WX_LOGG_H_ | |
14 | ||
7e8c564c VS |
15 | #if wxUSE_GUI |
16 | ||
17 | // ---------------------------------------------------------------------------- | |
18 | // the following log targets are only compiled in if the we're compiling the | |
19 | // GUI part (andnot just the base one) of the library, they're implemented in | |
20 | // src/generic/logg.cpp *and not src/common/log.cpp unlike all the rest) | |
21 | // ---------------------------------------------------------------------------- | |
22 | ||
23 | #if wxUSE_TEXTCTRL | |
24 | ||
25 | // log everything to a text window (GUI only of course) | |
53a2db12 | 26 | class WXDLLIMPEXP_CORE wxLogTextCtrl : public wxLog |
7e8c564c VS |
27 | { |
28 | public: | |
29 | wxLogTextCtrl(wxTextCtrl *pTextCtrl); | |
30 | ||
6f02a879 | 31 | protected: |
7e8c564c | 32 | // implement sink function |
5a20d2ce | 33 | virtual void DoLogString(const wxString& szString, time_t t); |
7e8c564c | 34 | |
b99891b0 VZ |
35 | wxSUPPRESS_DOLOGSTRING_HIDE_WARNING() |
36 | ||
6f02a879 | 37 | private: |
7e8c564c VS |
38 | // the control we use |
39 | wxTextCtrl *m_pTextCtrl; | |
40 | ||
41 | DECLARE_NO_COPY_CLASS(wxLogTextCtrl) | |
42 | }; | |
43 | ||
44 | #endif // wxUSE_TEXTCTRL | |
45 | ||
46 | // ---------------------------------------------------------------------------- | |
77ffb593 | 47 | // GUI log target, the default one for wxWidgets programs |
7e8c564c VS |
48 | // ---------------------------------------------------------------------------- |
49 | ||
50 | #if wxUSE_LOGGUI | |
51 | ||
53a2db12 | 52 | class WXDLLIMPEXP_CORE wxLogGui : public wxLog |
7e8c564c VS |
53 | { |
54 | public: | |
55 | // ctor | |
56 | wxLogGui(); | |
57 | ||
58 | // show all messages that were logged since the last Flush() | |
59 | virtual void Flush(); | |
60 | ||
61 | protected: | |
5a20d2ce | 62 | virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t); |
7e8c564c | 63 | |
b99891b0 VZ |
64 | wxSUPPRESS_DOLOG_HIDE_WARNING() |
65 | ||
7e8c564c VS |
66 | // empty everything |
67 | void Clear(); | |
68 | ||
69 | wxArrayString m_aMessages; // the log message texts | |
70 | wxArrayInt m_aSeverity; // one of wxLOG_XXX values | |
71 | wxArrayLong m_aTimes; // the time of each message | |
72 | bool m_bErrors, // do we have any errors? | |
73 | m_bWarnings, // any warnings? | |
74 | m_bHasMessages; // any messages at all? | |
75 | ||
76 | }; | |
77 | ||
78 | #endif // wxUSE_LOGGUI | |
79 | ||
80 | // ---------------------------------------------------------------------------- | |
81 | // (background) log window: this class forwards all log messages to the log | |
82 | // target which was active when it was instantiated, but also collects them | |
83 | // to the log window. This window has it's own menu which allows the user to | |
84 | // close it, clear the log contents or save it to the file. | |
85 | // ---------------------------------------------------------------------------- | |
86 | ||
87 | #if wxUSE_LOGWINDOW | |
88 | ||
53a2db12 | 89 | class WXDLLIMPEXP_CORE wxLogWindow : public wxLogPassThrough |
7e8c564c VS |
90 | { |
91 | public: | |
46ff9bd5 VS |
92 | wxLogWindow(wxWindow *pParent, // the parent frame (can be NULL) |
93 | const wxString& szTitle, // the title of the frame | |
dabbc6a5 DS |
94 | bool bShow = true, // show window immediately? |
95 | bool bPassToOld = true); // pass messages to the old target? | |
7e8c564c | 96 | |
d3c7fc99 | 97 | virtual ~wxLogWindow(); |
7e8c564c VS |
98 | |
99 | // window operations | |
100 | // show/hide the log window | |
dabbc6a5 | 101 | void Show(bool bShow = true); |
7e8c564c VS |
102 | // retrieve the pointer to the frame |
103 | wxFrame *GetFrame() const; | |
104 | ||
105 | // overridables | |
106 | // called immediately after the log frame creation allowing for | |
107 | // any extra initializations | |
108 | virtual void OnFrameCreate(wxFrame *frame); | |
109 | // called if the user closes the window interactively, will not be | |
110 | // called if it is destroyed for another reason (such as when program | |
dabbc6a5 | 111 | // exits) - return true from here to allow the frame to close, false |
7e8c564c VS |
112 | // to prevent this from happening |
113 | virtual bool OnFrameClose(wxFrame *frame); | |
114 | // called right before the log frame is going to be deleted: will | |
115 | // always be called unlike OnFrameClose() | |
116 | virtual void OnFrameDelete(wxFrame *frame); | |
117 | ||
118 | protected: | |
5a20d2ce VS |
119 | virtual void DoLog(wxLogLevel level, const wxString& szString, time_t t); |
120 | virtual void DoLogString(const wxString& szString, time_t t); | |
7e8c564c | 121 | |
b99891b0 VZ |
122 | wxSUPPRESS_DOLOG_HIDE_WARNING() |
123 | wxSUPPRESS_DOLOGSTRING_HIDE_WARNING() | |
124 | ||
7e8c564c VS |
125 | private: |
126 | wxLogFrame *m_pLogFrame; // the log frame | |
127 | ||
128 | DECLARE_NO_COPY_CLASS(wxLogWindow) | |
129 | }; | |
130 | ||
131 | #endif // wxUSE_LOGWINDOW | |
132 | ||
133 | #endif // wxUSE_GUI | |
134 | ||
135 | #endif // _WX_LOGG_H_ | |
136 |