rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home

Classes | Macros | Enumerations | Functions
event.h File Reference
#include <ilviews/macros.h>
#include <ilviews/base/geometry.h>

Classes

class  IlvEvent
 Event handling class. More...
 

Macros

#define IlvAltGModifier
 
#define IlvAltKey
 
#define IlvAltModifier
 
#define IlvBackSpace
 
#define IlvBreakKey
 
#define IlvButton4
 
#define IlvButton5
 
#define IlvCancelKey
 
#define IlvCapsLockKey
 
#define IlvClear
 
#define IlvCtrlChar(c)
 
#define IlvCtrlKey
 
#define IlvCtrlModifier
 
#define IlvDeleteKey
 
#define IlvDelKey
 
#define IlvDownKey
 
#define IlvEndKey
 
#define IlvEscape
 
#define IlvExecuteKey
 
#define IlvF0Key
 
#define IlvF10Key
 
#define IlvF11Key
 
#define IlvF12Key
 
#define IlvF13Key
 
#define IlvF14Key
 
#define IlvF15Key
 
#define IlvF16Key
 
#define IlvF17Key
 
#define IlvF18Key
 
#define IlvF19Key
 
#define IlvF1Key
 
#define IlvF2Key
 
#define IlvF3Key
 
#define IlvF4Key
 
#define IlvF5Key
 
#define IlvF6Key
 
#define IlvF7Key
 
#define IlvF8Key
 
#define IlvF9Key
 
#define IlvHelpKey
 
#define IlvHomeKey
 
#define IlvInsKey
 
#define IlvLeftButton
 
#define IlvLeftKey
 
#define IlvLinefeed
 
#define IlvLockModifier
 
#define IlvMetaKey
 
#define IlvMetaModifier
 
#define IlvMiddleButton
 
#define IlvNumLockKey
 
#define IlvNumModifier
 
#define IlvPageDownKey
 
#define IlvPageUpKey
 
#define IlvPause
 
#define IlvPauseKey
 
#define IlvPrScreenKey
 
#define IlvRAltKey
 
#define IlvRCtrlKey
 
#define IlvReturn
 
#define IlvRightButton
 
#define IlvRightKey
 
#define IlvRMetaKey
 
#define IlvRShiftKey
 
#define IlvScrollLock
 
#define IlvSelectKey
 
#define IlvShiftKey
 
#define IlvShiftModifier
 
#define IlvSysReq
 
#define IlvSystemKey
 
#define IlvTab
 
#define IlvUpKey
 
#define IlvUserKey
 

Enumerations

enum  IlvEventType {
  IlvKeyUp, IlvKeyDown, IlvButtonDown, IlvButtonUp,
  IlvEnterWindow, IlvLeaveWindow, IlvPointerMoved, IlvButtonDragged,
  IlvRepaint , IlvMapWindow, IlvUnMapWindow , IlvKeyboardFocusIn,
  IlvKeyboardFocusOut , IlvDoubleClick, IlvMouseEnter, IlvMouseLeave ,
  IlvMultiClick , IlvMouseWheel, IlvTouchDown, IlvTouchMoved,
  IlvTouchUp
}
 The different types of events managed by Rogue Wave Views. More...
 

Functions

IlUShort IlvGetDoubleClickPeriod ()
 Retrieves the double-click mouse period. More...
 
void IlvSetDoubleClickPeriod (IlUShort)
 Sets the double-click mouse period. More...
 

Detailed Description

[library display ilviews/base/event.h] Declaration of the event-related syumbols.

Macro Definition Documentation

#define IlvAltGModifier

The symbol that represents the AltGr modifier.

#define IlvAltKey

The symbol that represents the Alt key. If you have two Alt keys on your keyboard, this symbol represents the left one.

#define IlvAltModifier

The symbol that represents the Alt modifier.

#define IlvBackSpace

The symbol that represents the BackSpace key.

#define IlvBreakKey

The symbol that represents the Break key.

#define IlvButton4

The symbol that represents the fourth mouse button.

#define IlvButton5

The symbol that represents the fifth mouse button.

#define IlvCancelKey

The symbol that represents the Cancel key.

#define IlvCapsLockKey

The symbol that represents the CapsLock key.

#define IlvClear

The symbol that represents the Clear key.

#define IlvCtrlChar (   c)

This macro takes the key code parameter c (a char) and returns the corresponding Control key. For example, IlvCtrlChar('G') would return 7, which is the ASCII code for ^G (the Ctrl-G combination).
The parameter c must be an upper-case letter.

#define IlvCtrlKey

The symbol that represents the Ctrl key. If you have two Ctrl keys on your keyboard, this symbol represents the left one.

#define IlvCtrlModifier

The symbol that represents the Ctrl modifier.

#define IlvDeleteKey

The symbol that represents the Delete key.

#define IlvDelKey

The symbol that represents the Del key.

#define IlvDownKey

The symbol that represents the Down key.

#define IlvEndKey

The symbol that represents the End key.

#define IlvEscape

The symbol that represents the Escape key.

#define IlvExecuteKey

The symbol that represents the Execute key.

#define IlvF0Key

The symbol that represents the F0 key.

#define IlvF10Key

The symbol that represents the F10 key.

#define IlvF11Key

The symbol that represents the F11 key.

#define IlvF12Key

The symbol that represents the F12 key.

#define IlvF13Key

The symbol that represents the F13 key.

#define IlvF14Key

The symbol that represents the F14 key.

#define IlvF15Key

The symbol that represents the F15 key.

#define IlvF16Key

The symbol that represents the F16 key.

#define IlvF17Key

The symbol that represents the F17 key.

#define IlvF18Key

The symbol that represents the F18 key.

#define IlvF19Key

The symbol that represents the F19 key.

#define IlvF1Key

The symbol that represents the F1 key.

#define IlvF2Key

The symbol that represents the F2 key.

#define IlvF3Key

The symbol that represents the F3 key.

#define IlvF4Key

The symbol that represents the F4 key.

#define IlvF5Key

The symbol that represents the F5 key.

#define IlvF6Key

The symbol that represents the F6 key.

#define IlvF7Key

The symbol that represents the F7 key.

#define IlvF8Key

The symbol that represents the F8 key.

#define IlvF9Key

The symbol that represents the F9 key.

#define IlvHelpKey

The symbol that represents the Help key.

#define IlvHomeKey

The symbol that represents the Home key.

#define IlvInsKey

The symbol that represents the Ins key.

#define IlvLeftButton

The symbol that represents the Left mouse button.

#define IlvLeftKey

The symbol that represents the Left key.

#define IlvLinefeed

The symbol that represents the Linefeed key.

#define IlvLockModifier

The symbol that represents the CapsLock modifier.

#define IlvMetaKey

The symbol that represents the Meta key. If you have two Meta keys on your keyboard, this symbol represents the left one.

#define IlvMetaModifier

The symbol that represents the Meta modifier.

#define IlvMiddleButton

The symbol that represents the Middle mouse button.

#define IlvNumLockKey

The symbol that represents the NumLock key.

#define IlvNumModifier

The symbol that represents the NumLock modifier.

#define IlvPageDownKey

The symbol that represents the PageDown key.

#define IlvPageUpKey

The symbol that represents the PageUp key.

#define IlvPause

The symbol that represents the Pause key.

#define IlvPauseKey

The symbol that represents the Pause key.

#define IlvPrScreenKey

The symbol that represents the PrScreen key.

#define IlvRAltKey

The symbol that represents the right Alt key.

#define IlvRCtrlKey

The symbol that represents the right Ctrl key.

#define IlvReturn

The symbol that represents the Return key.

#define IlvRightButton

The symbol that represents the Right mouse button.

#define IlvRightKey

The symbol that represents the Right key.

#define IlvRMetaKey

The symbol that represents the right Meta key.

#define IlvRShiftKey

The symbol that represents the right Shift key.

#define IlvScrollLock

The symbol that represents the ScrollLock key.

#define IlvSelectKey

The symbol that represents the Select key.

#define IlvShiftKey

The symbol that represents the Shift key. If you have two Shift keys on your keyboard, this symbol represents the left one.

#define IlvShiftModifier

The symbol that represents the Shift modifier.

#define IlvSysReq

The symbol that represents the SysReq key.

#define IlvSystemKey

The symbol that represents the System key.

#define IlvTab

The symbol that represents the Tab key.

#define IlvUpKey

The symbol that represents the Up key.

#define IlvUserKey

The symbol that represents the User key.

Enumeration Type Documentation

enum IlvEventType

The different types of events managed by Rogue Wave Views.

An IlvEvent can represent different sorts of events that are received by your application. This type enumerates the possible event types.

Enumerator
IlvKeyUp 

A key was released.

IlvKeyDown 

A key was pressed.

IlvButtonDown 

A mouse button was pressed.

IlvButtonUp 

A mouse button was released.

IlvEnterWindow 

The mouse pointer entered an IlvView.

IlvLeaveWindow 

The mouse pointer left an IlvView.

IlvPointerMoved 

The mouse pointer was moved.

IlvButtonDragged 

The mouse was moved while a button was pressed.

IlvRepaint 

An expose event.

IlvMapWindow 

A view is displayed.

IlvUnMapWindow 

A view is hidden.

IlvKeyboardFocusIn 

The focus was sent to an IlvView.

IlvKeyboardFocusOut 

The focus was lost by an IlvView.

IlvDoubleClick 

A mouse button was pressed twice quickly.

See Also
IlvSetDoubleClickPeriod, IlvGetDoubleClickPeriod.
IlvMouseEnter 

The mouse pointer entered an IlvGraphic.

IlvMouseLeave 

The mouse pointer left an IlvGraphic.

IlvMultiClick 

A mouse button was pressed more than twice quickly.

IlvMouseWheel 

The mouse wheel was moved.

IlvTouchDown 

Multitouch event. A new touch point appeared.

IlvTouchMoved 

Multitouch event. An existing touch point was moved.

IlvTouchUp 

Multitouch event. A touch point was removed.

Function Documentation

IlvGetDoubleClickPeriod ( )

Retrieves the double-click mouse period.

This global function is used to get the maximum period allowed between two (or several) mouse clicks, in order that they be considered as a single double-click (or multi-click) event.

Returns
The period, in milliseconds, under which a pair of clicks are considered to be a double-click event.
See Also
IlvSetDoubleClickPeriod(), IlvDoubleClick.
IlvSetDoubleClickPeriod ( IlUShort  )

Sets the double-click mouse period.

Use this global function to set the maximum period allowed between two (or several) mouse clicks, in order that they be considered as a single double-click (or multi-click) event. Beyond this value, a series of clicks is seen as a succession of simple click events.

Parameters
periodThe maximum multi-click period, in milliseconds.
See Also
IlvGetDoubleClickPeriod, IlvDoubleClick.

© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.