| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | None |
| Language | Haskell2010 |
GI.Gdk.Flags
Description
Synopsis
- data AnchorHints
- data AxisFlags
- data DragAction
- data EventMask
- = EventMaskExposureMask
- | EventMaskPointerMotionMask
- | EventMaskButtonMotionMask
- | EventMaskButton1MotionMask
- | EventMaskButton2MotionMask
- | EventMaskButton3MotionMask
- | EventMaskButtonPressMask
- | EventMaskButtonReleaseMask
- | EventMaskKeyPressMask
- | EventMaskKeyReleaseMask
- | EventMaskEnterNotifyMask
- | EventMaskLeaveNotifyMask
- | EventMaskFocusChangeMask
- | EventMaskStructureMask
- | EventMaskPropertyChangeMask
- | EventMaskProximityInMask
- | EventMaskProximityOutMask
- | EventMaskSubstructureMask
- | EventMaskScrollMask
- | EventMaskTouchMask
- | EventMaskSmoothScrollMask
- | EventMaskTouchpadGestureMask
- | EventMaskTabletPadMask
- | EventMaskAllEventsMask
- | AnotherEventMask Int
- data FrameClockPhase
- data ModifierType
- = ModifierTypeShiftMask
- | ModifierTypeLockMask
- | ModifierTypeControlMask
- | ModifierTypeMod1Mask
- | ModifierTypeMod2Mask
- | ModifierTypeMod3Mask
- | ModifierTypeMod4Mask
- | ModifierTypeMod5Mask
- | ModifierTypeButton1Mask
- | ModifierTypeButton2Mask
- | ModifierTypeButton3Mask
- | ModifierTypeButton4Mask
- | ModifierTypeButton5Mask
- | ModifierTypeModifierReserved13Mask
- | ModifierTypeModifierReserved14Mask
- | ModifierTypeModifierReserved15Mask
- | ModifierTypeModifierReserved16Mask
- | ModifierTypeModifierReserved17Mask
- | ModifierTypeModifierReserved18Mask
- | ModifierTypeModifierReserved19Mask
- | ModifierTypeModifierReserved20Mask
- | ModifierTypeModifierReserved21Mask
- | ModifierTypeModifierReserved22Mask
- | ModifierTypeModifierReserved23Mask
- | ModifierTypeModifierReserved24Mask
- | ModifierTypeModifierReserved25Mask
- | ModifierTypeSuperMask
- | ModifierTypeHyperMask
- | ModifierTypeMetaMask
- | ModifierTypeModifierReserved29Mask
- | ModifierTypeReleaseMask
- | ModifierTypeModifierMask
- | AnotherModifierType Int
- data PaintableFlags
- data SeatCapabilities
- data SurfaceHints
- data SurfaceState
- = SurfaceStateWithdrawn
- | SurfaceStateIconified
- | SurfaceStateMaximized
- | SurfaceStateSticky
- | SurfaceStateFullscreen
- | SurfaceStateAbove
- | SurfaceStateBelow
- | SurfaceStateFocused
- | SurfaceStateTiled
- | SurfaceStateTopTiled
- | SurfaceStateTopResizable
- | SurfaceStateRightTiled
- | SurfaceStateRightResizable
- | SurfaceStateBottomTiled
- | SurfaceStateBottomResizable
- | SurfaceStateLeftTiled
- | SurfaceStateLeftResizable
- | AnotherSurfaceState Int
- data WMDecoration
- data WMFunction
Flags
AnchorHints
data AnchorHints Source #
Positioning hints for aligning a surface relative to a rectangle.
These hints determine how the surface should be positioned in the case that the surface would fall off-screen if placed in its ideal position.
For example, AnchorHintsFlipX will replace GravityNorthWest with
GravityNorthEast and vice versa if the surface extends beyond the left
or right edges of the monitor.
If AnchorHintsSlideX is set, the surface can be shifted horizontally to fit
on-screen. If AnchorHintsResizeX is set, the surface can be shrunken
horizontally to fit.
In general, when multiple flags are set, flipping should take precedence over sliding, which should take precedence over resizing.
Constructors
| AnchorHintsFlipX | allow flipping anchors horizontally |
| AnchorHintsFlipY | allow flipping anchors vertically |
| AnchorHintsSlideX | allow sliding surface horizontally |
| AnchorHintsSlideY | allow sliding surface vertically |
| AnchorHintsResizeX | allow resizing surface horizontally |
| AnchorHintsResizeY | allow resizing surface vertically |
| AnchorHintsFlip | allow flipping anchors on both axes |
| AnchorHintsSlide | allow sliding surface on both axes |
| AnchorHintsResize | allow resizing surface on both axes |
| AnotherAnchorHints Int | Catch-all for unknown values |
Instances
AxisFlags
Flags describing the current capabilities of a device/tool.
Constructors
| AxisFlagsX | X axis is present |
| AxisFlagsY | Y axis is present |
| AxisFlagsPressure | Pressure axis is present |
| AxisFlagsXtilt | X tilt axis is present |
| AxisFlagsYtilt | Y tilt axis is present |
| AxisFlagsWheel | Wheel axis is present |
| AxisFlagsDistance | Distance axis is present |
| AxisFlagsRotation | Z-axis rotation is present |
| AxisFlagsSlider | Slider axis is present |
| AnotherAxisFlags Int | Catch-all for unknown values |
Instances
| Enum AxisFlags Source # | |
Defined in GI.Gdk.Flags Methods succ :: AxisFlags -> AxisFlags # pred :: AxisFlags -> AxisFlags # fromEnum :: AxisFlags -> Int # enumFrom :: AxisFlags -> [AxisFlags] # enumFromThen :: AxisFlags -> AxisFlags -> [AxisFlags] # enumFromTo :: AxisFlags -> AxisFlags -> [AxisFlags] # enumFromThenTo :: AxisFlags -> AxisFlags -> AxisFlags -> [AxisFlags] # | |
| Eq AxisFlags Source # | |
| Ord AxisFlags Source # | |
| Show AxisFlags Source # | |
| IsGFlag AxisFlags Source # | |
Defined in GI.Gdk.Flags | |
| BoxedFlags AxisFlags Source # | |
Defined in GI.Gdk.Flags | |
DragAction
data DragAction Source #
Used in Drag to indicate what the destination
should do with the dropped data.
Constructors
| DragActionCopy | Copy the data. |
| DragActionMove | Move the data, i.e. first copy it, then delete it from the source using the DELETE target of the X selection protocol. |
| DragActionLink | Add a link to the data. Note that this is only useful if source and destination agree on what it means. |
| DragActionAsk | Ask the user what to do with the data. |
| AnotherDragAction Int | Catch-all for unknown values |
Instances
EventMask
A set of bit-flags to indicate which events a surface is to receive.
Most of these masks map onto one or more of the EventType event types
above.
See the [input handling overview][chap-input-handling] for details of [event masks][event-masks] and [event propagation][event-propagation].
If EventMaskTouchMask is enabled, the surface will receive touch events
from touch-enabled devices. Those will come as sequences of EventTouch
with type EventTypeTouchUpdate, enclosed by two events with
type EventTypeTouchBegin and EventTypeTouchEnd (or EventTypeTouchCancel).
eventGetEventSequence returns the event sequence for these
events, so different sequences may be distinguished.
Constructors
| EventMaskExposureMask | receive expose events |
| EventMaskPointerMotionMask | receive all pointer motion events |
| EventMaskButtonMotionMask | receive pointer motion events while any button is pressed |
| EventMaskButton1MotionMask | receive pointer motion events while 1 button is pressed |
| EventMaskButton2MotionMask | receive pointer motion events while 2 button is pressed |
| EventMaskButton3MotionMask | receive pointer motion events while 3 button is pressed |
| EventMaskButtonPressMask | receive button press events |
| EventMaskButtonReleaseMask | receive button release events |
| EventMaskKeyPressMask | receive key press events |
| EventMaskKeyReleaseMask | receive key release events |
| EventMaskEnterNotifyMask | receive surface enter events |
| EventMaskLeaveNotifyMask | receive surface leave events |
| EventMaskFocusChangeMask | receive focus change events |
| EventMaskStructureMask | receive events about surface configuration change |
| EventMaskPropertyChangeMask | receive property change events |
| EventMaskProximityInMask | receive proximity in events |
| EventMaskProximityOutMask | receive proximity out events |
| EventMaskSubstructureMask | receive events about surface configuration changes of child surfaces |
| EventMaskScrollMask | receive scroll events |
| EventMaskTouchMask | receive touch events |
| EventMaskSmoothScrollMask | receive smooth scrolling events |
| EventMaskTouchpadGestureMask | receive touchpad gesture events |
| EventMaskTabletPadMask | receive tablet pad events |
| EventMaskAllEventsMask | the combination of all the above event masks. |
| AnotherEventMask Int | Catch-all for unknown values |
Instances
| Enum EventMask Source # | |
Defined in GI.Gdk.Flags Methods succ :: EventMask -> EventMask # pred :: EventMask -> EventMask # fromEnum :: EventMask -> Int # enumFrom :: EventMask -> [EventMask] # enumFromThen :: EventMask -> EventMask -> [EventMask] # enumFromTo :: EventMask -> EventMask -> [EventMask] # enumFromThenTo :: EventMask -> EventMask -> EventMask -> [EventMask] # | |
| Eq EventMask Source # | |
| Ord EventMask Source # | |
| Show EventMask Source # | |
| IsGFlag EventMask Source # | |
Defined in GI.Gdk.Flags | |
| BoxedFlags EventMask Source # | |
Defined in GI.Gdk.Flags | |
FrameClockPhase
data FrameClockPhase Source #
FrameClockPhase is used to represent the different paint clock
phases that can be requested. The elements of the enumeration
correspond to the signals of FrameClock.
Constructors
| FrameClockPhaseNone | no phase |
| FrameClockPhaseFlushEvents | corresponds to GdkFrameClock[flushEvents](#signal:flushEvents). Should not be handled by applications. |
| FrameClockPhaseBeforePaint | corresponds to GdkFrameClock[beforePaint](#signal:beforePaint). Should not be handled by applications. |
| FrameClockPhaseUpdate | corresponds to GdkFrameClock[update](#signal:update). |
| FrameClockPhaseLayout | corresponds to GdkFrameClock[layout](#signal:layout). |
| FrameClockPhasePaint | corresponds to GdkFrameClock[paint](#signal:paint). |
| FrameClockPhaseResumeEvents | corresponds to GdkFrameClock[resumeEvents](#signal:resumeEvents). Should not be handled by applications. |
| FrameClockPhaseAfterPaint | corresponds to GdkFrameClock[afterPaint](#signal:afterPaint). Should not be handled by applications. |
| AnotherFrameClockPhase Int | Catch-all for unknown values |
Instances
ModifierType
data ModifierType Source #
A set of bit-flags to indicate the state of modifier keys and mouse buttons in various event types. Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.
Like the X Window System, GDK supports 8 modifier keys and 5 mouse buttons.
GDK recognizes which of the Meta, Super or Hyper keys are mapped
to Mod2 - Mod5, and indicates this by setting ModifierTypeSuperMask,
ModifierTypeHyperMask or ModifierTypeMetaMask in the state field of key events.
Note that GDK may add internal values to events which include
reserved values such as ModifierTypeModifierReserved13Mask. Your code
should preserve and ignore them. You can use ModifierTypeModifierMask to
remove all reserved values.
Also note that the GDK X backend interprets button press events for button
4-7 as scroll events, so ModifierTypeButton4Mask and ModifierTypeButton5Mask will never
be set.
Constructors
| ModifierTypeShiftMask | the Shift key. |
| ModifierTypeLockMask | a Lock key (depending on the modifier mapping of the X server this may either be CapsLock or ShiftLock). |
| ModifierTypeControlMask | the Control key. |
| ModifierTypeMod1Mask | the fourth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier, but normally it is the Alt key). |
| ModifierTypeMod2Mask | the fifth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). |
| ModifierTypeMod3Mask | the sixth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). |
| ModifierTypeMod4Mask | the seventh modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). |
| ModifierTypeMod5Mask | the eighth modifier key (it depends on the modifier mapping of the X server which key is interpreted as this modifier). |
| ModifierTypeButton1Mask | the first mouse button. |
| ModifierTypeButton2Mask | the second mouse button. |
| ModifierTypeButton3Mask | the third mouse button. |
| ModifierTypeButton4Mask | the fourth mouse button. |
| ModifierTypeButton5Mask | the fifth mouse button. |
| ModifierTypeModifierReserved13Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved14Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved15Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved16Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved17Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved18Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved19Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved20Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved21Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved22Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved23Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved24Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeModifierReserved25Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeSuperMask | the Super modifier |
| ModifierTypeHyperMask | the Hyper modifier |
| ModifierTypeMetaMask | the Meta modifier |
| ModifierTypeModifierReserved29Mask | A reserved bit flag; do not use in your own code |
| ModifierTypeReleaseMask | not used in GDK itself. GTK uses it to differentiate between (keyval, modifiers) pairs from key press and release events. |
| ModifierTypeModifierMask | a mask covering all modifier types. |
| AnotherModifierType Int | Catch-all for unknown values |
Instances
PaintableFlags
data PaintableFlags Source #
Flags about this object. Implementations use these for optimizations such as caching.
Constructors
| PaintableFlagsSize | The size is immutable. The GdkPaintable[invalidateSize](#signal:invalidateSize) signal will never be emitted. |
| PaintableFlagsContents | The content is immutable. The GdkPaintable[invalidateContent](#signal:invalidateContent) signal will never be emitted. |
| AnotherPaintableFlags Int | Catch-all for unknown values |
Instances
SeatCapabilities
data SeatCapabilities Source #
Flags describing the seat capabilities.
Constructors
| SeatCapabilitiesNone | No input capabilities |
| SeatCapabilitiesPointer | The seat has a pointer (e.g. mouse) |
| SeatCapabilitiesTouch | The seat has touchscreen(s) attached |
| SeatCapabilitiesTabletStylus | The seat has drawing tablet(s) attached |
| SeatCapabilitiesKeyboard | The seat has keyboard(s) attached |
| SeatCapabilitiesTabletPad | The seat has drawing tablet pad(s) attached |
| SeatCapabilitiesAllPointing | The union of all pointing capabilities |
| SeatCapabilitiesAll | The union of all capabilities |
| AnotherSeatCapabilities Int | Catch-all for unknown values |
Instances
SurfaceHints
data SurfaceHints Source #
Used to indicate which fields of a Geometry struct should be paid
attention to. Also, the presence/absence of gDKHINTPOS,
gDKHINTUSERPOS, and gDKHINTUSERSIZE is significant, though they don't
directly refer to Geometry fields. gDKHINTUSERPOS will be set
automatically by GtkWindow if you call gtk_window_move().
gDKHINTUSERPOS and gDKHINTUSERSIZE should be set if the user
specified a size/position using a --geometry command-line argument;
gtk_window_parse_geometry() automatically sets these flags.
Constructors
| SurfaceHintsPos | indicates that the program has positioned the surface |
| SurfaceHintsMinSize | min size fields are set |
| SurfaceHintsMaxSize | max size fields are set |
| SurfaceHintsBaseSize | base size fields are set |
| SurfaceHintsAspect | aspect ratio fields are set |
| SurfaceHintsResizeInc | resize increment fields are set |
| SurfaceHintsWinGravity | surface gravity field is set |
| SurfaceHintsUserPos | indicates that the surface’s position was explicitly set by the user |
| SurfaceHintsUserSize | indicates that the surface’s size was explicitly set by the user |
| AnotherSurfaceHints Int | Catch-all for unknown values |
Instances
SurfaceState
data SurfaceState Source #
Specifies the state of a toplevel surface.
On platforms that support information about individual edges, the SurfaceStateTiled
state will be set whenever any of the individual tiled states is set. On platforms
that lack that support, the tiled state will give an indication of tiledness without
any of the per-edge states being set.
Constructors
| SurfaceStateWithdrawn | the surface is not shown |
| SurfaceStateIconified | the surface is minimized |
| SurfaceStateMaximized | the surface is maximized |
| SurfaceStateSticky | the surface is sticky |
| SurfaceStateFullscreen | the surface is maximized without decorations |
| SurfaceStateAbove | the surface is kept above other surfaces |
| SurfaceStateBelow | the surface is kept below other surfaces |
| SurfaceStateFocused | the surface is presented as focused (with active decorations) |
| SurfaceStateTiled | the surface is in a tiled state |
| SurfaceStateTopTiled | whether the top edge is tiled |
| SurfaceStateTopResizable | whether the top edge is resizable |
| SurfaceStateRightTiled | whether the right edge is tiled |
| SurfaceStateRightResizable | whether the right edge is resizable |
| SurfaceStateBottomTiled | whether the bottom edge is tiled |
| SurfaceStateBottomResizable | whether the bottom edge is resizable |
| SurfaceStateLeftTiled | whether the left edge is tiled |
| SurfaceStateLeftResizable | whether the left edge is resizable |
| AnotherSurfaceState Int | Catch-all for unknown values |
Instances
WMDecoration
data WMDecoration Source #
These are hints originally defined by the Motif toolkit. The window manager can use them when determining how to decorate the surface. The hint must be set before mapping the surface.
Constructors
| WMDecorationAll | all decorations should be applied. |
| WMDecorationBorder | a frame should be drawn around the surface. |
| WMDecorationResizeh | the frame should have resize handles. |
| WMDecorationTitle | a titlebar should be placed above the surface. |
| WMDecorationMenu | a button for opening a menu should be included. |
| WMDecorationMinimize | a minimize button should be included. |
| WMDecorationMaximize | a maximize button should be included. |
| AnotherWMDecoration Int | Catch-all for unknown values |
Instances
WMFunction
data WMFunction Source #
These are hints originally defined by the Motif toolkit. The window manager can use them when determining the functions to offer for the surface. The hint must be set before mapping the surface.
Constructors
| WMFunctionAll | all functions should be offered. |
| WMFunctionResize | the surface should be resizable. |
| WMFunctionMove | the surface should be movable. |
| WMFunctionMinimize | the surface should be minimizable. |
| WMFunctionMaximize | the surface should be maximizable. |
| WMFunctionClose | the surface should be closable. |
| AnotherWMFunction Int | Catch-all for unknown values |