ZFFramework
 
Loading...
Searching...
No Matches
ZFProtocolZFUIKeyboardState.h
Go to the documentation of this file.
1
5
6#ifndef _ZFI_ZFProtocolZFUIKeyboardState_h_
7#define _ZFI_ZFProtocolZFUIKeyboardState_h_
8
9#include "ZFCore/ZFProtocol.h"
10#include "ZFUIKit/ZFUIKeyboardState.h"
11#include "ZFUIKit/ZFUIView.h"
12#include "ZFUIKit/ZFUIKeyEvent.h"
13ZF_NAMESPACE_GLOBAL_BEGIN
14
18ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_ZFUIKit, ZFUIKeyboardState)
19ZFPROTOCOL_INTERFACE_OPTIONAL
20public:
24 virtual zfbool keyPressed(ZF_IN ZFUIKeyCode keyCode) zfpurevirtual;
28 virtual zfbool keyPressedRaw(ZF_IN zfflags keyCodeRaw) zfpurevirtual;
29
30 // ============================================================
31 // callbacks that implementations must notify
32public:
39ZFPROTOCOL_INTERFACE_END(ZFUIKeyboardState)
40
41// ============================================================
42// builtin impl
52extern ZFLIB_ZFUIKit void ZFUIKeyboardStateBuiltinImplRegister(void);
56extern ZFLIB_ZFUIKit void ZFUIKeyboardStateBuiltinImplUnregister(void);
63extern ZFLIB_ZFUIKit void ZFUIKeyboardStateBuiltinImplNotifyKeyEvent(ZF_IN ZFUIKeyEvent *event);
64
65ZF_NAMESPACE_GLOBAL_END
66#endif // #ifndef _ZFI_ZFProtocolZFUIKeyboardState_h_
67
zffinal
#define zffinal
dummy macro shows that a method or class is designed must not to be overrided
Definition ZFCoreTypeDef_ClassType.h:63
zfpurevirtual
#define zfpurevirtual
dummy macro shows that a method is pure virtual method
Definition ZFCoreTypeDef_ClassType.h:68
ZF_IN
#define ZF_IN
dummy macro that shows the param used as required input
Definition ZFCoreTypeDef_ClassType.h:180
zfbool
_ZFT_t_zfbool zfbool
bool type
Definition ZFCoreTypeDef_CoreType.h:103
zfflags
_zft_zfflags zfflags
used to hold flags, ensured 32 bit, ensured unsigned
Definition ZFCoreTypeDef_CoreType.h:211
ZF_NAMESPACE_GLOBAL_BEGIN
#define ZF_NAMESPACE_GLOBAL_BEGIN
begin namespace ZFFramework
Definition ZFNamespace.h:97
ZF_NAMESPACE_GLOBAL_END
#define ZF_NAMESPACE_GLOBAL_END
end namespace ZFFramework
Definition ZFNamespace.h:98
ZFProtocol.h
protocol definitions for ZFFramework
ZFPROTOCOL_INTERFACE_OPTIONAL
#define ZFPROTOCOL_INTERFACE_OPTIONAL
macro to show that the protocol is optional
Definition ZFProtocol.h:420
ZFPROTOCOL_INTERFACE_END
#define ZFPROTOCOL_INTERFACE_END(ModuleName)
for more information, please refer to ZFPROTOCOL_INTERFACE_BEGIN
Definition ZFProtocol.h:414
ZFPROTOCOL_INTERFACE_BEGIN
#define ZFPROTOCOL_INTERFACE_BEGIN(ZFLIB_, ModuleName)
declare a protocol interface for ZFFramework
Definition ZFProtocol.h:408
ZFUIKeyboardStateBuiltinImplUnregister
void ZFUIKeyboardStateBuiltinImplUnregister(void)
see ZFUIKeyboardStateBuiltinImplRegister
ZFUIKeyboardStateBuiltinImplRegister
void ZFUIKeyboardStateBuiltinImplRegister(void)
register the builtin impl for ZFUIKeyboardState
ZFUIKeyboardStateBuiltinImplNotifyKeyEvent
void ZFUIKeyboardStateBuiltinImplNotifyKeyEvent(ZFUIKeyEvent *event)
see ZFUIKeyboardStateBuiltinImplRegister
ZFUIKeyCode
v_ZFUIKeyCode::ZFEnumType ZFUIKeyCode
see v_ZFUIKeyCode
Definition ZFUIKeyCode.h:294
ZFUIKeyEvent.h
key event for ui elements
ZFUIKeyboardState.h
hardware keyboard state helper
ZFLIB_ZFUIKit
#define ZFLIB_ZFUIKit
used to export symbols
Definition ZFUIKitDef.h:16
ZFUIView.h
base class of all UI views
ZFObject::observerNotify
void observerNotify(zfidentity eventId, ZFObject *param0=zft_zfnull, ZFObject *param1=zft_zfnull)
notify the observer with eventId
ZFPInterface_ZFUIKeyboardState::keyPressed
virtual zfbool keyPressed(ZFUIKeyCode keyCode)=0
see ZFUIKeyboardState::keyPressed
ZFPInterface_ZFUIKeyboardState::keyPressedRaw
virtual zfbool keyPressedRaw(zfflags keyCodeRaw)=0
see ZFUIKeyboardState::keyPressedRaw
ZFPInterface_ZFUIKeyboardState::notifyKeyPressedOnUpdate
void notifyKeyPressedOnUpdate(void)
implementations must notify when keyboard's state changed
Definition ZFProtocolZFUIKeyboardState.h:36
ZFUIKeyEvent
key event for ui elements
Definition ZFUIKeyEvent.h:17
ZFUIKeyboardState
hardware keyboard state helper
Definition ZFUIKeyboardState.h:16
ZFUIKeyboardState::E_KeyPressedOnUpdate
static zfidentity E_KeyPressedOnUpdate(void)
see ZFObject::observerNotify
ZFUIKeyboardState::instance
static ZFUIKeyboardState * instance()