No base class
+\wxheading{Include files}
+
+<wx/log.h>
+
\latexignore{\rtfignore{\wxheading{Function groups}}}
\membersection{Static functions}
The functions in this section work with and manipulate the active log target.
-The {\it OnLog()} is called by the {\it wxLogXXX()} functions and invokes the
+The {\it OnLog()} is called by the {\it wxLogXXX()} functions and invokes the
{\it DoLog()} of the active log target if any. Get/Set methods are used to
install/query the current active target and, finally, {\it
DontCreateOnDemand()} disables the automatic creation of a standard log target
\helpref{OnLog}{wxlogonlog}\\
\helpref{GetActiveTarget}{wxloggetactivetarget}\\
-\helpref{SetActiveTarget}{wxsetactivetarget}\\
+\helpref{SetActiveTarget}{wxlogsetactivetarget}\\
\helpref{DontCreateOnDemand}{wxlogdontcreateondemand}
\membersection{Message buffering}
Some of wxLog implementations, most notably the standard
-\helpref{wxLogGui}{wxloggui} class, buffer the messages (for example, to avoid
+wxLogGui class, buffer the messages (for example, to avoid
showing the user a zillion of modal message boxes one after another - which
would be really annoying). {\it Flush()} shows them all and clears the buffer
contents. Although this function doesn't do anything if the buffer is already
\helpref{Flush}{wxlogflush}\\
\helpref{HasPendingMessages}{haspendingmessages}
-\membersection{Customization}{wxlogcustomization}
+\membersection{Customization}\label{wxlogcustomization}
The functions below allow some limited customization of wxLog behaviour
without writing a new log target class (which, aside of being a matter of
for example, in order to help the user find some program problem.
As for the (real) trace messages, they come in different kinds:
+
\begin{itemize}\itemsep=0pt
\item{wxTraceMemAlloc} for the messages about creating and deleting objects
\item{wxTraceMessages} for tracing the windowing system messages/events
The trace mask is a bit mask which tells which (if any) of these trace
messages are going to be actually logged. For the trace message to appear
-somewhere, all the bits in the mask used in the call to {\it wxLogTrace()}
+somewhere, all the bits in the mask used in the call to {\it wxLogTrace()}
function must be set in the current trace mask. For example,
\begin{verbatim}
wxLogTrace(wxTraceRefCount | wxTraceOle, "Active object ref count: %d", nRef);
\helpref{SetVerbose}{wxlogsetverbose}\\
\helpref{GetVerbose}{wxloggetverbose}\\
-\helpref{SetTimeStampFormat}{wxlogsettimestampformat}\\
-\helpref{GetTimeStampFormat}{wxloggettimestampformat}\\
+\helpref{SetTimestamp}{wxlogsettimestamp}\\
+\helpref{GetTimestamp}{wxloggettimestamp}\\
\helpref{SetTraceMask}{wxlogsettracemask}\\
\helpref{GetTraceMask}{wxloggettracemask}
Instructs wxLog to not create new log targets on the fly if there is none
currently. (Almost) for internal use only.
-\membersection{wxLog::Flush}{wxlogflush}
+\membersection{wxLog::Flush}\label{wxlogflush}
\func{virtual void}{Flush}{\void}
Shows all the messages currently in buffer and clears it. If the buffer
is already empty, nothing happens.
-\membersection{wxLog::HasPendingMessages}{haspendingmessages}
+\membersection{wxLog::HasPendingMessages}\label{haspendingmessages}
\constfunc{bool}{HasPendingMessages}{\void}
Returns true if there are any messages in the buffer (not yet shown to the
user). (Almost) for internal use only.
-\membersection{wxLog::SetVerbose}{wxlogsetverbose}
+\membersection{wxLog::SetVerbose}\label{wxlogsetverbose}
\func{void}{SetVerbose}{\param{bool }{ verbose = TRUE}}
Activates or desactivates verbose mode in which the verbose messages are
logged as the normal ones instead of being silently dropped.
-\membersection{wxLog::GetVerbose}{wxloggetverbose}
+\membersection{wxLog::GetVerbose}\label{wxloggetverbose}
\constfunc{bool}{GetVerbose}{\void}
Returns whether the verbose mode is currently active.
-\membersection{wxLog::SetTimeStampFormat}{wxlogsettimestampformat}
+\membersection{wxLog::SetTimestamp}\label{wxlogsettimestamp}
-\func{void}{SetTimeStampFormat}{\param{const char * }{ format}}
+\func{void}{SetTimestamp}{\param{const char * }{ format}}
Sets the timestamp format prepended by the default log targets to all
messages. The string may contain any normal characters as well as \%
prefixed format specificators, see {\it strftime()} manual for details.
-Passing an empty string to this function disables message timestamping.
+Passing a null value (not empty string) to this function disables message timestamping.
-\membersection{wxLog::GetTimeStampFormat}{wxloggettimestampformat}
+\membersection{wxLog::GetTimestamp}\label{wxloggettimestamp}
-\constfunc{const char *}{GetTimeStampFormat}{\void}
+\constfunc{const char *}{GetTimestamp}{\void}
Returns the current timestamp format string.
-\membersection{wxLog::SetTraceMask}{wxlogsettracemask}
+\membersection{wxLog::SetTraceMask}\label{wxlogsettracemask}
\func{static void}{SetTraceMask}{\param{wxTraceMask }{ mask}}
Sets the trace mask, see \helpref{Customization}{wxlogcustomization}
section for details.
-\membersection{wxLog::GetTraceMask}{wxloggettracemask}
+\membersection{wxLog::GetTraceMask}\label{wxloggettracemask}
+
+Returns the current trace mask, see \helpref{Customization}{wxlogcustomization} section
+for details.
-Returns the current trace mask, see \helpref{Customization}{wxlogcustomization}
-section for details.
projects / wxWidgets.git / blobdiff