Gtk2HsContentsIndex
Graphics.UI.Gtk.Gdk.Gdk
Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Description
Gdk general functions.
Synopsis
flush :: IO ()
screenWidth :: IO Int
screenHeight :: IO Int
screenWidthMM :: IO Int
screenHeightMM :: IO Int
data GrabStatus
= GrabSuccess
| GrabAlreadyGrabbed
| GrabInvalidTime
| GrabNotViewable
| GrabFrozen
pointerGrab :: (DrawWindowClass window, DrawWindowClass confine_to) => window -> Bool -> [EventMask] -> Maybe confine_to -> Maybe Cursor -> TimeStamp -> IO GrabStatus
pointerUngrab :: TimeStamp -> IO ()
pointerIsGrabbed :: IO Bool
keyboardGrab :: DrawWindowClass window => window -> Bool -> TimeStamp -> IO GrabStatus
keyboardUngrab :: TimeStamp -> IO ()
beep :: IO ()
Documentation
flush :: IO ()
Flushes the X output buffer and waits until all requests have been processed by the server. This is rarely needed by applications.
screenWidth :: IO Int
Returns the width of the default screen in pixels.
screenHeight :: IO Int
Returns the height of the default screen in pixels.
screenWidthMM :: IO Int
Returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct.
screenHeightMM :: IO Int
Returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct.
data GrabStatus

Returned by pointerGrab and keyboardGrab to indicate success or the reason for the failure of the grab attempt.

GrabSuccess
the resource was successfully grabbed.
GrabAlreadyGrabbed
the resource is actively grabbed by another client.
GrabInvalidTime
the resource was grabbed more recently than the specified time.
GrabNotViewable
the grab window or the confine_to window are not viewable.
GrabFrozen
the resource is frozen by an active grab of another client.
Constructors
GrabSuccess
GrabAlreadyGrabbed
GrabInvalidTime
GrabNotViewable
GrabFrozen
show/hide Instances
pointerGrab
:: (DrawWindowClass window, DrawWindowClass confine_to)
=> windowwindow - the DrawWindow which will own the grab (the grab window).
-> Boolowner_events - if False then all pointer events are reported with respect to window and are only reported if selected by event_mask. If True then pointer events for this application are reported as normal, but pointer events outside this application are reported with respect to window and only if selected by event_mask. In either mode, unreported events are discarded.
-> [EventMask]event_mask - specifies the event mask, which is used in accordance with owner_events. Note that only pointer events (i.e. button and motion events) may be selected.
-> Maybe confine_toconfine_to If supplied, the pointer will be confined to this window during the grab. If the pointer is outside confine_to, it will automatically be moved to the closest edge of confine_to and enter and leave events will be generated as necessary.
-> Maybe Cursorcursor - the cursor to display while the grab is active. If this is Nothing then the normal cursors are used for window and its descendants, and the cursor for window is used for all other windows.
-> TimeStamptime - the timestamp of the event which led to this pointer grab. This usually comes from an Event, though currentTime can be used if the time isn't known.
-> IO GrabStatusReturns - GrabSuccess if the grab was successful.

Grabs the pointer (usually a mouse) so that all events are passed to this application until the pointer is ungrabbed with pointerUngrab, or the grab window becomes unviewable. This overrides any previous pointer grab by this client.

Pointer grabs are used for operations which need complete control over mouse events, even if the mouse leaves the application. For example in GTK+ it is used for Drag and Drop, for dragging the handle in the GtkHPaned and GtkVPaned widgets, and for resizing columns in GtkCList widgets.

Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with owner_events set to True.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

pointerUngrab
:: TimeStamptime - a timestamp from an Event, or currentTime if no timestamp is available.
-> IO ()
Ungrabs the pointer on the default display, if it is grabbed by this application.
pointerIsGrabbed :: IO Bool

Returns True if the pointer on the default display is currently grabbed by this application.

Note that this does not take the inmplicit pointer grab on button presses into account.

keyboardGrab
:: DrawWindowClass window
=> windowwindow - the DrawWindow which will own the grab (the grab window).
-> Boolowner_events - if False then all keyboard events are reported with respect to window. If True then keyboard events for this application are reported as normal, but keyboard events outside this application are reported with respect to window. Both key press and key release events are always reported, independant of the event mask set by the application.
-> TimeStamptime - a timestamp from an Event, or currentTime if no timestamp is available.
-> IO GrabStatusReturns - GrabSuccess if the grab was successful.

Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with keyboardUngrab. This overrides any previous keyboard grab by this client.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

keyboardUngrab
:: TimeStamptime - a timestamp from an Event, or currentTime if no timestamp is available.
-> IO ()
Ungrabs the keyboard on the default display, if it is grabbed by this application.
beep :: IO ()
Emits a short beep.
Produced by Haddock version 0.8