RbTranslateMsg Function

Microchip Graphics Library

previous page next page

Microchip Graphics Library

WORD RbTranslateMsg(
    void * pObj, 
    GOL_MSG * pMsg
);

Overview

This function evaluates the message from a user if the message will affect the object or not. The table below enumerates the translated messages for each event of the touch screen and keyboard inputs.

Translated Message	Input Source	Events	Description
RB_MSG_CHECKED	Touch Screen	EVENT_PRESS	If event occurs and the x,y position falls in the area of the Radio Button while the Radio Button is not checked.
	Keyboard	EVENT_KEYSCAN	If event occurs and parameter1 passed matches the object’s ID and parameter 2 passed matches SCAN_CR_PRESSED or SCAN_SPACE_PRESSED while the Radio Button is not checked.
OBJ_MSG_INVALID	Any	Any	If the message did not affect the object.

Input Parameters

Input Parameters	Description
GOL_MSG * pMsg	Pointer to the message struct containing the message from the user interface.
pRb	The pointer to the object where the message will be evaluated to check if the message will affect the object.

Returns

Returns the translated message depending on the received GOL message:

RB_MSG_CHECKED – Radio Button is checked
OBJ_MSG_INVALID – Radio Button is not affected

Preconditions

none

Side Effects

none

Example

Usage is similar to BtnTranslateMsg() example.

Library API > Graphics Object Layer API > GOL Objects > Radio Button > RbTranslateMsg Function

Contents | Index | Home

previous page start next page