gi-gdk-4.0.2: Gdk bindings
CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gdk.Flags

Description

 
Synopsis

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

Instances details
Enum AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

Eq AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

Ord AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

Show AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> AnchorHints -> ShowS #

show :: AnchorHints -> String #

showList :: [AnchorHints] -> ShowS #

TypedObject AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes AnchorHints Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes AnchorHints = '[] :: [Type]

AxisFlags

data AxisFlags Source #

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

Instances details
Enum AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Eq AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Ord AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Show AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> AxisFlags -> ShowS #

show :: AxisFlags -> String #

showList :: [AxisFlags] -> ShowS #

TypedObject AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes AxisFlags Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes AxisFlags = '[] :: [Type]

DragAction

data DragAction Source #

Used in Drop and Drag to indicate the actions that the destination can and 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, and is not supported on all platforms.

DragActionAsk

Ask the user what to do with the data.

AnotherDragAction Int

Catch-all for unknown values

Instances

Instances details
Enum DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

Eq DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

Ord DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

Show DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> DragAction -> ShowS #

show :: DragAction -> String #

showList :: [DragAction] -> ShowS #

TypedObject DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes DragAction Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes DragAction = '[] :: [Type]

EventMask

data EventMask Source #

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 GdkEventTouch 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

Instances details
Enum EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

Eq EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

Ord EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

Show EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> EventMask -> ShowS #

show :: EventMask -> String #

showList :: [EventMask] -> ShowS #

TypedObject EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes EventMask Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes EventMask = '[] :: [Type]

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](#g:signal:flushEvents). Should not be handled by applications.

FrameClockPhaseBeforePaint

corresponds to GdkFrameClock[beforePaint](#g:signal:beforePaint). Should not be handled by applications.

FrameClockPhaseUpdate

corresponds to GdkFrameClock[update](#g:signal:update).

FrameClockPhaseLayout

corresponds to GdkFrameClock[layout](#g:signal:layout).

FrameClockPhasePaint

corresponds to GdkFrameClock[paint](#g:signal:paint).

FrameClockPhaseResumeEvents

corresponds to GdkFrameClock[resumeEvents](#g:signal:resumeEvents). Should not be handled by applications.

FrameClockPhaseAfterPaint

corresponds to GdkFrameClock[afterPaint](#g:signal:afterPaint). Should not be handled by applications.

AnotherFrameClockPhase Int

Catch-all for unknown values

Instances

Instances details
Enum FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

Eq FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

Ord FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

Show FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> FrameClockPhase -> ShowS #

show :: FrameClockPhase -> String #

showList :: [FrameClockPhase] -> ShowS #

TypedObject FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes FrameClockPhase Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes FrameClockPhase = '[] :: [Type]

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.

Note that GDK may add internal values to events which include values outside of this enumeration. Your code should preserve and ignore them. You can use MODIFIER_MASK to remove all private values.

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.

ModifierTypeAltMask

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).

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.

ModifierTypeSuperMask

the Super modifier

ModifierTypeHyperMask

the Hyper modifier

ModifierTypeMetaMask

the Meta modifier

AnotherModifierType Int

Catch-all for unknown values

Instances

Instances details
Enum ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

Eq ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

Ord ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

Show ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> ModifierType -> ShowS #

show :: ModifierType -> String #

showList :: [ModifierType] -> ShowS #

TypedObject ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes ModifierType Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes ModifierType = '[] :: [Type]

PaintableFlags

data PaintableFlags Source #

Flags about this object. Implementations use these for optimizations such as caching.

Constructors

PaintableFlagsSize

The size is immutable. The invalidateSize signal will never be emitted.

PaintableFlagsContents

The content is immutable. The invalidateContents signal will never be emitted.

AnotherPaintableFlags Int

Catch-all for unknown values

Instances

Instances details
Enum PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Eq PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Ord PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Show PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> PaintableFlags -> ShowS #

show :: PaintableFlags -> String #

showList :: [PaintableFlags] -> ShowS #

TypedObject PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes PaintableFlags Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes PaintableFlags = '[] :: [Type]

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

Instances details
Enum SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

Eq SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

Ord SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

Show SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> SeatCapabilities -> ShowS #

show :: SeatCapabilities -> String #

showList :: [SeatCapabilities] -> ShowS #

TypedObject SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes SeatCapabilities Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes SeatCapabilities = '[] :: [Type]

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

SurfaceStateMinimized

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

Instances details
Enum SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

Eq SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

Ord SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

Show SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

showsPrec :: Int -> SurfaceState -> ShowS #

show :: SurfaceState -> String #

showList :: [SurfaceState] -> ShowS #

TypedObject SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

Methods

glibType :: IO GType #

BoxedFlags SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

IsGFlag SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

HasParentTypes SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes SurfaceState Source # 
Instance details

Defined in GI.Gdk.Flags

type ParentTypes SurfaceState = '[] :: [Type]