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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
|
<Type Name="EventHelper" FullName="Gdk.EventHelper">
<TypeSignature Language="C#" Value="public class EventHelper" Maintainer="auto" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EventHelper extends System.Object" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>A utility class that contains methods that operate on Event classes.</summary>
<remarks>This class contains static methods.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EventHelper ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>This constructor is never used.</summary>
<remarks>This class contains only static methods, and this constructor should never be used.</remarks>
</Docs>
</Member>
<Member MemberName="Copy">
<MemberSignature Language="C#" Value="public static Gdk.Event Copy (Gdk.Event evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Event Copy(class Gdk.Event evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Event</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<param name="evnt">The <see cref="T:Gdk.Event" /> to copy.</param>
<summary>Copies a <see cref="T:Gdk.Event" />.</summary>
<returns>The copied <see cref="T:Gdk.Event" />.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="Free">
<MemberSignature Language="C#" Value="public static void Free (Gdk.Event evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Free(class Gdk.Event evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<param name="evnt">
<see cref="T:Gdk.Event" /> to free.</param>
<summary>Frees a <see cref="T:Gdk.Event" />.</summary>
<remarks>This should only be called with events returned from functions such as <see cref="M:Gdk.EventHelper.Peek" />, <see cref="M:Gdk.EventHelper.Get" />, <see cref="M:Gdk.EventHelper.GetGraphicsExpose" /> and <see cref="M:Gdk.EventHelper.Copy" />.</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public static Gdk.Event Get ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Event Get() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Event</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Checks all open displays for a <see cref="T:Gdk.Event" /> to process, fetching events from the windowing system if necessary. See <see cref="P:Gdk.Display.Event" />.</summary>
<returns>The next <see cref="T:Gdk.Event" /> to be processed, or null if no events are pending. The returned <see cref="T:Gdk.Event" /> should be freed with <see cref="M:Gdk.EventHelper.Free" />.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="GetAxis">
<MemberSignature Language="C#" Value="public static bool GetAxis (Gdk.Event evnt, Gdk.AxisUse axis_use, out double value);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool GetAxis(class Gdk.Event evnt, valuetype Gdk.AxisUse axis_use, float64 value) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="axis_use" Type="Gdk.AxisUse" />
<Parameter Name="value" Type="System.Double&" RefType="out" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /></param>
<param name="axis_use">The axis use to look for.</param>
<param name="value">The value found.</param>
<summary>Extract the axis value for a particular axis use from an event.</summary>
<returns>True if the specified axis was found, otherwise false.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="GetCoords">
<MemberSignature Language="C#" Value="public static bool GetCoords (Gdk.Event evnt, out double x_win, out double y_win);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool GetCoords(class Gdk.Event evnt, float64 x_win, float64 y_win) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="x_win" Type="System.Double&" RefType="out" />
<Parameter Name="y_win" Type="System.Double&" RefType="out" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /></param>
<param name="x_win">Event window x coordinate.</param>
<param name="y_win">Event window y coordinate.</param>
<summary>Extract the event window relative x/y coordinates from an event.</summary>
<returns>True if the event delivered event coordinates.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="GetDevice">
<MemberSignature Language="C#" Value="public static Gdk.Device GetDevice (Gdk.Event evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Device GetDevice(class Gdk.Event evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Device</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetRootCoords">
<MemberSignature Language="C#" Value="public static bool GetRootCoords (Gdk.Event evnt, out double x_root, out double y_root);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool GetRootCoords(class Gdk.Event evnt, float64 x_root, float64 y_root) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="x_root" Type="System.Double&" RefType="out" />
<Parameter Name="y_root" Type="System.Double&" RefType="out" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /></param>
<param name="x_root">Root window x coordinate.</param>
<param name="y_root">Root window y coordinate.</param>
<summary>Extract the root window relative x/y coordinates from an event.</summary>
<returns>True if the event delivered root window coordinates.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="GetScreen">
<MemberSignature Language="C#" Value="public static Gdk.Screen GetScreen (Gdk.Event evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Screen GetScreen(class Gdk.Event evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Screen</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /></param>
<summary>Returns the screen for the event. The screen is typically the screen for <see cref="P:Gdk.Event.Window" />, but for events such as mouse events, it is the screen where the pointer was when the event occurs.</summary>
<returns>The <see cref="T:Gdk.Screen" /> for the event.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetSourceDevice">
<MemberSignature Language="C#" Value="public static Gdk.Device GetSourceDevice (Gdk.Event evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Device GetSourceDevice(class Gdk.Event evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Device</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetState">
<MemberSignature Language="C#" Value="public static bool GetState (Gdk.Event evnt, out Gdk.ModifierType state);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool GetState(class Gdk.Event evnt, valuetype Gdk.ModifierType state) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="state" Type="Gdk.ModifierType&" RefType="out" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /> or null.</param>
<param name="state">The <see cref="T:Gdk.ModifierType" /> of the event.</param>
<summary>If the event contains a "state" field, puts that field in state. Otherwise stores an empty state (0).</summary>
<returns>True if there was a state field in the event.</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetTime">
<MemberSignature Language="C#" Value="public static uint GetTime (Gdk.Event evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig unsigned int32 GetTime(class Gdk.Event evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /></param>
<summary>Returns the time stamp from event, if there is one. Otherwise returns the current time. If event is null, returns the current time..</summary>
<returns>Time stamp field from event.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.EventHelper" />.</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Gdk.Event New (Gdk.EventType type);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Event New(valuetype Gdk.EventType type) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Event</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Gdk.EventType" />
</Parameters>
<Docs>
<param name="type">A <see cref="T:Gdk.EventType" /></param>
<summary>Creates a new event of the given type. All fields are set to 0.</summary>
<returns>A <see cref="T:Gdk.Event" /></returns>
<remarks>The returned event should be freed with <see cref="M:Gdk.EventHelper.Free" />.</remarks>
</Docs>
</Member>
<Member MemberName="Peek">
<MemberSignature Language="C#" Value="public static Gdk.Event Peek ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gdk.Event Peek() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Event</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>If there is an event waiting in the event queue of some open display, returns a copy of it. See <see cref="M:Gdk.Display.PeekEvent" />.</summary>
<returns>A copy of the first <see cref="T:Gdk.Event" /> on some event queue, or null if no events are in any queues.</returns>
<remarks>The returned <see cref="T:Gdk.Event" /> should be freed with <see cref="M:Gdk.EventHelper.Free" />.</remarks>
</Docs>
</Member>
<Member MemberName="Put">
<MemberSignature Language="C#" Value="public static void Put (Gdk.Event evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Put(class Gdk.Event evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /></param>
<summary>Appends a copy of the given event onto the front of the event queue for <see cref="P:Gdk.Event.Window" />'s display, or the default queue if that window is null. See <see cref="M:Gdk.Display.PutEvent" />.</summary>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="RequestMotions">
<MemberSignature Language="C#" Value="public static void RequestMotions (Gdk.EventMotion evnt);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void RequestMotions(class Gdk.EventMotion evnt) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.EventMotion" />
</Parameters>
<Docs>
<param name="evnt">A MotionNotify event.</param>
<summary>Requests additional motion notify events.</summary>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="SetDevice">
<MemberSignature Language="C#" Value="public static void SetDevice (Gdk.Event evnt, Gdk.Device device);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetDevice(class Gdk.Event evnt, class Gdk.Device device) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="device" Type="Gdk.Device" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<param name="device">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="SetScreen">
<MemberSignature Language="C#" Value="public static void SetScreen (Gdk.Event evnt, Gdk.Screen screen);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetScreen(class Gdk.Event evnt, class Gdk.Screen screen) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="screen" Type="Gdk.Screen" />
</Parameters>
<Docs>
<param name="evnt">A <see cref="T:Gdk.Event" /></param>
<param name="screen">A <see cref="T:Gdk.Screen" /></param>
<summary>Sets the screen for event to screen. The event must have been allocated by GTK+, for instance, by <see cref="M:Gdk.EventHelper.Copy" />.</summary>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="SetSourceDevice">
<MemberSignature Language="C#" Value="public static void SetSourceDevice (Gdk.Event evnt, Gdk.Device device);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetSourceDevice(class Gdk.Event evnt, class Gdk.Device device) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="evnt" Type="Gdk.Event" />
<Parameter Name="device" Type="Gdk.Device" />
</Parameters>
<Docs>
<param name="evnt">To be added.</param>
<param name="device">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
</Members>
</Type>
|