Files | Data Structures | Typedefs | Enumerations | Functions
Button

This module handles the Button features. More...

+ Collaboration diagram for Button:

Files

file  XDK_Button.h
 

Data Structures

struct  Button_Setup_S
 Structure to represent the Button setup features. More...
 

Typedefs

typedef struct Button_Setup_S Button_Setup_T
 Typedef to represent the Button setup feature. More...
 
typedef enum ButtonEvent_E ButtonEvent_T
 
typedef void(* ButtonEventCallback_T )(ButtonEvent_T buttonEvent)
 

Enumerations

enum  ButtonEvent_E
 

Functions

Retcode_T Button_Enable (void)
 This will enable the Button. More...
 
Retcode_T Button_Setup (Button_Setup_T *setup)
 This will setup the Button. More...
 

Detailed Description


Data Structure Documentation

struct Button_Setup_S
+ Collaboration diagram for Button_Setup_S:

Data Fields

CmdProcessor_TCmdProcessorHandle
 
ButtonEventCallback_T InternalButton1Callback
 
bool InternalButton1isEnabled
 
ButtonEventCallback_T InternalButton2Callback
 
bool InternalButton2isEnabled
 

Field Documentation

CmdProcessor_T* CmdProcessorHandle
ButtonEventCallback_T InternalButton1Callback
bool InternalButton1isEnabled
ButtonEventCallback_T InternalButton2Callback
bool InternalButton2isEnabled

Typedef Documentation

typedef void(* ButtonEventCallback_T)(ButtonEvent_T buttonEvent)

Enumeration Type Documentation

Enumerator
BUTTON_EVENT_PRESSED 
BUTTON_EVENT_RELEASED 

Function Documentation

Retcode_T Button_Enable ( void  )
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:

Retcode_T Button_Setup ( Button_Setup_T setup)
Parameters
[in]setupPointer to the Button setup feature
Returns
RETCODE_OK on success, or an error code otherwise.

+ Here is the caller graph for this function:


This documentation file has been automatically generated on Fri Oct 4 2019 03:47:34 by doxygen 1.8.8