.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxDebugContext 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxDebugContext \- 
  Provides memory-checking facilities
 
.SH DESCRIPTION

  


   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 wxWidgets, i.e. if the __WXDEBUG__ symbol is
   defined. wxDebugContext and related functions and macros can be compiled out
   by setting wxUSE_DEBUG_CONTEXT to 0 is setup.h
  
 
.SH "PARENTS"

.SH "INCLUDE FILES"
wx/memory.h
.SH MEMBERS

  
.SS int Check ()

     


      Checks the memory blocks for errors, starting from the currently set
      checkpoint.
     
    
   
  
.SS bool Dump ()

     


      Performs a memory dump from the currently set checkpoint, writing to the
      current debug stream. Calls the
      
       Dump
      
      member function for each wxObject derived instance.
     
    
   
  
.SS bool GetCheckPrevious ()

     


      Returns true if the memory allocator checks all previous memory blocks for
      errors. By default, this is false since it slows down execution
      considerably.
     
    
   
  
.SS bool GetDebugMode ()

     


      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.
     
    
   
  
.SS int GetLevel ()

     


      Gets the debug level (default 1). The debug level is used by the
      wxTraceLevel function and 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.
     
     


      This is obsolete, replaced by
      wxLog
      functionality.
     
    
   
  
.SS ostream& GetStream ()

     


      Returns the output stream associated with the debug context.
     
     


      This is obsolete, replaced by
      wxLog
      functionality.
     
    
   
  
.SS streambuf* GetStreamBuf ()

     


      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.
     
     


      This is obsolete, replaced by
      wxLog
      functionality.
     
    
   
  
.SS bool HasStream ()

   
  
.SS bool PrintClasses ()

     


      Prints a list of the classes declared in this application, giving
      derivation and whether instances of this class can be dynamically created.
     
    
   
  
.SS bool PrintStatistics (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
      allocations is printed, together with the total size.
     
    
   
  
.SS void SetCheckpoint (bool all = false)

     


      Sets the current checkpoint: Dump and PrintStatistics operations will be
      performed from this point on. This allows you to ignore allocations that
      have been performed up to this point.
     
    
   
  
.SS void SetCheckPrevious (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.
     
    
   
  
.SS void SetDebugMode (bool debug)

     


      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.
     
     


      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 exist.
     
    
   
  
.SS bool SetFile (const wxString& filename)

     


      Sets the current debug file and creates a stream. This will delete any
      existing stream and stream buffer. By default, the debug context stream
      outputs to the debugger (Windows) or standard error (other platforms).
     
    
   
  
.SS void SetLevel (int level)

     


      Sets the debug level (default 1). The debug level is used by the
      wxTraceLevel function and 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.
     
     


      This is obsolete, replaced by
      wxLog
      functionality.
     
    
   
  
.SS bool SetStandardError ()

     


      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
      wxLog
      functionality.
     
    
   
  
.SS void SetStream (ostream* streamstreambuf* streamBuf = NULL)

 
.SH "SEE ALSO"

  Overview
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.