JX Application Framework
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
JXButtonStates Class Reference

#include <JXButtonStates.h>

Public Member Functions

 JXButtonStates ()
 
 JXButtonStates (const unsigned int state)
 
bool GetState (const JIndex i) const
 
void SetState (const JIndex i, const bool pushed)
 
bool AllOff () const
 
unsigned int GetState () const
 
void SetState (const unsigned int state)
 
void Clear ()
 
bool button (const JIndex i) const
 
bool left () const
 
bool middle () const
 
bool right () const
 
void ToggleState (const JIndex i)
 

Static Public Member Functions

static bool AllOff (const unsigned int state)
 
static bool GetState (const unsigned int state, const JIndex i)
 
static unsigned int SetState (const unsigned int state, const JIndex i, const bool pushed)
 
static unsigned int ToggleState (const unsigned int state, const JIndex i)
 

Detailed Description

Class to represent the states of the mouse buttons that X defines.

Constructor & Destructor Documentation

◆ JXButtonStates() [1/2]

JXButtonStates::JXButtonStates ( )

◆ JXButtonStates() [2/2]

JXButtonStates::JXButtonStates ( const unsigned int  state)

Member Function Documentation

◆ AllOff() [1/2]

bool JXButtonStates::AllOff ( ) const

◆ AllOff() [2/2]

static bool JXButtonStates::AllOff ( const unsigned int  state)
inlinestatic

◆ button()

bool JXButtonStates::button ( const JIndex  i) const
inline

◆ Clear()

void JXButtonStates::Clear ( )

◆ GetState() [1/3]

unsigned int JXButtonStates::GetState ( ) const

Return the state as a bit vector.

◆ GetState() [2/3]

bool JXButtonStates::GetState ( const JIndex  i) const

Return the state of the specified button.

◆ GetState() [3/3]

bool JXButtonStates::GetState ( const unsigned int  state,
const JIndex  i 
)
static

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

◆ left()

bool JXButtonStates::left ( ) const
inline

◆ middle()

bool JXButtonStates::middle ( ) const
inline

◆ right()

bool JXButtonStates::right ( ) const
inline

◆ SetState() [1/3]

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

Set the state of the specified button.

◆ SetState() [2/3]

void JXButtonStates::SetState ( const unsigned int  state)

Set the state of all the keys.

◆ SetState() [3/3]

unsigned int JXButtonStates::SetState ( const unsigned int  state,
const JIndex  i,
const bool  pushed 
)
static

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

◆ ToggleState() [1/2]

void JXButtonStates::ToggleState ( const JIndex  i)
inline

◆ ToggleState() [2/2]

static unsigned int JXButtonStates::ToggleState ( const unsigned int  state,
const JIndex  i 
)
inlinestatic

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