openshot-audio  0.1.5
Public Member Functions | List of all members
juce::Component::SafePointer< ComponentType > Class Template Reference

#include <juce_gui_basics.h>

Public Member Functions

 SafePointer () noexcept
 
 SafePointer (ComponentType *component)
 
 SafePointer (const SafePointer &other) noexcept
 
SafePointeroperator= (const SafePointer &other)
 
SafePointeroperator= (ComponentType *newComponent)
 
ComponentType * getComponent () const noexcept
 
 operator ComponentType * () const noexcept
 
ComponentType * operator-> () noexcept
 
const ComponentType * operator-> () const noexcept
 
void deleteAndZero ()
 
bool operator== (ComponentType *component) const noexcept
 
bool operator!= (ComponentType *component) const noexcept
 

Detailed Description

template<class ComponentType>
class juce::Component::SafePointer< ComponentType >

Holds a pointer to some type of Component, which automatically becomes null if the component is deleted.

If you're using a component which may be deleted by another event that's outside of your control, use a SafePointer instead of a normal pointer to refer to it, and you can test whether it's null before using it to see if something has deleted it.

The ComponentType typedef must be Component, or some subclass of Component.

You may also want to use a WeakReference<Component> object for the same purpose.

Constructor & Destructor Documentation

◆ SafePointer() [1/3]

template<class ComponentType>
juce::Component::SafePointer< ComponentType >::SafePointer ( )
inlinenoexcept

Creates a null SafePointer.

◆ SafePointer() [2/3]

template<class ComponentType>
juce::Component::SafePointer< ComponentType >::SafePointer ( ComponentType *  component)
inline

Creates a SafePointer that points at the given component.

◆ SafePointer() [3/3]

template<class ComponentType>
juce::Component::SafePointer< ComponentType >::SafePointer ( const SafePointer< ComponentType > &  other)
inlinenoexcept

Creates a copy of another SafePointer.

Member Function Documentation

◆ deleteAndZero()

template<class ComponentType>
void juce::Component::SafePointer< ComponentType >::deleteAndZero ( )
inline

If the component is valid, this deletes it and sets this pointer to null.

◆ getComponent()

template<class ComponentType>
ComponentType* juce::Component::SafePointer< ComponentType >::getComponent ( ) const
inlinenoexcept

Returns the component that this pointer refers to, or null if the component no longer exists.

◆ operator ComponentType *()

template<class ComponentType>
juce::Component::SafePointer< ComponentType >::operator ComponentType * ( ) const
inlinenoexcept

Returns the component that this pointer refers to, or null if the component no longer exists.

◆ operator!=()

template<class ComponentType>
bool juce::Component::SafePointer< ComponentType >::operator!= ( ComponentType *  component) const
inlinenoexcept

◆ operator->() [1/2]

template<class ComponentType>
ComponentType* juce::Component::SafePointer< ComponentType >::operator-> ( )
inlinenoexcept

Returns the component that this pointer refers to, or null if the component no longer exists.

◆ operator->() [2/2]

template<class ComponentType>
const ComponentType* juce::Component::SafePointer< ComponentType >::operator-> ( ) const
inlinenoexcept

Returns the component that this pointer refers to, or null if the component no longer exists.

◆ operator=() [1/2]

template<class ComponentType>
SafePointer& juce::Component::SafePointer< ComponentType >::operator= ( const SafePointer< ComponentType > &  other)
inline

Copies another pointer to this one.

◆ operator=() [2/2]

template<class ComponentType>
SafePointer& juce::Component::SafePointer< ComponentType >::operator= ( ComponentType *  newComponent)
inline

Copies another pointer to this one.

◆ operator==()

template<class ComponentType>
bool juce::Component::SafePointer< ComponentType >::operator== ( ComponentType *  component) const
inlinenoexcept

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