File: qcontextmenuevent.html

package info (click to toggle)
qt4-x11 4%3A4.8.2%2Bdfsg-11
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 701,696 kB
  • sloc: cpp: 2,686,179; ansic: 375,485; python: 25,859; sh: 19,349; xml: 17,091; perl: 14,765; yacc: 5,383; asm: 5,038; makefile: 1,259; lex: 555; ruby: 526; objc: 347; cs: 112; pascal: 112; php: 54; sed: 34
file content (174 lines) | stat: -rw-r--r-- 13,865 bytes parent folder | download 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en_US" lang="en_US">
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<!-- qevent.cpp -->
  <title>Qt 4.8: QContextMenuEvent Class Reference</title>
  <link rel="stylesheet" type="text/css" href="style/offline.css" />
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="content"> 
    <a href="index.html" class="qtref"><span>Qt Reference Documentation</span></a>
  </div>
  <div class="breadcrumb toolblock">
    <ul>
      <li class="first"><a href="index.html">Home</a></li>
      <!--  Breadcrumbs go here -->
<li><a href="modules.html">Modules</a></li>
<li><a href="qtgui.html">QtGui</a></li>
<li>QContextMenuEvent</li>
    </ul>
  </div>
</div>
<div class="content mainContent">
<div class="toc">
<h3><a name="toc">Contents</a></h3>
<ul>
<li class="level1"><a href="#public-types">Public Types</a></li>
<li class="level1"><a href="#public-functions">Public Functions</a></li>
<li class="level1"><a href="#details">Detailed Description</a></li>
</ul>
</div>
<h1 class="title">QContextMenuEvent Class Reference</h1>
<!-- $$$QContextMenuEvent-brief -->
<p>The QContextMenuEvent class contains parameters that describe a context menu event. <a href="#details">More...</a></p>
<!-- @@@QContextMenuEvent -->
<pre class="cpp"> <span class="preprocessor">#include &lt;QContextMenuEvent&gt;</span></pre><p><b>Inherits: </b><a href="qinputevent.html">QInputEvent</a>.</p>
<ul>
<li><a href="qcontextmenuevent-members.html">List of all members, including inherited members</a></li>
<li><a href="qcontextmenuevent-qt3.html">Qt 3 support members</a></li>
</ul>
<a name="public-types"></a>
<h2>Public Types</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> enum </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#Reason-enum">Reason</a></b> { Mouse, Keyboard, Other }</td></tr>
</table>
<a name="public-functions"></a>
<h2>Public Functions</h2>
<table class="alignedsummary">
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#QContextMenuEvent">QContextMenuEvent</a></b> ( Reason <i>reason</i>, const QPoint &amp; <i>pos</i>, const QPoint &amp; <i>globalPos</i>, Qt::KeyboardModifiers <i>modifiers</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#QContextMenuEvent-2">QContextMenuEvent</a></b> ( Reason <i>reason</i>, const QPoint &amp; <i>pos</i>, const QPoint &amp; <i>globalPos</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#QContextMenuEvent-3">QContextMenuEvent</a></b> ( Reason <i>reason</i>, const QPoint &amp; <i>pos</i> )</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QPoint &amp; </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#globalPos">globalPos</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#globalX">globalX</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#globalY">globalY</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> const QPoint &amp; </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#pos">pos</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> Reason </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#reason">reason</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#x">x</a></b> () const</td></tr>
<tr><td class="memItemLeft rightAlign topAlign"> int </td><td class="memItemRight bottomAlign"><b><a href="qcontextmenuevent.html#y">y</a></b> () const</td></tr>
</table>
<ul>
<li class="fn">1 public function inherited from <a href="qinputevent.html#public-functions">QInputEvent</a></li>
<li class="fn">6 public functions inherited from <a href="qevent.html#public-functions">QEvent</a></li>
</ul>
<h3>Additional Inherited Members</h3>
<ul>
<li class="fn">1 property inherited from <a href="qevent.html#properties">QEvent</a></li>
<li class="fn">1 static public member inherited from <a href="qevent.html#static-public-members">QEvent</a></li>
</ul>
<a name="details"></a>
<!-- $$$QContextMenuEvent-description -->
<div class="descr">
<h2>Detailed Description</h2>
<p>The QContextMenuEvent class contains parameters that describe a context menu event.</p>
<p>Context menu events are sent to widgets when a user performs an action associated with opening a context menu. The actions required to open context menus vary between platforms; for example, on Windows, pressing the menu button or clicking the right mouse button will cause this event to be sent.</p>
<p>When this event occurs it is customary to show a <a href="qmenu.html">QMenu</a> with a context menu, if this is relevant to the context.</p>
<p>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, if possible, whatever triggered the event will be handled as a regular input event.</p>
</div>
<!-- @@@QContextMenuEvent -->
<div class="types">
<h2>Member Type Documentation</h2>
<!-- $$$Reason$$$Mouse$$$Keyboard$$$Other -->
<h3 class="fn"><a name="Reason-enum"></a>enum QContextMenuEvent::<span class="name">Reason</span></h3>
<p>This enum describes the reason why the event was sent.</p>
<table class="valuelist"><tr valign="top" class="odd"><th class="tblConst">Constant</th><th class="tblval">Value</th><th class="tbldscr">Description</th></tr>
<tr><td class="topAlign"><tt>QContextMenuEvent::Mouse</tt></td><td class="topAlign"><tt>0</tt></td><td class="topAlign">The mouse caused the event to be sent. Normally this means the right mouse button was clicked, but this is platform dependent.</td></tr>
<tr><td class="topAlign"><tt>QContextMenuEvent::Keyboard</tt></td><td class="topAlign"><tt>1</tt></td><td class="topAlign">The keyboard caused this event to be sent. On Windows, this means the menu button was pressed.</td></tr>
<tr><td class="topAlign"><tt>QContextMenuEvent::Other</tt></td><td class="topAlign"><tt>2</tt></td><td class="topAlign">The event was sent by some other means (i.e&#x2e; not by the mouse or keyboard).</td></tr>
</table>
<!-- @@@Reason -->
</div>
<div class="func">
<h2>Member Function Documentation</h2>
<!-- $$$QContextMenuEvent[overload1]$$$QContextMenuEventReasonconstQPoint&constQPoint&Qt::KeyboardModifiers -->
<h3 class="fn"><a name="QContextMenuEvent"></a>QContextMenuEvent::<span class="name">QContextMenuEvent</span> ( <span class="type"><a href="qcontextmenuevent.html#Reason-enum">Reason</a></span> <i>reason</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> &amp; <i>pos</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> &amp; <i>globalPos</i>, <span class="type"><a href="qt.html#KeyboardModifier-enum">Qt::KeyboardModifiers</a></span> <i>modifiers</i> )</h3>
<p>Constructs a context menu event object with the accept parameter flag set to false.</p>
<p>The <i>reason</i> parameter must be <a href="qcontextmenuevent.html#Reason-enum">QContextMenuEvent::Mouse</a> or <a href="qcontextmenuevent.html#Reason-enum">QContextMenuEvent::Keyboard</a>.</p>
<p>The <i>pos</i> parameter specifies the mouse position relative to the receiving widget. <i>globalPos</i> is the mouse position in absolute coordinates. The <i>modifiers</i> holds the keyboard modifiers.</p>
<!-- @@@QContextMenuEvent -->
<!-- $$$QContextMenuEvent$$$QContextMenuEventReasonconstQPoint&constQPoint& -->
<h3 class="fn"><a name="QContextMenuEvent-2"></a>QContextMenuEvent::<span class="name">QContextMenuEvent</span> ( <span class="type"><a href="qcontextmenuevent.html#Reason-enum">Reason</a></span> <i>reason</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> &amp; <i>pos</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> &amp; <i>globalPos</i> )</h3>
<p>Constructs a context menu event object with the accept parameter flag set to false.</p>
<p>The <i>reason</i> parameter must be <a href="qcontextmenuevent.html#Reason-enum">QContextMenuEvent::Mouse</a> or <a href="qcontextmenuevent.html#Reason-enum">QContextMenuEvent::Keyboard</a>.</p>
<p>The <i>pos</i> parameter specifies the mouse position relative to the receiving widget. <i>globalPos</i> is the mouse position in absolute coordinates.</p>
<!-- @@@QContextMenuEvent -->
<!-- $$$QContextMenuEvent$$$QContextMenuEventReasonconstQPoint& -->
<h3 class="fn"><a name="QContextMenuEvent-3"></a>QContextMenuEvent::<span class="name">QContextMenuEvent</span> ( <span class="type"><a href="qcontextmenuevent.html#Reason-enum">Reason</a></span> <i>reason</i>, const <span class="type"><a href="qpoint.html">QPoint</a></span> &amp; <i>pos</i> )</h3>
<p>Constructs a context menu event object with the accept parameter flag set to false.</p>
<p>The <i>reason</i> parameter must be <a href="qcontextmenuevent.html#Reason-enum">QContextMenuEvent::Mouse</a> or <a href="qcontextmenuevent.html#Reason-enum">QContextMenuEvent::Keyboard</a>.</p>
<p>The <i>pos</i> parameter specifies the mouse position relative to the receiving widget.</p>
<p>The <a href="qcontextmenuevent.html#globalPos">globalPos</a>() is initialized to <a href="qcursor.html#pos">QCursor::pos</a>(), which may not be appropriate. Use the other constructor to specify the global position explicitly.</p>
<!-- @@@QContextMenuEvent -->
<!-- $$$globalPos[overload1]$$$globalPos -->
<h3 class="fn"><a name="globalPos"></a>const <span class="type"><a href="qpoint.html">QPoint</a></span> &amp; QContextMenuEvent::<span class="name">globalPos</span> () const</h3>
<p>Returns the global position of the mouse pointer at the time of the event.</p>
<p><b>See also </b><a href="qcontextmenuevent.html#x">x</a>(), <a href="qcontextmenuevent.html#y">y</a>(), and <a href="qcontextmenuevent.html#pos">pos</a>().</p>
<!-- @@@globalPos -->
<!-- $$$globalX[overload1]$$$globalX -->
<h3 class="fn"><a name="globalX"></a><span class="type">int</span> QContextMenuEvent::<span class="name">globalX</span> () const</h3>
<p>Returns the global x position of the mouse pointer at the time of the event.</p>
<p><b>See also </b><a href="qcontextmenuevent.html#globalY">globalY</a>() and <a href="qcontextmenuevent.html#globalPos">globalPos</a>().</p>
<!-- @@@globalX -->
<!-- $$$globalY[overload1]$$$globalY -->
<h3 class="fn"><a name="globalY"></a><span class="type">int</span> QContextMenuEvent::<span class="name">globalY</span> () const</h3>
<p>Returns the global y position of the mouse pointer at the time of the event.</p>
<p><b>See also </b><a href="qcontextmenuevent.html#globalX">globalX</a>() and <a href="qcontextmenuevent.html#globalPos">globalPos</a>().</p>
<!-- @@@globalY -->
<!-- $$$pos[overload1]$$$pos -->
<h3 class="fn"><a name="pos"></a>const <span class="type"><a href="qpoint.html">QPoint</a></span> &amp; QContextMenuEvent::<span class="name">pos</span> () const</h3>
<p>Returns the position of the mouse pointer relative to the widget that received the event.</p>
<p><b>See also </b><a href="qcontextmenuevent.html#x">x</a>(), <a href="qcontextmenuevent.html#y">y</a>(), and <a href="qcontextmenuevent.html#globalPos">globalPos</a>().</p>
<!-- @@@pos -->
<!-- $$$reason[overload1]$$$reason -->
<h3 class="fn"><a name="reason"></a><span class="type"><a href="qcontextmenuevent.html#Reason-enum">Reason</a></span> QContextMenuEvent::<span class="name">reason</span> () const</h3>
<p>Returns the reason for this context event.</p>
<!-- @@@reason -->
<!-- $$$x[overload1]$$$x -->
<h3 class="fn"><a name="x"></a><span class="type">int</span> QContextMenuEvent::<span class="name">x</span> () const</h3>
<p>Returns the x position of the mouse pointer, relative to the widget that received the event.</p>
<p><b>See also </b><a href="qcontextmenuevent.html#y">y</a>() and <a href="qcontextmenuevent.html#pos">pos</a>().</p>
<!-- @@@x -->
<!-- $$$y[overload1]$$$y -->
<h3 class="fn"><a name="y"></a><span class="type">int</span> QContextMenuEvent::<span class="name">y</span> () const</h3>
<p>Returns the y position of the mouse pointer, relative to the widget that received the event.</p>
<p><b>See also </b><a href="qcontextmenuevent.html#x">x</a>() and <a href="qcontextmenuevent.html#pos">pos</a>().</p>
<!-- @@@y -->
</div>
  <div class="ft">
    <span></span>
  </div>
</div> 
<div class="footer">
    <p>
      <acronym title="Copyright">&copy;</acronym> 2012 Nokia Corporation and/or its
      subsidiaries. Documentation contributions included herein are the copyrights of
      their respective owners.</p>
    <br />
    <p>
      The documentation provided herein is licensed under the terms of the
      <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation
      License version 1.3</a> as published by the Free Software Foundation.</p>
    <p>
      Documentation sources may be obtained from <a href="http://www.qt-project.org">
      www.qt-project.org</a>.</p>
    <br />
    <p>
      Nokia, Qt and their respective logos are trademarks of Nokia Corporation 
      in Finland and/or other countries worldwide. All other trademarks are property
      of their respective owners. <a title="Privacy Policy"
      href="http://en.gitorious.org/privacy_policy/">Privacy Policy</a></p>
</div>
</body>
</html>