VWLib REFERENCE MANUAL

NAME

vwTextFrame -

A frame class that supports labels.

INHERITS FROM

vwFrame, vwLabel

HEADER FILE

#include <vwTextFrame.h>

PUBLIC METHOD SUMMARY

vwTextFrame::vwTextFrame (

vwMediator * concreteMediator, pfSCS * scs);

virtual vwTextFrame::~vwTextFrame (

void);

INHERITED PUBLIC METHODS

   Inherited from vwFrame

inline int vwFrame::isGeneric (

void);

   Inherited from vwLabel

void vwLabel::setLabelColor (

float * rgba);

void vwLabel::setLabelText (

vwWidget::wdgStruct *widget_struct, pfFont *font);

void vwLabel::addToLabel (

char *word, int column, int row);

void vwLabel::initLabelParms (

pfFont * font, int total_words=1, int total_rows=1);

inline void vwLabel::setLabelSize (

float size=1.0);

inline void vwLabel::setLabelVSpc (

float verticalSpacing=1.0);

inline void vwLabel::setExtrudeSize (

float size=1.0);

inline void vwLabel::setSpacingScale (

float horiz=1.0, float vert=1.0, float depth=1.0);

inline void vwLabel::setLabelHeight (

float hight=0.0);

inline void vwLabel::setFlatten (

int flatten=True);

inline void vwLabel::clearLabel (

void);

   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

vwTextFrame is frame class that supports labels. By default, its activeState is set to False (see vwWidget::setActive()) so that it does not generate events. Its primary function is to enhance other widgets with informative text.

METHOD DESCRIPTIONS

   vwTextFrame()

vwTextFrame (

vwMediator *concreteMediator, pfSCS *scs);

Construct a textFrame.

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

*scs specifies a pointer to a Performer pfSCS containing the textFrame's geometry.

   ~vwTextFrame()

virtual ~vwTextFrame (

void);

Destruct an instance.

SEE ALSO

vwFrame, vwLabel