SldTranslateMsg Function

Microchip Graphics Library

Microchip Graphics Library
SldTranslateMsg Function
C
WORD SldTranslateMsg(
    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 
SLD_MSG_INC 
Touch Screen 
EVENT_PRESS, EVENT_MOVE 
If events occurs and the x,y position falls in the area of the slider and the slider position is to the LEFT of the x,y position for a horizontal slider or BELOW the x,y position for a vertical slider. 
 
Keyboard 
EVENT_KEYSCAN 
If event occurs and parameter1 passed matches the object’s ID and parameter 2 passed matches SCAN_UP_PRESSED or SCAN_LEFT_PRESSED
SLD_MSG_DEC 
Touch Screen 
EVENT_PRESS, EVENT_MOVE 
If events occurs and the x,y position falls in the area of the slider and the slider position is to the RIGHT of the x,y position for a horizontal slider or ABOVE the x,y position for a vertical slider. 
 
Keyboard 
EVENT_KEYSCAN 
If event occurs and parameter1 passed matches the object’s ID and parameter 2 passed matches SCAN_DOWN_PRESSED or SCAN_RIGHT_PRESSED
OBJ_MSG_PASSIVE 
Touch Screen 
EVENT_RELEASE 
If events occurs and the x,y position falls in the area of the slider. 
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. 
pSld 
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:

  • SLD_MSG_INC – Increment slider position
  • SLD_MSG_DEC – Decrement slider position
  • OBJ_MSG_PASSIVE – Slider is not affected
  • OBJ_MSG_INVALID – Slider 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