From bd0f3345a938b35ce6a12f6150373b0955b8dd12 Mon Sep 17 00:00:00 2001 From: Timothy Pearson Date: Sun, 10 Jul 2011 15:24:15 -0500 Subject: Add Qt3 development HEAD version --- doc/html/qcontextmenuevent.html | 223 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 223 insertions(+) create mode 100644 doc/html/qcontextmenuevent.html (limited to 'doc/html/qcontextmenuevent.html') diff --git a/doc/html/qcontextmenuevent.html b/doc/html/qcontextmenuevent.html new file mode 100644 index 0000000..962594d --- /dev/null +++ b/doc/html/qcontextmenuevent.html @@ -0,0 +1,223 @@ + + + + + +QContextMenuEvent Class + + + + + + + +

QContextMenuEvent Class Reference

+ +

The QContextMenuEvent class contains parameters that describe a context menu event. +More... +

#include <qevent.h> +

Inherits QEvent. +

List of all member functions. +

Public Members

enum Reason { Mouse, Keyboard, Other }
QContextMenuEvent ( Reason reason, const QPoint & pos, const QPoint & globalPos, int state )
QContextMenuEvent ( Reason reason, const QPoint & pos, int state )
int x () const
int y () const
int globalX () const
int globalY () const
const QPoint & pos () const
const QPoint & globalPos () const
ButtonState state () const
bool isAccepted () const
bool isConsumed () const
void consume ()
void accept ()
void ignore ()
Reason reason () const

Detailed Description

+ + +The QContextMenuEvent class contains parameters that describe a context menu event. +

Context menu events are sent to widgets when a user triggers a +context menu. What triggers this is platform dependent. For +example, on Windows, pressing the menu button or releasing the +right mouse button will cause this event to be sent. +

When this event occurs it is customary to show a QPopupMenu with a +context menu, if this is relevant to the context. +

Context menu events contain a special accept flag that indicates +whether the receiver accepted the event. If the event handler does +not accept the event, then whatever triggered the event will be +handled as a regular input event if possible. +

See also QPopupMenu and Event Classes. + +

Member Type Documentation

QContextMenuEvent::Reason

+ +

This enum describes the reason the ContextMenuEvent was sent. The +values are: +

QContextMenuEvent::Mouse - The mouse caused the event to be sent. Normally this +means the right mouse button was clicked, but this is platform +specific. +
QContextMenuEvent::Keyboard - The keyboard caused this event to be sent. On +Windows this means the menu button was pressed. +
QContextMenuEvent::Other - The event was sent by some other means (i.e. not by +the mouse or keyboard). +

Member Function Documentation

QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, const QPoint & globalPos, int state ) +

+ +

Constructs a context menu event object with the accept parameter +flag set to FALSE. +

The reason parameter must be QContextMenuEvent::Mouse or QContextMenuEvent::Keyboard. +

The pos parameter specifies the mouse position relative to the +receiving widget. globalPos is the mouse position in absolute +coordinates. state is the ButtonState at the time of the event. + +

QContextMenuEvent::QContextMenuEvent ( Reason reason, const QPoint & pos, int state ) +

+ +

Constructs a context menu event object with the accept parameter +flag set to FALSE. +

The reason parameter must be QContextMenuEvent::Mouse or QContextMenuEvent::Keyboard. +

The pos parameter specifies the mouse position relative to the +receiving widget. state is the ButtonState at the time of the +event. +

The globalPos() is initialized to QCursor::pos(), which may not be +appropriate. Use the other constructor to specify the global +position explicitly. + +

void QContextMenuEvent::accept () +

+ +

Sets the accept flag of the context event object. +

Setting the accept flag indicates that the receiver of this event +has processed the event. Processing the event means you did +something with it and it will be implicitly consumed. +

The accept flag is not set by default. +

void QContextMenuEvent::consume () +

+ +

Sets the consume flag of the context event object. +

Setting the consume flag indicates that the receiver of this event +does not want the event to be propagated further (i.e. not sent to +parent classes.) +

The consumed flag is not set by default. +

const QPoint & QContextMenuEvent::globalPos () const +

+ +

Returns the global position of the mouse pointer at the time of +the event. +

int QContextMenuEvent::globalX () const +

+ +

Returns the global x-position of the mouse pointer at the time of +the event. +

int QContextMenuEvent::globalY () const +

+ +

Returns the global y-position of the mouse pointer at the time of +the event. +

void QContextMenuEvent::ignore () +

+ +

Clears the accept flag of the context event object. +

Clearing the accept flag indicates that the receiver of this event +does not need to show a context menu. This will implicitly remove +the consumed flag as well. +

The accept flag is not set by default. +

bool QContextMenuEvent::isAccepted () const +

+ +

Returns TRUE if the receiver has processed the event; otherwise +returns FALSE. +

See also accept(), ignore(), and consume(). + +

bool QContextMenuEvent::isConsumed () const +

+ +

Returns TRUE (which stops propagation of the event) if the +receiver has blocked the event; otherwise returns FALSE. +

See also accept(), ignore(), and consume(). + +

const QPoint & QContextMenuEvent::pos () const +

+ +

Returns the position of the mouse pointer relative to the widget +that received the event. +

Reason QContextMenuEvent::reason () const +

+ +

Returns the reason for this context event. + +

ButtonState QContextMenuEvent::state () const +

+ +

Returns the button state (a combination of mouse buttons and +keyboard modifiers), i.e. what buttons and keys were being +pressed immediately before the event was generated. +

The returned value is LeftButton, RightButton, MidButton, +ShiftButton, ControlButton and AltButton OR'ed together. + +

int QContextMenuEvent::x () const +

+ +

Returns the x-position of the mouse pointer, relative to the +widget that received the event. +

int QContextMenuEvent::y () const +

+ +

Returns the y-position of the mouse pointer, relative to the +widget that received the event. +