WDS_Activation

WDS_Activation

wds

1998 12-05


CLASS

WDS_Activation - data sent to a WDS_Widget callback


SYNOPSIS

Class WDS_Widget allow for callbacks after specific state changes. WDS_Activation holds this data.


PUBLIC MEMBER FUNCTIONS



void SetThisWidget(WDS_Widget *set)

WDS_Widget *GetThisWidget(void)
Set/Get the widget that changed state, causing this callback. SetThisWidget() is generally only used by WDS_Widget internally which sets the value before each callback.



void SetTargetWidget(WDS_Widget *set)

WDS_Widget *GetTargetWidget(void)
Set/Get the target widget, usually stated in the call to WDS_Widget::SetStateChangeCallback().



void SetEvent(EW_Event *set)

WDS_Widget *GetEvent(void)
Set/Get the event causing the callback. This can be NULL, such as if the callback is not the direct result of an event. SetEvent() is generally only used by WDS_Widget internally which sets the value before each callback.



void SetCode(long set)

long GetCode(void)
Set/Get the activation code, usually stated in the call to WDS_Widget::SetStateChangeCallback(). This code allows the widget to use the same callback for mulitple actions by differentiating using unique codes.



void SetState(long set)

long GetState(void)
Set/Get the state which caused this callback. SetState() is generally only used by WDS_Widget internally so that callback functions can use GetState() to know which state changed caused them to be called.



void SetObject(void *set)

void *GetObject(void)
Set/Get a type-non-specfic object, generally stated in the call to WDS_Widget::SetStateChangeCallback(). The meaning and interpretation of the void pointer is left to the widget who sets up the callback. The Set versions of the above functions are generally only called from WDS_Widget or just prior to defining callbacks with WDS_Widget::SetStateChangeCallback(). The Get versions are then used in the callbacks themselves.



void CopyFrom(WDS_Activation *source)
Copy the data from another WDS_Activation source.


FILES

wds/wwidget.h WDS general widget header file


SEE ALSO

WDS_intro(3), WDS_Widget(3)