Gnash  0.8.11dev
Public Member Functions | List of all members
gnash::DragState Class Reference

What is being dragged and how. More...

#include <DragState.h>

Public Member Functions

 DragState (DisplayObject *d, bool lock)
 
bool isLockCentered () const
 
void setOffset (std::int32_t x, std::int32_t y)
 
std::int32_t xOffset () const
 
std::int32_t yOffset () const
 
bool hasBounds () const
 
const SWFRectgetBounds () const
 Get the boundaries to constraint the drag into. More...
 
void setBounds (const SWFRect &bounds)
 Set the boundaries to constraint the drag into. More...
 
DisplayObjectgetCharacter () const
 May return NULL !! More...
 
void reset ()
 Reset drag state to its initial condition. More...
 
void markReachableResources () const
 Mark DisplayObject as reachable (if any) More...
 

Detailed Description

What is being dragged and how.

Constructor & Destructor Documentation

§ DragState()

gnash::DragState::DragState ( DisplayObject d,
bool  lock 
)
inline

Member Function Documentation

§ getBounds()

const SWFRect& gnash::DragState::getBounds ( ) const
inline

Get the boundaries to constraint the drag into.

Coordinates of the rectangle are expected in TWIPS.

Note that if hasBounds() is false the returned rectangle is the NULL rectangle - see SWFRect::is_null().

§ getCharacter()

DisplayObject* gnash::DragState::getCharacter ( ) const
inline

May return NULL !!

§ hasBounds()

bool gnash::DragState::hasBounds ( ) const
inline

§ isLockCentered()

bool gnash::DragState::isLockCentered ( ) const
inline

§ markReachableResources()

void gnash::DragState::markReachableResources ( ) const
inline

Mark DisplayObject as reachable (if any)

References gnash::GcResource::setReachable().

§ reset()

void gnash::DragState::reset ( )
inline

Reset drag state to its initial condition.

§ setBounds()

void gnash::DragState::setBounds ( const SWFRect bounds)
inline

Set the boundaries to constraint the drag into.

Coordinates of the rectangle are expected in TWIPS.

§ setOffset()

void gnash::DragState::setOffset ( std::int32_t  x,
std::int32_t  y 
)
inline

Set displacement offset from origin at time of drag start. Coordinates are in stage space (twips)

References x, and y.

§ xOffset()

std::int32_t gnash::DragState::xOffset ( ) const
inline

§ yOffset()

std::int32_t gnash::DragState::yOffset ( ) const
inline

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