JUCE-7.0.12-0-g4f43011b96 JUCE-7.0.12-0-g4f43011b96
JUCE — C++ application framework with suport for VST, VST3, LV2 audio plug-ins

« « « Anklang Documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
juce::ModalComponentManager::ModalItem Struct Referencefinal
Inheritance diagram for juce::ModalComponentManager::ModalItem:
juce::ComponentMovementWatcher juce::ComponentListener

Public Member Functions

 ModalItem (Component *comp, bool shouldAutoDelete)
 
void componentMovedOrResized (bool, bool) override
 This callback happens when the component that is being watched is moved relative to its top-level peer window, or when it is resized.
 
void componentPeerChanged () override
 This callback happens when the component's top-level peer is changed.
 
void componentVisibilityChanged () override
 This callback happens when the component's visibility state changes, possibly due to one of its parents being made visible or invisible.
 
void componentBeingDeleted (Component &comp) override
 Called when the component is in the process of being deleted.
 
void cancel ()
 
virtual void componentMovedOrResized (bool wasMoved, bool wasResized)=0
 This callback happens when the component that is being watched is moved relative to its top-level peer window, or when it is resized.
 
void componentMovedOrResized (Component &, bool wasMoved, bool wasResized) override
 Called when the component's position or size changes.
 
virtual void componentVisibilityChanged ()=0
 This callback happens when the component's visibility state changes, possibly due to one of its parents being made visible or invisible.
 
void componentVisibilityChanged (Component &) override
 Called when the component is made visible or invisible.
 
- Public Member Functions inherited from juce::ComponentMovementWatcher
 ComponentMovementWatcher (Component *componentToWatch)
 Creates a ComponentMovementWatcher to watch a given target component.
 
 ~ComponentMovementWatcher () override
 Destructor.
 
ComponentgetComponent () const noexcept
 Returns the component that's being watched.
 
void componentParentHierarchyChanged (Component &) override
 Called to indicate that the component's parents have changed.
 
- Public Member Functions inherited from juce::ComponentListener
virtual ~ComponentListener ()=default
 Destructor.
 
virtual void componentBroughtToFront (Component &component)
 Called when the component is brought to the top of the z-order.
 
virtual void componentChildrenChanged (Component &component)
 Called when the component has children added or removed, or their z-order changes.
 
virtual void componentNameChanged (Component &component)
 Called when the component's name is changed.
 
virtual void componentEnablementChanged (Component &component)
 

Public Attributes

Componentcomponent
 
OwnedArray< Callbackcallbacks
 
int returnValue
 
bool isActive
 
bool autoDelete
 

Detailed Description

Definition at line 29 of file juce_ModalComponentManager.cpp.

Constructor & Destructor Documentation

◆ ModalItem()

juce::ModalComponentManager::ModalItem::ModalItem ( Component comp,
bool  shouldAutoDelete 
)

Definition at line 31 of file juce_ModalComponentManager.cpp.

◆ ~ModalItem()

juce::ModalComponentManager::ModalItem::~ModalItem ( )
override

Definition at line 38 of file juce_ModalComponentManager.cpp.

Member Function Documentation

◆ cancel()

void juce::ModalComponentManager::ModalItem::cancel ( )

Definition at line 72 of file juce_ModalComponentManager.cpp.

◆ componentBeingDeleted()

void juce::ModalComponentManager::ModalItem::componentBeingDeleted ( Component component)
overridevirtual

Called when the component is in the process of being deleted.

This callback is made from inside the destructor, so be very, very cautious about what you do in here.

In particular, bear in mind that it's the Component base class's destructor that calls this - so if the object that's being deleted is a subclass of Component, then the subclass layers of the object will already have been destructed when it gets to this point!

Parameters
componentthe component that was deleted

Reimplemented from juce::ComponentMovementWatcher.

Definition at line 61 of file juce_ModalComponentManager.cpp.

◆ componentMovedOrResized() [1/3]

virtual void juce::ComponentMovementWatcher::componentMovedOrResized ( bool  wasMoved,
bool  wasResized 
)
virtual

This callback happens when the component that is being watched is moved relative to its top-level peer window, or when it is resized.

Implements juce::ComponentMovementWatcher.

◆ componentMovedOrResized() [2/3]

void juce::ModalComponentManager::ModalItem::componentMovedOrResized ( bool  wasMoved,
bool  wasResized 
)
overridevirtual

This callback happens when the component that is being watched is moved relative to its top-level peer window, or when it is resized.

Implements juce::ComponentMovementWatcher.

Definition at line 44 of file juce_ModalComponentManager.cpp.

◆ componentMovedOrResized() [3/3]

void juce::ComponentMovementWatcher::componentMovedOrResized ( Component component,
bool  wasMoved,
bool  wasResized 
)
overridevirtual

Called when the component's position or size changes.

Parameters
componentthe component that was moved or resized
wasMovedtrue if the component's top-left corner has just moved
wasResizedtrue if the component's width or height has just changed
See also
Component::setBounds, Component::resized, Component::moved

Reimplemented from juce::ComponentMovementWatcher.

Definition at line 76 of file juce_ComponentMovementWatcher.cpp.

◆ componentPeerChanged()

void juce::ModalComponentManager::ModalItem::componentPeerChanged ( )
overridevirtual

This callback happens when the component's top-level peer is changed.

Implements juce::ComponentMovementWatcher.

Definition at line 48 of file juce_ModalComponentManager.cpp.

◆ componentVisibilityChanged() [1/3]

void juce::ModalComponentManager::ModalItem::componentVisibilityChanged ( )
overridevirtual

This callback happens when the component's visibility state changes, possibly due to one of its parents being made visible or invisible.

Implements juce::ComponentMovementWatcher.

Definition at line 53 of file juce_ModalComponentManager.cpp.

◆ componentVisibilityChanged() [2/3]

virtual void juce::ComponentMovementWatcher::componentVisibilityChanged ( )
virtual

This callback happens when the component's visibility state changes, possibly due to one of its parents being made visible or invisible.

Implements juce::ComponentMovementWatcher.

◆ componentVisibilityChanged() [3/3]

void juce::ComponentMovementWatcher::componentVisibilityChanged ( Component component)
overridevirtual

Called when the component is made visible or invisible.

Parameters
componentthe component that changed
See also
Component::setVisible

Reimplemented from juce::ComponentMovementWatcher.

Definition at line 80 of file juce_ComponentMovementWatcher.cpp.

Member Data Documentation

◆ autoDelete

bool juce::ModalComponentManager::ModalItem::autoDelete

Definition at line 86 of file juce_ModalComponentManager.cpp.

◆ callbacks

OwnedArray<Callback> juce::ModalComponentManager::ModalItem::callbacks

Definition at line 84 of file juce_ModalComponentManager.cpp.

◆ component

Component* juce::ModalComponentManager::ModalItem::component

Definition at line 83 of file juce_ModalComponentManager.cpp.

◆ isActive

bool juce::ModalComponentManager::ModalItem::isActive

Definition at line 86 of file juce_ModalComponentManager.cpp.

◆ returnValue

int juce::ModalComponentManager::ModalItem::returnValue

Definition at line 85 of file juce_ModalComponentManager.cpp.


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