The Table Objects: 5.2 TableContentClass: Altering TableContent Instance Data

Up: GEOS SDK TechDocs| Up | Prev: 5.1 TableContent Instance Data | Next: 6 LocatorClass
MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_ON, MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_OFF, MSG_TABLE_CONTENT_GRAB_KBD_EXCLUSIVE, MSG_TABLE_CONTENT_RELEASE_KBD_EXCLUSIVE

By default, the TableContent broadcasts keyboard events to its children. If this behavior is not desired, you can send the TableContent MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_OFF . Sending the TableContent MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_ON turns keyboard event broadcasting back on.

Keyboard event broadcasting must be on for any child object to receive any keyboard events, even if a child object attempts to grabs the keyboard exclusive on its own. A TableContent's child can grab the keyboard exclusive by sending MSG_TABLE_CONTENT_GRAB_KBD_EXCLUSIVE to its parent TableContent object, passing it the optr of the child object (usually itself) which should be given the keyboard exclusive. If keyboard event broadcasting is not on, or if another child object already has the exclusive, the grab will not be successful.

The child object should also make sure to send its parent MSG_TABLE_CONTENT_RELEASE_KBD_EXCLUSIVE when it can release the keyboard exclusive.

MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_ON

Boolean	MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_ON();

This message instructs the TableContent object to allow keyboard messages to be sent to its children. (This must be enabled if any child object is to grab the keyboard exclusive.) It does this by modifying the TableContent's TCI_ kbdSend instance field. Do not modify this field yourself.

Source: Unrestricted.

Destination: A TableContent object.

Parameters: None.

Return: true (non-zero ) if the TableContent object was not able to turn on keyboard dispatching to its children; false (zero) otherwise.

MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_OFF

Boolean	MSG_TABLE_CONTENT_KBD_SEND_TO_CHILDREN_OFF();

This message instructs the TableContent object to disallow keyboard messages to be sent to its children. (If any child object currently has the keyboard exclusive, this message will not succeed in turning off keyboard event broadcasting.) The TableContent modifies this behavior by modifying the TableContent's TCI_ kbdSend instance field. Do not modify this field yourself.

Source: Unrestricted.

Destination: A TableContent object.

Parameters: None.

Return: true (non-zero) if the TableContent object was not able to turn off keyboard dispatching to its children; false (zero) otherwise.

MSG_TABLE_CONTENT_GRAB_KBD_EXCLUSIVE

Boolean	MSG_TABLE_CONTENT_GRAB_KBD_EXCLUSIVE(
        optr		obj);

This message instructs the TableContent object to give the keyboard grab to the child object whose optr is passed in the message. It does this by modifying the TableContent's TCI_ exclDestination modify this field yourself. Keyboard event broadcasting must be "on" for this grab to succeed.

Source: One of the TableContent's children

Destination: A TableContent object.

Parameters: obj Object to receive the TableContent's keyboard exclusive.

Return: true (non-zero) if the child object was not able to grab the TableContent's keyboard exclusive; false (zero) otherwise.

MSG_TABLE_CONTENT_RELEASE_KBD_EXCLUSIVE

Boolean	MSG_TABLE_CONTENT_RELEASE_KBD_EXCLUSIVE(
        optr		obj);

This message instructs the TableContent object to release the keyboard grab from the child object whose optr is passed in the message. Only a child object which currently has the grab can release it. It does this by modifying the TableContent's TCI _exclDestination instance field, setting it to null. Do not modify this field yourself.

Source: Unrestricted.

Destination: A TableContent object.

Parameters: obj Object releasing the TableContent's keyboard exclusive.

Return: true (non-zero) if the child object was not able to release the TableContent's keyboard exclusive; false (zero) otherwise.


Up: GEOS SDK TechDocs| Up | Prev: 5.1 TableContent Instance Data | Next: 6 LocatorClass