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

  


   This is a simple scoped smart pointer array implementation that is similar to
   the
   
    http://www.boost.org
   
   smart pointers but rewritten to use macros instead.
  
 
.SH "PARENTS"

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

  
.SS  wxScopedArray (type * T = NULL)

     


      Creates the smart pointer with the given pointer or none if NULL. On
      compilers that support it, this uses the explicit keyword.
     
    
   
  
.SS void reset (T * = NULL)

     


      Deletes the currently held pointer and sets it to 'p' or to NULL if no
      arguments are specified. This function does check to make sure that the
      pointer you are assigning is not the same pointer that is already stored.
     
    
   
  
.SS const T & operator [] (long inti)

     


      This operator acts like the standard [] indexing operator for C++ arrays.
      The function does not do bounds checking.
     
    
   
  
.SS const T* get ()

     


      This operator gets the pointer stored in the smart pointer or returns NULL
      if there is none.
     
    
   
  
.SS void swap (wxScopedPtr & ot)

     


      Swap the pointer inside the smart pointer with 'ot'. The pointer being
      swapped must be of the same type (hence the same class name).
     
    
 
.SH EXAMPLE

  
   Below is an example of using a wxWidgets scoped smart pointer and pointer
   array.
  
  
  class MyClass { /* ... */ };

  // declare a smart pointer to a MyClass called wxMyClassPtr
  wxDECLARE_SCOPED_PTR(MyClass, wxMyClassPtr)
  // declare a smart pointer to an array of chars
  wxDECLARE_SCOPED_ARRAY(char, wxCharArray)

  ...

  // define the first pointer class, must be complete
  wxDEFINE_SCOPED_PTR(MyClass, wxMyClassPtr)
  // define the second pointer class
  wxDEFINE_SCOPED_ARRAY(char, wxCharArray)

  // create an object with a new pointer to MyClass
  wxMyClassPtr theObj(new MyClass());
  // reset the pointer (deletes the previous one)
  theObj.reset(new MyClass());

  // access the pointer
  theObj->MyFunc();

  // create an object with a new array of chars
  wxCharArray theCharObj(new char[100]);

  // access the array
  theCharObj[0] = "!";

  
   
    Declaring new smart pointer types
   
  
  
    wxDECLAR_SCOPED_ARRAY( TYPE,     // type of the values
                                CLASSNAME ); // name of the class

  
   A smart pointer holds a pointer to an object (which must be complete when
   wxDEFINE_SCOPED_ARRAY() is called). The memory used by the object is deleted
   when the smart pointer goes out of scope. The first argument of the macro is
   the pointer type, the second is the name of the new smart pointer class being
   created. Below we will use wxScopedArray to represent the scoped pointer
   array class, but the user may create the class with any legal name.
  
 
.SH "SEE ALSO"

  wxScopedPtr
 
.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.