QContextMenuEvent(3qt)													    QContextMenuEvent(3qt)

NAME

       QContextMenuEvent - Parameters that describe a context menu event

SYNOPSIS

       #include <qevent.h>

       Inherits QEvent.

   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

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.

       See also ignore() and consume().

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.

       See also ignore() and accept().

const QPoint &; QContextMenuEvent::globalPos () const
       Returns the global position of the mouse pointer at the time of the event.

       See also x(), y(), and pos().

int QContextMenuEvent::globalX () const
       Returns the global x-position of the mouse pointer at the time of the event.

       See also globalY() and globalPos().

int QContextMenuEvent::globalY () const
       Returns the global y-position of the mouse pointer at the time of the event.

       See also globalX() and globalPos().

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.

       See also accept() and consume().

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.

       See also x(), y(), and globalPos().

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.

       See also y() and pos().

int QContextMenuEvent::y () const
       Returns the y-position of the mouse pointer, relative to the widget that received the event.

       See also x() and pos().

SEE ALSO

       http://doc.trolltech.com/qcontextmenuevent.html http://www.trolltech.com/faq/tech.html

COPYRIGHT

       Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com.  See the license file included in the distribution for a complete license
       statement.

AUTHOR

       Generated automatically from the source code.

BUGS

       If you find a bug in Qt, please report it as described in http://doc.trolltech.com/bughowto.html.  Good bug reports help us to help you.
       Thank you.

       The definitive Qt documentation is provided in HTML format; it is located at $QTDIR/doc/html and can be read using Qt Assistant or with a
       web browser. This man page is provided as a convenience for those users who prefer man pages, although this format is not officially
       supported by Trolltech.

       If you find errors in this manual page, please report them to qt-bugs@trolltech.com.  Please include the name of the manual page
       (qcontextmenuevent.3qt) and the Qt version (3.3.8).

Trolltech AS							  2 February 2007					    QContextMenuEvent(3qt)