X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d2c2afc91be4bdb6e036516785f334ddb54afa0c..b98bd6af23c1c73eb2cddf14da18455e5668de6d:/docs/latex/wx/log.tex?ds=sidebyside diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex index 20e9515b77..573022808a 100644 --- a/docs/latex/wx/log.tex +++ b/docs/latex/wx/log.tex @@ -11,7 +11,7 @@ \section{\class{wxLog}}\label{wxlog} -wxLog class defines the interface for the {\it log targets} used by wxWindows +wxLog class defines the interface for the {\it log targets} used by wxWidgets logging functions as explained in the \helpref{wxLog overview}{wxlogoverview}. The only situations when you need to directly use this class is when you want to derive your own log target because the existing ones don't satisfy your @@ -23,7 +23,7 @@ completely) the timestamp on the messages. Otherwise, it is completely hidden behind the {\it wxLogXXX()} functions and you may not even know about its existence. -See \helpref{log overview}{wxlogoverview} for the descriptions of wxWindows +See \helpref{log overview}{wxlogoverview} for the descriptions of wxWidgets logging facilities. \wxheading{Derived from} @@ -36,7 +36,7 @@ No base class \latexignore{\rtfignore{\wxheading{Function groups}}} -\membersection{Static functions} +\membersection{Static functions}\label{staticlogfunctions} The functions in this section work with and manipulate the active log target. The \helpref{OnLog()}{wxlogonlog} is called by the {\it wxLogXXX()} functions @@ -54,7 +54,7 @@ situations because it may easily lead to a loss of messages. \helpref{Suspend}{wxlogsuspend}\\ \helpref{Resume}{wxlogresume} -\membersection{Logging functions} +\membersection{Logging functions}\label{loggingfunctions} There are two functions which must be implemented by any derived class to actually process the log messages: \helpref{DoLog}{wxlogdolog} and @@ -155,7 +155,9 @@ window on the corresponding error message. If you wish to enable it, please use \helpref{SetTimestamp}{wxlogsettimestamp}\\ \helpref{GetTimestamp}{wxloggettimestamp}\\ \helpref{SetTraceMask}{wxlogsettracemask}\\ -\helpref{GetTraceMask}{wxloggettracemask} +\helpref{GetTraceMask}{wxloggettracemask}\\ +\helpref{SetRepetitionCounting}{wxlogsetrepetitioncounting}\\ +\helpref{GetRepetitionCounting}{wxloggetrepetitioncounting} %%%%% MEMBERS HERE %%%%% \helponly{\insertatlevel{2}{ @@ -215,7 +217,9 @@ Returns the pointer to the active log target (may be NULL). \func{static wxLog *}{SetActiveTarget}{\param{wxLog * }{ logtarget}} Sets the specified log target as the active one. Returns the pointer to the -previous active log target (may be NULL). +previous active log target (may be NULL). To suppress logging use a new +instance of wxLogNull not NULL. If the active log target is set to NULL a +new default log target will be created when logging occurs. \membersection{wxLog::Suspend}\label{wxlogsuspend} @@ -320,6 +324,21 @@ and not sent to the active log target. Returns the current log level limit. +\membersection{wxLog::SetRepetitionCounting}\label{wxlogsetrepetitioncounting} + +\func{static void}{SetRepetitionCounting}{\param{bool }{ repetCounting = true}} + +Enables logging mode in which a log message is logged once, and in case exactly +the same message successively repeats one or more times, only the number of +repetitions is logged. + +\membersection{wxLog::GetRepetitionCounting}\label{wxloggetrepetitioncounting} + +\func{static bool}{GetRepetitionCounting}{\void} + +Returns whether the repetition counting mode is enabled. + + \membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp} \func{void}{SetTimestamp}{\param{const char * }{ format}} @@ -402,14 +421,14 @@ delete wxLog::SetActiveTarget(...something else or NULL...); \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogChain::wxLogChain}\label{wxlogchainwxlogchain} +\membersection{wxLogChain::wxLogChain}\label{wxlogchainctor} \func{}{wxLogChain}{\param{wxLog *}{logger}} Sets the specified {\tt logger} (which may be {\tt NULL}) as the default log target but the log messages are also passed to the previous log target if any. -\membersection{wxLogChain::\destruct{wxLogChain}} +\membersection{wxLogChain::\destruct{wxLogChain}}\label{wxlogchaindtor} \func{}{\destruct{wxLogChain}}{\void} @@ -445,7 +464,7 @@ true}. \func{void}{SetLog}{\param{wxLog *}{logger}} Sets another log target to use (may be {\tt NULL}). The log target specified -in the \helpref{constructor}{wxlogchainwxlogchain} or in a previous call to +in the \helpref{constructor}{wxlogchainctor} or in a previous call to this function is deleted. This doesn't change the old log target value (the one the messages are @@ -456,9 +475,9 @@ object was created. \section{\class{wxLogGui}}\label{wxloggui} -This is the default log target for the GUI wxWindows applications. It is passed +This is the default log target for the GUI wxWidgets applications. It is passed to \helpref{wxLog::SetActiveTarget}{wxlogsetactivetarget} at the program -startup and is deleted by wxWindows during the program shut down. +startup and is deleted by wxWidgets during the program shut down. \wxheading{Derived from} @@ -470,7 +489,7 @@ startup and is deleted by wxWindows during the program shut down. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogGui::wxLogGui} +\membersection{wxLogGui::wxLogGui}\label{wxlogguictor} \func{}{wxLogGui}{\void} @@ -483,7 +502,7 @@ Default constructor. This class allows to temporarily suspend logging. All calls to the log functions during the life time of an object of this class are just ignored. -In particular, it can be used to suppress the log messages given by wxWindows +In particular, it can be used to suppress the log messages given by wxWidgets itself but it should be noted that it is rarely the best way to cope with this problem as {\bf all} log messages are suppressed, even if they indicate a completely different error than the one the programmer wanted to suppress. @@ -535,13 +554,13 @@ would be better written as: \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogNull::wxLogNull} +\membersection{wxLogNull::wxLogNull}\label{wxlognullctor} \func{}{wxLogNull}{\void} Suspends logging. -\membersection{wxLogNull::\destruct{wxLogNull}} +\membersection{wxLogNull::\destruct{wxLogNull}}\label{wxlognulldtor} Resumes logging. @@ -578,7 +597,7 @@ Default ctor installs this object as the current active log target. This class can be used to redirect the log messages to a C file stream (not to be confused with C++ streams). It is the default log target for the non-GUI -wxWindows applications which send all the output to {\tt stderr}. +wxWidgets applications which send all the output to {\tt stderr}. \wxheading{Derived from} @@ -594,7 +613,7 @@ wxWindows applications which send all the output to {\tt stderr}. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogStderr::wxLogStderr} +\membersection{wxLogStderr::wxLogStderr}\label{wxlogstderrctor} \func{}{wxLogStderr}{\param{FILE }{*fp = NULL}} @@ -607,7 +626,7 @@ Constructs a log target which sends all the log messages to the given This class can be used to redirect the log messages to a C++ stream. -Please note that this class is only available if wxWindows was compiled with +Please note that this class is only available if wxWidgets was compiled with the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on). \wxheading{Derived from} @@ -625,7 +644,7 @@ the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on). \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogStream::wxLogStream} +\membersection{wxLogStream::wxLogStream}\label{wxlogstreamctor} \func{}{wxLogStream}{\param{std::ostream }{*ostr = NULL}} @@ -650,12 +669,12 @@ caller previously. \wxheading{See also} -\helpref{wxLogTextCtrl}{wxlogtextctrl},\\ +\helpref{wxTextCtrl}{wxtextctrl},\\ \helpref{wxStreamToTextRedirector}{wxstreamtotextredirector} \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogTextCtrl::wxLogTextCtrl} +\membersection{wxLogTextCtrl::wxLogTextCtrl}\label{wxlogtextctrlctor} \func{}{wxLogTextCtrl}{\param{wxTextCtrl }{*textctrl}} @@ -686,7 +705,7 @@ them normally by showing the standard log dialog. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxLogWindow::wxLogWindow} +\membersection{wxLogWindow::wxLogWindow}\label{wxlogwindowctor} \func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt true}}, \param{bool }{passToOld = {\tt true}}} @@ -711,14 +730,14 @@ log frame.} Shows or hides the frame. -\membersection{wxLogWindow::GetFrame} +\membersection{wxLogWindow::GetFrame}\label{wxlogwindowgetframe} \constfunc{wxFrame *}{GetFrame}{\void} Returns the associated log frame window. This may be used to position or resize it but use \helpref{wxLogWindow::Show}{wxlogwindowshow} to show or hide it. -\membersection{wxLogWindow::OnFrameCreate} +\membersection{wxLogWindow::OnFrameCreate}\label{wxlogwindowonframecreate} \func{virtual void}{OnFrameCreate}{\param{wxFrame }{*frame}} @@ -727,7 +746,7 @@ any extra initializations. \membersection{wxLogWindow::OnFrameClose}\label{wxlogwindowonframeclose} -\func{virtual void}{OnFrameClose}{\param{wxFrame }{*frame}} +\func{virtual bool}{OnFrameClose}{\param{wxFrame }{*frame}} Called if the user closes the window interactively, will not be called if it is destroyed for another reason (such as when program