Public Member Functions

ComponentMovementWatcher Class Reference

An object that watches for any movement of a component or any of its parent components. More...

Inherits ComponentListener.

Inherited by CarbonViewWrapperComponent.

List of all members.

Public Member Functions

 ComponentMovementWatcher (Component *component)
 Creates a ComponentMovementWatcher to watch a given target component.
 ~ComponentMovementWatcher ()
 Destructor.
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.
virtual void componentPeerChanged ()=0
 This callback happens when the component's top-level peer is changed.
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 componentParentHierarchyChanged (Component &component)
 Called to indicate that the component's parents have changed.
void componentMovedOrResized (Component &component, bool wasMoved, bool wasResized)
 Called when the component's position or size changes.
void componentBeingDeleted (Component &component)
 Called when the component is in the process of being deleted.
void componentVisibilityChanged (Component &component)
 Called when the component is made visible or invisible.

Detailed Description

An object that watches for any movement of a component or any of its parent components.

This makes it easy to check when a component is moved relative to its top-level peer window. The normal Component::moved() method is only called when a component moves relative to its immediate parent, and sometimes you want to know if any of components higher up the tree have moved (which of course will affect the overall position of all their sub-components).

It also includes a callback that lets you know when the top-level peer is changed.

This class is used by specialised components like OpenGLComponent or QuickTimeComponent because they need to keep their custom windows in the right place and respond to changes in the peer.


Constructor & Destructor Documentation

ComponentMovementWatcher::ComponentMovementWatcher ( Component component )

Creates a ComponentMovementWatcher to watch a given target component.

ComponentMovementWatcher::~ComponentMovementWatcher (  )

Destructor.


Member Function Documentation

virtual void ComponentMovementWatcher::componentMovedOrResized ( bool  wasMoved,
bool  wasResized 
) [pure 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.

Implemented in CarbonViewWrapperComponent.

virtual void ComponentMovementWatcher::componentPeerChanged (  ) [pure virtual]

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

Implemented in CarbonViewWrapperComponent.

virtual void ComponentMovementWatcher::componentVisibilityChanged (  ) [pure virtual]

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

Implemented in CarbonViewWrapperComponent.

void ComponentMovementWatcher::componentParentHierarchyChanged ( Component component ) [virtual]

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:
componentthe component that this listener is registered with
See also:
Component::parentHierarchyChanged

Reimplemented from ComponentListener.

void ComponentMovementWatcher::componentMovedOrResized ( Component component,
bool  wasMoved,
bool  wasResized 
) [virtual]

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 ComponentListener.

void ComponentMovementWatcher::componentBeingDeleted ( Component component ) [virtual]

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!

Reimplemented from ComponentListener.

void ComponentMovementWatcher::componentVisibilityChanged ( Component component ) [virtual]

Called when the component is made visible or invisible.

Parameters:
componentthe component that changed
See also:
Component::setVisible

Reimplemented from ComponentListener.


The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Defines