JXKeyModifiers Class Reference

#include <JXKeyModifiers.h>

Public Member Functions
	JXKeyModifiers (const JXDisplay *display)
	JXKeyModifiers (const JXDisplay *display, const unsigned int state)
bool	Available (const JIndex i) const
bool	GetState (const JIndex i) const
void	SetState (const JIndex i, const bool pushed)
bool	AllOff () const
unsigned int	GetState () const
void	SetState (const JXDisplay *display, const unsigned int state)
void	Clear ()
bool	key (const JIndex i) const
bool	shift () const
bool	shiftLock () const
bool	numLock () const
bool	scrollLock () const
bool	control () const
bool	meta () const
bool	alt () const
bool	super () const
bool	hyper () const
void	ToggleState (const JIndex i)

Static Public Member Functions
static bool	AllOff (const JXDisplay *display, const unsigned int state)
static bool	GetState (const JXDisplay *display, const unsigned int state, const JIndex i)
static unsigned int	SetState (const JXDisplay *display, const unsigned int state, const JIndex i, const bool pushed)
static unsigned int	ToggleState (const JXDisplay *display, const unsigned int state, const JIndex i)

Detailed Description

Class to represent the states of the modifiers keys that X defines.

Constructor & Destructor Documentation

JXKeyModifiers() [1/2]

JXKeyModifiers::JXKeyModifiers

(

const JXDisplay *

display

)

JXKeyModifiers() [2/2]

JXKeyModifiers::JXKeyModifiers	(	const JXDisplay *	display,
		const unsigned int	state
	)

Member Function Documentation

AllOff() [1/2]

bool JXKeyModifiers::AllOff

(

)

const

AllOff() [2/2]

static bool JXKeyModifiers::AllOff ( const JXDisplay *  display, const unsigned int  state  )

inlinestatic

alt()

bool JXKeyModifiers::alt ( ) const

inline

Available()

bool JXKeyModifiers::Available

(

const JIndex

i

)

const

Returns true if the specified modifier key is available.

Clear()

void JXKeyModifiers::Clear

(

)

control()

bool JXKeyModifiers::control ( ) const

inline

GetState() [1/3]

unsigned int JXKeyModifiers::GetState

(

)

const

Return the state as a bit vector.

GetState() [2/3]

bool JXKeyModifiers::GetState

(

const JIndex

i

)

const

Return the state of the specified key.

GetState() [3/3]

bool JXKeyModifiers::GetState ( const JXDisplay *  display, const unsigned int  state, const JIndex  i  )

static

Get the state of the given key in the given bit vector.

hyper()

bool JXKeyModifiers::hyper ( ) const

inline

key()

bool JXKeyModifiers::key ( const JIndex  i ) const

inline

meta()

bool JXKeyModifiers::meta ( ) const

inline

numLock()

bool JXKeyModifiers::numLock ( ) const

inline

scrollLock()

bool JXKeyModifiers::scrollLock ( ) const

inline

SetState() [1/3]

void JXKeyModifiers::SetState	(	const JIndex	i,
		const bool	pushed
	)

Set the state of the specified key.

SetState() [2/3]

void JXKeyModifiers::SetState	(	const JXDisplay *	display,
		const unsigned int	state
	)

Set the state of all the keys.

SetState() [3/3]

unsigned int JXKeyModifiers::SetState ( const JXDisplay *  display, const unsigned int  state, const JIndex  i, const bool  pushed  )

static

Set the state of the given key in the given bit vector.

shift()

bool JXKeyModifiers::shift ( ) const

inline

shiftLock()

bool JXKeyModifiers::shiftLock ( ) const

inline

super()

bool JXKeyModifiers::super ( ) const

inline

ToggleState() [1/2]

void JXKeyModifiers::ToggleState ( const JIndex  i )

inline

ToggleState() [2/2]

static unsigned int JXKeyModifiers::ToggleState ( const JXDisplay *  display, const unsigned int  state, const JIndex  i  )

inlinestatic

---

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

• libjx/code/JXKeyModifiers.h
• libjx/code/JXKeyModifiers.cpp