Flags

Details

class Gdk.AnchorHints(value)

Bases: GObject.GFlags

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, Gdk.AnchorHints.FLIP_X will replace Gdk.Gravity.NORTH_WEST with Gdk.Gravity.NORTH_EAST and vice versa if the surface extends beyond the left or right edges of the monitor.

If Gdk.AnchorHints.SLIDE_X is set, the surface can be shifted horizontally to fit on-screen. If Gdk.AnchorHints.RESIZE_X 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.

FLIP_X = 1

allow flipping anchors horizontally

SLIDE = 12

allow sliding surface on both axes

RESIZE_X = 16

allow resizing surface horizontally

FLIP_Y = 2

allow flipping anchors vertically

FLIP = 3

allow flipping anchors on both axes

RESIZE_Y = 32

allow resizing surface vertically

SLIDE_X = 4

allow sliding surface horizontally

RESIZE = 48

allow resizing surface on both axes

SLIDE_Y = 8

allow sliding surface vertically

class Gdk.AxisFlags(value)

Bases: GObject.GFlags

Flags describing the current capabilities of a device/tool.

ROTATION = 1024

Z-axis rotation is present

YTILT = 128

Y tilt axis is present

DELTA_Y = 16

Scroll Y delta axis is present

X = 2

X axis is present

SLIDER = 2048

Slider axis is present

WHEEL = 256

Wheel axis is present

PRESSURE = 32

Pressure axis is present

Y = 4

Y axis is present

DISTANCE = 512

Distance axis is present

XTILT = 64

X tilt axis is present

DELTA_X = 8

Scroll X delta axis is present

class Gdk.DragAction(value)

Bases: GObject.GFlags

Used in GdkDrop and GdkDrag to indicate the actions that the destination can and should do with the dropped data.

COPY = 1

Copy the data.

MOVE = 2

Move the data, i.e. first copy it, then delete it from the source using the DELETE target of the X selection protocol.

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.

ASK = 8

Ask the user what to do with the data.

class Gdk.FrameClockPhase(value)

Bases: GObject.GFlags

Used to represent the different paint clock phases that can be requested.

The elements of the enumeration correspond to the signals of GdkFrameClock.

NONE = 0

no phase

FLUSH_EVENTS = 1

corresponds to Gdk.FrameClock ::flush-events. Should not be handled by applications.

PAINT = 16

corresponds to Gdk.FrameClock ::paint.

BEFORE_PAINT = 2

corresponds to Gdk.FrameClock ::before-paint. Should not be handled by applications.

RESUME_EVENTS = 32

corresponds to Gdk.FrameClock ::resume-events. Should not be handled by applications.

UPDATE = 4

corresponds to Gdk.FrameClock ::update.

AFTER_PAINT = 64

corresponds to Gdk.FrameClock ::after-paint. Should not be handled by applications.

LAYOUT = 8

corresponds to Gdk.FrameClock ::layout. Should not be handled by applications.

class Gdk.GLAPI(value)

Bases: GObject.GFlags

The list of the different APIs that Gdk.GLContext can potentially support.

New in version 4.6.

GL = 1

The OpenGL API

GLES = 2

The OpenGL ES API

class Gdk.ModifierType(value)

Bases: GObject.GFlags

Flags to indicate the state of modifier keys and mouse buttons in events.

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 Gdk.MODIFIER_MASK to remove all private values.

NO_MODIFIER_MASK = 0

No modifier.

New in version 4.14.

SHIFT_MASK = 1

the Shift key.

BUTTON3_MASK = 1024

the third mouse button.

HYPER_MASK = 134217728

the Hyper modifier.

LOCK_MASK = 2

a Lock key (depending on the Windowing System configuration, this may either be <kbd>CapsLock</kbd> or <kbd>ShiftLock</kbd>).

BUTTON4_MASK = 2048

the fourth mouse button.

BUTTON1_MASK = 256

the first mouse button.

META_MASK = 268435456

the Meta modifier. Maps to Command on macOS.

CONTROL_MASK = 4

the Control key.

BUTTON5_MASK = 4096

the fifth mouse button.

BUTTON2_MASK = 512

the second mouse button.

SUPER_MASK = 67108864

the Super modifier.

ALT_MASK = 8

the fourth modifier key (it depends on the Windowing System configuration which key is interpreted as this modifier, but normally it is the <kbd>Alt</kbd> key).

class Gdk.PaintableFlags(value)

Bases: GObject.GFlags

Flags about a paintable object.

Implementations use these for optimizations such as caching.

SIZE = 1

The size is immutable. The [signal`Gdk`.Paintable::invalidate-size] signal will never be emitted.

CONTENTS = 2

The content is immutable. The [signal`Gdk`.Paintable::invalidate-contents] signal will never be emitted.

class Gdk.SeatCapabilities(value)

Bases: GObject.GFlags

Flags describing the seat capabilities.

NONE = 0

No input capabilities

POINTER = 1

The seat has a pointer (e.g. mouse)

TABLET_PAD = 16

The seat has drawing tablet pad(s) attached

TOUCH = 2

The seat has touchscreen(s) attached

ALL = 31

The union of all capabilities

TABLET_STYLUS = 4

The seat has drawing tablet(s) attached

ALL_POINTING = 7

The union of all pointing capabilities

KEYBOARD = 8

The seat has keyboard(s) attached

class Gdk.ToplevelState(value)

Bases: GObject.GFlags

Specifies the state of a toplevel surface.

On platforms that support information about individual edges, the Gdk.ToplevelState.TILED 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.

MINIMIZED = 1

the surface is minimized

RIGHT_TILED = 1024

whether the right edge is tiled

TILED = 128

the surface is in a tiled state

ABOVE = 16

the surface is kept above other surfaces

LEFT_TILED = 16384

whether the left edge is tiled

MAXIMIZED = 2

the surface is maximized

RIGHT_RESIZABLE = 2048

whether the right edge is resizable

TOP_TILED = 256

whether the top edge is tiled

BELOW = 32

the surface is kept below other surfaces

LEFT_RESIZABLE = 32768

whether the left edge is resizable

STICKY = 4

the surface is sticky

BOTTOM_TILED = 4096

whether the bottom edge is tiled

TOP_RESIZABLE = 512

whether the top edge is resizable

FOCUSED = 64

the surface is presented as focused (with active decorations)

SUSPENDED = 65536

The surface is not visible to the user.

New in version 4.12.

FULLSCREEN = 8

the surface is maximized without decorations

BOTTOM_RESIZABLE = 8192

whether the bottom edge is resizable