Flags

Details

class Gtk.AccelFlags(value)

Bases: GObject.GFlags

Accelerator flags used with Gtk.AccelGroup.connect().

VISIBLE = 1

Accelerator is visible

LOCKED = 2

Accelerator not removable

MASK = 7

Mask

class Gtk.ApplicationInhibitFlags(value)

Bases: GObject.GFlags

Types of user actions that may be blocked by Gtk.Application.inhibit().

New in version 3.4.

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.AttachOptions(value)

Bases: GObject.GFlags

Denotes the expansion properties that a widget will have when it (or its parent) is resized.

EXPAND = 1

the widget should expand to take up any extra space in its container that has been allocated.

SHRINK = 2

the widget should shrink as and when possible.

FILL = 4

the widget should fill the space allocated to it.

class Gtk.CalendarDisplayOptions(value)

Bases: GObject.GFlags

These options can be used to influence the display and behaviour of a Gtk.Calendar.

SHOW_HEADING = 1

Specifies that the month and year should be displayed.

SHOW_DAY_NAMES = 2

Specifies that three letter day descriptions should be present.

SHOW_DETAILS = 32

Just show an indicator, not the full details text when details are provided. See Gtk.Calendar.set_detail_func().

NO_MONTH_CHANGE = 4

Prevents the user from switching months with the calendar.

SHOW_WEEK_NUMBERS = 8

Displays each week numbers of the current year, down the left side of the calendar.

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.

New in version 3.4.

INSENSITIVE = 4

The cell is drawn in an insensitive manner

EXPANDED = 64

The cell is in a row that is expanded.

New in version 3.4.

SORTED = 8

The cell is in a sorted row

class Gtk.DebugFlag(value)

Bases: GObject.GFlags

MISC = 1
PRINTING = 1024
RESIZE = 1048576
MODULES = 128
INTERACTIVE = 131072
UPDATES = 16
BASELINES = 16384
PLUGSOCKET = 2
BUILDER = 2048
LAYOUT = 2097152
GEOMETRY = 256
TOUCHSCREEN = 262144
KEYBINDINGS = 32
PIXEL_CACHE = 32768
TEXT = 4
SIZE_REQUEST = 4096
ICONTHEME = 512
ACTIONS = 524288
MULTIHEAD = 64
NO_PIXEL_CACHE = 65536
TREE = 8
NO_CSS_CACHE = 8192
class Gtk.DestDefaults(value)

Bases: GObject.GFlags

The Gtk.DestDefaults enumeration specifies the various types of action that will be taken on behalf of the user for a drag destination site.

MOTION = 1

If set for a widget, GTK+, during a drag over this widget will check if the drag matches this widget’s list of possible targets and actions. GTK+ will then call Gdk.drag_status() as appropriate.

HIGHLIGHT = 2

If set for a widget, GTK+ will draw a highlight on this widget as long as a drag is over this widget and the widget drag format and action are acceptable.

DROP = 4

If set for a widget, when a drop occurs, GTK+ will will check if the drag matches this widget’s list of possible targets and actions. If so, GTK+ will call Gtk.Widget.drag_get_data() on behalf of the widget. Whether or not the drop is successful, GTK+ will call Gtk.drag_finish(). If the action was a move, then if the drag was successful, then True will be passed for the delete parameter to Gtk.drag_finish().

ALL = 7

If set, specifies that all default actions should be taken.

class Gtk.DialogFlags(value)

Bases: GObject.GFlags

Flags used to influence dialog construction.

MODAL = 1

Make the constructed dialog modal, see Gtk.Window.set_modal()

DESTROY_WITH_PARENT = 2

Destroy the dialog when its parent is destroyed, see Gtk.Window.set_destroy_with_parent()

USE_HEADER_BAR = 4

Create dialog with actions in header bar instead of action area.

New in version 3.12.

class Gtk.EventControllerScrollFlags(value)

Bases: GObject.GFlags

Describes the behavior of a Gtk.EventControllerScroll.

New in version 3.24.

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 Gtk.EventControllerScroll ::decelerate after continuous scroll finishes.

class Gtk.FileFilterFlags(value)

Bases: GObject.GFlags

These flags indicate what parts of a Gtk.FileFilterInfo struct are filled or need to be filled.

FILENAME = 1

the filename of the file being tested

URI = 2

the URI for the file being tested

DISPLAY_NAME = 4

the string that will be used to display the file in the file chooser

MIME_TYPE = 8

the mime type of the file

class Gtk.FontChooserLevel(value)

Bases: GObject.GFlags

This enumeration specifies the granularity of font selection that is desired in a font chooser.

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
FEATURES = 8

Allow selecting specific OpenType font features

class Gtk.IconLookupFlags(value)

Bases: GObject.GFlags

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

NO_SVG = 1

Never get SVG icons, even if gdk-pixbuf supports them. Cannot be used together with Gtk.IconLookupFlags.FORCE_SVG.

DIR_LTR = 128

Try to load a variant of the icon for left-to-right text direction.

New in version 3.14.

FORCE_SIZE = 16

Always get the icon scaled to the requested size.

New in version 2.14.

FORCE_SVG = 2

Get SVG icons, even if gdk-pixbuf doesn’t support them. Cannot be used together with Gtk.IconLookupFlags.NO_SVG.

DIR_RTL = 256

Try to load a variant of the icon for right-to-left text direction.

New in version 3.14.

FORCE_REGULAR = 32

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

New in version 3.14.

USE_BUILTIN = 4

When passed to Gtk.IconTheme.lookup_icon() includes builtin icons as well as files. For a builtin icon, Gtk.IconInfo.get_filename() is None and you need to call Gtk.IconInfo.get_builtin_pixbuf().

FORCE_SYMBOLIC = 64

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

New in version 3.14.

GENERIC_FALLBACK = 8

Try to shorten icon name at ‘-’ characters before looking at inherited themes. This flag is only supported in functions that take a single icon name. For more general fallback, see Gtk.IconTheme.choose_icon().

New in version 2.12.

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

New in version 3.6.

NONE = 0

No special behaviour suggested

SPELLCHECK = 1

Suggest checking for typos

NO_EMOJI = 1024

Suggest not offering Emoji support.

New in version 3.22.20.

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

VERTICAL_WRITING = 256

The text is vertical.

New in version 3.18.

UPPERCASE_WORDS = 32

Suggest to capitalize the first character of each word

WORD_COMPLETION = 4

Suggest word completion

EMOJI = 512

Suggest offering Emoji support.

New in version 3.22.20.

UPPERCASE_SENTENCES = 64

Suggest to capitalize the first word of each sentence

LOWERCASE = 8

Suggest to convert all text to lowercase

class Gtk.JunctionSides(value)

Bases: GObject.GFlags

Describes how a rendered element connects to adjacent elements.

NONE = 0

No junctions.

CORNER_TOPLEFT = 1

Element connects on the top-left corner.

RIGHT = 10

Element connects on the right side.

BOTTOM = 12

Element connects on the bottom side.

CORNER_TOPRIGHT = 2

Element connects on the top-right corner.

TOP = 3

Element connects on the top side.

CORNER_BOTTOMLEFT = 4

Element connects on the bottom-left corner.

LEFT = 5

Element connects on the left side.

CORNER_BOTTOMRIGHT = 8

Element connects on the bottom-right corner.

class Gtk.PlacesOpenFlags(value)

Bases: GObject.GFlags

These flags serve two purposes. First, the application can call Gtk.PlacesSidebar.set_open_flags() using these flags as a bitmask. This tells the sidebar that the application is able to open folders selected from the sidebar in various ways, for example, in new tabs or in new windows in addition to the normal mode.

Second, when one of these values gets passed back to the application in the Gtk.PlacesSidebar ::open-location signal, it means that the application should open the selected location in the normal way, in a new tab, or in a new window. The sidebar takes care of determining the desired way to open the location, based on the modifier keys that the user is pressing at the time the selection is made.

If the application never calls Gtk.PlacesSidebar.set_open_flags(), then the sidebar will only use Gtk.PlacesOpenFlags.NORMAL in the Gtk.PlacesSidebar ::open-location signal. This is the default mode of operation.

NORMAL = 1

This is the default mode that Gtk.PlacesSidebar uses if no other flags are specified. It indicates that the calling application should open the selected location in the normal way, for example, in the folder view beside the sidebar.

NEW_TAB = 2

When passed to Gtk.PlacesSidebar.set_open_flags(), this indicates that the application can open folders selected from the sidebar in new tabs. This value will be passed to the Gtk.PlacesSidebar ::open-location signal when the user selects that a location be opened in a new tab instead of in the standard fashion.

NEW_WINDOW = 4

Similar to Gtk.PlacesOpenFlags.NEW_TAB, but indicates that the application can open folders in new windows.

class Gtk.RcFlags(value)

Bases: GObject.GFlags

Deprecated

FG = 1

Deprecated

BG = 2

Deprecated

TEXT = 4

Deprecated

BASE = 8

Deprecated

class Gtk.RecentFilterFlags(value)

Bases: GObject.GFlags

These flags indicate what parts of a Gtk.RecentFilterInfo struct are filled or need to be filled.

URI = 1

the URI of the file being tested

GROUP = 16

the groups to which the file belongs to

DISPLAY_NAME = 2

the string that will be used to display the file in the recent chooser

AGE = 32

the number of days elapsed since the file has been registered

MIME_TYPE = 4

the mime type of the file

APPLICATION = 8

the list of applications that have registered the file

class Gtk.RegionFlags(value)

Bases: GObject.GFlags

Describes a region within a widget.

EVEN = 1

Region has an even number within a set.

ONLY = 16

Region is the only one within a set.

ODD = 2

Region has an odd number within a set.

SORTED = 32

Region is part of a sorted area.

FIRST = 4

Region is the first one within a set.

LAST = 8

Region is the last one within a set.

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.

New in version 3.12.

DIR_LTR = 128

Widget is in left-to-right text direction.

New in version 3.8.

INCONSISTENT = 16

Widget is inconsistent.

PRELIGHT = 2

Widget has a mouse pointer over it.

CHECKED = 2048

Widget is checked.

New in version 3.14.

DIR_RTL = 256

Widget is in right-to-left text direction.

New in version 3.8.

FOCUSED = 32

Widget has the keyboard focus.

SELECTED = 4

Widget is selected.

DROP_ACTIVE = 4096

Widget is highlighted as a drop target for DND.

New in version 3.20.

Widget is a link.

New in version 3.12.

BACKDROP = 64

Widget is in a background toplevel window.

INSENSITIVE = 8

Widget is insensitive.

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

class Gtk.TargetFlags(value)

Bases: GObject.GFlags

The Gtk.TargetFlags enumeration is used to specify constraints on a Gtk.TargetEntry.

SAME_APP = 1

If this is set, the target will only be selected for drags within a single application.

SAME_WIDGET = 2

If this is set, the target will only be selected for drags within a single widget.

OTHER_APP = 4

If this is set, the target will not be selected for drags within a single application.

OTHER_WIDGET = 8

If this is set, the target will not be selected for drags withing a single widget.

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 pixbufs 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 pixbufs 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.ToolPaletteDragTargets(value)

Bases: GObject.GFlags

Flags used to specify the supported drag targets.

ITEMS = 1

Support drag of items.

GROUPS = 2

Support drag of groups.

class Gtk.TreeModelFlags(value)

Bases: GObject.GFlags

These flags indicate various properties of a Gtk.TreeModel.

They are returned by 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

class Gtk.UIManagerItemType(value)

Bases: GObject.GFlags

These enumeration values are used by Gtk.UIManager.add_ui() to determine what UI element to create.

Deprecated since version 3.10.

AUTO = 0

Pick the type of the UI element according to context.

MENUBAR = 1

Create a menubar.

SEPARATOR = 128

Create a separator.

POPUP = 16

Create a popup menu.

MENU = 2

Create a menu.

ACCELERATOR = 256

Install an accelerator.

MENUITEM = 32

Create a menuitem.

TOOLBAR = 4

Create a toolbar.

POPUP_WITH_ACCELS = 512

Same as Gtk.UIManagerItemType.POPUP, but the actions’ accelerators are shown.

TOOLITEM = 64

Create a toolitem.

PLACEHOLDER = 8

Insert a placeholder.