File: classGFC_1_1Gdk_1_1EventButton.html

package info (click to toggle)
gfcui 2.3.1-2
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 43,420 kB
  • ctags: 18,023
  • sloc: cpp: 53,967; sh: 31,555; makefile: 1,322; perl: 108
file content (143 lines) | stat: -rw-r--r-- 9,669 bytes parent folder | download | duplicates (3)
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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
  <meta content="text/html; charset=ISO-8859-1"
 http-equiv="content-type">
  <title>GTK+ Foundation Classes</title>
  <link href="gfc.css" rel="stylesheet" type="text/css">
  <meta content="The GFC Development Team" name="author">
  <meta content="Core Library Reference Manual" name="description">
</head>
<body style="color: rgb(0, 0, 0); background-color: rgb(243, 244, 248);"
 alink="#000099" link="#000099" vlink="#990099">
<table style="text-align: left; width: 1227px; height: 117px;"
 border="0" cellpadding="0" cellspacing="0">
  <tbody>
    <tr>
      <td
 style="text-align: center; background-color: rgb(255, 255, 255); width: 220px; vertical-align: top;"><img
 alt="GFC Logo" src="../images/gfc.png"
 style="width: 207px; height: 92px;"></td>
      <td
 style="text-align: center; background-color: rgb(87, 107, 152); vertical-align: middle;"><img
 alt="GFC Title Logo" src="../images/gfc-title.png"
 style="width: 418px; height: 76px;"><br>
      </td>
    </tr>
    <tr>
      <td
 style="text-align: center; background-color: rgb(65, 77, 104); vertical-align: middle;"><big><span
 style="color: rgb(255, 255, 153); font-weight: bold;">Reference Manual</span></big><br>
      </td>
      <td
 style="text-align: center; background-color: rgb(148, 164, 200); vertical-align: middle;"><small
 style="font-family: helvetica,arial,sans-serif;"><a
 href="../html/index.html">Main Page</a>&nbsp; |&nbsp; <a
 href="../html/namespaces.html">Namespace List</a>&nbsp; |&nbsp; <a
 href="classes.html">Alphabetical List</a>&nbsp; |&nbsp; <a
 href="../html/annotated.html">Class List</a>&nbsp; |&nbsp; <a
 href="../html/files.html">File List</a></small><br>
      </td>
    </tr>
  </tbody>
</table>
<small> </small>
</body>
</html>
<!-- Generated by Doxygen 1.3.8 -->
<h1>GFC::Gdk::EventButton Class Reference</h1>A GdkEventButton C++ wrapper class.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="events_8hh-source.html">gfc/gdk/events.hh</a>&gt;</code>
<p>
<p>Inheritance diagram for GFC::Gdk::EventButton:
<p><center><img src="classGFC_1_1Gdk_1_1EventButton.png" usemap="#GFC::Gdk::EventButton_map" border="0" alt=""></center>
<map name="GFC::Gdk::EventButton_map">
<area href="classGFC_1_1Gdk_1_1EventAny.html" alt="GFC::Gdk::EventAny" shape="rect" coords="0,224,139,248">
<area href="classGFC_1_1Gdk_1_1Event.html" alt="GFC::Gdk::Event" shape="rect" coords="0,168,139,192">
<area doxygen="gfccore.tag:" href="classGFC_1_1G_1_1Boxed.html" alt="GFC::G::Boxed" shape="rect" coords="0,112,139,136">
<area doxygen="gfccore.tag:" href="classGFC_1_1Object.html" alt="GFC::Object" shape="rect" coords="0,56,139,80">
<area doxygen="gfccore.tag:" href="classGFC_1_1Trackable.html" alt="GFC::Trackable" shape="rect" coords="0,0,139,24">
</map>
<a href="classGFC_1_1Gdk_1_1EventButton-members.html">List of all members.</a><h2>Public Member Functions</h2>
<tr><td colspan="2"><div class="groupHeader">Accessors</div></td></tr>
<ul>
<li><a class="anchor" name="z145_0" doxytag="GFC::Gdk::EventButton::gdk_event_button" ></a>
GdkEventButton * <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_0">gdk_event_button</a> () const
<dl class="el"><dd class="mdescRight">Get a pointer to the GdkEventButton structure. <br></dl><li><a class="anchor" name="z145_1" doxytag="GFC::Gdk::EventButton::time" ></a>
unsigned int <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_1">time</a> () const
<dl class="el"><dd class="mdescRight">Returns the time of the event in milliseconds. <br></dl><li><a class="anchor" name="z145_2" doxytag="GFC::Gdk::EventButton::x" ></a>
double <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_2">x</a> () const
<dl class="el"><dd class="mdescRight">Returns the X coordinate of the pointer relative to the window, as a double. <br></dl><li><a class="anchor" name="z145_3" doxytag="GFC::Gdk::EventButton::y" ></a>
double <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_3">y</a> () const
<dl class="el"><dd class="mdescRight">Returns the Y coordinate of the pointer relative to the window, as a double. <br></dl><li><a class="anchor" name="z145_4" doxytag="GFC::Gdk::EventButton::x_int" ></a>
int <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_4">x_int</a> () const
<dl class="el"><dd class="mdescRight">Returns the X coordinate of the pointer relative to the window, as an integer. <br></dl><li><a class="anchor" name="z145_5" doxytag="GFC::Gdk::EventButton::y_int" ></a>
int <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_5">y_int</a> () const
<dl class="el"><dd class="mdescRight">Returns the Y coordinate of the pointer relative to the window, as an integer. <br></dl><li><a class="anchor" name="z145_6" doxytag="GFC::Gdk::EventButton::axes" ></a>
double * <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_6">axes</a> () const
<dl class="el"><dd class="mdescRight">Returns x, y translated to the axes of the device, or null if device is the mouse. <br></dl><li><a class="anchor" name="z145_7" doxytag="GFC::Gdk::EventButton::state" ></a>
<a class="el" href="namespaceGFC_1_1Gdk.html#a136">ModifierTypeField</a> <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_7">state</a> () const
<dl class="el"><dd class="mdescRight">Returns a bit-mask representing the state of the modifier keys (for example, Control, Shift and Alt) and the pointer buttons (see <a class="el" href="namespaceGFC_1_1Gdk.html#a286">Gdk::ModifierType</a>). <br></dl><li>unsigned int <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_8">button</a> () const
<dl class="el"><dd class="mdescRight">Returns the button which was pressed or released, numbered from 1 to 5.  <a href="#z145_8"></a><br></dl><li><a class="anchor" name="z145_9" doxytag="GFC::Gdk::EventButton::device" ></a>
<a class="el" href="classGFC_1_1Gdk_1_1Device.html">Device</a> * <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_9">device</a> () const
<dl class="el"><dd class="mdescRight">Returns the <a class="el" href="classGFC_1_1Gdk_1_1Device.html">Device</a> where the event originated. <br></dl><li><a class="anchor" name="z145_10" doxytag="GFC::Gdk::EventButton::x_root" ></a>
double <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_10">x_root</a> () const
<dl class="el"><dd class="mdescRight">Returns the X coordinate of the pointer relative to the root of the screen. <br></dl><li><a class="anchor" name="z145_11" doxytag="GFC::Gdk::EventButton::y_root" ></a>
double <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html#z145_11">y_root</a> () const
<dl class="el"><dd class="mdescRight">Returns the Y coordinate of the pointer relative to the root of the screen. <br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GdkEventButton C++ wrapper class. 
<p>
An <a class="el" href="classGFC_1_1Gdk_1_1EventButton.html">EventButton</a> is used for button press and button release events.<p>
The event type will be one of BUTTON_PRESS, TWO_BUTTON_PRESS, THREE_BUTTON_PRESS and BUTTON_RELEASE. Double and triple-clicks result in a sequence of events being received.<p>
For double-clicks the order of events will be:<ul>
<li>BUTTON_PRESS</li><li>BUTTON_RELEASE</li><li>BUTTON_PRESS</li><li>TWO_BUTTON_PRESS</li><li>BUTTON_RELEASE</li></ul>
<p>
Note that the first click is received just like a normal button press, while the second click results in a TWO_BUTTON_PRESS being received just after the BUTTON_PRESS.<p>
Triple-clicks are very similar to double-clicks, except that THREE_BUTTON_PRESS is inserted after the third click. The order of the events is:<ul>
<li>BUTTON_PRESS</li><li>BUTTON_RELEASE</li><li>BUTTON_PRESS</li><li>TWO_BUTTON_PRESS</li><li>BUTTON_RELEASE</li><li>BUTTON_PRESS</li><li>THREE_BUTTON_PRESS</li><li>BUTTON_RELEASE</li></ul>
<p>
For a double click to occur, the second button press must occur within 1/4 of a second of the first. For a triple click to occur, the third button press must also occur within 1/2 second of the first button press. 
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="z145_8" doxytag="GFC::Gdk::EventButton::button" ></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top"> unsigned int GFC::Gdk::EventButton::button           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the button which was pressed or released, numbered from 1 to 5. 
<p>
Normally button 1 is the left mouse button, 2 is the middle button, and 3 is the right button. On 2-button mice, the middle button can often be simulated by pressing both mouse buttons together. 
<p>
Reimplemented from <a class="el" href="classGFC_1_1Gdk_1_1Event.html#z139_7">GFC::Gdk::Event</a>.
<p>
    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="events_8hh-source.html">events.hh</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:35 2004 for GFC-UI by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 ></a> 1.3.8 </small></address>
</body>
</html>