Linux Certif

Toute la documentation sur la certification Linux LPI

SoButtonEvent.3coin2

NAME

SoButtonEvent -

The SoButtonEvent class is the base class for all button events.

The event classes which results from the user pushing buttons on some device (keyboard, mouse or spaceball) all inherit this class. The SoButtonEvent class contains methods for setting and getting the state of the button(s).

SYNOPSIS

#include <Inventor/events/SoButtonEvent.h>

Inherits SoEvent.

Inherited by SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

Public Types

enum State { UP, DOWN, UNKNOWN }

Public Member Functions

SoButtonEvent (void)

virtual ~SoButtonEvent ()

void setState (SoButtonEvent::State state)

SoButtonEvent::State getState (void) const

Static Public Member Functions

static void initClass (void)

Detailed Description

The SoButtonEvent class is the base class for all button events.

The event classes which results from the user pushing buttons on some device (keyboard, mouse or spaceball) all inherit this class. The SoButtonEvent class contains methods for setting and getting the state of the button(s).

See also:

SoEvent, SoKeyboardEvent, SoMouseButtonEvent, SoSpaceballButtonEvent
SoEventCallback, SoHandleEventAction

Member Enumeration Documentation

enum SoButtonEvent::StateThis gives the actual state of the button.

Enumerator:

UP

Button has been released.

DOWN

Button has been pressed down.

UNKNOWN

The state of the button is unknown.

Constructor & Destructor Documentation

SoButtonEvent::SoButtonEvent (void)Constructor.

References UNKNOWN.

SoButtonEvent::~SoButtonEvent () [virtual]Destructor.

Member Function Documentation

void SoButtonEvent::setState (SoButtonEvent::State state)Set the state of the button which the user interacted with.

This method is used from the window specific device classes when translating events to the generic Coin library.

See also:

getState()

SoButtonEvent::State SoButtonEvent::getState (void) constReturns the state of the button which is the cause of the event, i.e. whether it was pushed down or released.

See also:

wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime()

Referenced by SoSpaceballButtonEvent::isButtonPressEvent(), SoMouseButtonEvent::isButtonPressEvent(), SoSpaceballButtonEvent::isButtonReleaseEvent(), SoMouseButtonEvent::isButtonReleaseEvent(), SoKeyboardEvent::isKeyPressEvent(), and SoKeyboardEvent::isKeyReleaseEvent().

void SoButtonEvent::initClass (void) [static]Initialize the type information data.

Reimplemented from SoEvent.

Reimplemented in SoKeyboardEvent, SoMouseButtonEvent, and SoSpaceballButtonEvent.

Author

Generated automatically by Doxygen for Coin from the source code.