StTranslateMsg Function

Microchip Graphics Library

Microchip Graphics Library
StTranslateMsg Function
C
WORD StTranslateMsg(
    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 
ST_MSG_SELECTED 
Touch Screen 
EVENT_PRESS, EVENT_RELEASE 
If events occurs and the x,y position falls in the area of the static text. 
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. 
pSt 
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:

  • ST_MSG_SELECTED – Static Text is selected
  • OBJ_MSG_INVALID – Static Text is not affected

Preconditions

none

Side Effects

none

Example

Usage is similar to BtnTranslateMsg() example.

Microchip Graphics Library Version 3.06.02 - October 15, 2012
Copyright © 2012 Microchip Technology, Inc.  All rights reserved