SoKeyboardEvent.3coin3 - Online Linux Manual Page

SoKeyboardEvent - Online Linux Manual PageSection : 3
Updated : Mon Jan 25 2021
Source : Version 3.1.3
Note : Coin

NAMESoKeyboardEvent − The SoKeyboardEvent class contains information about keyboard interaction.

SYNOPSIS
#include <Inventor/events/SoKeyboardEvent.h> Inherits SoButtonEvent.

Public Typesenum Key { ANY = 0, UNDEFINED = 1, LEFT_SHIFT = 0xffe1, RIGHT_SHIFT, LEFT_CONTROL, RIGHT_CONTROL, LEFT_ALT = 0xffe9, RIGHT_ALT, NUMBER_0 = 0x0030, NUMBER_1, NUMBER_2, NUMBER_3, NUMBER_4, NUMBER_5, NUMBER_6, NUMBER_7, NUMBER_8, NUMBER_9, A = 0x0061, B, C, D, E, F, G, H, I, J, K, L, M, N, O, P, Q, R, S, T, U, V, W, X, Y, Z, HOME = 0xff50, LEFT_ARROW, UP_ARROW, RIGHT_ARROW, DOWN_ARROW, PAGE_UP, PAGE_DOWN, END, PRIOR = 0xff55, NEXT, PAD_ENTER = 0xff8d, PAD_F1 = 0xff91, PAD_F2, PAD_F3, PAD_F4, PAD_0 = 0xff9e, PAD_1 = 0xff9c, PAD_2 = 0xff99, PAD_3 = 0xff9b, PAD_4 = 0xff96, PAD_5 = 0xff9d, PAD_6 = 0xff98, PAD_7 = 0xff95, PAD_8 = 0xff97, PAD_9 = 0xff9a, PAD_ADD = 0xffab, PAD_SUBTRACT = 0xffad, PAD_MULTIPLY = 0xffaa, PAD_DIVIDE = 0xffaf, PAD_SPACE = 0xff8d, PAD_TAB = 0xff89, PAD_INSERT = 0xff9e, PAD_DELETE = 0xff9f, PAD_PERIOD = 0xff9f, F1 = 0xffbe, F2, F3, F4, F5, F6, F7, F8, F9, F10, F11, F12, BACKSPACE = 0xff08, TAB = 0xff09, RETURN = 0xff0d, ENTER = 0xff0d, PAUSE = 0xff13, SCROLL_LOCK = 0xff14, ESCAPE = 0xff1b, DELETE = 0xffff, KEY_DELETE = DELETE, PRINT = 0xff61, INSERT = 0xff63, NUM_LOCK = 0xff7f, CAPS_LOCK = 0xffe5, SHIFT_LOCK = 0xffe6, SPACE = 0x0020, APOSTROPHE = 0x0027, COMMA = 0x002c, MINUS = 0x002d, PERIOD = 0x002e, SLASH = 0x002f, SEMICOLON = 0x003b, EQUAL = 0x003d, BRACKETLEFT = 0x005b, BACKSLASH = 0x005c, BRACKETRIGHT = 0x005d, GRAVE = 0x0060 }

Public Member Functionsvirtual SoType getTypeId (void) const
SoKeyboardEvent (void)
virtual ~SoKeyboardEvent ()
void setKey (Key key)
Key getKey (void) const
void setPrintableCharacter (const char c)
char getPrintableCharacter (void) const

Static Public Member Functionsstatic SoType getClassTypeId (void)
static void initClass (void)
static SbBool isKeyPressEvent (const SoEvent *e, Key whichKey)
static SbBool isKeyReleaseEvent (const SoEvent *e, Key whichKey)
static SbBool enumToString (Key enumval, SbString &stringrep)

Detailed DescriptionThe SoKeyboardEvent class contains information about keyboard interaction. When the user presses any keys on the keyboard, these will be translated from a system specific event into a Coin event and sent to the scenegraph by using instances of this class. See also SoEvent, SoButtonEvent, SoMouseButtonEvent, SoSpaceballButtonEvent SoEventCallback, SoHandleEventAction

Member Enumeration Documentation

enum SoKeyboardEvent::KeyThis enum contains all keys detected by Coin.

Constructor & Destructor Documentation

SoKeyboardEvent::SoKeyboardEvent (void)Constructor.

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

Member Function Documentation

SoType SoKeyboardEvent::getTypeId (void) const [virtual]Returns the actual type id of an instantiated object. Reimplemented from SoButtonEvent.

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

void SoKeyboardEvent::setKey (SoKeyboardEvent::Key keyarg)Set the value of the key 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 getKey()

SoKeyboardEvent::Key SoKeyboardEvent::getKey (void) constReturns the value of the key which was pressed or released. Coin adds a new key value called UNDEFINED. This is needed to support GUI toolkits where it's not possible to find exactly which key is pressed, and/or to support non-US keyboards. The Open Inventor design for this class is flawed, since it assumes everybody uses a US keyboard. We recommend using getPrintableCharacter() to find which key is pressed/released, at least for printable non-alphanumerical characters. See also getPrintableCharacter(), getState() wasShiftDown(), wasCtrlDown(), wasAltDown(), getPosition(), getTime()

void SoKeyboardEvent::setPrintableCharacter (const char c)Sets the printable character for this keyboard event. If this method is not called when creating an event, getPrintableCharacter() will convert the SoKeyboardEvent::Key value into a printable character. This conversion does not work on non-US keyboards, so we recommend that you set the printable character using this method instead. This printable character is cleared each time setKey() is called. This method is an extension versus the Open Inventor API. See also getPrintableCharacter()

char SoKeyboardEvent::getPrintableCharacter (void) constReturn ASCII value which would be generated by the key and modifier combination. NB! If setPrintableCharacter() hasn't been called, this function does not always work as expected, particularly not on non-US keyboards. The Coin GUI toolkits (SoGtk/SoQt/SoWin/SoXt/Sc21) will set the printable character correctly. See also getKey(), wasShiftDown(), wasCtrlDown(), wasAltDown(), setPrintableCharacter()

SbBool SoKeyboardEvent::isKeyPressEvent (const SoEvent * e, SoKeyboardEvent::Key whichKey) [static]Convenience method for quickly checking if the given event is a keypress on the given key, whichKey. See also isKeyReleaseEvent(), isOfType(), getKey(), getState()

SbBool SoKeyboardEvent::isKeyReleaseEvent (const SoEvent * e, SoKeyboardEvent::Key whichKey) [static]Convenience method for quickly checking if the given event is a key release of the given key, whichKey. See also isKeyPressEvent(), isOfType(), getKey(), getState()

SbBool SoKeyboardEvent::enumToString (Key enumval, SbString & stringrep) [static]Converts from an enum value of type SoKeyboardEvent::State to a string containing the enum symbol. This function is an extension for Coin, and it is not available in the original SGI Open Inventor v2.1 API.
Since Coin 3.0

AuthorGenerated automatically by Doxygen for Coin from the source code. 0

Johanes Gumabo

Data Size : 38,482 byte
man-SoKeyboardEvent.3coin3Build : 2024-12-05, 20:55 :
Visitor Screen : x
Visitor Counter ( page / site ) : 3 / 182,668
Visitor ID : :
Visitor IP : 3.144.102.43 :
Visitor Provider : AMAZON-02 :
Provider Position ( lat x lon ) : 39.962500 x -83.006100 : x
Provider Accuracy Radius ( km ) : 1000 :
Provider City : Columbus :
Provider Province : Ohio , : ,
Provider Country : United States :
Provider Continent : North America :
Visitor Recorder : Version :
Visitor Recorder : Library :
Online Linux Manual Page : Version : Online Linux Manual Page - Fedora.40 - march=x86-64 - mtune=generic - 24.12.05
Online Linux Manual Page : Library : lib_c - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Online Linux Manual Page : Library : lib_m - 24.10.03 - march=x86-64 - mtune=generic - Fedora.40
Data Base : Version : Online Linux Manual Page Database - 24.04.13 - march=x86-64 - mtune=generic - fedora-38
Data Base : Library : lib_c - 23.02.07 - march=x86-64 - mtune=generic - fedora.36

Very long time ago, I have the best tutor, Wenzel Svojanovsky . If someone knows the email address of Wenzel Svojanovsky , please send an email to johanes_gumabo@yahoo.co.id .

If error, please print screen and send to johanes_gumabo@yahoo.co.id
Under development. Support me via PayPal.