openshot-audio  0.1.7
Public Member Functions | List of all members
juce::OptionalScopedPointer< ObjectType > Class Template Reference

#include <juce_core.h>

Public Member Functions

 OptionalScopedPointer ()
 
 OptionalScopedPointer (ObjectType *objectToHold, bool takeOwnership)
 
 OptionalScopedPointer (OptionalScopedPointer &objectToTransferFrom)
 
OptionalScopedPointeroperator= (OptionalScopedPointer &objectToTransferFrom)
 
 ~OptionalScopedPointer ()
 
 operator ObjectType * () const noexcept
 
ObjectType * get () const noexcept
 
ObjectType & operator* () const noexcept
 
ObjectType * operator-> () const noexcept
 
ObjectType * release () noexcept
 
void clear ()
 
void set (ObjectType *newObject, bool takeOwnership)
 
void setOwned (ObjectType *newObject)
 
void setNonOwned (ObjectType *newObject)
 
bool willDeleteObject () const noexcept
 
void swapWith (OptionalScopedPointer< ObjectType > &other) noexcept
 

Detailed Description

template<class ObjectType>
class juce::OptionalScopedPointer< ObjectType >

Holds a pointer to an object which can optionally be deleted when this pointer goes out of scope.

This acts in many ways like a ScopedPointer, but allows you to specify whether or not the object is deleted.

See Also
ScopedPointer

Constructor & Destructor Documentation

template<class ObjectType>
juce::OptionalScopedPointer< ObjectType >::OptionalScopedPointer ( )
inline

Creates an empty OptionalScopedPointer.

template<class ObjectType>
juce::OptionalScopedPointer< ObjectType >::OptionalScopedPointer ( ObjectType *  objectToHold,
bool  takeOwnership 
)
inline

Creates an OptionalScopedPointer to point to a given object, and specifying whether the OptionalScopedPointer will delete it.

If takeOwnership is true, then the OptionalScopedPointer will act like a ScopedPointer, deleting the object when it is itself deleted. If this parameter is false, then the OptionalScopedPointer just holds a normal pointer to the object, and won't delete it.

template<class ObjectType>
juce::OptionalScopedPointer< ObjectType >::OptionalScopedPointer ( OptionalScopedPointer< ObjectType > &  objectToTransferFrom)
inline

Takes ownership of the object that another OptionalScopedPointer holds.

Like a normal ScopedPointer, the objectToTransferFrom object will become null, as ownership of the managed object is transferred to this object.

The flag to indicate whether or not to delete the managed object is also copied from the source object.

template<class ObjectType>
juce::OptionalScopedPointer< ObjectType >::~OptionalScopedPointer ( )
inline

The destructor may or may not delete the object that is being held, depending on the takeOwnership flag that was specified when the object was first passed into an OptionalScopedPointer constructor.

Member Function Documentation

template<class ObjectType>
void juce::OptionalScopedPointer< ObjectType >::clear ( )
inline

Resets this pointer to null, possibly deleting the object that it holds, if it has ownership of it.

template<class ObjectType>
ObjectType* juce::OptionalScopedPointer< ObjectType >::get ( ) const
inlinenoexcept

Returns the object that this pointer is managing.

template<class ObjectType>
juce::OptionalScopedPointer< ObjectType >::operator ObjectType * ( ) const
inlinenoexcept

Returns the object that this pointer is managing.

template<class ObjectType>
ObjectType& juce::OptionalScopedPointer< ObjectType >::operator* ( ) const
inlinenoexcept

Returns the object that this pointer is managing.

template<class ObjectType>
ObjectType* juce::OptionalScopedPointer< ObjectType >::operator-> ( ) const
inlinenoexcept

Lets you access methods and properties of the object that this pointer is holding.

template<class ObjectType>
OptionalScopedPointer& juce::OptionalScopedPointer< ObjectType >::operator= ( OptionalScopedPointer< ObjectType > &  objectToTransferFrom)
inline

Takes ownership of the object that another OptionalScopedPointer holds.

Like a normal ScopedPointer, the objectToTransferFrom object will become null, as ownership of the managed object is transferred to this object.

The ownership flag that says whether or not to delete the managed object is also copied from the source object.

template<class ObjectType>
ObjectType* juce::OptionalScopedPointer< ObjectType >::release ( )
inlinenoexcept

Removes the current object from this OptionalScopedPointer without deleting it. This will return the current object, and set this OptionalScopedPointer to a null pointer.

template<class ObjectType>
void juce::OptionalScopedPointer< ObjectType >::set ( ObjectType *  newObject,
bool  takeOwnership 
)
inline

Makes this OptionalScopedPointer point at a new object, specifying whether the OptionalScopedPointer will take ownership of the object.

If takeOwnership is true, then the OptionalScopedPointer will act like a ScopedPointer, deleting the object when it is itself deleted. If this parameter is false, then the OptionalScopedPointer just holds a normal pointer to the object, and won't delete it.

template<class ObjectType>
void juce::OptionalScopedPointer< ObjectType >::setNonOwned ( ObjectType *  newObject)
inline

Makes this OptionalScopedPointer point at a new object, but will not take ownership of that object.

template<class ObjectType>
void juce::OptionalScopedPointer< ObjectType >::setOwned ( ObjectType *  newObject)
inline

Makes this OptionalScopedPointer point at a new object, and take ownership of that object.

template<class ObjectType>
void juce::OptionalScopedPointer< ObjectType >::swapWith ( OptionalScopedPointer< ObjectType > &  other)
inlinenoexcept

Swaps this object with another OptionalScopedPointer. The two objects simply exchange their states.

template<class ObjectType>
bool juce::OptionalScopedPointer< ObjectType >::willDeleteObject ( ) const
inlinenoexcept

Returns true if the target object will be deleted when this pointer object is deleted.


The documentation for this class was generated from the following file: