From d796c9dd933ab96ec83b9a634feedd5d32e1ba3f Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Tue, 8 Nov 2011 12:31:36 -0600 Subject: Test conversion to TQt3 from Qt3 8c6fc1f8e35fd264dd01c582ca5e7549b32ab731 --- doc/html/qkeyevent.html | 185 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 185 insertions(+) create mode 100644 doc/html/qkeyevent.html (limited to 'doc/html/qkeyevent.html') diff --git a/doc/html/qkeyevent.html b/doc/html/qkeyevent.html new file mode 100644 index 000000000..af844331a --- /dev/null +++ b/doc/html/qkeyevent.html @@ -0,0 +1,185 @@ + + + + + +TQKeyEvent Class + + + + + + + +

TQKeyEvent Class Reference

+ +

The TQKeyEvent class contains describes a key event. +More... +

#include <qevent.h> +

Inherits TQEvent. +

List of all member functions. +

Public Members

TQKeyEvent ( Type type, int key, int ascii, int state, const TQString & text = TQString::null, bool autorep = FALSE, ushort count = 1 )
int key () const
int ascii () const
ButtonState state () const
ButtonState stateAfter () const
bool isAccepted () const
TQString text () const
bool isAutoRepeat () const
int count () const
void accept ()
void ignore ()

Detailed Description

+ + +The TQKeyEvent class contains describes a key event. +

Key events occur when a key is pressed or released when a widget +has keyboard input focus. +

A key event contains a special accept flag that indicates whether the +receiver wants the key event. You should call TQKeyEvent::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 +TQKeyEvent::accept() or an event filter consumes it. +Key events for multi media keys are ignored by default. You should call +TQKeyEvent::accept() if your widget handles those events. +

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

The event handlers TQWidget::keyPressEvent() and +TQWidget::keyReleaseEvent() receive key events. +

See also TQFocusEvent, TQWidget::grabKeyboard(), and Event Classes. + +

Member Function Documentation

TQKeyEvent::TQKeyEvent ( Type type, int key, int ascii, int state, const TQString & text = TQString::null, bool autorep = FALSE, ushort count = 1 ) +

+ +

Constructs a key event object. +

The type parameter must be TQEvent::KeyPress or TQEvent::KeyRelease. If key is 0 the event is not a result of a +known key (e.g. it may be the result of a compose sequence or +keyboard macro). ascii is the ASCII code of the key that was +pressed or released. state holds the keyboard modifiers. text is the Unicode text that the key generated. If autorep is +TRUE, isAutoRepeat() will be TRUE. count is the number of +single keys. +

The accept flag is set to TRUE. + +

void TQKeyEvent::accept () +

+ +

Sets the accept flag of the key event object. +

Setting the accept parameter indicates that the receiver of the +event wants the key event. Unwanted key events are sent to the +parent widget. +

The accept flag is set by default. +

int TQKeyEvent::ascii () const +

+ +

Returns the ASCII code of the key that was pressed or released. We +recommend using text() instead. +

int TQKeyEvent::count () const +

+ +

Returns the number of single keys for this event. If text() is not +empty, this is simply the length of the string. +

See also TQWidget::setKeyCompression(). + +

void TQKeyEvent::ignore () +

+ +

Clears the accept flag parameter of the key event object. +

Clearing the accept parameter indicates that the event receiver +does not want the key event. Unwanted key events are sent to the +parent widget. +

The accept flag is set by default. +

bool TQKeyEvent::isAccepted () const +

+ +

Returns TRUE if the receiver of the event wants to keep the key; +otherwise returns FALSE + +

bool TQKeyEvent::isAutoRepeat () const +

+ +

Returns TRUE if this event comes from an auto-repeating key and +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. + +

int TQKeyEvent::key () const +

+ +

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

See TQt::Key for the list of keyboard codes. These codes are +independent of the underlying window system. +

A value of either 0 or Key_unknown means that the event is not +the result of a known key (e.g. it may be the result of a compose +sequence or a keyboard macro, or due to key event compression). +

See also TQWidget::setKeyCompression(). + +

Example: fileiconview/qfileiconview.cpp. +

ButtonState TQKeyEvent::state () const +

+ +

Returns the keyboard modifier flags that existed immediately +before the event occurred. +

The returned value is ShiftButton, ControlButton, AltButton +and MetaButton OR'ed together. +

ButtonState TQKeyEvent::stateAfter () const +

+ +

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

Warning: This function cannot be trusted. +

TQString TQKeyEvent::text () const +

+ +

Returns the Unicode text that this key generated. The text returned +migth be empty, which is the case when pressing or +releasing modifying keys as Shift, Control, Alt and Meta. In these +cases key() will contain a valid value. +

See also TQWidget::setKeyCompression(). + + +

+ +

Trademarks +

TQt 3.3.8

+ -- cgit v1.2.1