neogfx::i_keyboard Class Reference

#include <i_keyboard.hpp>

Inheritance diagram for neogfx::i_keyboard:

Classes
struct	already_grabbed

Public Types
typedef i_keyboard	abstract_type
Public Types inherited from neogfx::i_hid_device
typedef i_hid_device	abstract_type

Public Member Functions
	declare_event (key_pressed, scan_code_e, key_code_e, key_modifiers_e) declare_event(key_released
key_modifiers_e	declare_event (text_input, std::string const &) declare_event(sys_text_input
virtual i_keyboard_layout &	layout () const =0
virtual bool	is_key_pressed (scan_code_e aScanCode) const =0
virtual keyboard_locks	locks () const =0
virtual key_modifiers_e	modifiers () const =0
virtual key_modifiers_e	event_modifiers () const =0
virtual void	set_event_modifiers (key_modifiers_e aModifiers)=0
virtual void	clear_event_modifiers ()=0
virtual bool	is_keyboard_grabbed () const =0
virtual bool	is_keyboard_grabbed_by (i_keyboard_handler &aKeyboardHandler) const =0
virtual bool	is_front_grabber (i_keyboard_handler &aKeyboardHandler) const =0
virtual void	grab_keyboard (i_keyboard_handler &aKeyboardHandler)=0
virtual void	ungrab_keyboard (i_keyboard_handler &aKeyboardHandler)=0
virtual i_keyboard_handler &	grabber () const =0
virtual key_code_e	scan_code_to_key_code (scan_code_e aScanCode) const =0
Public Member Functions inherited from neogfx::i_hid_device
virtual declare_event(enabled) declare_event(disabled) public hid_device_class	device_class () const =0
virtual hid_device_subclass	device_subclass () const =0
virtual hid_device_uuid	product_id () const =0
virtual hid_device_uuid	instance_id () const =0
virtual bool	is_enabled () const =0
virtual void	enable ()=0
virtual void	disable ()=0
virtual const i_string &	product_name () const =0
Public Member Functions inherited from neolib::i_reference_counted
virtual	~i_reference_counted ()=default
virtual void	add_ref () const noexcept=0
virtual void	release () const =0
virtual int32_t	use_count () const noexcept=0
virtual const i_reference_counted *	release_and_take_ownership () const =0
virtual i_reference_counted *	release_and_take_ownership ()=0
virtual void	pin () const noexcept=0
virtual void	unpin () const =0
virtual i_ref_control_block &	control_block ()=0
Public Member Functions inherited from neolib::services::i_service
virtual	~i_service ()=default

Static Public Member Functions
static uuid const &	iid ()

Public Attributes
	scan_code_e
	key_code_e

Detailed Description

Definition at line 661 of file i_keyboard.hpp.

Member Typedef Documentation

abstract_type

typedef i_keyboard neogfx::i_keyboard::abstract_type

Definition at line 664 of file i_keyboard.hpp.

Member Function Documentation

clear_event_modifiers()

virtual void neogfx::i_keyboard::clear_event_modifiers ( )

pure virtual

declare_event() [1/2]

neogfx::i_keyboard::declare_event	(	key_pressed	,
		scan_code_e	,
		key_code_e	,
		key_modifiers_e
	)

declare_event() [2/2]

key_modifiers_e neogfx::i_keyboard::declare_event	(	text_input	,
		std::string const &
	)

event_modifiers()

virtual key_modifiers_e neogfx::i_keyboard::event_modifiers ( ) const

pure virtual

grab_keyboard()

virtual void neogfx::i_keyboard::grab_keyboard ( i_keyboard_handler &  aKeyboardHandler )

pure virtual

grabber()

virtual i_keyboard_handler & neogfx::i_keyboard::grabber ( ) const

pure virtual

iid()

static uuid const & neogfx::i_keyboard::iid ( )

inlinestatic

Definition at line 693 of file i_keyboard.hpp.

is_front_grabber()

virtual bool neogfx::i_keyboard::is_front_grabber ( i_keyboard_handler &  aKeyboardHandler ) const

pure virtual

is_key_pressed()

virtual bool neogfx::i_keyboard::is_key_pressed ( scan_code_e  aScanCode ) const

pure virtual

is_keyboard_grabbed()

virtual bool neogfx::i_keyboard::is_keyboard_grabbed ( ) const

pure virtual

is_keyboard_grabbed_by()

virtual bool neogfx::i_keyboard::is_keyboard_grabbed_by ( i_keyboard_handler &  aKeyboardHandler ) const

pure virtual

layout()

virtual i_keyboard_layout & neogfx::i_keyboard::layout ( ) const

pure virtual

locks()

virtual keyboard_locks neogfx::i_keyboard::locks ( ) const

pure virtual

modifiers()

virtual key_modifiers_e neogfx::i_keyboard::modifiers ( ) const

pure virtual

scan_code_to_key_code()

virtual key_code_e neogfx::i_keyboard::scan_code_to_key_code ( scan_code_e  aScanCode ) const

pure virtual

set_event_modifiers()

virtual void neogfx::i_keyboard::set_event_modifiers ( key_modifiers_e  aModifiers )

pure virtual

ungrab_keyboard()

virtual void neogfx::i_keyboard::ungrab_keyboard ( i_keyboard_handler &  aKeyboardHandler )

pure virtual

Member Data Documentation

key_code_e

neogfx::i_keyboard::key_code_e

Definition at line 667 of file i_keyboard.hpp.

scan_code_e

neogfx::i_keyboard::scan_code_e

Definition at line 667 of file i_keyboard.hpp.

---

The documentation for this class was generated from the following file:

• include/neogfx/hid/i_keyboard.hpp