split wxSizer::Fit() into ComputeFittingWindow/ClientSize() that only does computatio...

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

diff --git a/docs/latex/wx/debugcxt.tex b/docs/latex/wx/debugcxt.tex
index 841b177e3bb962fdb9996b3b3c83fd512206f619..4967c04bdd2b63bf3451389b5084b17a8ac28c85 100644 (file)
--- a/docs/latex/wx/debugcxt.tex
+++ b/docs/latex/wx/debugcxt.tex
@@ -2,15 +2,23 @@
 
 A class for performing various debugging and memory tracing
 operations. Full functionality (such as printing out objects
 
 A class for performing various debugging and memory tracing
 operations. Full functionality (such as printing out objects

-currently allocated) is only present in a debugging build of wxWindows,
-i.e. if the DEBUG symbol is defined and non-zero. wxDebugContext
+currently allocated) is only present in a debugging build of wxWidgets,
+i.e. if the \_\_WXDEBUG\_\_ symbol is defined. wxDebugContext

 and related functions and macros can be compiled out by setting
 and related functions and macros can be compiled out by setting

-USE\_DEBUG\_CONTEXT to 0 is wx\_setup.h
+wxUSE\_DEBUG\_CONTEXT to 0 is setup.h

 
 \wxheading{Derived from}
 
 No parent class.
 
 
 \wxheading{Derived from}
 
 No parent class.
 

+\wxheading{Include files}
+
+<wx/memory.h>
+
+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \wxheading{See also}
 
 \overview{Overview}{wxdebugcontextoverview}
 \wxheading{See also}
 
 \overview{Overview}{wxdebugcontextoverview}


@@ -40,14 +48,14 @@ derived instance.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the function succeeded, FALSE otherwise.
+true if the function succeeded, false otherwise.

 
 \membersection{wxDebugContext::GetCheckPrevious}\label{wxdebugcontextgetcheckprevious}
 
 \func{bool}{GetCheckPrevious}{\void}
 
 
 \membersection{wxDebugContext::GetCheckPrevious}\label{wxdebugcontextgetcheckprevious}
 
 \func{bool}{GetCheckPrevious}{\void}
 

-Returns TRUE if the memory allocator checks all previous memory blocks for errors.
-By default, this is FALSE since it slows down execution considerably.
+Returns true if the memory allocator checks all previous memory blocks for errors.
+By default, this is false since it slows down execution considerably.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -57,7 +65,7 @@ By default, this is FALSE since it slows down execution considerably.
 
 \func{bool}{GetDebugMode}{\void}
 
 
 \func{bool}{GetDebugMode}{\void}
 

-Returns TRUE if debug mode is on. If debug mode is on, the wxObject new and delete
+Returns true if debug mode is on. If debug mode is on, the wxObject new and delete

 operators store or use information about memory allocation. Otherwise,
 a straight malloc and free will be performed by these operators.
 
 operators store or use information about memory allocation. Otherwise,
 a straight malloc and free will be performed by these operators.
 


@@ -74,6 +82,8 @@ the WXTRACELEVEL macro to specify how detailed the trace information is; setting
 a different level will only have an effect if trace statements in the application
 specify a value other than one.
 
 a different level will only have an effect if trace statements in the application
 specify a value other than one.
 

+This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

 \wxheading{See also}
 
 \helpref{wxDebugContext::SetLevel}{wxdebugcontextsetlevel}
 \wxheading{See also}
 
 \helpref{wxDebugContext::SetLevel}{wxdebugcontextsetlevel}


@@ -84,6 +94,8 @@ specify a value other than one.
 
 Returns the output stream associated with the debug context.
 
 
 Returns the output stream associated with the debug context.
 

+This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

 \wxheading{See also}
 
 \helpref{wxDebugContext::SetStream}{wxdebugcontextsetstream}
 \wxheading{See also}
 
 \helpref{wxDebugContext::SetStream}{wxdebugcontextsetstream}


@@ -96,13 +108,17 @@ Returns a pointer to the output stream buffer associated with the debug context.
 There may not necessarily be a stream buffer if the stream has been set
 by the user.
 
 There may not necessarily be a stream buffer if the stream has been set
 by the user.
 

+This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

 \membersection{wxDebugContext::HasStream}\label{wxdebugcontexthasstream}
 
 \func{bool}{HasStream}{\void}
 
 \membersection{wxDebugContext::HasStream}\label{wxdebugcontexthasstream}
 
 \func{bool}{HasStream}{\void}
 

-Returns TRUE if there is a stream currently associated
+Returns true if there is a stream currently associated

 with the debug context.
 
 with the debug context.
 

+This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

 \wxheading{See also}
 
 \helpref{wxDebugContext::SetStream}{wxdebugcontextsetstream}, \helpref{wxDebugContext::GetStream}{wxdebugcontextgetstream}
 \wxheading{See also}
 
 \helpref{wxDebugContext::SetStream}{wxdebugcontextsetstream}, \helpref{wxDebugContext::GetStream}{wxdebugcontextgetstream}


@@ -120,7 +136,7 @@ and whether instances of this class can be dynamically created.
 
 \membersection{wxDebugContext::PrintStatistics}\label{wxdebugcontextprintstatistics}
 
 
 \membersection{wxDebugContext::PrintStatistics}\label{wxdebugcontextprintstatistics}
 

-\func{bool}{PrintStatistics}{\param{bool}{ detailed = TRUE}}
+\func{bool}{PrintStatistics}{\param{bool}{ detailed = true}}

 
 Performs a statistics analysis from the currently set checkpoint, writing
 to the current debug stream. The number of object and non-object
 
 Performs a statistics analysis from the currently set checkpoint, writing
 to the current debug stream. The number of object and non-object


@@ -128,7 +144,7 @@ allocations is printed, together with the total size.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{detailed}{If TRUE, the function will also print how many
+\docparam{detailed}{If true, the function will also print how many

 objects of each class have been allocated, and the space taken by
 these class instances.}
 
 objects of each class have been allocated, and the space taken by
 these class instances.}
 


@@ -138,7 +154,7 @@ these class instances.}
 
 \membersection{wxDebugContext::SetCheckpoint}\label{wxdebugcontextsetcheckpoint}
 
 
 \membersection{wxDebugContext::SetCheckpoint}\label{wxdebugcontextsetcheckpoint}
 

-\func{void}{SetCheckpoint}{\param{bool}{ all = FALSE}}
+\func{void}{SetCheckpoint}{\param{bool}{ all = false}}

 
 Sets the current checkpoint: Dump and PrintStatistics operations will
 be performed from this point on. This allows you to ignore allocations
 
 Sets the current checkpoint: Dump and PrintStatistics operations will
 be performed from this point on. This allows you to ignore allocations


@@ -146,7 +162,7 @@ that have been performed up to this point.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{all}{If TRUE, the checkpoint is reset to include all
+\docparam{all}{If true, the checkpoint is reset to include all

 memory allocations since the program started.}
 
 \membersection{wxDebugContext::SetCheckPrevious}\label{wxdebugcontextsetcheckprevious}
 memory allocations since the program started.}
 
 \membersection{wxDebugContext::SetCheckPrevious}\label{wxdebugcontextsetcheckprevious}


@@ -154,7 +170,7 @@ memory allocations since the program started.}
 \func{void}{SetCheckPrevious}{\param{bool}{ check}}
 
 Tells the memory allocator to check all previous memory blocks for errors.
 \func{void}{SetCheckPrevious}{\param{bool}{ check}}
 
 Tells the memory allocator to check all previous memory blocks for errors.

-By default, this is FALSE since it slows down execution considerably.
+By default, this is false since it slows down execution considerably.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -168,7 +184,7 @@ Sets the debug mode on or off. If debug mode is on, the wxObject new and delete
 operators store or use information about memory allocation. Otherwise,
 a straight malloc and free will be performed by these operators.
 
 operators store or use information about memory allocation. Otherwise,
 a straight malloc and free will be performed by these operators.
 

-By default, debug mode is on if DEBUG is non-zero. If the application
+By default, debug mode is on if \_\_WXDEBUG\_\_ is defined. If the application

 uses this function, it should make sure that all object memory allocated
 is deallocated with the same value of debug mode. Otherwise, the
 delete operator might try to look for memory information that does not
 uses this function, it should make sure that all object memory allocated
 is deallocated with the same value of debug mode. Otherwise, the
 delete operator might try to look for memory information that does not


@@ -195,10 +211,21 @@ the WXTRACELEVEL macro to specify how detailed the trace information is; setting
 a different level will only have an effect if trace statements in the application
 specify a value other than one.
 
 a different level will only have an effect if trace statements in the application
 specify a value other than one.
 

+This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

 \wxheading{See also}
 
 \helpref{wxDebugContext::GetLevel}{wxdebugcontextgetlevel}
 
 \wxheading{See also}
 
 \helpref{wxDebugContext::GetLevel}{wxdebugcontextgetlevel}
 

+\membersection{wxDebugContext::SetShutdownNotifyFunction}\label{wxdebugcontextsetshutdownnotifyhook}
+
+\func{void}{SetShutdownNotifyFunction}{\param{wxShutdownNotifyFunction }{func}}
+
+Installs a function to be called at the end of wxWidgets shutdown. It will be called after
+all files with global instances of wxDebugContextDumpDelayCounter have run their destructors.
+
+The shutdown function must be take no parameters and return nothing.
+

 \membersection{wxDebugContext::SetStandardError}\label{wxdebugcontextsetstandarderror}
 
 \func{bool}{SetStandardError}{\void}
 \membersection{wxDebugContext::SetStandardError}\label{wxdebugcontextsetstandarderror}
 
 \func{bool}{SetStandardError}{\void}


@@ -206,6 +233,8 @@ specify a value other than one.
 Sets the debugging stream to be the debugger (Windows) or standard error (other platforms).
 This is the default setting. The existing stream will be flushed and deleted.
 
 Sets the debugging stream to be the debugger (Windows) or standard error (other platforms).
 This is the default setting. The existing stream will be flushed and deleted.
 

+This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

 \membersection{wxDebugContext::SetStream}\label{wxdebugcontextsetstream}
 
 \func{void}{SetStream}{\param{ostream* }{stream}, \param{streambuf* }{streamBuf = NULL}}
 \membersection{wxDebugContext::SetStream}\label{wxdebugcontextsetstream}
 
 \func{void}{SetStream}{\param{ostream* }{stream}, \param{streambuf* }{streamBuf = NULL}}


@@ -213,6 +242,8 @@ This is the default setting. The existing stream will be flushed and deleted.
 Sets the stream and optionally, stream buffer associated with the debug context.
 This operation flushes and deletes the existing stream (and stream buffer if any).
 
 Sets the stream and optionally, stream buffer associated with the debug context.
 This operation flushes and deletes the existing stream (and stream buffer if any).
 

+This is obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

 \wxheading{Parameters}
 
 \docparam{stream}{Stream to associate with the debug context. Do not set this to NULL.}
 \wxheading{Parameters}
 
 \docparam{stream}{Stream to associate with the debug context. Do not set this to NULL.}


@@ -231,10 +262,16 @@ Windows, an ostream constructed with this buffer outputs
 to the debugger, or other program that intercepts debugging
 output. On other platforms, the output goes to standard error (cerr).
 
 to the debugger, or other program that intercepts debugging
 output. On other platforms, the output goes to standard error (cerr).
 

+This is soon to be obsolete, replaced by \helpref{wxLog}{wxlog} functionality.
+

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

+\wxheading{Include files}
+
+<wx/memory.h>
+

 \wxheading{Example}
 
 \begin{verbatim}
 \wxheading{Example}
 
 \begin{verbatim}