tbx  0.7.5
Public Types | Public Member Functions | List of all members
tbx::KeyEvent Class Reference

Event data for lose or gain caret listener. More...

#include <keylistener.h>

Inheritance diagram for tbx::KeyEvent:
tbx::EventInfo

Public Types

enum  SpecialKeys {
  Escape = 0x1B, Print = 0x180, Shift_Print = 0x190, Control_Print = 0x1A0,
  ControlShift_Print = 0x1B0, F1 = 0x181, Shift_F1 = 0x191, Control_F1 = 0x1A1,
  ControlShift_F1 = 0x1B1, F2 = 0x182, Shift_F2 = 0x192, Control_F2 = 0x1A2,
  ControlShift_F2 = 0x1B2, F3 = 0x183, Shift_F3 = 0x193, Control_F3 = 0x1A3,
  ControlShift_F3 = 0x1B3, F4 = 0x184, Shift_F4 = 0x194, Control_F4 = 0x1A4,
  ControlShift_F4 = 0x1B4, F5 = 0x185, Shift_F5 = 0x195, Control_F5 = 0x1A5,
  ControlShift_F5 = 0x1B5, F6 = 0x186, Shift_F6 = 0x196, Control_F6 = 0x1A6,
  ControlShift_F6 = 0x1B6, F7 = 0x187, Shift_F7 = 0x197, Control_F7 = 0x1A7,
  ControlShift_F7 = 0x1B7, F8 = 0x188, Shift_F8 = 0x198, Control_F8 = 0x1A8,
  ControlShift_F8 = 0x1B8, F9 = 0x189, Shift_F9 = 0x199, Control_F9 = 0x1A9,
  ControlShift_F9 = 0x1B9, Tab = 0x18A, Shift_Tab = 0x19A, Control_Tab = 0x1AA,
  ControlShift_Tab = 0x1BA, Copy = 0x18B, Shift_Copy = 0x19B, Control_Copy = 0x1AB,
  ControlShift_Copy = 0x1BB, LeftArrow = 0x18C, Shift_LeftArrow = 0x19C, Control_LeftArrow = 0x1AC,
  ControlShift_LeftArrow = 0x1BC, RightArrow = 0x18D, Shift_RightArrow = 0x19D, Control_RightArrow = 0x1AD,
  ControlShift_RightArrow = 0x1BD, DownArrow = 0x18E, Shift_DownArrow = 0x19E, Control_DownArrow = 0x1AE,
  ControlShift_DownArrow = 0x1BE, UpArrow = 0x18F, Shift_UpArrow = 0x19F, Control_UpArrow = 0x1AF,
  ControlShift_UpArrow = 0x1BF, PageDown = 0x19E, Shift_PageDown = 0x18E, Control_PageDown = 0x1BE,
  ControlShift_PageDown = 0x1AE, PageUp = 0x19F, Shift_PageUp = 0x18F, Control_PageUp = 0x1BF,
  ControlShift_PageUp = 0x1AF, F10 = 0x1CA, Shift_F10 = 0x1DA, Control_F10 = 0x1EA,
  ControlShift_F10 = 0x1FA, F11 = 0x1CB, Shift_F11 = 0x1DB, Control_F11 = 0x1EB,
  ControlShift_F11 = 0x1FB, F12 = 0x1CC, Shift_F12 = 0x1DC, Control_F12 = 0x1EC,
  ControlShift_F12 = 0x1FC, Insert = 0x1CD, Shift_Insert = 0x1DD, Control_Insert = 0x1ED,
  ControlShift_Insert = 0x1FD
}
 Enumeration for special key codes passed from the WIMP.
 

Public Member Functions

 KeyEvent (IdBlock &id_block, PollBlock &poll_block)
 Construct KeyEvent from information returned from the WIMP. More...
 
Window window () const
 Get Window that the key is pressed in.
 
Gadget gadget () const
 Get the gadget that the key is pressed in. More...
 
int x_offset () const
 Get the current x offset of the caret relative to the window origin.
 
int y_offset () const
 Get the current y offset of the caret relative to the window origin.
 
int height () const
 Get the height of the caret.
 
int colour () const
 Get caret colour - if colour set.
 
bool vdu () const
 Is it a vdu caret. More...
 
bool invisible () const
 Invisible caret.
 
bool uses_colour () const
 caret_color is used for the colour otherwise caret is Wimp colour 11
 
bool colour_untranslated () const
 Colour is untranslated, otherwise they are a Wimp colour.
 
int index () const
 The index of the caret into the writeable field or -1 if not in a writeable field.
 
int key () const
 key code of character press. More...
 
void key_used ()
 Call if the key has been used by the listener.
 
bool is_key_used () const
 Returns true if a listener has used the key.
 
- Public Member Functions inherited from tbx::EventInfo
 EventInfo (const IdBlock &id_block, PollBlock &data)
 Contruct the event information from the id_block and data update by the toolbox.
 
const IdBlockid_block () const
 IdBlock for the current event. More...
 

Additional Inherited Members

- Protected Attributes inherited from tbx::EventInfo
PollBlock_data
 raw data from the event
 

Detailed Description

Event data for lose or gain caret listener.

Constructor & Destructor Documentation

◆ KeyEvent()

tbx::KeyEvent::KeyEvent ( IdBlock id_block,
PollBlock poll_block 
)
inline

Construct KeyEvent from information returned from the WIMP.

Parameters
id_blockToolbox ID block
poll_blockWIMP message block

Member Function Documentation

◆ gadget()

Gadget tbx::KeyEvent::gadget ( ) const
inline

Get the gadget that the key is pressed in.

Returns
gadget or a null gadget focus on a window

◆ key()

int tbx::KeyEvent::key ( ) const
inline

key code of character press.

As well as ascii values can also be from the SpecialKeys enumeration.

◆ vdu()

bool tbx::KeyEvent::vdu ( ) const
inline

Is it a vdu caret.

Returns
true for vdu caret, false for antialiased caret

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