TouchScreen.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  File description:
 *  Touch Screen settings
 *
 *  Use the function GetTouchScreen() to get a handle to pass on to the other functions.
 *  Use the method TouchScreen_release(TOUCHSCREENHANDLE) to return the handle.
 *  Note that the VC platform uses a different touch screen solution which is not supported by this API.
 *
 *  Example Usage:
 *  @include touchscreen_example.cpp
 *
 ************************************************/
 
#ifndef CC_TOUCHSCR_H
#define CC_TOUCHSCR_H
 
#include "CCAuxErrors.h"
#include "CCPlatform.h"
 
#ifdef __cplusplus
namespace CrossControl
{
#endif
 
typedef void *TOUCHSCREENHANDLE;
 
typedef enum
{
    MOUSE_NEXT_BOOT = 0, 
    TOUCH_NEXT_BOOT = 1, 
    MOUSE_NOW       = 2, 
    TOUCH_NOW       = 3  
} TouchScreenModeSettings;
 
#define TS_CALIBTATION_WIDTH TS_CALIBRATION_WIDTH
 
typedef enum
{
    TS_RIGHT_CLICK_TIME = 0,
 
    TS_LOW_LEVEL = 1,
 
    TS_UNTOUCHLEVEL = 2,
 
    TS_DEBOUNCE_TIME = 3,
 
    TS_DEBOUNCE_TIMEOUT_TIME = 4,
 
    TS_DOUBLECLICK_MAX_CLICK_TIME = 5,
 
    TS_DOUBLE_CLICK_TIME = 6,
 
    TS_MAX_RIGHTCLICK_DISTANCE = 7,
 
    TS_USE_DEJITTER = 8,
 
    TS_CALIBRATION_WIDTH = 9,
 
    TS_CALIBRATION_MEASUREMENTS = 10,
 
    TS_RESTORE_DEFAULT_SETTINGS = 11,
 
    TS_TCHAUTOCAL = 12
 
} TSAdvancedSettingsParameter;
 
EXTERN_C
CCAUXDLL_API
TOUCHSCREENHANDLE
CCAUXDLL_CALLING_CONV
GetTouchScreen(void);
 
EXTERN_C
CCAUXDLL_API
void CCAUXDLL_CALLING_CONV TouchScreen_release(TOUCHSCREENHANDLE);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreen_getMode(TOUCHSCREENHANDLE, TouchScreenModeSettings *config);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreen_getMouseRightClickTime(TOUCHSCREENHANDLE, uint16_t *time);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreen_setMode(TOUCHSCREENHANDLE, TouchScreenModeSettings config);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreen_setMouseRightClickTime(TOUCHSCREENHANDLE, uint16_t time);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreen_setAdvancedSetting(TOUCHSCREENHANDLE, TSAdvancedSettingsParameter param,
                                                          uint16_t data);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV TouchScreen_getAdvancedSetting(TOUCHSCREENHANDLE, TSAdvancedSettingsParameter param,
                                                          uint16_t *data);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#endif /* CC_TOUCHSCR_H */