adjusted indentation with astyle; added Id keyword
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -9,27 +9,27 @@
|
||||
/**
|
||||
@class wxScopedPtr
|
||||
@wxheader{ptr_scpd.h}
|
||||
|
||||
This is a simple scoped smart pointer implementation that is similar to
|
||||
|
||||
This is a simple scoped smart pointer implementation that is similar to
|
||||
the Boost smart pointers but rewritten to
|
||||
use macros instead.
|
||||
|
||||
|
||||
Since wxWidgets 2.9.0 there is also a templated version of this class
|
||||
with the same name. See wxScopedPtrT.
|
||||
|
||||
|
||||
A smart pointer holds a pointer to an object. The memory used by the object is
|
||||
deleted when the smart pointer goes out of scope. This class is different from
|
||||
the @c std::auto_ptr in so far as it doesn't provide copy constructor
|
||||
nor assignment operator. This limits what you can do with it but is much less
|
||||
surprizing than the "destructive copy'' behaviour of the standard class.
|
||||
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
|
||||
@seealso
|
||||
wxScopedArray
|
||||
*/
|
||||
class wxScopedPtr
|
||||
class wxScopedPtr
|
||||
{
|
||||
public:
|
||||
/**
|
||||
@@ -63,42 +63,42 @@ public:
|
||||
const T* operator -();
|
||||
|
||||
/**
|
||||
Returns the currently hold pointer and resets the smart pointer object to
|
||||
Returns the currently hold pointer and resets the smart pointer object to
|
||||
@NULL. After a call to this function the caller is responsible for
|
||||
deleting the pointer.
|
||||
*/
|
||||
T * release();
|
||||
|
||||
/**
|
||||
Deletes the currently held pointer and sets it to @e p or to @NULL if no
|
||||
Deletes the currently held pointer and sets it to @e 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.
|
||||
*/
|
||||
reset(T p = @NULL);
|
||||
reset(T p = @NULL);
|
||||
|
||||
/**
|
||||
Swap the pointer inside the smart pointer with @e other. The pointer being
|
||||
swapped must be of the same type (hence the same class name).
|
||||
*/
|
||||
swap(wxScopedPtr amp; other);
|
||||
swap(wxScopedPtr amp; other);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
@class wxScopedArray
|
||||
@wxheader{ptr_scpd.h}
|
||||
|
||||
This is a simple scoped smart pointer array implementation that is similar to
|
||||
|
||||
This is a simple scoped smart pointer array implementation that is similar to
|
||||
the Boost smart pointers but rewritten to
|
||||
use macros instead.
|
||||
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
|
||||
@seealso
|
||||
wxScopedPtr
|
||||
*/
|
||||
class wxScopedArray
|
||||
class wxScopedArray
|
||||
{
|
||||
public:
|
||||
/**
|
||||
@@ -120,24 +120,24 @@ public:
|
||||
const T operator [](long int i);
|
||||
|
||||
/**
|
||||
Deletes the currently held pointer and sets it to 'p' or to @NULL if no
|
||||
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.
|
||||
*/
|
||||
reset(T p = @NULL);
|
||||
reset(T p = @NULL);
|
||||
|
||||
/**
|
||||
Swap the pointer inside the smart pointer with 'ot'. The pointer being swapped
|
||||
must be of the same type (hence the same class name).
|
||||
*/
|
||||
swap(wxScopedPtr amp; ot);
|
||||
swap(wxScopedPtr amp; ot);
|
||||
};
|
||||
|
||||
|
||||
/**
|
||||
@class wxScopedTiedPtr
|
||||
@wxheader{ptr_scpd.h}
|
||||
|
||||
|
||||
This is a variation on the topic of wxScopedPtr. This
|
||||
class is also a smart pointer but in addition it "ties'' the pointer value to
|
||||
another variable. In other words, during the life time of this class the value
|
||||
@@ -145,16 +145,16 @@ public:
|
||||
it is reset to its old value when the object is destroyed. This class is
|
||||
especially useful when converting the existing code (which may already store
|
||||
the pointers value in some variable) to the smart pointers.
|
||||
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
*/
|
||||
class wxScopedTiedPtr
|
||||
class wxScopedTiedPtr
|
||||
{
|
||||
public:
|
||||
/**
|
||||
Constructor creates a smart pointer initialized with @e ptr and stores
|
||||
@e ptr in the location specified by @e ppTie which must not be
|
||||
Constructor creates a smart pointer initialized with @e ptr and stores
|
||||
@e ptr in the location specified by @e ppTie which must not be
|
||||
@NULL.
|
||||
*/
|
||||
wxScopedTiedPtr(T ** ppTie, T * ptr);
|
||||
@@ -165,7 +165,7 @@ public:
|
||||
to the old value.
|
||||
|
||||
Warning: this location may now contain an uninitialized value if it hadn't been
|
||||
initialized previously, in particular don't count on it magically being
|
||||
initialized previously, in particular don't count on it magically being
|
||||
@NULL!
|
||||
*/
|
||||
~wxScopedTiedPtr();
|
||||
@@ -175,17 +175,17 @@ public:
|
||||
/**
|
||||
@class wxScopedPtrT
|
||||
@wxheader{ptr_scpd.h}
|
||||
|
||||
|
||||
A scoped pointer template class. It is the template version of
|
||||
the old-style @ref overview_wxscopedptr "scoped pointer macros".
|
||||
|
||||
|
||||
@library{wxbase}
|
||||
@category{FIXME}
|
||||
|
||||
|
||||
@seealso
|
||||
wxSharedPtr, wxWeakRef
|
||||
*/
|
||||
class wxScopedPtr<T>
|
||||
class wxScopedPtr<T>
|
||||
{
|
||||
public:
|
||||
/**
|
||||
@@ -204,12 +204,12 @@ public:
|
||||
T * get();
|
||||
|
||||
/**
|
||||
Conversion to a boolean expression (in a variant which is not
|
||||
Conversion to a boolean expression (in a variant which is not
|
||||
convertable to anything but a boolean expression). If this class
|
||||
contains a valid pointer it will return @e @true, if it contains
|
||||
a @NULL pointer it will return @e @false.
|
||||
*/
|
||||
operator unspecified_bool_type();
|
||||
operator unspecified_bool_type();
|
||||
|
||||
/**
|
||||
Returns a reference to the object. If the internal pointer is @NULL
|
||||
@@ -218,7 +218,7 @@ public:
|
||||
T operator*();
|
||||
|
||||
/**
|
||||
Returns pointer to object. If the pointer is @NULL this method will
|
||||
Returns pointer to object. If the pointer is @NULL this method will
|
||||
cause an assert in debug mode.
|
||||
*/
|
||||
T * operator-();
|
||||
|
Reference in New Issue
Block a user