WDS_Bypass

WDS_Bypass

wds

1998 12-05


CLASS

WDS_Bypass - an event object with extensions for bypass registration


SYNOPSIS

Class WDS_Bypass is used to register an event bypass with an ancestral scope. Each scope maintains a list of bypasses.


The bypass contains the event data as well as a destination widget to which the bypassed data will be sent. The bypass is then registered with a WDS_Scope using
WDS_Scope::RegisterBypass(WDS_Bypass *bypass).


PUBLIC MEMBER FUNCTIONS

Inheritance from class EW_Event



void SetDestination(WDS_Widget *dest)

WDS_Widget *GetDestination(void)
Set/Get the destination widget to which the bypassed data will be sent.



void SetFlags(long new_flags)

long GetFlags(void)
Set/Get options pertaining to the bypass of the event. Acceptable OR'able values are:



WDS_BYPASS_FLAG_NULL 0 No special flags.
WDS_BYPASS_FLAG_TAKE 1 The destination requires exclusive access to the specified event.
WDS_BYPASS_FLAG_DESCEND 2 During a bypass, call the widget's Descend() member instead of its Operate() so that the widget's children may act on the event as well.



void CopyDataFromEvent(EW_Event *event)

void CopyDataToEvent(EW_Event *event)
Copy/Retrieve relevant data in bypass object to/from the given event. Each bypass addresses a single source, but, in many cases, multiple event items and states can be OR'ed together.


FILES

wds/scope.h Scope/Bypass header file


SEE ALSO

WDS_intro(3), EW_Event(3), WDS_Scope(3)