File: input_8hh.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 (208 lines) | stat: -rw-r--r-- 9,227 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
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
<!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>input.hh File Reference</h1>A GdkDevice C++ wrapper interface. <a href="#_details">More...</a>
<p>
<code>#include &lt;gfc/glib/object.hh&gt;</code><br>
<code>#include &lt;<a class="el" href="gdk_2types_8hh-source.html">gfc/gdk/types.hh</a>&gt;</code><br>
<code>#include &lt;vector&gt;</code><br>
<code>#include &lt;gfc/gdk/inline/input.inl&gt;</code><br>

<p>
<a href="input_8hh-source.html">Go to the source code of this file.</a><h2>Namespaces</h2>
<ul>
<li>namespace <a class="elRef" doxygen="gfccore.tag:" href="namespaceGFC.html">GFC</a>
<li>namespace <a class="el" href="namespaceGFC_1_1Gdk.html">GFC::Gdk</a>
</ul>
<h2>Classes</h2>
<ul>
<li>class <a class="el" href="classGFC_1_1Gdk_1_1Device.html">GFC::Gdk::Device</a>
<dl class="el"><dd class="mdescRight">A GdkDevice C++ wrapper class.  <a href="classGFC_1_1Gdk_1_1Device.html#_details">More...</a><br></dl></ul>
<h2>Device Methods</h2>
<ul>
<li>bool <a class="el" href="namespaceGFC_1_1Gdk.html#a252">devices_list</a> (std::vector&lt; Device * &gt; &amp;devices)
<dl class="el"><dd class="mdescRight">Returns the list of available input devices attached to the default display.  <a href="#a252"></a><br></dl></ul>
<h2>Enumerations</h2>
<ul>
<li>enum <a class="el" href="namespaceGFC_1_1Gdk.html#a274">InputSource</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Gdk.html#a274a122">SOURCE_MOUSE</a> =  GDK_SOURCE_MOUSE, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Gdk.html#a274a123">SOURCE_PEN</a> =  GDK_SOURCE_PEN, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Gdk.html#a274a124">SOURCE_ERASER</a> =  GDK_SOURCE_ERASER, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Gdk.html#a274a125">SOURCE_CURSOR</a> =  GDK_SOURCE_CURSOR
<br>
 }
<dl class="el"><dd class="mdescRight">An enumeration describing the type of an input device in general terms.  <a href="#a274">More...</a><br></dl><li>enum <a class="el" href="namespaceGFC_1_1Gdk.html#a275">InputMode</a> { <br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Gdk.html#a275a126">MODE_DISABLED</a> =  GDK_MODE_DISABLED, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Gdk.html#a275a127">MODE_SCREEN</a> =  GDK_MODE_SCREEN, 
<br>
&nbsp;&nbsp;<a class="el" href="namespaceGFC_1_1Gdk.html#a275a128">MODE_WINDOW</a> =  GDK_MODE_WINDOW
<br>
 }
<dl class="el"><dd class="mdescRight">An enumeration that describes the mode of an input device.  <a href="#a275">More...</a><br></dl></ul>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A GdkDevice C++ wrapper interface. 
<p>
Provides Device, an object for handling extended input devices.<hr><h2>Enumeration Type Documentation</h2>
<a class="anchor" name="a275" doxytag="input.hh::InputMode" ></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"> enum <a class="el" href="namespaceGFC_1_1Gdk.html#a275">InputMode</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
An enumeration that describes the mode of an input device. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a275a126" doxytag="MODE_DISABLED" ></a>MODE_DISABLED</em>&nbsp;</td><td>
The device is disabled and will not report any events. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a275a127" doxytag="MODE_SCREEN" ></a>MODE_SCREEN</em>&nbsp;</td><td>
The device is enabled; the device's coordinate space maps to the entire screen. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a275a128" doxytag="MODE_WINDOW" ></a>MODE_WINDOW</em>&nbsp;</td><td>
The device is enabled; the device's coordinate space is mapped to a single window (the manner in which this window is chosen is undefined, but it will typically be the same way in which the focus window for key events is determined). </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<a class="anchor" name="a274" doxytag="input.hh::InputSource" ></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"> enum <a class="el" href="namespaceGFC_1_1Gdk.html#a274">InputSource</a>          </td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
An enumeration describing the type of an input device in general terms. 
<p>
<dl compact><dt><b>Enumeration values: </b></dt><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a class="anchor" name="a274a122" doxytag="SOURCE_MOUSE" ></a>SOURCE_MOUSE</em>&nbsp;</td><td>
The device is a mouse (this will be reported for the core pointer, even if it is something else, such as a trackball). </td></tr>
<tr><td valign=top><em><a class="anchor" name="a274a123" doxytag="SOURCE_PEN" ></a>SOURCE_PEN</em>&nbsp;</td><td>
The device is a stylus of a graphics tablet or similar device. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a274a124" doxytag="SOURCE_ERASER" ></a>SOURCE_ERASER</em>&nbsp;</td><td>
The device is an eraser; typically, this would be the other end of a stylus on a graphics tablet. </td></tr>
<tr><td valign=top><em><a class="anchor" name="a274a125" doxytag="SOURCE_CURSOR" ></a>SOURCE_CURSOR</em>&nbsp;</td><td>
The device is a graphics tablet "puck" or similar device. </td></tr>
</table>
</dl>
    </td>
  </tr>
</table>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="a252" doxytag="input.hh::devices_list" ></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"> bool devices_list           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">std::vector&lt; Device * &gt; &amp;&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>devices</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns the list of available input devices attached to the default display. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td></td><td valign=top><em>devices</em>&nbsp;</td><td>A reference to a vector of Device* to hold the list of devices. </td></tr>
  </table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd><em>true</em> if the vector is not empty.</dd></dl>
<br>
The devices in this list are statically allocated and will be freed by GTK+. See also Gdk::Display::list_devcies.     </td>
  </tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Tue Aug 24 00:34:33 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>