juce::DropShadower Class Reference

Adds a drop-shadow to a component. More...

#include <juce_DropShadower.h>

Inheritance diagram for juce::DropShadower:

Collaboration diagram for juce::DropShadower:

Public Member Functions
	DropShadower (const DropShadow &shadowType)
	Creates a DropShadower. More...
	~DropShadower () override
	Destructor. More...
void	setOwner (Component *componentToFollow)
	Attaches the DropShadower to the component you want to shadow. More...

Private Member Functions
virtual void	componentBeingDeleted (Component &component)
	Called when the component is in the process of being deleted. More...
void	componentBroughtToFront (Component &) override
	Called when the component is brought to the top of the z-order. More...
void	componentChildrenChanged (Component &) override
	Called when the component has children added or removed, or their z-order changes. More...
virtual void	componentEnablementChanged (Component &component)
void	componentMovedOrResized (Component &, bool, bool) override
	Called when the component's position or size changes. More...
virtual void	componentNameChanged (Component &component)
	Called when the component's name is changed. More...
void	componentParentHierarchyChanged (Component &) override
	Called to indicate that the component's parents have changed. More...
void	componentVisibilityChanged (Component &) override
	Called when the component is made visible or invisible. More...
void	updateParent ()
void	updateShadows ()

Private Attributes
WeakReference< Component >	lastParentComp
WeakReference< Component >	owner
bool	reentrant = false
DropShadow	shadow
OwnedArray< Component >	shadowWindows
std::unique_ptr< ParentVisibilityChangedListener >	visibilityChangedListener

Detailed Description

Adds a drop-shadow to a component.

This object creates and manages a set of components which sit around a component, creating a gaussian shadow around it. The components will track the position of the component and if it's brought to the front they'll also follow this.

For desktop windows you don't need to use this class directly - just set the Component::windowHasDropShadow flag when calling Component::addToDesktop(), and the system will create one of these if it's needed (which it obviously isn't on the Mac, for example).

@tags{GUI}

Constructor & Destructor Documentation

DropShadower()

juce::DropShadower::DropShadower

(

const DropShadow &

shadowType

)

Creates a DropShadower.

~DropShadower()

juce::DropShadower::~DropShadower ( )

override

Destructor.

Member Function Documentation

componentBeingDeleted()

virtual void juce::ComponentListener::componentBeingDeleted ( Component &  component )

virtualinherited

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

component

the component that was deleted

Reimplemented in juce::ComponentMovementWatcher, and juce::RelativeCoordinatePositionerBase.

componentBroughtToFront()

void juce::DropShadower::componentBroughtToFront ( Component &  component )

overrideprivatevirtual

Called when the component is brought to the top of the z-order.

Parameters

component

the component that was moved

See also

Component::toFront, Component::broughtToFront

Reimplemented from juce::ComponentListener.

componentChildrenChanged()

void juce::DropShadower::componentChildrenChanged ( Component &  component )

overrideprivatevirtual

Called when the component has children added or removed, or their z-order changes.

Parameters

component

the component whose children have changed

See also

Component::childrenChanged, Component::addChildComponent, Component::removeChildComponent

Reimplemented from juce::ComponentListener.

componentEnablementChanged()

virtual void juce::ComponentListener::componentEnablementChanged ( Component &  component )

virtualinherited

componentMovedOrResized()

void juce::DropShadower::componentMovedOrResized ( Component &  component, bool  wasMoved, bool  wasResized  )

overrideprivatevirtual

Called when the component's position or size changes.

Parameters

component	the component that was moved or resized
wasMoved	true if the component's top-left corner has just moved
wasResized	true if the component's width or height has just changed

See also

Component::setBounds, Component::resized, Component::moved

Reimplemented from juce::ComponentListener.

componentNameChanged()

virtual void juce::ComponentListener::componentNameChanged ( Component &  component )

virtualinherited

Called when the component's name is changed.

Parameters

component

the component that had its name changed

See also

Component::setName, Component::getName

Reimplemented in juce::MultiDocumentPanel.

componentParentHierarchyChanged()

void juce::DropShadower::componentParentHierarchyChanged ( Component &  component )

overrideprivatevirtual

Called to indicate that the component's parents have changed.

When a component is added or removed from its parent, all of its children will produce this notification (recursively - so all children of its children will also be called as well).

Parameters

component

the component that this listener is registered with

See also

Component::parentHierarchyChanged

Reimplemented from juce::ComponentListener.

componentVisibilityChanged()

void juce::DropShadower::componentVisibilityChanged ( Component &  component )

overrideprivatevirtual

Called when the component is made visible or invisible.

Parameters

component

the component that changed

See also

Component::setVisible

Reimplemented from juce::ComponentListener.

setOwner()

void juce::DropShadower::setOwner

(

Component *

componentToFollow

)

Attaches the DropShadower to the component you want to shadow.

updateParent()

void juce::DropShadower::updateParent ( )

private

updateShadows()

void juce::DropShadower::updateShadows ( )

private

Member Data Documentation

lastParentComp

WeakReference<Component> juce::DropShadower::lastParentComp

private

owner

WeakReference<Component> juce::DropShadower::owner

private

reentrant

bool juce::DropShadower::reentrant = false

private

shadow

DropShadow juce::DropShadower::shadow

private

shadowWindows

OwnedArray<Component> juce::DropShadower::shadowWindows

private

visibilityChangedListener

std::unique_ptr<ParentVisibilityChangedListener> juce::DropShadower::visibilityChangedListener

private

---

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

• juce_DropShadower.h