Flags

Details

class Gtk.ApplicationInhibitFlags(value)

Bases: GObject.GFlags

Types of user actions that may be blocked by GtkApplication.

See [method`Gtk`.Application.inhibit].

LOGOUT = 1

Inhibit ending the user session by logging out or by shutting down the computer

SWITCH = 2

Inhibit user switching

SUSPEND = 4

Inhibit suspending the session or computer

IDLE = 8

Inhibit the session being marked as idle (and possibly locked)

class Gtk.BuilderClosureFlags(value)

Bases: GObject.GFlags

The list of flags that can be passed to Gtk.Builder.create_closure().

New values may be added in the future for new features, so external implementations of [iface`Gtk`.BuilderScope] should test the flags for unknown values and raise a Gtk.BuilderError.INVALID_ATTRIBUTE error when they encounter one.

SWAPPED = 1

The closure should be created swapped. See g_cclosure_new_swap() for details.

class Gtk.CellRendererState(value)

Bases: GObject.GFlags

Tells how a cell is to be rendered.

SELECTED = 1

The cell is currently selected, and probably has a selection colored background to render to.

FOCUSED = 16

The cell is in the focus row.

PRELIT = 2

The mouse is hovering over the cell.

EXPANDABLE = 32

The cell is in a row that can be expanded

INSENSITIVE = 4

The cell is drawn in an insensitive manner

EXPANDED = 64

The cell is in a row that is expanded

SORTED = 8

The cell is in a sorted row

class Gtk.DebugFlags(value)

Bases: GObject.GFlags

Flags to use with Gtk.set_debug_flags().

Settings these flags causes GTK to print out different types of debugging information. Some of these flags are only available when GTK has been configured with -Ddebug=true.

TEXT = 1

Information about Gtk.TextView

INTERACTIVE = 1024

Open the GTK inspector

BUILDER = 128

Trace Gtk.Builder operation

A11Y = 131072

Information about accessibility state changes

GEOMETRY = 16

Information about size allocation

SNAPSHOT = 16384

Include debug render nodes in the generated snapshots

TREE = 2

Information about Gtk.TreeView

SIZE_REQUEST = 256

Information about size requests

ICONFALLBACK = 262144

Information about icon fallback.

New in version 4.2.

ICONTHEME = 32

Information about icon themes

CONSTRAINTS = 32768

Information from the constraints solver

KEYBINDINGS = 4

Information about keyboard shortcuts

ACTIONS = 4096

Information about actions and menu models

NO_CSS_CACHE = 512

Disable the style property cache

INVERT_TEXT_DIR = 524288
PRINTING = 64

Information about printing

BUILDER_OBJECTS = 65536

Log unused Gtk.Builder objects

MODULES = 8

Information about modules and extensions

LAYOUT = 8192

Information from layout managers

class Gtk.DialogFlags(value)

Bases: GObject.GFlags

Flags used to influence dialog construction.

MODAL = 1

Make the constructed dialog modal

DESTROY_WITH_PARENT = 2

Destroy the dialog when its parent is destroyed

USE_HEADER_BAR = 4

Create dialog with actions in header bar instead of action area

class Gtk.EventControllerScrollFlags(value)

Bases: GObject.GFlags

Describes the behavior of a GtkEventControllerScroll.

NONE = 0

Don’t emit scroll.

VERTICAL = 1

Emit scroll with vertical deltas.

HORIZONTAL = 2

Emit scroll with horizontal deltas.

BOTH_AXES = 3

Emit scroll on both axes.

DISCRETE = 4

Only emit deltas that are multiples of 1.

KINETIC = 8

Emit ::decelerate after continuous scroll finishes.

class Gtk.FontChooserLevel(value)

Bases: GObject.GFlags

Specifies the granularity of font selection that is desired in a GtkFontChooser.

This enumeration may be extended in the future; applications should ignore unknown values.

FAMILY = 0

Allow selecting a font family

STYLE = 1

Allow selecting a specific font face

SIZE = 2

Allow selecting a specific font size

VARIATIONS = 4

Allow changing OpenType font variation axes

FEATURES = 8

Allow selecting specific OpenType font features

class Gtk.IconLookupFlags(value)

Bases: GObject.GFlags

Used to specify options for Gtk.IconTheme.lookup_icon().

FORCE_REGULAR = 1

Try to always load regular icons, even when symbolic icon names are given

FORCE_SYMBOLIC = 2

Try to always load symbolic icons, even when regular icon names are given

PRELOAD = 4

Starts loading the texture in the background so it is ready when later needed.

class Gtk.InputHints(value)

Bases: GObject.GFlags

Describes hints that might be taken into account by input methods or applications.

Note that input methods may already tailor their behaviour according to the [enum`InputPurpose`] of the entry.

Some common sense is expected when using these flags - mixing Gtk.InputHints.LOWERCASE with any of the uppercase hints makes no sense.

This enumeration may be extended in the future; input methods should ignore unknown values.

NONE = 0

No special behaviour suggested

SPELLCHECK = 1

Suggest checking for typos

NO_EMOJI = 1024

Suggest not offering Emoji support

INHIBIT_OSK = 128

Suggest to not show an onscreen keyboard (e.g for a calculator that already has all the keys).

UPPERCASE_CHARS = 16

Suggest to capitalize all text

NO_SPELLCHECK = 2

Suggest not checking for typos

PRIVATE = 2048

Request that the input method should not update personalized data (like typing history)

VERTICAL_WRITING = 256

The text is vertical

UPPERCASE_WORDS = 32

Suggest to capitalize the first character of each word

WORD_COMPLETION = 4

Suggest word completion

EMOJI = 512

Suggest offering Emoji support

UPPERCASE_SENTENCES = 64

Suggest to capitalize the first word of each sentence

LOWERCASE = 8

Suggest to convert all text to lowercase

class Gtk.ListScrollFlags(value)

Bases: GObject.GFlags

List of actions to perform when scrolling to items in a list widget.

New in version 4.12.

NONE = 0

Don’t do anything extra

FOCUS = 1

Focus the target item

SELECT = 2

Select the target item and unselect all other items.

class Gtk.PickFlags(value)

Bases: GObject.GFlags

Flags that influence the behavior of [method`Widget`.pick].

DEFAULT = 0

The default behavior, include widgets that are receiving events

INSENSITIVE = 1

Include widgets that are insensitive

NON_TARGETABLE = 2

Include widgets that are marked as non-targetable. See [property`Widget`:can-target]

class Gtk.PopoverMenuFlags(value)

Bases: GObject.GFlags

Flags that affect how popover menus are created from a menu model.

NESTED = 1

Create submenus as nested popovers. Without this flag, submenus are created as sliding pages that replace the main menu.

class Gtk.PrintCapabilities(value)

Bases: GObject.GFlags

Specifies which features the print dialog should offer.

If neither Gtk.PrintCapabilities.GENERATE_PDF nor Gtk.PrintCapabilities.GENERATE_PS is specified, GTK assumes that all formats are supported.

PAGE_SET = 1

Print dialog will offer printing even/odd pages.

PREVIEW = 128

Print dialog will offer a preview

SCALE = 16

Print dialog will allow to scale the output.

COPIES = 2

Print dialog will allow to print multiple copies.

NUMBER_UP = 256

Print dialog will offer printing multiple pages per sheet

GENERATE_PDF = 32

The program will send the document to the printer in PDF format

COLLATE = 4

Print dialog will allow to collate multiple copies.

NUMBER_UP_LAYOUT = 512

Print dialog will allow to rearrange pages when printing multiple pages per sheet

GENERATE_PS = 64

The program will send the document to the printer in Postscript format

REVERSE = 8

Print dialog will allow to print pages in reverse order.

class Gtk.ShortcutActionFlags(value)

Bases: GObject.GFlags

List of flags that can be passed to action activation.

More flags may be added in the future.

EXCLUSIVE = 1

The action is the only action that can be activated. If this flag is not set, a future activation may select a different action.

class Gtk.StateFlags(value)

Bases: GObject.GFlags

Describes a widget state.

Widget states are used to match the widget against CSS pseudo-classes. Note that GTK extends the regular CSS classes and sometimes uses different names.

NORMAL = 0

State during normal operation

ACTIVE = 1

Widget is active

VISITED = 1024

The location the widget points to has already been visited

DIR_LTR = 128

Widget is in left-to-right text direction

INCONSISTENT = 16

Widget is inconsistent

FOCUS_WITHIN = 16384

Widget contains the keyboard focus

PRELIGHT = 2

Widget has a mouse pointer over it

CHECKED = 2048

Widget is checked

DIR_RTL = 256

Widget is in right-to-left text direction

FOCUSED = 32

Widget has the keyboard focus

SELECTED = 4

Widget is selected

DROP_ACTIVE = 4096

Widget is highlighted as a drop target for DND

Widget is a link

BACKDROP = 64

Widget is in a background toplevel window

INSENSITIVE = 8

Widget is insensitive

FOCUS_VISIBLE = 8192

Widget has the visible focus

class Gtk.StyleContextPrintFlags(value)

Bases: GObject.GFlags

Flags that modify the behavior of Gtk.StyleContext.to_string().

New values may be added to this enumeration.

NONE = 0

Default value.

RECURSE = 1

Print the entire tree of CSS nodes starting at the style context’s node

SHOW_STYLE = 2

Show the values of the CSS properties for each node

SHOW_CHANGE = 4

Show information about what changes affect the styles

class Gtk.TextSearchFlags(value)

Bases: GObject.GFlags

Flags affecting how a search is done.

If neither Gtk.TextSearchFlags.VISIBLE_ONLY nor Gtk.TextSearchFlags.TEXT_ONLY are enabled, the match must be exact; the special 0xFFFC character will match embedded paintables or child widgets.

VISIBLE_ONLY = 1

Search only visible data. A search match may have invisible text interspersed.

TEXT_ONLY = 2

Search only text. A match may have paintables or child widgets mixed inside the matched range.

CASE_INSENSITIVE = 4

The text will be matched regardless of what case it is in.

class Gtk.TreeModelFlags(value)

Bases: GObject.GFlags

These flags indicate various properties of a GtkTreeModel.

They are returned by [method`Gtk`.TreeModel.get_flags], and must be static for the lifetime of the object. A more complete description of Gtk.TreeModelFlags.ITERS_PERSIST can be found in the overview of this section.

ITERS_PERSIST = 1

iterators survive all signals emitted by the tree

LIST_ONLY = 2

the model is a list only, and never has children