OnChildWrapping - cUIObject

Called any time a wrapping event occurs

Type: Event

Return Data Type: Handle

Parameters: handle hoDestination boolean bDown

ParameterDescription
hoDestinationHandle of destination object
bDownIndicates wrapping direction. True=last to first, False=first to last


Return Value

Returns the handle of the object to navigate to. If 0, navigation is stopped.


Syntax
Function OnChildWrapping handle hoDestination boolean bDown Returns Handle

Description

The OnChildWrapping message is sent any time a wrapping event occurs. A wrapping event occurs when navigation would "ring" either from last object to first object or first object to last object. When this occurs the OnChildWrapping event is sent to the owner of the ring (the container object that has ring_state set to true) passing the destination object and a boolean indicating if the ring is moving from last to first (bDown=True) or last to first (false).

The message must return the object handle ID of the object to navigate to. Often this will be hoDestination, the object that was passed. If zero is returned, the navigation event should not take place. By default the runtime returns the passed object.

By default, this changes nothing. If you return a 0, navigation is stopped and no change takes place. If you return any other value navigation will continue from that object. Tab-dialogs use this extensively to handle all of the custom navigations required.

You should never send this message yourself. It may be augmented. If do you augment this message never use it to change the focus.

This event is called whenever the old message child_wrapping is sent but it is more flexible.