support for huge files (patch 1002226)

[wxWidgets.git] / docs / latex / wx / log.tex

diff --git a/docs/latex/wx/log.tex b/docs/latex/wx/log.tex
index fa31caabb9753b33ad728c767dbab72a161ca7ed..447d73d2f9e6c1e58c0a49fbde72377b83a9bcc6 100644 (file)
--- a/docs/latex/wx/log.tex
+++ b/docs/latex/wx/log.tex
@@ -6,12 +6,12 @@
 %% Created:     some time ago
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 1997-2001 Vadim Zeitlin
 %% Created:     some time ago
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 1997-2001 Vadim Zeitlin

-%% License:     wxWindows license
+%% License:     wxWidgets license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxLog}}\label{wxlog}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \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
 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.
 
 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}
 logging facilities.
 
 \wxheading{Derived from}


@@ -172,6 +172,7 @@ Add the {\it mask} to the list of allowed masks for
 \helpref{wxLogTrace}{wxlogtrace}.
 
 \wxheading{See also}
 \helpref{wxLogTrace}{wxlogtrace}.
 
 \wxheading{See also}

+

 \helpref{RemoveTraceMask}{wxlogremovetracemask}
 \helpref{GetTraceMasks}{wxloggettracemasks}
 
 \helpref{RemoveTraceMask}{wxlogremovetracemask}
 \helpref{GetTraceMasks}{wxloggettracemasks}
 


@@ -183,15 +184,17 @@ Removes all trace masks previously set with
 \helpref{AddTraceMask}{wxlogaddtracemask}.
 
 \wxheading{See also}
 \helpref{AddTraceMask}{wxlogaddtracemask}.
 
 \wxheading{See also}

+

 \helpref{RemoveTraceMask}{wxlogremovetracemask}
 
 \membersection{wxLog::GetTraceMasks}\label{wxloggettracemasks}
 
 \helpref{RemoveTraceMask}{wxlogremovetracemask}
 
 \membersection{wxLog::GetTraceMasks}\label{wxloggettracemasks}
 

-\func{static const wxArrayString &}{GetTraceMasks}{\void}
+\func{static const wxArrayString \&}{GetTraceMasks}{\void}

 
 Returns the currently allowed list of string trace masks.
 
 \wxheading{See also}
 
 Returns the currently allowed list of string trace masks.
 
 \wxheading{See also}

+

 \helpref{AddTraceMask}{wxlogaddtracemask}.
 
 \membersection{wxLog::OnLog}\label{wxlogonlog}
 \helpref{AddTraceMask}{wxlogaddtracemask}.
 
 \membersection{wxLog::OnLog}\label{wxlogonlog}


@@ -228,7 +231,7 @@ logging immediately without waiting for \helpref{Flush}{wxlogflush} to be
 called (the standard GUI log target only shows the log dialog when it is
 flushed, so Suspend() works as expected with it).
 
 called (the standard GUI log target only shows the log dialog when it is
 flushed, so Suspend() works as expected with it).
 

-\wxheading{See also:}
+\wxheading{See also}

 
 \helpref{Resume}{wxlogresume},\\
 \helpref{wxLogNull}{wxlogoverview}
 
 \helpref{Resume}{wxlogresume},\\
 \helpref{wxLogNull}{wxlogoverview}


@@ -287,13 +290,13 @@ is already empty, nothing happens.
 
 Flushes the current log target if any, does nothing if there is none.
 
 
 Flushes the current log target if any, does nothing if there is none.
 

-See also:
+\wxheading{See also}

 
 \helpref{Flush}{wxlogflush}
 
 \membersection{wxLog::SetVerbose}\label{wxlogsetverbose}
 
 
 \helpref{Flush}{wxlogflush}
 
 \membersection{wxLog::SetVerbose}\label{wxlogsetverbose}
 

-\func{static void}{SetVerbose}{\param{bool }{ verbose = TRUE}}
+\func{static void}{SetVerbose}{\param{bool }{ verbose = true}}

 
 Activates or deactivates verbose mode in which the verbose messages are
 logged as the normal ones instead of being silently dropped.
 
 Activates or deactivates verbose mode in which the verbose messages are
 logged as the normal ones instead of being silently dropped.


@@ -348,7 +351,7 @@ for details.
 
 \func{static bool}{IsAllowedTraceMask}{\param{const wxChar *}{mask}}
 
 
 \func{static bool}{IsAllowedTraceMask}{\param{const wxChar *}{mask}}
 

-Returns TRUE if the {\it mask} is one of allowed masks for
+Returns true if the {\it mask} is one of allowed masks for

 \helpref{wxLogTrace}{wxlogtrace}.
 
 See also: \helpref{AddTraceMask}{wxlogaddtracemask},
 \helpref{wxLogTrace}{wxlogtrace}.
 
 See also: \helpref{AddTraceMask}{wxlogaddtracemask},


@@ -423,8 +426,8 @@ NULL}).
 
 \constfunc{bool}{IsPassingMessages}{\void}
 
 
 \constfunc{bool}{IsPassingMessages}{\void}
 

-Returns {\tt TRUE} if the messages are passed to the previously active log
-target (default) or {\tt FALSE} if \helpref{PassMessages}{wxlogchainpassmessages}
+Returns {\tt true} if the messages are passed to the previously active log
+target (default) or {\tt false} if \helpref{PassMessages}{wxlogchainpassmessages}

 had been called.
 
 \membersection{wxLogChain::PassMessages}\label{wxlogchainpassmessages}
 had been called.
 
 \membersection{wxLogChain::PassMessages}\label{wxlogchainpassmessages}


@@ -432,10 +435,10 @@ had been called.
 \func{void}{PassMessages}{\param{bool }{passMessages}}
 
 By default, the log messages are passed to the previously active log target.
 \func{void}{PassMessages}{\param{bool }{passMessages}}
 
 By default, the log messages are passed to the previously active log target.

-Calling this function with {\tt FALSE} parameter disables this behaviour
+Calling this function with {\tt false} parameter disables this behaviour

 (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
 it can be reenabled by calling it again with {\it passMessages} set to {\tt
 (presumably temporarily, as you shouldn't use wxLogChain at all otherwise) and
 it can be reenabled by calling it again with {\it passMessages} set to {\tt

-TRUE}.
+true}.

 
 \membersection{wxLogChain::SetLog}\label{wxlogchainsetlog}
 
 
 \membersection{wxLogChain::SetLog}\label{wxlogchainsetlog}
 


@@ -453,9 +456,9 @@ object was created.
 
 \section{\class{wxLogGui}}\label{wxloggui}
 
 
 \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
 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}
 
 
 \wxheading{Derived from}
 


@@ -480,7 +483,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.
 
 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.
 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.


@@ -500,7 +503,7 @@ For instance, the example of the overview:
 
   wxLogMessage("..."); // ok
 \end{verbatim}
 
   wxLogMessage("..."); // ok
 \end{verbatim}

-}
+}%

 
 would be better written as:
 
 
 would be better written as:
 


@@ -520,7 +523,7 @@ would be better written as:
       ...
   }
 \end{verbatim}
       ...
   }
 \end{verbatim}

-}
+}%

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -575,7 +578,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
 
 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}
 
 
 \wxheading{Derived from}
 


@@ -604,7 +607,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.
 
 
 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}
 the standard iostream library support ({\tt wxUSE\_STD\_IOSTREAM} must be on).
 
 \wxheading{Derived from}


@@ -685,7 +688,7 @@ them normally by showing the standard log dialog.
 
 \membersection{wxLogWindow::wxLogWindow}
 
 
 \membersection{wxLogWindow::wxLogWindow}
 

-\func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt TRUE}}, \param{bool }{passToOld = {\tt TRUE}}}
+\func{}{wxLogWindow}{\param{wxFrame }{*parent}, \param{const wxChar }{*title}, \param{bool }{show = {\tt true}}, \param{bool }{passToOld = {\tt true}}}

 
 Creates the log frame window and starts collecting the messages in it.
 
 
 Creates the log frame window and starts collecting the messages in it.
 


@@ -695,16 +698,16 @@ Creates the log frame window and starts collecting the messages in it.
 
 \docparam{title}{The title for the log frame}
 
 
 \docparam{title}{The title for the log frame}
 

-\docparam{show}{{\tt TRUE} to show the frame initially (default), otherwise
+\docparam{show}{{\tt true} to show the frame initially (default), otherwise

 \helpref{wxLogWindow::Show}{wxlogwindowshow} must be called later.}
 
 \helpref{wxLogWindow::Show}{wxlogwindowshow} must be called later.}
 

-\docparam{passToOld}{{\tt TRUE} to process the log messages normally in addition to
-logging them in the log frame (default), {\tt FALSE} to only log them in the
+\docparam{passToOld}{{\tt true} to process the log messages normally in addition to
+logging them in the log frame (default), {\tt false} to only log them in the

 log frame.}
 
 \membersection{wxLogWindow::Show}\label{wxlogwindowshow}
 
 log frame.}
 
 \membersection{wxLogWindow::Show}\label{wxlogwindowshow}
 

-\func{void}{Show}{\param{bool }{show = {\tt TRUE}}}
+\func{void}{Show}{\param{bool }{show = {\tt true}}}

 
 Shows or hides the frame.
 
 
 Shows or hides the frame.
 


@@ -724,13 +727,13 @@ any extra initializations.
 
 \membersection{wxLogWindow::OnFrameClose}\label{wxlogwindowonframeclose}
 
 
 \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
 exits).
 
 
 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 {\tt TRUE} from here to allow the frame to close, {\tt FALSE} to
+Return {\tt true} from here to allow the frame to close, {\tt false} to

 prevent this from happening.
 
 \wxheading{See also}
 prevent this from happening.
 
 \wxheading{See also}