VWLib REFERENCE MANUAL

NAME

vwFrame -

A generic frame class.

INHERITS FROM

vwWidget

HEADER FILE

#include <vwFrame.h>

PUBLIC METHOD SUMMARY

vwFrame::vwFrame (

vwMediator * concreteMediator, pfSCS * scs);

virtual vwFrame::~vwFrame (

void);

inline int vwFrame::isGeneric (

void);

INHERITED PUBLIC METHODS

   Inherited from vwWidget

virtual void vwWidget::setActive (

int activeState=True);

virtual void vwWidget::setOver (

int overState=True);

virtual void vwWidget::setVisible (

int visibiltyState=True);

inline int vwWidget::getActive (

void);

inline int vwWidget::getOver (

void);

inline int vwWidget::getPressed (

void);

inline int vwWidget::getVisible (

void);

inline int vwWidget::getDragged (

void);

inline int vwWidget::getIdent (

void);

inline int vwWidget::getInterface (

void);

void vwWidget::getColor (

wColor colorIndex, float rgba[]);

inline void vwWidget::setColor (

wColor colorIndex=ACTIVE);

void vwWidget::registerColor (

wColor colorIndex, float *rgba);

inline int vwWidget::isOfType (

wType wdg_type);

inline pfSCS * vwWidget::getSCS (

void);

inline pfDCS * vwWidget::getDCS (

void);

inline void vwWidget::getParentMtx (

pfMatrix * m);

   Inherited from vwSubject

virtual void vwSubject::attach (

vwObserver *concreteObserver);

virtual void vwSubject::detach (

vwObserver *concreteObserver);

inline void vwSubject::setSubectData (

void * data);

inline void * vwSubject::getSubjectData (

void);

inline unsigned long vwSubject::getID (

void);

INHERITED PROTECTED METHODS

   Inherited from vwWidget

virtual void vwWidget::doSetColor (

wColor colorIndex);

virtual void vwWidget::setWType (

wType widgetType);

   Inherited from vwSubject

virtual void vwSubject::notify (

void);

CLASS DESCRIPTION

vwFrame is the generic frame class publicly derived from vwWidget. Unlike most other widgets, a vwFrame will not generate events prior to a call to vwFrame::setActive(). Its Active State is set to False by default.  See vwWidget::setActive(). vwFrame's primary purpose consists of being a base-class for more sophisticated frames and for providing intersection information as a backdrop for vwSliders.

METHOD DESCRIPTIONS

   vwFrame()

vwFrame (

vwMediator *concreteMediator, pfSCS *scs);

Construct a frame.

*concreteMediator specifies a pointer to the concrete mediator of the interface being created.

*scs specifies a pointer to a Performer pfSCS containing the frame geometry.

   ~vwFrame()

virtual ~vwFrame (

void);

Destruct an instance.

   isGeneric()

inline int isGeneric (

void);

Returns True if this is a generic vwFrame, Should return False if it is a subclass of vwFrame.

SEE ALSO

vwWidget