Qt 4.8
Public Functions | Protected Variables | List of all members
QShortcutEvent Class Reference

The QShortcutEvent class provides an event which is generated when the user presses a key combination. More...

#include <qevent.h>

Inheritance diagram for QShortcutEvent:
QEvent

Public Functions

bool isAmbiguous ()
 
bool isAmbiguous () const
 Returns true if the key sequence that triggered the event is ambiguous. More...
 
const QKeySequencekey ()
 
const QKeySequencekey () const
 Returns the key sequence that triggered the event. More...
 
 QShortcutEvent (const QKeySequence &key, int id, bool ambiguous=false)
 Constructs a shortcut event for the given key press, associated with the QShortcut ID id. More...
 
int shortcutId ()
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
int shortcutId () const
 Returns the ID of the QShortcut object for which this event was generated. More...
 
 ~QShortcutEvent ()
 Destroys the event object. More...
 
- Public Functions inherited from QEvent
void accept ()
 Sets the accept flag of the event object, the equivalent of calling setAccepted(true). More...
 
void ignore ()
 Clears the accept flag parameter of the event object, the equivalent of calling setAccepted(false). More...
 
bool isAccepted () const
 
 QEvent (Type type)
 Contructs an event object of type type. More...
 
void setAccepted (bool accepted)
 
bool spontaneous () const
 Returns true if the event originated outside the application (a system event); otherwise returns false. More...
 
Type type () const
 Returns the event type. More...
 
virtual ~QEvent ()
 Destroys the event. More...
 

Protected Variables

bool ambig
 
QKeySequence sequence
 
int sid
 
- Protected Variables inherited from QEvent
QEventPrivate * d
 
ushort t
 

Additional Inherited Members

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

Detailed Description

The QShortcutEvent class provides an event which is generated when the user presses a key combination.

Normally you don't need to use this class directly; QShortcut provides a higher-level interface to handle shortcut keys.

See also
QShortcut

Definition at line 675 of file qevent.h.

Constructors and Destructors

◆ QShortcutEvent()

QShortcutEvent::QShortcutEvent ( const QKeySequence key,
int  id,
bool  ambiguous = false 
)

Constructs a shortcut event for the given key press, associated with the QShortcut ID id.

ambiguous specifies whether there is more than one QShortcut for the same key sequence.

Definition at line 3624 of file qevent.cpp.

3625  : QEvent(Shortcut), sequence(key), ambig(ambiguous), sid(id)
3626 {
3627 }
QKeySequence sequence
Definition: qevent.h:688
QEvent(Type type)
Contructs an event object of type type.
Definition: qcoreevent.cpp:289
bool ambig
Definition: qevent.h:689

◆ ~QShortcutEvent()

QShortcutEvent::~QShortcutEvent ( )

Destroys the event object.

Definition at line 3632 of file qevent.cpp.

3633 {
3634 }

Functions

◆ isAmbiguous() [1/2]

bool QShortcutEvent::isAmbiguous ( )
inline
Warning
This function is not part of the public interface.

Definition at line 685 of file qevent.h.

Referenced by QShortcut::event(), QAbstractButton::event(), QLabel::event(), and QAction::event().

685 { return ambig; }
bool ambig
Definition: qevent.h:689

◆ isAmbiguous() [2/2]

bool QShortcutEvent::isAmbiguous ( ) const
inline

Returns true if the key sequence that triggered the event is ambiguous.

See also
QShortcut::activatedAmbiguously()

Definition at line 686 of file qevent.h.

686 { return ambig; }
bool ambig
Definition: qevent.h:689

◆ key() [1/2]

const QKeySequence & QShortcutEvent::key ( )
inline
Warning
This function is not part of the public interface.

Definition at line 681 of file qevent.h.

Referenced by QShortcut::event(), and QAction::event().

681 { return sequence; }
QKeySequence sequence
Definition: qevent.h:688

◆ key() [2/2]

const QKeySequence & QShortcutEvent::key ( ) const
inline

Returns the key sequence that triggered the event.

Definition at line 682 of file qevent.h.

682 { return sequence; }
QKeySequence sequence
Definition: qevent.h:688

◆ shortcutId() [1/2]

int QShortcutEvent::shortcutId ( )
inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Warning
This function is not part of the public interface.

Definition at line 683 of file qevent.h.

Referenced by QGroupBox::event(), QShortcut::event(), QWorkspace::event(), QAbstractButton::event(), QLabel::event(), QMenuBar::event(), and QTabBar::event().

683 { return sid; }

◆ shortcutId() [2/2]

int QShortcutEvent::shortcutId ( ) const
inline

Returns the ID of the QShortcut object for which this event was generated.

See also
QShortcut::id()

Definition at line 684 of file qevent.h.

684 { return sid; }

Properties

◆ ambig

bool QShortcutEvent::ambig
protected

Definition at line 689 of file qevent.h.

◆ sequence

QKeySequence QShortcutEvent::sequence
protected

Definition at line 688 of file qevent.h.

◆ sid

int QShortcutEvent::sid
protected

Definition at line 690 of file qevent.h.


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