CLC_Fct_SharedDisplayClient.h

Go to the documentation of this file.

//*********************************************************
// File:            CLC_Fct_SharedDisplayClient.h
// Project:         CopperLan CHAILink Client SDK
// Version:         1.3
// Release Date:    2014/04/15
//*********************************************************

/********************************************************************
Software License Agreement:  CHAILink Client source code

The software supplied herewith by Klavis Technology (the “Company”) is intended and
supplied to you, the Company’s customer, for use solely and exclusively on embedded
CopperLan products needing a CHAILink Client. 
 The software is owned by the Company and/or its supplier, and is protected 
 under applicable copyright laws. All rights are reserved. Any use in violation of the 
 foregoing restrictions may subject the user to criminal sanctions under applicable laws,
as well as to civil liability for the breach of the terms and conditions of this license.

THIS SOFTWARE MUST REMAIN UNMODIFIED. NO WARRANTIES, WHETHER EXPRESS, 
 IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF 
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE
IN CASE OF SOURCE CODE CHANGE BY THE CUSTOMER. IN CASE OF SUCH CHANGE, THE
COMPANY SHALL NOT BE LIABLE FOR SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
OF ANY KIND.
********************************************************************/

#ifndef _CLC_FCT_SHAREDDISPLAYCLIENT_H_
#define _CLC_FCT_SHAREDDISPLAYCLIENT_H_

#ifdef __cplusplus
extern "C" {
#endif



#if defined(ENABLE_DEVICE_SHAREDDISPLAY_CLIENT)
CLC_SDK_API CLC_ErrorCode SharedDisplayClient_RegisterNotificationHandler(
    CPHOBJECT const hSharedDisplayClient);

CLC_SDK_API CLC_ErrorCode SharedDisplayClient_UnregisterNotificationHandler(
    CPHOBJECT const hSharedDisplayClient);
#endif //defined(ENABLE_DEVICE_SHAREDDISPLAY_CLIENT)


CLC_SDK_API CLC_ErrorCode SharedDisplayClient_RequestSharedDisplay(
    CPHOBJECT const hSharedDisplayClient);

CLC_SDK_API CLC_ErrorCode SharedDisplayClient_ReleaseSharedDisplay(
    CPHOBJECT const hSharedDisplayClient);

CLC_SDK_API CLC_ErrorCode SharedDisplayClient_ClearDisplay(
    CPHOBJECT const hSharedDisplayClient);

CLC_SDK_API CLC_ErrorCode SharedDisplayClient_SetText(
    CPHOBJECT const hSharedDisplayClient, 
    CPUINT16 const wX, 
    CPUINT16 const wY, 
    CPCHAR8 const * const utf8Text);

CLC_SDK_API CLC_ErrorCode SharedDisplayClient_SetCursor(
    CPHOBJECT const hSharedDisplayClient, 
    CPUINT16 const wX, 
    CPUINT16 const wY, 
    SharedDisplayCursorTypes const keyType);

CLC_SDK_API CLC_ErrorCode SharedDisplayClient_GetSize(
    CPHOBJECT const hSharedDisplayClient, 
    CPUINT16 * const pwWidth, 
    CPUINT16 * const pwHeight);

CLC_SDK_API CLC_ErrorCode SharedDisplayClient_GetCursorPos(
    CPHOBJECT const hSharedDisplayClient, 
    CPUINT16 * const pwX, 
    CPUINT16 * const pwY);



#ifdef __cplusplus
}
#endif

#endif // _CLC_FCT_SHAREDDISPLAYCLIENT_H_