Qyoto  4.0.7
Qyoto is a C# language binding for Qt
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties
QtGui.QKeyEvent Class Reference

The QKeyEvent class describes a key event. More...

Inheritance diagram for QtGui.QKeyEvent:
Collaboration diagram for QtGui.QKeyEvent:

Public Member Functions

override bool Equals (object o)
 
override int GetHashCode ()
 
 QKeyEvent (QKeyEvent copy)
 
 QKeyEvent (QEvent.Type type, int key, Qt.KeyboardModifier modifiers, string text="", bool autorep=false, ushort count=1)
  More...
 
override void CreateProxy ()
 
new bool Matches (QKeySequence.StandardKey key)
  More...
 
new void Dispose ()
 
- Public Member Functions inherited from QtGui.QInputEvent
 QInputEvent (QInputEvent copy)
 
 QInputEvent (QEvent.Type type, Qt.KeyboardModifier modifiers=Qt.KeyboardModifier.NoModifier)
 
new void Dispose ()
 
- Public Member Functions inherited from QtCore.QEvent
 QEvent (QEvent copy)
 
 QEvent (QEvent.Type type)
  More...
 
new void Accept ()
  More...
 
new void Ignore ()
  More...
 
new void SetAccepted (bool accepted)
 
new void Dispose ()
 

Static Public Member Functions

static bool operator== (QKeyEvent e, QKeySequence.StandardKey key)
  More...
 
static QKeyEvent OnCreateExtendedKeyEvent (QEvent.Type type, int key, Qt.KeyboardModifier modifiers, uint nativeScanCode, uint nativeVirtualKey, uint nativeModifiers)
 
static QKeyEvent OnCreateExtendedKeyEvent (QEvent.Type type, int key, Qt.KeyboardModifier modifiers, uint nativeScanCode, uint nativeVirtualKey, uint nativeModifiers, string text="")
 
static QKeyEvent OnCreateExtendedKeyEvent (QEvent.Type type, int key, Qt.KeyboardModifier modifiers, uint nativeScanCode, uint nativeVirtualKey, uint nativeModifiers, string text="", bool autorep=false)
 
static QKeyEvent OnCreateExtendedKeyEvent (QEvent.Type type, int key, Qt.KeyboardModifier modifiers, uint nativeScanCode, uint nativeVirtualKey, uint nativeModifiers, string text="", bool autorep=false, ushort count=1)
 
static bool operator!= (QKeyEvent e, QKeySequence.StandardKey key)
 

Protected Member Functions

 QKeyEvent (System.Type dummy)
 
- Protected Member Functions inherited from QtGui.QInputEvent
 QInputEvent (System.Type dummy)
 
- Protected Member Functions inherited from QtCore.QEvent
 QEvent (System.Type dummy)
 

Properties

int Count [get]
  More...
 
bool HasExtendedInfo [get]
 
bool IsAutoRepeat [get]
  More...
 
int Key [get]
  More...
 
Qt.KeyboardModifier Modifiers [get]
  More...
 
uint NativeModifiers [get]
  More...
 
uint NativeScanCode [get]
  More...
 
uint NativeVirtualKey [get]
  More...
 
string Text [get]
  More...
 
new uint Autor [get, set]
 
new ushort C [get, set]
 
new int K [get, set]
 
new string Txt [get, set]
 
- Properties inherited from QtGui.QInputEvent
Qt.KeyboardModifier Modifiers [get, set]
  More...
 
new Qt.KeyboardModifier ModState [get, set]
 
- Properties inherited from QtCore.QEvent
bool IsAccepted [get]
 
bool Spontaneous [get]
  More...
 
QEvent.Type type [get]
  More...
 
virtual System.IntPtr SmokeObject [get, set]
 
new ushort T [get, set]
 
static new QMetaObject StaticMetaObject [get]
 

Additional Inherited Members

- Public Types inherited from QtCore.QEvent
enum  Type {
  AcceptDropsChange = 152, AccessibilityDescription = 130, AccessibilityHelp = 119, AccessibilityPrepare = 86,
  ActionAdded = 114, ActionChanged = 113, ActionRemoved = 115, ActivateControl = 80,
  ActivationChange = 99, ApplicationActivate = 121, ApplicationActivated = 121, ApplicationDeactivate = 122,
  ApplicationDeactivated = 122, ApplicationFontChange = 36, ApplicationLayoutDirectionChange = 37, ApplicationPaletteChange = 38,
  ApplicationWindowIconChange = 35, ChildAdded = 68, ChildPolished = 69, ChildRemoved = 71,
  Clipboard = 40, Close = 19, CloseSoftwareInputPanel = 200, ContentsRectChange = 178,
  ContextMenu = 82, Create = 15, CursorChange = 183, DeactivateControl = 81,
  DeferredDelete = 52, Destroy = 16, DragEnter = 60, DragLeave = 62,
  DragMove = 61, DragResponse = 64, Drop = 63, DynamicPropertyChange = 170,
  EmbeddingControl = 79, EnabledChange = 98, Enter = 10, EnterWhatsThisMode = 124,
  FileOpen = 116, FocusIn = 8, FocusOut = 9, FontChange = 97,
  FutureCallOut = 180, Gesture = 198, GestureOverride = 202, GrabKeyboard = 188,
  GrabMouse = 186, GraphicsSceneContextMenu = 159, GraphicsSceneDragEnter = 164, GraphicsSceneDragLeave = 166,
  GraphicsSceneDragMove = 165, GraphicsSceneDrop = 167, GraphicsSceneHelp = 163, GraphicsSceneHoverEnter = 160,
  GraphicsSceneHoverLeave = 162, GraphicsSceneHoverMove = 161, GraphicsSceneMouseDoubleClick = 158, GraphicsSceneMouseMove = 155,
  GraphicsSceneMousePress = 156, GraphicsSceneMouseRelease = 157, GraphicsSceneMove = 182, GraphicsSceneResize = 181,
  GraphicsSceneWheel = 168, HelpRequest = 95, Hide = 18, HideToParent = 27,
  HoverEnter = 127, HoverLeave = 128, HoverMove = 129, IconDrag = 96,
  IconTextChange = 101, InputMethod = 83, KeyPress = 6, KeyRelease = 7,
  KeyboardLayoutChange = 169, LanguageChange = 89, LayoutDirectionChange = 90, LayoutRequest = 76,
  Leave = 11, LeaveWhatsThisMode = 125, LocaleChange = 88, MacGLClearDrawable = 191,
  MacGLWindowChange = 179, MacSizeChange = 177, MaxUser = 65535, MenubarUpdated = 153,
  MetaCall = 43, ModifiedChange = 102, MouseButtonDblClick = 4, MouseButtonPress = 2,
  MouseButtonRelease = 3, MouseMove = 5, MouseTrackingChange = 109, Move = 13,
  NativeGesture = 197, NetworkReplyUpdated = 185, NonClientAreaMouseButtonDblClick = 176, NonClientAreaMouseButtonPress = 174,
  NonClientAreaMouseButtonRelease = 175, NonClientAreaMouseMove = 173, None = 0, OkRequest = 94,
  Paint = 12, PaletteChange = 39, ParentAboutToChange = 131, ParentChange = 21,
  PlatformPanel = 212, Polish = 75, PolishRequest = 74, QueryWhatsThis = 123,
  Quit = 20, RequestSoftwareInputPanel = 199, Resize = 14, Shortcut = 117,
  ShortcutOverride = 51, Show = 17, ShowToParent = 26, ShowWindowRequest = 73,
  SockAct = 50, Speech = 42, StateMachineSignal = 192, StateMachineWrapped = 193,
  StatusTip = 112, Style = 91, StyleChange = 100, TabletEnterProximity = 171,
  TabletLeaveProximity = 172, TabletMove = 87, TabletPress = 92, TabletRelease = 93,
  ThreadChange = 22, Timer = 1, ToolBarChange = 120, ToolTip = 110,
  ToolTipChange = 184, TouchBegin = 194, TouchEnd = 196, TouchUpdate = 195,
  UngrabKeyboard = 189, UngrabMouse = 187, UpdateLater = 78, UpdateRequest = 77,
  UpdateSoftKeys = 201, User = 1000, WhatsThis = 111, WhatsThisClicked = 118,
  Wheel = 31, WinEventAct = 132, WinIdChange = 203, WindowActivate = 24,
  WindowBlocked = 103, WindowDeactivate = 25, WindowIconChange = 34, WindowStateChange = 105,
  WindowTitleChange = 33, WindowUnblocked = 104, ZOrderChange = 126, ZeroTimerEvent = 154
}
  More...
 
- Protected Attributes inherited from QtCore.QEvent
SmokeInvocation interceptor
 

Detailed Description

The QKeyEvent class describes a key event.

Key events are sent to the widget with keyboard input focus when keys are pressed or released.

A key event contains a special accept flag that indicates whether the receiver will handle the key event. You should call ignore() if the key press or release event is not handled by your widget. A key event is propagated up the parent widget chain until a widget accepts it with accept() or an event filter consumes it. Key events for multimedia keys are ignored by default. You should call accept() if your widget handles those events.

The QWidget::setEnable() function can be used to enable or disable mouse and keyboard events for a widget.

The event handlers QWidget::keyPressEvent(), QWidget::keyReleaseEvent(), QGraphicsItem::keyPressEvent() and QGraphicsItem::keyReleaseEvent() receive key events.

See also QFocusEvent and QWidget::grabKeyboard().

Constructor & Destructor Documentation

QtGui.QKeyEvent.QKeyEvent ( System.Type  dummy)
protected

Here is the caller graph for this function:

QtGui.QKeyEvent.QKeyEvent ( QKeyEvent  copy)

Here is the call graph for this function:

QtGui.QKeyEvent.QKeyEvent ( QEvent.Type  type,
int  key,
Qt.KeyboardModifier  modifiers,
string  text = "",
bool  autorep = false,
ushort  count = 1 
)

Constructs a key event object.

The type parameter must be QEvent::KeyPress, QEvent::KeyRelease, or QEvent::ShortcutOverride.

Int key is the code for the Qt::Key that the event loop should listen for. If key is 0, the event is not a result of a known key; for example, it may be the result of a compose sequence or keyboard macro. The modifiers holds the keyboard modifiers, and the given text is the Unicode text that the key generated. If autorep is true, isAutoRepeat() will be true. count is the number of keys involved in the event.

Here is the call graph for this function:

Member Function Documentation

override void QtGui.QKeyEvent.CreateProxy ( )
virtual

Reimplemented from QtGui.QInputEvent.

Here is the caller graph for this function:

new void QtGui.QKeyEvent.Dispose ( )
override bool QtGui.QKeyEvent.Equals ( object  o)

Here is the call graph for this function:

override int QtGui.QKeyEvent.GetHashCode ( )
new bool QtGui.QKeyEvent.Matches ( QKeySequence.StandardKey  key)

Returns true if the key event matches the given standard key; otherwise returns false.

This function was introduced in Qt 4.2.

static QKeyEvent QtGui.QKeyEvent.OnCreateExtendedKeyEvent ( QEvent.Type  type,
int  key,
Qt.KeyboardModifier  modifiers,
uint  nativeScanCode,
uint  nativeVirtualKey,
uint  nativeModifiers 
)
static
static QKeyEvent QtGui.QKeyEvent.OnCreateExtendedKeyEvent ( QEvent.Type  type,
int  key,
Qt.KeyboardModifier  modifiers,
uint  nativeScanCode,
uint  nativeVirtualKey,
uint  nativeModifiers,
string  text = "" 
)
static
static QKeyEvent QtGui.QKeyEvent.OnCreateExtendedKeyEvent ( QEvent.Type  type,
int  key,
Qt.KeyboardModifier  modifiers,
uint  nativeScanCode,
uint  nativeVirtualKey,
uint  nativeModifiers,
string  text = "",
bool  autorep = false 
)
static
static QKeyEvent QtGui.QKeyEvent.OnCreateExtendedKeyEvent ( QEvent.Type  type,
int  key,
Qt.KeyboardModifier  modifiers,
uint  nativeScanCode,
uint  nativeVirtualKey,
uint  nativeModifiers,
string  text = "",
bool  autorep = false,
ushort  count = 1 
)
static
static bool QtGui.QKeyEvent.operator!= ( QKeyEvent  e,
QKeySequence.StandardKey  key 
)
static
static bool QtGui.QKeyEvent.operator== ( QKeyEvent  e,
QKeySequence.StandardKey  key 
)
static

Returns true if key is currently bound to the key combination specified by e.

Equivalent to e->matches(key).

Property Documentation

new uint QtGui.QKeyEvent.Autor
getsetprotected
new ushort QtGui.QKeyEvent.C
getsetprotected
int QtGui.QKeyEvent.Count
get

Returns the number of keys involved in this event. If text() is not empty, this is simply the length of the string.

See also Qt::WA_KeyCompression.

bool QtGui.QKeyEvent.HasExtendedInfo
get
bool QtGui.QKeyEvent.IsAutoRepeat
get

Returns true if this event comes from an auto-repeating key; returns false if it comes from an initial key press.

Note that if the event is a multiple-key compressed event that is partly due to auto-repeat, this function could return either true or false indeterminately.

new int QtGui.QKeyEvent.K
getsetprotected
int QtGui.QKeyEvent.Key
get

Returns the code of the key that was pressed or released.

See Qt::Key for the list of keyboard codes. These codes are independent of the underlying window system. Note that this function does not distinguish between capital and non-capital letters, use the text() function (returning the Unicode text the key generated) for this purpose.

A value of either 0 or Qt::Key_unknown means that the event is not the result of a known key; for example, it may be the result of a compose sequence, a keyboard macro, or due to key event compression.

See also Qt::WA_KeyCompression.

Qt.KeyboardModifier QtGui.QKeyEvent.Modifiers
get

Returns the keyboard modifier flags that existed immediately after the event occurred.

Warning: This function cannot always be trusted. The user can confuse it by pressing both Shift keys simultaneously and releasing one of them, for example.

See also QApplication::keyboardModifiers().

uint QtGui.QKeyEvent.NativeModifiers
get

Returns the native modifiers of a key event. If the key event does not contain this data 0 is returned.

Note: The native modifiers may be 0, even if the key event contains extended information.

This function was introduced in Qt 4.2.

uint QtGui.QKeyEvent.NativeScanCode
get

Returns the native scan code of the key event. If the key event does not contain this data 0 is returned.

Note: The native scan code may be 0, even if the key event contains extended information.

Note: On Mac OS/X, this function is not useful, because there is no way to get the scan code from Carbon or Cocoa. The function always returns 1 (or 0 in the case explained above).

This function was introduced in Qt 4.2.

uint QtGui.QKeyEvent.NativeVirtualKey
get

Returns the native virtual key, or key sym of the key event. If the key event does not contain this data 0 is returned.

Note: The native virtual key may be 0, even if the key event contains extended information.

This function was introduced in Qt 4.2.

string QtGui.QKeyEvent.Text
get

Returns the Unicode text that this key generated. The text returned can be an empty string in cases where modifier keys, such as Shift, Control, Alt, and Meta, are being pressed or released. In such cases key() will contain a valid value.

See also Qt::WA_KeyCompression.

new string QtGui.QKeyEvent.Txt
getsetprotected