GI.Gtk.Objects.Widget

The base class for all widgets.

GtkWidget is the base class all widgets in GTK derive from. It manages the widget lifecycle, layout, states and style.

Height-for-width Geometry Management

GTK uses a height-for-width (and width-for-height) geometry management system. Height-for-width means that a widget can change how much vertical space it needs, depending on the amount of horizontal space that it is given (and similar for width-for-height). The most common example is a label that reflows to fill up the available width, wraps to fewer lines, and therefore needs less height.

Height-for-width geometry management is implemented in GTK by way of two virtual methods:

• Widget.get_request_mode()
• Widget.measure()

There are some important things to keep in mind when implementing height-for-width and when using it in widget implementations.

If you implement a direct GtkWidget subclass that supports height-for-width or width-for-height geometry management for itself or its child widgets, the Widget.get_request_mode() virtual function must be implemented as well and return the widget's preferred request mode. The default implementation of this virtual function returns SizeRequestModeConstantSize, which means that the widget will only ever get -1 passed as the for_size value to its Widget.measure() implementation.

The geometry management system will query a widget hierarchy in only one orientation at a time. When widgets are initially queried for their minimum sizes it is generally done in two initial passes in the SizeRequestMode chosen by the toplevel.

For example, when queried in the normal SizeRequestModeHeightForWidth mode:

First, the default minimum and natural width for each widget in the interface will be computed using widgetMeasure with an orientation of OrientationHorizontal and a for_size of -1. Because the preferred widths for each widget depend on the preferred widths of their children, this information propagates up the hierarchy, and finally a minimum and natural width is determined for the entire toplevel. Next, the toplevel will use the minimum width to query for the minimum height contextual to that width using widgetMeasure with an orientation of OrientationVertical and a for_size of the just computed width. This will also be a highly recursive operation. The minimum height for the minimum width is normally used to set the minimum size constraint on the toplevel.

After the toplevel window has initially requested its size in both dimensions it can go on to allocate itself a reasonable size (or a size previously specified with windowSetDefaultSize). During the recursive allocation process it’s important to note that request cycles will be recursively executed while widgets allocate their children. Each widget, once allocated a size, will go on to first share the space in one orientation among its children and then request each child's height for its target allocated width or its width for allocated height, depending. In this way a GtkWidget will typically be requested its size a number of times before actually being allocated a size. The size a widget is finally allocated can of course differ from the size it has requested. For this reason, GtkWidget caches a small number of results to avoid re-querying for the same sizes in one allocation cycle.

If a widget does move content around to intelligently use up the allocated size then it must support the request in both GtkSizeRequestModes even if the widget in question only trades sizes in a single orientation.

For instance, a Label that does height-for-width word wrapping will not expect to have Widget.measure() with an orientation of OrientationVertical called because that call is specific to a width-for-height request. In this case the label must return the height required for its own minimum possible width. By following this rule any widget that handles height-for-width or width-for-height requests will always be allocated at least enough space to fit its own content.

Here are some examples of how a SizeRequestModeHeightForWidth widget generally deals with width-for-height requests:

c code

static void
foo_widget_measure (GtkWidget      *widget,
                    GtkOrientation  orientation,
                    int             for_size,
                    int            *minimum_size,
                    int            *natural_size,
                    int            *minimum_baseline,
                    int            *natural_baseline)
{
  if (orientation == GTK_ORIENTATION_HORIZONTAL)
    {
      // Calculate minimum and natural width
    }
  else // VERTICAL
    {
      if (i_am_in_height_for_width_mode)
        {
          int min_width, dummy;

          // First, get the minimum width of our widget
          GTK_WIDGET_GET_CLASS (widget)->measure (widget, GTK_ORIENTATION_HORIZONTAL, -1,
                                                  &min_width, &dummy, &dummy, &dummy);

          // Now use the minimum width to retrieve the minimum and natural height to display
          // that width.
          GTK_WIDGET_GET_CLASS (widget)->measure (widget, GTK_ORIENTATION_VERTICAL, min_width,
                                                  minimum_size, natural_size, &dummy, &dummy);
        }
      else
        {
          // ... some widgets do both.
        }
    }
}

Often a widget needs to get its own request during size request or allocation. For example, when computing height it may need to also compute width. Or when deciding how to use an allocation, the widget may need to know its natural size. In these cases, the widget should be careful to call its virtual methods directly, like in the code example above.

It will not work to use the wrapper function widgetMeasure inside your own Widget.size_allocate() implementation. These return a request adjusted by SizeGroup, the widget's align and expand flags, as well as its CSS style.

If a widget used the wrappers inside its virtual method implementations, then the adjustments (such as widget margins) would be applied twice. GTK therefore does not allow this and will warn if you try to do it.

Of course if you are getting the size request for another widget, such as a child widget, you must use widgetMeasure; otherwise, you would not properly consider widget margins, SizeGroup, and so forth.

GTK also supports baseline vertical alignment of widgets. This means that widgets are positioned such that the typographical baseline of widgets in the same row are aligned. This happens if a widget supports baselines, has a vertical alignment of AlignBaseline, and is inside a widget that supports baselines and has a natural “row” that it aligns to the baseline, or a baseline assigned to it by the grandparent.

Baseline alignment support for a widget is also done by the Widget.measure() virtual function. It allows you to report both a minimum and natural size.

If a widget ends up baseline aligned it will be allocated all the space in the parent as if it was AlignFill, but the selected baseline can be found via widgetGetAllocatedBaseline. If the baseline has a value other than -1 you need to align the widget such that the baseline appears at the position.

GtkWidget as GtkBuildable

The GtkWidget implementation of the GtkBuildable interface supports various custom elements to specify additional aspects of widgets that are not directly expressed as properties.

If the widget uses a LayoutManager, GtkWidget supports a custom <layout> element, used to define layout properties:

xml code

<object class="GtkGrid" id="my_grid">
  <child>
    <object class="GtkLabel" id="label1">
      <property name="label">Description</property>
      <layout>
        <property name="column">0</property>
        <property name="row">0</property>
        <property name="row-span">1</property>
        <property name="column-span">1</property>
      </layout>
    </object>
  </child>
  <child>
    <object class="GtkEntry" id="description_entry">
      <layout>
        <property name="column">1</property>
        <property name="row">0</property>
        <property name="row-span">1</property>
        <property name="column-span">1</property>
      </layout>
    </object>
  </child>
</object>

GtkWidget allows style information such as style classes to be associated with widgets, using the custom <style> element:

xml code

<object class="GtkButton" id="button1">
  <style>
    <class name="my-special-button-class"/>
    <class name="dark-button"/>
  </style>
</object>

GtkWidget allows defining accessibility information, such as properties, relations, and states, using the custom <accessibility> element:

xml code

<object class="GtkButton" id="button1">
  <accessibility>
    <property name="label">Download</property>
    <relation name="labelled-by">label1</relation>
  </accessibility>
</object>

Building composite widgets from template XML

GtkWidget exposes some facilities to automate the procedure of creating composite widgets using "templates".

To create composite widgets with GtkBuilder XML, one must associate the interface description with the widget class at class initialization time using widgetClassSetTemplate.

The interface description semantics expected in composite template descriptions is slightly different from regular Builder XML.

Unlike regular interface descriptions, widgetClassSetTemplate will expect a <template> tag as a direct child of the toplevel <interface> tag. The <template> tag must specify the “class” attribute which must be the type name of the widget. Optionally, the “parent” attribute may be specified to specify the direct parent type of the widget type, this is ignored by GtkBuilder but required for UI design tools like Glade to introspect what kind of properties and internal children exist for a given type when the actual type does not exist.

The XML which is contained inside the <template> tag behaves as if it were added to the <object> tag defining the widget itself. You may set properties on a widget by inserting <property> tags into the <template> tag, and also add <child> tags to add children and extend a widget in the normal way you would with <object> tags.

Additionally, <object> tags can also be added before and after the initial <template> tag in the normal way, allowing one to define auxiliary objects which might be referenced by other widgets declared as children of the <template> tag.

An example of a template definition:

xml code

<interface>
  <template class="FooWidget" parent="GtkBox">
    <property name="orientation">horizontal</property>
    <property name="spacing">4</property>
    <child>
      <object class="GtkButton" id="hello_button">
        <property name="label">Hello World</property>
        <signal name="clicked" handler="hello_button_clicked" object="FooWidget" swapped="yes"/>
      </object>
    </child>
    <child>
      <object class="GtkButton" id="goodbye_button">
        <property name="label">Goodbye World</property>
      </object>
    </child>
  </template>
</interface>

Typically, you'll place the template fragment into a file that is bundled with your project, using GResource. In order to load the template, you need to call widgetClassSetTemplateFromResource from the class initialization of your GtkWidget type:

c code

static void
foo_widget_class_init (FooWidgetClass *klass)
{
  // ...

  gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass),
                                               "/com/example/ui/foowidget.ui");
}

You will also need to call widgetInitTemplate from the instance initialization function:

c code

static void
foo_widget_init (FooWidget *self)
{
  // ...
  gtk_widget_init_template (GTK_WIDGET (self));
}

You can access widgets defined in the template using the widgetGetTemplateChild function, but you will typically declare a pointer in the instance private data structure of your type using the same name as the widget in the template definition, and call widgetClassBindTemplateChildFull (or one of its wrapper macros Gtk.widget_class_bind_template_child and Gtk.widget_class_bind_template_child_private) with that name, e.g.

c code

typedef struct {
  GtkWidget *hello_button;
  GtkWidget *goodbye_button;
} FooWidgetPrivate;

G_DEFINE_TYPE_WITH_PRIVATE (FooWidget, foo_widget, GTK_TYPE_BOX)

static void
foo_widget_class_init (FooWidgetClass *klass)
{
  // ...
  gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass),
                                               "/com/example/ui/foowidget.ui");
  gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass),
                                                FooWidget, hello_button);
  gtk_widget_class_bind_template_child_private (GTK_WIDGET_CLASS (klass),
                                                FooWidget, goodbye_button);
}

static void
foo_widget_init (FooWidget *widget)
{

}

You can also use widgetClassBindTemplateCallbackFull (or is wrapper macro Gtk.widget_class_bind_template_callback) to connect a signal callback defined in the template with a function visible in the scope of the class, e.g.

c code

// the signal handler has the instance and user data swapped
// because of the swapped="yes" attribute in the template XML
static void
hello_button_clicked (FooWidget *self,
                      GtkButton *button)
{
  g_print ("Hello, world!\n");
}

static void
foo_widget_class_init (FooWidgetClass *klass)
{
  // ...
  gtk_widget_class_set_template_from_resource (GTK_WIDGET_CLASS (klass),
                                               "/com/example/ui/foowidget.ui");
  gtk_widget_class_bind_template_callback (GTK_WIDGET_CLASS (klass), hello_button_clicked);
}

Exported types

newtype Widget

Memory-managed wrapper type.

Constructors

Widget (ManagedPtr Widget)

Instances

Eq Widget

Defined in GI.Gtk.Objects.Widget

Methods

(==) :: Widget -> Widget -> Bool

(/=) :: Widget -> Widget -> Bool

GObject Widget

Defined in GI.Gtk.Objects.Widget

ManagedPtrNewtype Widget

Defined in GI.Gtk.Objects.Widget

Methods

toManagedPtr :: Widget -> ManagedPtr Widget

TypedObject Widget

Defined in GI.Gtk.Objects.Widget

Methods

glibType :: IO GType

HasParentTypes Widget

Defined in GI.Gtk.Objects.Widget

IsGValue (Maybe Widget)

Convert Widget to and from GValue. See toGValue and fromGValue.

Defined in GI.Gtk.Objects.Widget

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Widget -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Widget)

type ParentTypes Widget

Defined in GI.Gtk.Objects.Widget

type ParentTypes Widget = '[Object, Accessible, Buildable, ConstraintTarget]

class (GObject o, IsDescendantOf Widget o) => IsWidget o

Type class for types which can be safely cast to Widget, for instance with toWidget.

Instances

(GObject o, IsDescendantOf Widget o) => IsWidget o

Defined in GI.Gtk.Objects.Widget

toWidget :: (MonadIO m, IsWidget o) => o -> m Widget

Cast to Widget, for types for which this is known to be safe. For general casts, use castTo.

Methods

Click to display all available methods, including inherited ones

Methods

actionSetEnabled, activate, activateAction, activateDefault, addController, addCssClass, addMnemonicLabel, addTickCallback, allocate, bindProperty, bindPropertyFull, childFocus, computeBounds, computeExpand, computePoint, computeTransform, contains, createPangoContext, createPangoLayout, dragCheckThreshold, errorBell, forceFloating, freezeNotify, getv, grabFocus, hasCssClass, hasDefault, hasFocus, hasVisibleFocus, hide, inDestruction, initTemplate, insertActionGroup, insertAfter, insertBefore, isAncestor, isDrawable, isFloating, isFocus, isSensitive, isVisible, keynavFailed, listMnemonicLabels, map, measure, mnemonicActivate, notify, notifyByPspec, observeChildren, observeControllers, pick, queueAllocate, queueDraw, queueResize, realize, ref, refSink, removeController, removeCssClass, removeMnemonicLabel, removeTickCallback, resetProperty, resetRelation, resetState, runDispose, shouldLayout, show, sizeAllocate, snapshotChild, stealData, stealQdata, thawNotify, translateCoordinates, triggerTooltipQuery, unmap, unparent, unrealize, unref, unsetStateFlags, updateProperty, updateRelation, updateState, watchClosure.

Getters

getAccessibleRole, getAllocatedBaseline, getAllocatedHeight, getAllocatedWidth, getAllocation, getAncestor, getBuildableId, getCanFocus, getCanTarget, getChildVisible, getClipboard, getCssClasses, getCssName, getCursor, getData, getDirection, getDisplay, getFirstChild, getFocusChild, getFocusOnClick, getFocusable, getFontMap, getFontOptions, getFrameClock, getHalign, getHasTooltip, getHeight, getHexpand, getHexpandSet, getLastChild, getLayoutManager, getMapped, getMarginBottom, getMarginEnd, getMarginStart, getMarginTop, getName, getNative, getNextSibling, getOpacity, getOverflow, getPangoContext, getParent, getPreferredSize, getPrevSibling, getPrimaryClipboard, getProperty, getQdata, getRealized, getReceivesDefault, getRequestMode, getRoot, getScaleFactor, getSensitive, getSettings, getSize, getSizeRequest, getStateFlags, getStyleContext, getTemplateChild, getTooltipMarkup, getTooltipText, getValign, getVexpand, getVexpandSet, getVisible, getWidth.

Setters

setCanFocus, setCanTarget, setChildVisible, setCssClasses, setCursor, setCursorFromName, setData, setDataFull, setDirection, setFocusChild, setFocusOnClick, setFocusable, setFontMap, setFontOptions, setHalign, setHasTooltip, setHexpand, setHexpandSet, setLayoutManager, setMarginBottom, setMarginEnd, setMarginStart, setMarginTop, setName, setOpacity, setOverflow, setParent, setProperty, setReceivesDefault, setSensitive, setSizeRequest, setStateFlags, setTooltipMarkup, setTooltipText, setValign, setVexpand, setVexpandSet, setVisible.

actionSetEnabled

widgetActionSetEnabled

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Text

actionName: action name, such as "clipboard.paste"

-> Bool

enabled: whether the action is now enabled

-> m ()

Enable or disable an action installed with widgetClassInstallAction.

activate

widgetActivate

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget that’s activatable

-> m Bool

Returns: True if the widget was activatable

For widgets that can be “activated” (buttons, menu items, etc.), this function activates them.

The activation will emit the signal set using widgetClassSetActivateSignal during class initialization.

Activation is what happens when you press <kbd>Enter</kbd> on a widget during key navigation.

If you wish to handle the activation keybinding yourself, it is recommended to use widgetClassAddShortcut with an action created with signalActionNew.

If widget isn't activatable, the function returns False.

activateAction

widgetActivateAction

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Text

name: the name of the action to activate

-> Maybe GVariant

args: parameters to use

-> m Bool

Returns: True if the action was activated, False if the action does not exist.

Looks up the action in the action groups associated with widget and its ancestors, and activates it.

If the action is in an action group added with widgetInsertActionGroup, the name is expected to be prefixed with the prefix that was used when the group was inserted.

The arguments must match the actions expected parameter type, as returned by g_action_get_parameter_type().

activateDefault

widgetActivateDefault

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Activates the default.activate action from widget.

addController

widgetAddController

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsEventController b)

=> a

widget: a GtkWidget

-> b

controller: a GtkEventController that hasn't been added to a widget yet

-> m ()

Adds controller to widget so that it will receive events.

You will usually want to call this function right after creating any kind of EventController.

addCssClass

widgetAddCssClass

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Text

cssClass: The style class to add to widget, without the leading '.' used for notation of style classes

-> m ()

Adds a style class to widget.

After calling this function, the widgets style will match for cssClass, according to CSS matching rules.

Use widgetRemoveCssClass to remove the style again.

addMnemonicLabel

widgetAddMnemonicLabel

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: a GtkWidget

-> b

label: a GtkWidget that acts as a mnemonic label for widget

-> m ()

Adds a widget to the list of mnemonic labels for this widget.

See widgetListMnemonicLabels. Note the list of mnemonic labels for the widget is cleared when the widget is destroyed, so the caller must make sure to update its internal state at this point as well.

addTickCallback

widgetAddTickCallback

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> TickCallback

callback: function to call for updating animations

-> m Word32

Returns: an id for the connection of this callback. Remove the callback by passing the id returned from this function to widgetRemoveTickCallback

Queues an animation frame update and adds a callback to be called before each frame.

Until the tick callback is removed, it will be called frequently (usually at the frame rate of the output device or as quickly as the application can be repainted, whichever is slower). For this reason, is most suitable for handling graphics that change every frame or every few frames. The tick callback does not automatically imply a relayout or repaint. If you want a repaint or relayout, and aren’t changing widget properties that would trigger that (for example, changing the text of a GtkLabel), then you will have to call widgetQueueResize or widgetQueueDraw yourself.

frameClockGetFrameTime should generally be used for timing continuous animations and frameTimingsGetPredictedPresentationTime if you are trying to display isolated frames at particular times.

This is a more convenient alternative to connecting directly to the FrameClock::update signal of GdkFrameClock, since you don't have to worry about when a GdkFrameClock is assigned to a widget.

allocate

widgetAllocate

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: A GtkWidget

-> Int32

width: New width of widget

-> Int32

height: New height of widget

-> Int32

baseline: New baseline of widget, or -1

-> Maybe Transform

transform: Transformation to be applied to widget

-> m ()

This function is only used by GtkWidget subclasses, to assign a size, position and (optionally) baseline to their child widgets.

In this function, the allocation and baseline may be adjusted. The given allocation will be forced to be bigger than the widget's minimum size, as well as at least 0×0 in size.

For a version that does not take a transform, see widgetSizeAllocate.

childFocus

widgetChildFocus

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> DirectionType

direction: direction of focus movement

-> m Bool

Returns: True if focus ended up inside widget

Called by widgets as the user moves around the window using keyboard shortcuts.

The direction argument indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward).

This function calls the Widget.focus() virtual function; widgets can override the virtual function in order to implement appropriate focus behavior.

The default focus() virtual function for a widget should return TRUE if moving in direction left the focus on a focusable location inside that widget, and FALSE if moving in direction moved the focus outside the widget. When returning TRUE, widgets normallycall widgetGrabFocus to place the focus accordingly; when returning FALSE, they don’t modify the current focus location.

This function is used by custom widget implementations; if you're writing an app, you’d use widgetGrabFocus to move the focus to a particular widget.

computeBounds

widgetComputeBounds

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: the GtkWidget to query

-> b

target: the GtkWidget

-> m (Bool, Rect)

Returns: True if the bounds could be computed

Computes the bounds for widget in the coordinate space of target.

FIXME: Explain what "bounds" are.

If the operation is successful, True is returned. If widget has no bounds or the bounds cannot be expressed in target's coordinate space (for example if both widgets are in different windows), False is returned and bounds is set to the zero rectangle.

It is valid for widget and target to be the same widget.

computeExpand

widgetComputeExpand

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> Orientation

orientation: expand direction

-> m Bool

Returns: whether widget tree rooted here should be expanded

Computes whether a container should give this widget extra space when possible.

Containers should check this, rather than looking at widgetGetHexpand or widgetGetVexpand.

This function already checks whether the widget is visible, so visibility does not need to be checked separately. Non-visible widgets are not expanded.

The computed expand value uses either the expand setting explicitly set on the widget itself, or, if none has been explicitly set, the widget may expand if some of its children do.

computePoint

widgetComputePoint

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: the GtkWidget to query

-> b

target: the GtkWidget to transform into

-> Point

point: a point in widget's coordinate system

-> m (Bool, Point)

Returns: True if the point could be determined, False on failure. In this case, 0 is stored in outPoint.

Translates the given point in widget's coordinates to coordinates relative to target’s coordinate system.

In order to perform this operation, both widgets must share a common ancestor.

computeTransform

widgetComputeTransform

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: a GtkWidget

-> b

target: the target widget that the matrix will transform to

-> m (Bool, Matrix)

Returns: True if the transform could be computed, False otherwise

Computes a matrix suitable to describe a transformation from widget's coordinate system into target's coordinate system.

The transform can not be computed in certain cases, for example when widget and target do not share a common ancestor. In that case outTransform gets set to the identity matrix.

contains

widgetContains

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget to query

-> Double

x: X coordinate to test, relative to widget's origin

-> Double

y: Y coordinate to test, relative to widget's origin

-> m Bool

Returns: True if widget contains (x, y).

Tests if the point at (x, y) is contained in widget.

The coordinates for (x, y) must be in widget coordinates, so (0, 0) is assumed to be the top left of widget's content area.

createPangoContext

widgetCreatePangoContext

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Context

Returns: the new PangoContext

Creates a new PangoContext with the appropriate font map, font options, font description, and base direction for drawing text for this widget.

See also widgetGetPangoContext.

createPangoLayout

widgetCreatePangoLayout

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Maybe Text

text: text to set on the layout

-> m Layout

Returns: the new PangoLayout

Creates a new PangoLayout with the appropriate font map, font description, and base direction for drawing text for this widget.

If you keep a PangoLayout created in this way around, you need to re-create it when the widget PangoContext is replaced. This can be tracked by listening to changes of the Widget:root property on the widget.

dragCheckThreshold

widgetDragCheckThreshold

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Int32

startX: X coordinate of start of drag

-> Int32

startY: Y coordinate of start of drag

-> Int32

currentX: current X coordinate

-> Int32

currentY: current Y coordinate

-> m Bool

Returns: True if the drag threshold has been passed.

Checks to see if a drag movement has passed the GTK drag threshold.

errorBell

widgetErrorBell

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Notifies the user about an input-related error on this widget.

If the Settings:gtkErrorBell setting is True, it calls surfaceBeep, otherwise it does nothing.

Note that the effect of surfaceBeep can be configured in many ways, depending on the windowing backend and the desktop environment or window manager that is used.

getAllocatedBaseline

widgetGetAllocatedBaseline

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget to query

-> m Int32

Returns: the baseline of the widget, or -1 if none

Returns the baseline that has currently been allocated to widget.

This function is intended to be used when implementing handlers for the GtkWidgetClass.snapshot() function, and when allocating child widgets in GtkWidgetClass.size_allocate().

getAllocatedHeight

widgetGetAllocatedHeight

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget to query

-> m Int32

Returns: the height of the widget

Returns the height that has currently been allocated to widget.

getAllocatedWidth

widgetGetAllocatedWidth

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget to query

-> m Int32

Returns: the width of the widget

Returns the width that has currently been allocated to widget.

getAllocation

widgetGetAllocation

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Rectangle

Retrieves the widget’s allocation.

Note, when implementing a layout container: a widget’s allocation will be its “adjusted” allocation, that is, the widget’s parent typically calls widgetSizeAllocate with an allocation, and that allocation is then adjusted (to handle margin and alignment for example) before assignment to the widget. widgetGetAllocation returns the adjusted allocation that was actually assigned to the widget. The adjusted allocation is guaranteed to be completely contained within the widgetSizeAllocate allocation, however.

So a layout container is guaranteed that its children stay inside the assigned bounds, but not that they have exactly the bounds the container assigned.

getAncestor

widgetGetAncestor

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> GType

widgetType: ancestor type

-> m (Maybe Widget)

Returns: the ancestor widget

Gets the first ancestor of widget with type widgetType.

For example, gtk_widget_get_ancestor (widget, GTK_TYPE_BOX) gets the first GtkBox that’s an ancestor of widget. No reference will be added to the returned widget; it should not be unreferenced.

Note that unlike widgetIsAncestor, this function considers widget to be an ancestor of itself.

getCanFocus

widgetGetCanFocus

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the input focus can enter widget, False otherwise

Determines whether the input focus can enter widget or any of its children.

See widgetSetFocusable.

getCanTarget

widgetGetCanTarget

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if widget can receive pointer events

Queries whether widget can be the target of pointer events.

getChildVisible

widgetGetChildVisible

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget is mapped with the parent.

Gets the value set with widgetSetChildVisible.

If you feel a need to use this function, your code probably needs reorganization.

This function is only useful for container implementations and should never be called by an application.

getClipboard

widgetGetClipboard

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Clipboard

Returns: the appropriate clipboard object

Gets the clipboard object for widget.

This is a utility function to get the clipboard object for the GdkDisplay that widget is using.

Note that this function always works, even when widget is not realized yet.

getCssClasses

widgetGetCssClasses

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m [Text]

Returns: a Nothing-terminated list of css classes currently applied to widget. The returned list must freed using strfreev.

Returns the list of style classes applied to widget.

getCssName

widgetGetCssName

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

self: a GtkWidget

-> m Text

Returns: the CSS name

Returns the CSS name that is used for self.

getCursor

widgetGetCursor

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Cursor)

Returns: the cursor currently in use or Nothing if the cursor is inherited

Queries the cursor set on widget.

See widgetSetCursor for details.

getDefaultDirection

widgetGetDefaultDirection

Arguments

:: (HasCallStack, MonadIO m)

=> m TextDirection

Returns: the current default direction.

Obtains the current default reading direction.

See [funcgtk.Widget.set_default_direction].

getDirection

widgetGetDirection

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m TextDirection

Returns: the reading direction for the widget.

Gets the reading direction for a particular widget.

See widgetSetDirection.

getDisplay

widgetGetDisplay

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Display

Returns: the GdkDisplay for the toplevel for this widget.

Get the GdkDisplay for the toplevel window associated with this widget.

This function can only be called after the widget has been added to a widget hierarchy with a GtkWindow at the top.

In general, you should only create display specific resources when a widget has been realized, and you should free those resources when the widget is unrealized.

getFirstChild

widgetGetFirstChild

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Widget)

Returns: The widget's first child

Returns the widgets first child.

This API is primarily meant for widget implementations.

getFocusChild

widgetGetFocusChild

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Widget)

Returns: The current focus child of widget

Returns the current focus child of widget.

getFocusOnClick

widgetGetFocusOnClick

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget should grab focus when it is clicked with the mouse

Returns whether the widget should grab focus when it is clicked with the mouse.

See widgetSetFocusOnClick.

getFocusable

widgetGetFocusable

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if widget can own the input focus, False otherwise

Determines whether widget can own the input focus.

See widgetSetFocusable.

getFontMap

widgetGetFontMap

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe FontMap)

Returns: A PangoFontMap

Gets the font map of widget.

See widgetSetFontMap.

getFontOptions

widgetGetFontOptions

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe FontOptions)

Returns: the cairo_font_options_t of widget

Returns the cairo_font_options_t of widget.

Seee widgetSetFontOptions.

getFrameClock

widgetGetFrameClock

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe FrameClock)

Returns: a GdkFrameClock

Obtains the frame clock for a widget.

The frame clock is a global “ticker” that can be used to drive animations and repaints. The most common reason to get the frame clock is to call frameClockGetFrameTime, in order to get a time to use for animating. For example you might record the start of the animation with an initial value from frameClockGetFrameTime, and then update the animation by calling frameClockGetFrameTime again during each repaint.

frameClockRequestPhase will result in a new frame on the clock, but won’t necessarily repaint any widgets. To repaint a widget, you have to use widgetQueueDraw which invalidates the widget (thus scheduling it to receive a draw on the next frame). widgetQueueDraw will also end up requesting a frame on the appropriate frame clock.

A widget’s frame clock will not change while the widget is mapped. Reparenting a widget (which implies a temporary unmap) can change the widget’s frame clock.

Unrealized widgets do not have a frame clock.

getHalign

widgetGetHalign

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Align

Returns: the horizontal alignment of widget

Gets the horizontal alignment of widget.

For backwards compatibility reasons this method will never return AlignBaseline, but instead it will convert it to AlignFill. Baselines are not supported for horizontal alignment.

getHasTooltip

widgetGetHasTooltip

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: current value of has-tooltip on widget.

Returns the current value of the has-tooltip property.

getHeight

widgetGetHeight

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Int32

Returns: The height of widget

Returns the content height of the widget.

This function returns the height passed to its size-allocate implementation, which is the height you should be using in Widget.snapshot().

For pointer events, see widgetContains.

getHexpand

widgetGetHexpand

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> m Bool

Returns: whether hexpand flag is set

Gets whether the widget would like any available extra horizontal space.

When a user resizes a GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.

Containers should use widgetComputeExpand rather than this function, to see whether a widget, or any of its children, has the expand flag set. If any child of a widget wants to expand, the parent may ask to expand also.

This function only looks at the widget’s own hexpand flag, rather than computing whether the entire widget tree rooted at this widget wants to expand.

getHexpandSet

widgetGetHexpandSet

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> m Bool

Returns: whether hexpand has been explicitly set

Gets whether widgetSetHexpand has been used to explicitly set the expand flag on this widget.

If Widget:hexpand property is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.

There are few reasons to use this function, but it’s here for completeness and consistency.

getLastChild

widgetGetLastChild

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Widget)

Returns: The widget's last child

Returns the widgets last child.

This API is primarily meant for widget implementations.

getLayoutManager

widgetGetLayoutManager

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe LayoutManager)

Returns: a GtkLayoutManager

Retrieves the layout manager used by widget.

See widgetSetLayoutManager.

getMapped

widgetGetMapped

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget is mapped, False otherwise.

Whether the widget is mapped.

getMarginBottom

widgetGetMarginBottom

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Int32

Returns: The bottom margin of widget

Gets the bottom margin of widget.

getMarginEnd

widgetGetMarginEnd

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Int32

Returns: The end margin of widget

Gets the end margin of widget.

getMarginStart

widgetGetMarginStart

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Int32

Returns: The start margin of widget

Gets the start margin of widget.

getMarginTop

widgetGetMarginTop

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Int32

Returns: The top margin of widget

Gets the top margin of widget.

getName

widgetGetName

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Text

Returns: name of the widget. This string is owned by GTK and should not be modified or freed

Retrieves the name of a widget.

See widgetSetName for the significance of widget names.

getNative

widgetGetNative

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Native)

Returns: the GtkNative ancestor of widget

Returns the nearest GtkNative ancestor of widget.

This function will return Nothing if the widget is not contained inside a widget tree with a native ancestor.

GtkNative widgets will return themselves here.

getNextSibling

widgetGetNextSibling

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Widget)

Returns: The widget's next sibling

Returns the widgets next sibling.

This API is primarily meant for widget implementations.

getOpacity

widgetGetOpacity

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Double

Returns: the requested opacity for this widget.

Fetches the requested opacity for this widget.

See widgetSetOpacity.

getOverflow

widgetGetOverflow

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Overflow

Returns: The widget's overflow.

Returns the widgets overflow value.

getPangoContext

widgetGetPangoContext

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Context

Returns: the PangoContext for the widget.

Gets a PangoContext with the appropriate font map, font description, and base direction for this widget.

Unlike the context returned by widgetCreatePangoContext, this context is owned by the widget (it can be used until the screen for the widget changes or the widget is removed from its toplevel), and will be updated to match any changes to the widget’s attributes. This can be tracked by listening to changes of the Widget:root property on the widget.

getParent

widgetGetParent

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Widget)

Returns: the parent widget of widget

Returns the parent widget of widget.

getPreferredSize

widgetGetPreferredSize

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget instance

-> m (Requisition, Requisition)

Retrieves the minimum and natural size of a widget, taking into account the widget’s preference for height-for-width management.

This is used to retrieve a suitable size by container widgets which do not impose any restrictions on the child placement. It can be used to deduce toplevel window and menu sizes as well as child widgets in free-form containers such as GtkFixed.

Handle with care. Note that the natural height of a height-for-width widget will generally be a smaller size than the minimum height, since the required height for the natural width is generally smaller than the required height for the minimum width.

Use widgetMeasure if you want to support baseline alignment.

getPrevSibling

widgetGetPrevSibling

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Widget)

Returns: The widget's previous sibling

Returns the widgets previous sibling.

This API is primarily meant for widget implementations.

getPrimaryClipboard

widgetGetPrimaryClipboard

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Clipboard

Returns: the appropriate clipboard object

Gets the primary clipboard of widget.

This is a utility function to get the primary clipboard object for the GdkDisplay that widget is using.

Note that this function always works, even when widget is not realized yet.

getRealized

widgetGetRealized

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if widget is realized, False otherwise

Determines whether widget is realized.

getReceivesDefault

widgetGetReceivesDefault

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if widget acts as the default widget when focused, False otherwise

Determines whether widget is always treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

See widgetSetReceivesDefault.

getRequestMode

widgetGetRequestMode

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget instance

-> m SizeRequestMode

Returns: The GtkSizeRequestMode preferred by widget.

Gets whether the widget prefers a height-for-width layout or a width-for-height layout.

Single-child widgets generally propagate the preference of their child, more complex widgets need to request something either in context of their children or in context of their allocation capabilities.

getRoot

widgetGetRoot

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Root)

Returns: the root widget of widget

Returns the GtkRoot widget of widget.

This function will return Nothing if the widget is not contained inside a widget tree with a root widget.

GtkRoot widgets will return themselves here.

getScaleFactor

widgetGetScaleFactor

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Int32

Returns: the scale factor for widget

Retrieves the internal scale factor that maps from window coordinates to the actual device pixels.

On traditional systems this is 1, on high density outputs, it can be a higher value (typically 2).

See surfaceGetScaleFactor.

getSensitive

widgetGetSensitive

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget is sensitive

Returns the widget’s sensitivity.

This function returns the value that has been set using widgetSetSensitive).

The effective sensitivity of a widget is however determined by both its own and its parent widget’s sensitivity. See widgetIsSensitive.

getSettings

widgetGetSettings

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Settings

Returns: the relevant GtkSettings object

Gets the settings object holding the settings used for this widget.

Note that this function can only be called when the GtkWidget is attached to a toplevel, since the settings object is specific to a particular GdkDisplay. If you want to monitor the widget for changes in its settings, connect to the notify::display signal.

getSize

widgetGetSize

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Orientation

orientation: the orientation to query

-> m Int32

Returns: The size of widget in orientation.

Returns the content width or height of the widget.

Which dimension is returned depends on orientation.

This is equivalent to calling widgetGetWidth for OrientationHorizontal or widgetGetHeight for OrientationVertical, but can be used when writing orientation-independent code, such as when implementing Orientable widgets.

getSizeRequest

widgetGetSizeRequest

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Int32, Int32)

Gets the size request that was explicitly set for the widget using widgetSetSizeRequest.

A value of -1 stored in width or height indicates that that dimension has not been set explicitly and the natural requisition of the widget will be used instead. See widgetSetSizeRequest. To get the size a widget will actually request, call widgetMeasure instead of this function.

getStateFlags

widgetGetStateFlags

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m [StateFlags]

Returns: The state flags for widget

Returns the widget state as a flag set.

It is worth mentioning that the effective StateFlagsInsensitive state will be returned, that is, also based on parent insensitivity, even if widget itself is sensitive.

Also note that if you are looking for a way to obtain the [flagsgtk.StateFlags] to pass to a StyleContext method, you should look at styleContextGetState.

getStyleContext

widgetGetStyleContext

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m StyleContext

Returns: the widgets GtkStyleContext

Returns the style context associated to widget.

The returned object is guaranteed to be the same for the lifetime of widget.

getTemplateChild

widgetGetTemplateChild

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: A GtkWidget

-> GType

widgetType: The GType to get a template child for

-> Text

name: The “id” of the child defined in the template XML

-> m Object

Returns: The object built in the template XML with the id name

Fetch an object build from the template XML for widgetType in this widget instance.

This will only report children which were previously declared with widgetClassBindTemplateChildFull or one of its variants.

This function is only meant to be called for code which is private to the widgetType which declared the child and is meant for language bindings which cannot easily make use of the GObject structure offsets.

getTooltipMarkup

widgetGetTooltipMarkup

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Text)

Returns: the tooltip text

Gets the contents of the tooltip for widget.

If the tooltip has not been set using widgetSetTooltipMarkup, this function returns Nothing.

getTooltipText

widgetGetTooltipText

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m (Maybe Text)

Returns: the tooltip text

Gets the contents of the tooltip for widget.

If the widget's tooltip was set using widgetSetTooltipMarkup, this function will return the escaped text.

getValign

widgetGetValign

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Align

Returns: the vertical alignment of widget

Gets the vertical alignment of widget.

getVexpand

widgetGetVexpand

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> m Bool

Returns: whether vexpand flag is set

Gets whether the widget would like any available extra vertical space.

See widgetGetHexpand for more detail.

getVexpandSet

widgetGetVexpandSet

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> m Bool

Returns: whether vexpand has been explicitly set

Gets whether widgetSetVexpand has been used to explicitly set the expand flag on this widget.

See widgetGetHexpandSet for more detail.

getVisible

widgetGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget is visible

Determines whether the widget is visible.

If you want to take into account whether the widget’s parent is also marked as visible, use widgetIsVisible instead.

This function does not check if the widget is obscured in any way.

See widgetSetVisible.

getWidth

widgetGetWidth

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Int32

Returns: The width of widget

Returns the content width of the widget.

This function returns the width passed to its size-allocate implementation, which is the width you should be using in Widget.snapshot().

For pointer events, see widgetContains.

grabFocus

widgetGrabFocus

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if focus is now inside widget.

Causes widget to have the keyboard focus for the GtkWindow it's inside.

If widget is not focusable, or its Widget.grab_focus() implementation cannot transfer the focus to a descendant of widget that is focusable, it will not take focus and False will be returned.

Calling widgetGrabFocus on an already focused widget is allowed, should not have an effect, and return True.

hasCssClass

widgetHasCssClass

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Text

cssClass: A style class, without the leading '.' used for notation of style classes

-> m Bool

Returns: True if cssClass is currently applied to widget, False otherwise.

Returns whether cssClass is currently applied to widget.

hasDefault

widgetHasDefault

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if widget is the current default widget within its toplevel, False otherwise

Determines whether widget is the current default widget within its toplevel.

hasFocus

widgetHasFocus

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget has the global input focus.

Determines if the widget has the global input focus.

See widgetIsFocus for the difference between having the global input focus, and only having the focus within a toplevel.

hasVisibleFocus

widgetHasVisibleFocus

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget should display a “focus rectangle”

Determines if the widget should show a visible indication that it has the global input focus.

This is a convenience function that takes into account whether focus indication should currently be shown in the toplevel window of widget. See windowGetFocusVisible for more information about focus indication.

To find out if the widget has the global input focus, use widgetHasFocus.

hide

widgetHide

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Reverses the effects of widgetShow.

This is causing the widget to be hidden (invisible to the user).

inDestruction

widgetInDestruction

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if widget is being destroyed

Returns whether the widget is currently being destroyed.

This information can sometimes be used to avoid doing unnecessary work.

initTemplate

widgetInitTemplate

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Creates and initializes child widgets defined in templates.

This function must be called in the instance initializer for any class which assigned itself a template using widgetClassSetTemplate.

It is important to call this function in the instance initializer of a GtkWidget subclass and not in GObject.constructed() or GObject.constructor() for two reasons:

• derived widgets will assume that the composite widgets defined by its parent classes have been created in their relative instance initializers
• when calling g_object_new() on a widget with composite templates, it’s important to build the composite widgets before the construct properties are set. Properties passed to g_object_new() should take precedence over properties set in the private template XML

A good rule of thumb is to call this function as the first thing in an instance initialization function.

insertActionGroup

widgetInsertActionGroup

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsActionGroup b)

=> a

widget: a GtkWidget

-> Text

name: the prefix for actions in group

-> Maybe b

group: a GActionGroup, or Nothing to remove the previously inserted group for name

-> m ()

Inserts group into widget.

Children of widget that implement Actionable can then be associated with actions in group by setting their “action-name” to prefix.action-name.

Note that inheritance is defined for individual actions. I.e. even if you insert a group with prefix prefix, actions with the same prefix will still be inherited from the parent, unless the group contains an action with the same name.

If group is Nothing, a previously inserted group for name is removed from widget.

insertAfter

widgetInsertAfter

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b, IsWidget c)

=> a

widget: a GtkWidget

-> b

parent: the parent GtkWidget to insert widget into

-> Maybe c

previousSibling: the new previous sibling of widget

-> m ()

Inserts widget into the child widget list of parent.

It will be placed after previousSibling, or at the beginning if previousSibling is Nothing.

After calling this function, gtk_widget_get_prev_sibling(widget) will return previousSibling.

If parent is already set as the parent widget of widget, this function can also be used to reorder widget in the child widget list of parent.

This API is primarily meant for widget implementations; if you are just using a widget, you *must* use its own API for adding children.

insertBefore

widgetInsertBefore

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b, IsWidget c)

=> a

widget: a GtkWidget

-> b

parent: the parent GtkWidget to insert widget into

-> Maybe c

nextSibling: the new next sibling of widget

-> m ()

Inserts widget into the child widget list of parent.

It will be placed before nextSibling, or at the end if nextSibling is Nothing.

After calling this function, gtk_widget_get_next_sibling(widget) will return nextSibling.

If parent is already set as the parent widget of widget, this function can also be used to reorder widget in the child widget list of parent.

This API is primarily meant for widget implementations; if you are just using a widget, you *must* use its own API for adding children.

isAncestor

widgetIsAncestor

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: a GtkWidget

-> b

ancestor: another GtkWidget

-> m Bool

Returns: True if ancestor contains widget as a child, grandchild, great grandchild, etc.

Determines whether widget is somewhere inside ancestor, possibly with intermediate containers.

isDrawable

widgetIsDrawable

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if widget is drawable, False otherwise

Determines whether widget can be drawn to.

A widget can be drawn if it is mapped and visible.

isFocus

widgetIsFocus

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget is the focus widget.

Determines if the widget is the focus widget within its toplevel.

This does not mean that the Widget:hasFocus property is necessarily set; Widget:hasFocus will only be set if the toplevel widget additionally has the global input focus.

isSensitive

widgetIsSensitive

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget is effectively sensitive

Returns the widget’s effective sensitivity.

This means it is sensitive itself and also its parent widget is sensitive.

isVisible

widgetIsVisible

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m Bool

Returns: True if the widget and all its parents are visible

Determines whether the widget and all its parents are marked as visible.

This function does not check if the widget is obscured in any way.

See also widgetGetVisible and widgetSetVisible.

keynavFailed

widgetKeynavFailed

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> DirectionType

direction: direction of focus movement

-> m Bool

Returns: True if stopping keyboard navigation is fine, False if the emitting widget should try to handle the keyboard navigation attempt in its parent container(s).

Emits the ::keynav-failed signal on the widget.

This function should be called whenever keyboard navigation within a single widget hits a boundary.

The return value of this function should be interpreted in a way similar to the return value of widgetChildFocus. When True is returned, stay in the widget, the failed keyboard navigation is OK and/or there is nowhere we can/should move the focus to. When False is returned, the caller should continue with keyboard navigation outside the widget, e.g. by calling widgetChildFocus on the widget’s toplevel.

The default Widget::keynavFailed handler returns False for DirectionTypeTabForward and DirectionTypeTabBackward. For the other values of GtkDirectionType it returns True.

Whenever the default handler returns True, it also calls widgetErrorBell to notify the user of the failed keyboard navigation.

A use case for providing an own implementation of keynavFailed (either by connecting to it or by overriding it) would be a row of Entry widgets where the user should be able to navigate the entire row with the cursor keys, as e.g. known from user interfaces that require entering license keys.

listMnemonicLabels

widgetListMnemonicLabels

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m [Widget]

Returns: the list of mnemonic labels; free this list with g_list_free() when you are done with it.

Returns the widgets for which this widget is the target of a mnemonic.

Typically, these widgets will be labels. See, for example, labelSetMnemonicWidget.

The widgets in the list are not individually referenced. If you want to iterate through the list and perform actions involving callbacks that might destroy the widgets, you must call g_list_foreach (result, (GFunc)g_object_ref, NULL) first, and then unref all the widgets afterwards.

map

widgetMap

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Causes a widget to be mapped if it isn’t already.

This function is only for use in widget implementations.

measure

widgetMeasure

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: A GtkWidget instance

-> Orientation

orientation: the orientation to measure

-> Int32

forSize: Size for the opposite of orientation, i.e. if orientation is OrientationHorizontal, this is the height the widget should be measured with. The OrientationVertical case is analogous. This way, both height-for-width and width-for-height requests can be implemented. If no size is known, -1 can be passed.

-> m (Int32, Int32, Int32, Int32)

Measures widget in the orientation orientation and for the given forSize.

As an example, if orientation is OrientationHorizontal and forSize is 300, this functions will compute the minimum and natural width of widget if it is allocated at a height of 300 pixels.

See GtkWidget’s geometry management section for a more details on implementing GtkWidgetClass.measure().

mnemonicActivate

widgetMnemonicActivate

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

groupCycling: True if there are other widgets with the same mnemonic

-> m Bool

Returns: True if the signal has been handled

Emits the mnemonicActivate signal.

See Widget::mnemonicActivate.

observeChildren

widgetObserveChildren

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ListModel

Returns: a GListModel tracking widget's children

Returns a GListModel to track the children of widget.

Calling this function will enable extra internal bookkeeping to track children and emit signals on the returned listmodel. It may slow down operations a lot.

Applications should try hard to avoid calling this function because of the slowdowns.

observeControllers

widgetObserveControllers

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ListModel

Returns: a GListModel tracking widget's controllers

Returns a GListModel to track the EventControllers of widget.

Calling this function will enable extra internal bookkeeping to track controllers and emit signals on the returned listmodel. It may slow down operations a lot.

Applications should try hard to avoid calling this function because of the slowdowns.

pick

widgetPick

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget to query

-> Double

x: X coordinate to test, relative to widget's origin

-> Double

y: Y coordinate to test, relative to widget's origin

-> [PickFlags]

flags: Flags to influence what is picked

-> m (Maybe Widget)

Returns: The widget descendant at the given point

Finds the descendant of widget closest to the point (x, y).

The point must be given in widget coordinates, so (0, 0) is assumed to be the top left of widget's content area.

Usually widgets will return Nothing if the given coordinate is not contained in widget checked via widgetContains. Otherwise they will recursively try to find a child that does not return Nothing. Widgets are however free to customize their picking algorithm.

This function is used on the toplevel to determine the widget below the mouse cursor for purposes of hover highlighting and delivering events.

queueAllocate

widgetQueueAllocate

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Flags the widget for a rerun of the Widget.size_allocate() function.

Use this function instead of widgetQueueResize when the widget's size request didn't change but it wants to reposition its contents.

An example user of this function is widgetSetHalign.

This function is only for use in widget implementations.

queueDraw

widgetQueueDraw

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Schedules this widget to be redrawn in the paint phase of the current or the next frame.

This means widget's Widget.snapshot() implementation will be called.

queueResize

widgetQueueResize

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Flags a widget to have its size renegotiated.

This should be called when a widget for some reason has a new size request. For example, when you change the text in a Label, the label queues a resize to ensure there’s enough space for the new text.

Note that you cannot call widgetQueueResize on a widget from inside its implementation of the Widget.size_allocate() virtual method. Calls to widgetQueueResize from inside Widget.size_allocate() will be silently ignored.

This function is only for use in widget implementations.

realize

widgetRealize

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Creates the GDK resources associated with a widget.

Normally realization happens implicitly; if you show a widget and all its parent containers, then the widget will be realized and mapped automatically.

Realizing a widget requires all the widget’s parent widgets to be realized; calling this function realizes the widget’s parents in addition to widget itself. If a widget is not yet inside a toplevel window when you realize it, bad things will happen.

This function is primarily used in widget implementations, and isn’t very useful otherwise. Many times when you think you might need it, a better approach is to connect to a signal that will be called after the widget is realized automatically, such as Widget::realize.

removeController

widgetRemoveController

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsEventController b)

=> a

widget: a GtkWidget

-> b

controller: a GtkEventController

-> m ()

Removes controller from widget, so that it doesn't process events anymore.

It should not be used again.

Widgets will remove all event controllers automatically when they are destroyed, there is normally no need to call this function.

removeCssClass

widgetRemoveCssClass

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Text

cssClass: The style class to remove from widget, without the leading '.' used for notation of style classes

-> m ()

Removes a style from widget.

After this, the style of widget will stop matching for cssClass.

removeMnemonicLabel

widgetRemoveMnemonicLabel

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: a GtkWidget

-> b

label: a GtkWidget that was previously set as a mnemonic label for widget with widgetAddMnemonicLabel

-> m ()

Removes a widget from the list of mnemonic labels for this widget.

See widgetListMnemonicLabels. The widget must have previously been added to the list with widgetAddMnemonicLabel.

removeTickCallback

widgetRemoveTickCallback

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Word32

id: an id returned by widgetAddTickCallback

-> m ()

Removes a tick callback previously registered with widgetAddTickCallback.

setCanFocus

widgetSetCanFocus

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

canFocus: whether or not the input focus can enter the widget or any of its children

-> m ()

Specifies whether the input focus can enter the widget or any of its children.

Applications should set canFocus to False to mark a widget as for pointer/touch use only.

Note that having canFocus be True is only one of the necessary conditions for being focusable. A widget must also be sensitive and focusable and not have an ancestor that is marked as not can-focus in order to receive input focus.

See widgetGrabFocus for actually setting the input focus on a widget.

setCanTarget

widgetSetCanTarget

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

canTarget: whether this widget should be able to receive pointer events

-> m ()

Sets whether widget can be the target of pointer events.

setChildVisible

widgetSetChildVisible

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

childVisible: if True, widget should be mapped along with its parent.

-> m ()

Sets whether widget should be mapped along with its parent.

The child visibility can be set for widget before it is added to a container with widgetSetParent, to avoid mapping children unnecessary before immediately unmapping them. However it will be reset to its default state of True when the widget is removed from a container.

Note that changing the child visibility of a widget does not queue a resize on the widget. Most of the time, the size of a widget is computed from all visible children, whether or not they are mapped. If this is not the case, the container can queue a resize itself.

This function is only useful for container implementations and should never be called by an application.

setCssClasses

widgetSetCssClasses

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> [Text]

classes: Nothing-terminated list of style classes to apply to widget.

-> m ()

Clear all style classes applied to widget and replace them with classes.

setCursor

widgetSetCursor

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsCursor b)

=> a

widget: a GtkWidget

-> Maybe b

cursor: the new cursor

-> m ()

Sets the cursor to be shown when pointer devices point towards widget.

If the cursor is NULL, widget will use the cursor inherited from the parent widget.

setCursorFromName

widgetSetCursorFromName

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Maybe Text

name: The name of the cursor

-> m ()

Sets a named cursor to be shown when pointer devices point towards widget.

This is a utility function that creates a cursor via cursorNewFromName and then sets it on widget with widgetSetCursor. See those functions for details.

On top of that, this function allows name to be Nothing, which will do the same as calling widgetSetCursor with a Nothing cursor.

setDefaultDirection

widgetSetDefaultDirection

Arguments

:: (HasCallStack, MonadIO m)

=> TextDirection

dir: the new default direction. This cannot be TextDirectionNone.

-> m ()

Sets the default reading direction for widgets.

See widgetSetDirection.

setDirection

widgetSetDirection

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> TextDirection

dir: the new direction

-> m ()

Sets the reading direction on a particular widget.

This direction controls the primary direction for widgets containing text, and also the direction in which the children of a container are packed. The ability to set the direction is present in order so that correct localization into languages with right-to-left reading directions can be done. Generally, applications will let the default reading direction present, except for containers where the containers are arranged in an order that is explicitly visual rather than logical (such as buttons for text justification).

If the direction is set to TextDirectionNone, then the value set by [funcgtk.Widget.set_default_direction] will be used.

setFocusChild

widgetSetFocusChild

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: a GtkWidget

-> Maybe b

child: a direct child widget of widget or Nothing to unset the focus child of widget

-> m ()

Set child as the current focus child of widget.

This function is only suitable for widget implementations. If you want a certain widget to get the input focus, call widgetGrabFocus on it.

setFocusOnClick

widgetSetFocusOnClick

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

focusOnClick: whether the widget should grab focus when clicked with the mouse

-> m ()

Sets whether the widget should grab focus when it is clicked with the mouse.

Making mouse clicks not grab focus is useful in places like toolbars where you don’t want the keyboard focus removed from the main area of the application.

setFocusable

widgetSetFocusable

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

focusable: whether or not widget can own the input focus

-> m ()

Specifies whether widget can own the input focus.

Widget implementations should set focusable to True in their init() function if they want to receive keyboard input.

Note that having focusable be True is only one of the necessary conditions for being focusable. A widget must also be sensitive and can-focus and not have an ancestor that is marked as not can-focus in order to receive input focus.

See widgetGrabFocus for actually setting the input focus on a widget.

setFontMap

widgetSetFontMap

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsFontMap b)

=> a

widget: a GtkWidget

-> Maybe b

fontMap: a PangoFontMap, or Nothing to unset any previously set font map

-> m ()

Sets the font map to use for Pango rendering.

The font map is the object that is used to look up fonts. Setting a custom font map can be useful in special situations, e.g. when you need to add application-specific fonts to the set of available fonts.

When not set, the widget will inherit the font map from its parent.

setFontOptions

widgetSetFontOptions

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Maybe FontOptions

options: a cairo_font_options_t to unset any previously set default font options

-> m ()

Sets the cairo_font_options_t used for Pango rendering in this widget.

When not set, the default font options for the GdkDisplay will be used.

setHalign

widgetSetHalign

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Align

align: the horizontal alignment

-> m ()

Sets the horizontal alignment of widget.

setHasTooltip

widgetSetHasTooltip

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

hasTooltip: whether or not widget has a tooltip.

-> m ()

Sets the has-tooltip property on widget to hasTooltip.

setHexpand

widgetSetHexpand

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> Bool

expand: whether to expand

-> m ()

Sets whether the widget would like any available extra horizontal space.

When a user resizes a GtkWindow, widgets with expand=TRUE generally receive the extra space. For example, a list or scrollable area or document in your window would often be set to expand.

Call this function to set the expand flag if you would like your widget to become larger horizontally when the window has extra room.

By default, widgets automatically expand if any of their children want to expand. (To see if a widget will automatically expand given its current children and state, call widgetComputeExpand. A container can decide how the expandability of children affects the expansion of the container by overriding the compute_expand virtual method on GtkWidget.).

Setting hexpand explicitly with this function will override the automatic expand behavior.

This function forces the widget to expand or not to expand, regardless of children. The override occurs because widgetSetHexpand sets the hexpand-set property (see widgetSetHexpandSet) which causes the widget’s hexpand value to be used, rather than looking at children and widget state.

setHexpandSet

widgetSetHexpandSet

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> Bool

set: value for hexpand-set property

-> m ()

Sets whether the hexpand flag will be used.

The Widget:hexpandSet property will be set automatically when you call widgetSetHexpand to set hexpand, so the most likely reason to use this function would be to unset an explicit expand flag.

If hexpand is set, then it overrides any computed expand value based on child widgets. If hexpand is not set, then the expand value depends on whether any children of the widget would like to expand.

There are few reasons to use this function, but it’s here for completeness and consistency.

setLayoutManager

widgetSetLayoutManager

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsLayoutManager b)

=> a

widget: a GtkWidget

-> Maybe b

layoutManager: a GtkLayoutManager

-> m ()

Sets the layout manager delegate instance that provides an implementation for measuring and allocating the children of widget.

setMarginBottom

widgetSetMarginBottom

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Int32

margin: the bottom margin

-> m ()

Sets the bottom margin of widget.

setMarginEnd

widgetSetMarginEnd

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Int32

margin: the end margin

-> m ()

Sets the end margin of widget.

setMarginStart

widgetSetMarginStart

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Int32

margin: the start margin

-> m ()

Sets the start margin of widget.

setMarginTop

widgetSetMarginTop

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Int32

margin: the top margin

-> m ()

Sets the top margin of widget.

setName

widgetSetName

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Text

name: name for the widget

-> m ()

Sets a widgets name.

Setting a name allows you to refer to the widget from a CSS file. You can apply a style to widgets with a particular name in the CSS file. See the documentation for the CSS syntax (on the same page as the docs for StyleContext.

Note that the CSS syntax has certain special characters to delimit and represent elements in a selector (period, #, >, *...), so using these will make your widget impossible to match by name. Any combination of alphanumeric symbols, dashes and underscores will suffice.

setOpacity

widgetSetOpacity

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Double

opacity: desired opacity, between 0 and 1

-> m ()

Request the widget to be rendered partially transparent.

An opacity of 0 is fully transparent and an opacity of 1 is fully opaque.

Opacity works on both toplevel widgets and child widgets, although there are some limitations: For toplevel widgets, applying opacity depends on the capabilities of the windowing system. On X11, this has any effect only on X displays with a compositing manager, see displayIsComposited. On Windows and Wayland it should always work, although setting a window’s opacity after the window has been shown may cause some flicker.

Note that the opacity is inherited through inclusion — if you set a toplevel to be partially translucent, all of its content will appear translucent, since it is ultimatively rendered on that toplevel. The opacity value itself is not inherited by child widgets (since that would make widgets deeper in the hierarchy progressively more translucent). As a consequence, Popovers and other Native widgets with their own surface will use their own opacity value, and thus by default appear non-translucent, even if they are attached to a toplevel that is translucent.

setOverflow

widgetSetOverflow

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Overflow

overflow: desired overflow

-> m ()

Sets how widget treats content that is drawn outside the widget's content area.

See the definition of Overflow for details.

This setting is provided for widget implementations and should not be used by application code.

The default value is OverflowVisible.

setParent

widgetSetParent

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

widget: a GtkWidget

-> b

parent: parent widget

-> m ()

Sets parent as the parent widget of widget.

This takes care of details such as updating the state and style of the child to reflect its new location and resizing the parent. The opposite function is widgetUnparent.

This function is useful only when implementing subclasses of GtkWidget.

setReceivesDefault

widgetSetReceivesDefault

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

receivesDefault: whether or not widget can be a default widget.

-> m ()

Specifies whether widget will be treated as the default widget within its toplevel when it has the focus, even if another widget is the default.

setSensitive

widgetSetSensitive

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

sensitive: True to make the widget sensitive

-> m ()

Sets the sensitivity of a widget.

A widget is sensitive if the user can interact with it. Insensitive widgets are “grayed out” and the user can’t interact with them. Insensitive widgets are known as “inactive”, “disabled”, or “ghosted” in some other toolkits.

setSizeRequest

widgetSetSizeRequest

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Int32

width: width widget should request, or -1 to unset

-> Int32

height: height widget should request, or -1 to unset

-> m ()

Sets the minimum size of a widget.

That is, the widget’s size request will be at least width by height. You can use this function to force a widget to be larger than it normally would be.

In most cases, windowSetDefaultSize is a better choice for toplevel windows than this function; setting the default size will still allow users to shrink the window. Setting the size request will force them to leave the window at least as large as the size request.

Note the inherent danger of setting any fixed size - themes, translations into other languages, different fonts, and user action can all change the appropriate size for a given widget. So, it's basically impossible to hardcode a size that will always be correct.

The size request of a widget is the smallest size a widget can accept while still functioning well and drawing itself correctly. However in some strange cases a widget may be allocated less than its requested size, and in many cases a widget may be allocated more space than it requested.

If the size request in a given direction is -1 (unset), then the “natural” size request of the widget will be used instead.

The size request set here does not include any margin from the properties Widget:marginStart, Widget:marginEnd, Widget:marginTop, and Widget:marginBottom, but it does include pretty much all other padding or border properties set by any subclass of GtkWidget.

setStateFlags

widgetSetStateFlags

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> [StateFlags]

flags: State flags to turn on

-> Bool

clear: Whether to clear state before turning on flags

-> m ()

Turns on flag values in the current widget state.

Typical widget states are insensitive, prelighted, etc.

This function accepts the values StateFlagsDirLtr and StateFlagsDirRtl but ignores them. If you want to set the widget's direction, use widgetSetDirection.

This function is for use in widget implementations.

setTooltipMarkup

widgetSetTooltipMarkup

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Maybe Text

markup: the contents of the tooltip for widget

-> m ()

Sets markup as the contents of the tooltip, which is marked up with Pango markup.

This function will take care of setting the Widget:hasTooltip as a side effect, and of the default handler for the Widget::queryTooltip signal.

See also tooltipSetMarkup.

setTooltipText

widgetSetTooltipText

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Maybe Text

text: the contents of the tooltip for widget

-> m ()

Sets text as the contents of the tooltip.

If text contains any markup, it will be escaped.

This function will take care of setting Widget:hasTooltip as a side effect, and of the default handler for the Widget::queryTooltip signal.

See also tooltipSetText.

setValign

widgetSetValign

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Align

align: the vertical alignment

-> m ()

Sets the vertical alignment of widget.

setVexpand

widgetSetVexpand

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> Bool

expand: whether to expand

-> m ()

Sets whether the widget would like any available extra vertical space.

See widgetSetHexpand for more detail.

setVexpandSet

widgetSetVexpandSet

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: the widget

-> Bool

set: value for vexpand-set property

-> m ()

Sets whether the vexpand flag will be used.

See widgetSetHexpandSet for more detail.

setVisible

widgetSetVisible

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Bool

visible: whether the widget should be shown or not

-> m ()

Sets the visibility state of widget.

Note that setting this to True doesn’t mean the widget is actually viewable, see widgetGetVisible.

This function simply calls widgetShow or widgetHide but is nicer to use when the visibility of the widget depends on some condition.

shouldLayout

widgetShouldLayout

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a widget

-> m Bool

Returns: True if child should be included in measuring and allocating

Returns whether widget should contribute to the measuring and allocation of its parent.

This is False for invisible children, but also for children that have their own surface.

show

widgetShow

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Flags a widget to be displayed.

Any widget that isn’t shown will not appear on the screen.

Remember that you have to show the containers containing a widget, in addition to the widget itself, before it will appear onscreen.

When a toplevel container is shown, it is immediately realized and mapped; other shown widgets are realized and mapped when their toplevel container is realized and mapped.

sizeAllocate

widgetSizeAllocate

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> Rectangle

allocation: position and size to be allocated to widget

-> Int32

baseline: The baseline of the child, or -1

-> m ()

Allocates widget with a transformation that translates the origin to the position in allocation.

This is a simple form of widgetAllocate.

snapshotChild

widgetSnapshotChild

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b, IsSnapshot c)

=> a

widget: a GtkWidget

-> b

child: a child of widget

-> c

snapshot: GtkSnapshot as passed to the widget. In particular, no calls to snapshotTranslate or other transform calls should have been made.

-> m ()

Snapshot the a child of widget.

When a widget receives a call to the snapshot function, it must send synthetic Widget.snapshot() calls to all children. This function provides a convenient way of doing this. A widget, when it receives a call to its Widget.snapshot() function, calls widgetSnapshotChild once for each child, passing in the snapshot the widget received.

widgetSnapshotChild takes care of translating the origin of snapshot, and deciding whether the child needs to be snapshot.

This function does nothing for children that implement GtkNative.

translateCoordinates

widgetTranslateCoordinates

Arguments

:: (HasCallStack, MonadIO m, IsWidget a, IsWidget b)

=> a

srcWidget: a GtkWidget

-> b

destWidget: a GtkWidget

-> Double

srcX: X position relative to srcWidget

-> Double

srcY: Y position relative to srcWidget

-> m (Bool, Double, Double)

Returns: False if srcWidget and destWidget have no common ancestor. In this case, 0 is stored in *destX and *destY. Otherwise True.

Translate coordinates relative to srcWidget’s allocation to coordinates relative to destWidget’s allocations.

In order to perform this operation, both widget must share a common ancestor.

triggerTooltipQuery

widgetTriggerTooltipQuery

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Triggers a tooltip query on the display where the toplevel of widget is located.

unmap

widgetUnmap

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Causes a widget to be unmapped if it’s currently mapped.

This function is only for use in widget implementations.

unparent

widgetUnparent

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Dissociate widget from its parent.

This function is only for use in widget implementations, typically in dispose.

unrealize

widgetUnrealize

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> m ()

Causes a widget to be unrealized (frees all GDK resources associated with the widget).

This function is only useful in widget implementations.

unsetStateFlags

widgetUnsetStateFlags

Arguments

:: (HasCallStack, MonadIO m, IsWidget a)

=> a

widget: a GtkWidget

-> [StateFlags]

flags: State flags to turn off

-> m ()

Turns off flag values for the current widget state.

See widgetSetStateFlags.

This function is for use in widget implementations.

Properties

canFocus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

constructWidgetCanFocus :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “can-focus” property. This is rarely needed directly, but it is used by new.

getWidgetCanFocus :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “can-focus” property. When overloading is enabled, this is equivalent to

get widget #canFocus

setWidgetCanFocus :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “can-focus” property. When overloading is enabled, this is equivalent to

set widget [ #canFocus := value ]

canTarget

Whether the widget can receive pointer events.

constructWidgetCanTarget :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “can-target” property. This is rarely needed directly, but it is used by new.

getWidgetCanTarget :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “can-target” property. When overloading is enabled, this is equivalent to

get widget #canTarget

setWidgetCanTarget :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “can-target” property. When overloading is enabled, this is equivalent to

set widget [ #canTarget := value ]

cssClasses

A list of css classes applied to this widget.

constructWidgetCssClasses :: (IsWidget o, MonadIO m) => [Text] -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “css-classes” property. This is rarely needed directly, but it is used by new.

getWidgetCssClasses :: (MonadIO m, IsWidget o) => o -> m (Maybe [Text])

Get the value of the “css-classes” property. When overloading is enabled, this is equivalent to

get widget #cssClasses

setWidgetCssClasses :: (MonadIO m, IsWidget o) => o -> [Text] -> m ()

Set the value of the “css-classes” property. When overloading is enabled, this is equivalent to

set widget [ #cssClasses := value ]

cssName

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

constructWidgetCssName :: (IsWidget o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “css-name” property. This is rarely needed directly, but it is used by new.

getWidgetCssName :: (MonadIO m, IsWidget o) => o -> m Text

Get the value of the “css-name” property. When overloading is enabled, this is equivalent to

get widget #cssName

cursor

The cursor used by widget.

clearWidgetCursor :: (MonadIO m, IsWidget o) => o -> m ()

Set the value of the “cursor” property to Nothing. When overloading is enabled, this is equivalent to

clear #cursor

constructWidgetCursor :: (IsWidget o, MonadIO m, IsCursor a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “cursor” property. This is rarely needed directly, but it is used by new.

getWidgetCursor :: (MonadIO m, IsWidget o) => o -> m (Maybe Cursor)

Get the value of the “cursor” property. When overloading is enabled, this is equivalent to

get widget #cursor

setWidgetCursor :: (MonadIO m, IsWidget o, IsCursor a) => o -> a -> m ()

Set the value of the “cursor” property. When overloading is enabled, this is equivalent to

set widget [ #cursor := value ]

focusOnClick

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

constructWidgetFocusOnClick :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “focus-on-click” property. This is rarely needed directly, but it is used by new.

getWidgetFocusOnClick :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “focus-on-click” property. When overloading is enabled, this is equivalent to

get widget #focusOnClick

setWidgetFocusOnClick :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “focus-on-click” property. When overloading is enabled, this is equivalent to

set widget [ #focusOnClick := value ]

focusable

Whether this widget itself will accept the input focus.

constructWidgetFocusable :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “focusable” property. This is rarely needed directly, but it is used by new.

getWidgetFocusable :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “focusable” property. When overloading is enabled, this is equivalent to

get widget #focusable

setWidgetFocusable :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “focusable” property. When overloading is enabled, this is equivalent to

set widget [ #focusable := value ]

halign

How to distribute horizontal space if widget gets extra space.

constructWidgetHalign :: (IsWidget o, MonadIO m) => Align -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “halign” property. This is rarely needed directly, but it is used by new.

getWidgetHalign :: (MonadIO m, IsWidget o) => o -> m Align

Get the value of the “halign” property. When overloading is enabled, this is equivalent to

get widget #halign

setWidgetHalign :: (MonadIO m, IsWidget o) => o -> Align -> m ()

Set the value of the “halign” property. When overloading is enabled, this is equivalent to

set widget [ #halign := value ]

hasDefault

Whether the widget is the default widget.

getWidgetHasDefault :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “has-default” property. When overloading is enabled, this is equivalent to

get widget #hasDefault

hasFocus

Whether the widget has the input focus.

getWidgetHasFocus :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “has-focus” property. When overloading is enabled, this is equivalent to

get widget #hasFocus

hasTooltip

Enables or disables the emission of the queryTooltip signal on widget.

A value of True indicates that widget can have a tooltip, in this case the widget will be queried using Widget::queryTooltip to determine whether it will provide a tooltip or not.

constructWidgetHasTooltip :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “has-tooltip” property. This is rarely needed directly, but it is used by new.

getWidgetHasTooltip :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “has-tooltip” property. When overloading is enabled, this is equivalent to

get widget #hasTooltip

setWidgetHasTooltip :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “has-tooltip” property. When overloading is enabled, this is equivalent to

set widget [ #hasTooltip := value ]

heightRequest

Override for height request of the widget.

If this is -1, the natural request will be used.

constructWidgetHeightRequest :: (IsWidget o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “height-request” property. This is rarely needed directly, but it is used by new.

getWidgetHeightRequest :: (MonadIO m, IsWidget o) => o -> m Int32

Get the value of the “height-request” property. When overloading is enabled, this is equivalent to

get widget #heightRequest

setWidgetHeightRequest :: (MonadIO m, IsWidget o) => o -> Int32 -> m ()

Set the value of the “height-request” property. When overloading is enabled, this is equivalent to

set widget [ #heightRequest := value ]

hexpand

Whether to expand horizontally.

constructWidgetHexpand :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “hexpand” property. This is rarely needed directly, but it is used by new.

getWidgetHexpand :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “hexpand” property. When overloading is enabled, this is equivalent to

get widget #hexpand

setWidgetHexpand :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “hexpand” property. When overloading is enabled, this is equivalent to

set widget [ #hexpand := value ]

hexpandSet

Whether to use the hexpand property.

constructWidgetHexpandSet :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “hexpand-set” property. This is rarely needed directly, but it is used by new.

getWidgetHexpandSet :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “hexpand-set” property. When overloading is enabled, this is equivalent to

get widget #hexpandSet

setWidgetHexpandSet :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “hexpand-set” property. When overloading is enabled, this is equivalent to

set widget [ #hexpandSet := value ]

layoutManager

The GtkLayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

clearWidgetLayoutManager :: (MonadIO m, IsWidget o) => o -> m ()

Set the value of the “layout-manager” property to Nothing. When overloading is enabled, this is equivalent to

clear #layoutManager

constructWidgetLayoutManager :: (IsWidget o, MonadIO m, IsLayoutManager a) => a -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “layout-manager” property. This is rarely needed directly, but it is used by new.

getWidgetLayoutManager :: (MonadIO m, IsWidget o) => o -> m (Maybe LayoutManager)

Get the value of the “layout-manager” property. When overloading is enabled, this is equivalent to

get widget #layoutManager

setWidgetLayoutManager :: (MonadIO m, IsWidget o, IsLayoutManager a) => o -> a -> m ()

Set the value of the “layout-manager” property. When overloading is enabled, this is equivalent to

set widget [ #layoutManager := value ]

marginBottom

Margin on bottom side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from widgetSetSizeRequest for example.

constructWidgetMarginBottom :: (IsWidget o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “margin-bottom” property. This is rarely needed directly, but it is used by new.

getWidgetMarginBottom :: (MonadIO m, IsWidget o) => o -> m Int32

Get the value of the “margin-bottom” property. When overloading is enabled, this is equivalent to

get widget #marginBottom

setWidgetMarginBottom :: (MonadIO m, IsWidget o) => o -> Int32 -> m ()

Set the value of the “margin-bottom” property. When overloading is enabled, this is equivalent to

set widget [ #marginBottom := value ]

marginEnd

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from widgetSetSizeRequest for example.

constructWidgetMarginEnd :: (IsWidget o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “margin-end” property. This is rarely needed directly, but it is used by new.

getWidgetMarginEnd :: (MonadIO m, IsWidget o) => o -> m Int32

Get the value of the “margin-end” property. When overloading is enabled, this is equivalent to

get widget #marginEnd

setWidgetMarginEnd :: (MonadIO m, IsWidget o) => o -> Int32 -> m ()

Set the value of the “margin-end” property. When overloading is enabled, this is equivalent to

set widget [ #marginEnd := value ]

marginStart

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from widgetSetSizeRequest for example.

constructWidgetMarginStart :: (IsWidget o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “margin-start” property. This is rarely needed directly, but it is used by new.

getWidgetMarginStart :: (MonadIO m, IsWidget o) => o -> m Int32

Get the value of the “margin-start” property. When overloading is enabled, this is equivalent to

get widget #marginStart

setWidgetMarginStart :: (MonadIO m, IsWidget o) => o -> Int32 -> m ()

Set the value of the “margin-start” property. When overloading is enabled, this is equivalent to

set widget [ #marginStart := value ]

marginTop

Margin on top side of widget.

This property adds margin outside of the widget's normal size request, the margin will be added in addition to the size from widgetSetSizeRequest for example.

constructWidgetMarginTop :: (IsWidget o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “margin-top” property. This is rarely needed directly, but it is used by new.

getWidgetMarginTop :: (MonadIO m, IsWidget o) => o -> m Int32

Get the value of the “margin-top” property. When overloading is enabled, this is equivalent to

get widget #marginTop

setWidgetMarginTop :: (MonadIO m, IsWidget o) => o -> Int32 -> m ()

Set the value of the “margin-top” property. When overloading is enabled, this is equivalent to

set widget [ #marginTop := value ]

name

The name of the widget.

constructWidgetName :: (IsWidget o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “name” property. This is rarely needed directly, but it is used by new.

getWidgetName :: (MonadIO m, IsWidget o) => o -> m Text

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get widget #name

setWidgetName :: (MonadIO m, IsWidget o) => o -> Text -> m ()

Set the value of the “name” property. When overloading is enabled, this is equivalent to

set widget [ #name := value ]

opacity

The requested opacity of the widget.

constructWidgetOpacity :: (IsWidget o, MonadIO m) => Double -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “opacity” property. This is rarely needed directly, but it is used by new.

getWidgetOpacity :: (MonadIO m, IsWidget o) => o -> m Double

Get the value of the “opacity” property. When overloading is enabled, this is equivalent to

get widget #opacity

setWidgetOpacity :: (MonadIO m, IsWidget o) => o -> Double -> m ()

Set the value of the “opacity” property. When overloading is enabled, this is equivalent to

set widget [ #opacity := value ]

overflow

How content outside the widget's content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

constructWidgetOverflow :: (IsWidget o, MonadIO m) => Overflow -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “overflow” property. This is rarely needed directly, but it is used by new.

getWidgetOverflow :: (MonadIO m, IsWidget o) => o -> m Overflow

Get the value of the “overflow” property. When overloading is enabled, this is equivalent to

get widget #overflow

setWidgetOverflow :: (MonadIO m, IsWidget o) => o -> Overflow -> m ()

Set the value of the “overflow” property. When overloading is enabled, this is equivalent to

set widget [ #overflow := value ]

parent

The parent widget of this widget.

getWidgetParent :: (MonadIO m, IsWidget o) => o -> m (Maybe Widget)

Get the value of the “parent” property. When overloading is enabled, this is equivalent to

get widget #parent

receivesDefault

Whether the widget will receive the default action when it is focused.

constructWidgetReceivesDefault :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “receives-default” property. This is rarely needed directly, but it is used by new.

getWidgetReceivesDefault :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “receives-default” property. When overloading is enabled, this is equivalent to

get widget #receivesDefault

setWidgetReceivesDefault :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “receives-default” property. When overloading is enabled, this is equivalent to

set widget [ #receivesDefault := value ]

root

The GtkRoot widget of the widget tree containing this widget.

This will be Nothing if the widget is not contained in a root widget.

getWidgetRoot :: (MonadIO m, IsWidget o) => o -> m (Maybe Root)

Get the value of the “root” property. When overloading is enabled, this is equivalent to

get widget #root

scaleFactor

The scale factor of the widget.

getWidgetScaleFactor :: (MonadIO m, IsWidget o) => o -> m Int32

Get the value of the “scale-factor” property. When overloading is enabled, this is equivalent to

get widget #scaleFactor

sensitive

Whether the widget responds to input.

constructWidgetSensitive :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “sensitive” property. This is rarely needed directly, but it is used by new.

getWidgetSensitive :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “sensitive” property. When overloading is enabled, this is equivalent to

get widget #sensitive

setWidgetSensitive :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “sensitive” property. When overloading is enabled, this is equivalent to

set widget [ #sensitive := value ]

tooltipMarkup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see tooltipSetMarkup.

This is a convenience property which will take care of getting the tooltip shown if the given string is not Nothing: Widget:hasTooltip will automatically be set to True and there will be taken care of Widget::queryTooltip in the default signal handler.

Note that if both Widget:tooltipText and Widget:tooltipMarkup are set, the last one wins.

clearWidgetTooltipMarkup :: (MonadIO m, IsWidget o) => o -> m ()

Set the value of the “tooltip-markup” property to Nothing. When overloading is enabled, this is equivalent to

clear #tooltipMarkup

constructWidgetTooltipMarkup :: (IsWidget o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “tooltip-markup” property. This is rarely needed directly, but it is used by new.

getWidgetTooltipMarkup :: (MonadIO m, IsWidget o) => o -> m (Maybe Text)

Get the value of the “tooltip-markup” property. When overloading is enabled, this is equivalent to

get widget #tooltipMarkup

setWidgetTooltipMarkup :: (MonadIO m, IsWidget o) => o -> Text -> m ()

Set the value of the “tooltip-markup” property. When overloading is enabled, this is equivalent to

set widget [ #tooltipMarkup := value ]

tooltipText

Sets the text of tooltip to be the given string.

Also see tooltipSetText.

This is a convenience property which will take care of getting the tooltip shown if the given string is not Nothing: Widget:hasTooltip will automatically be set to True and there will be taken care of Widget::queryTooltip in the default signal handler.

Note that if both Widget:tooltipText and Widget:tooltipMarkup are set, the last one wins.

clearWidgetTooltipText :: (MonadIO m, IsWidget o) => o -> m ()

Set the value of the “tooltip-text” property to Nothing. When overloading is enabled, this is equivalent to

clear #tooltipText

constructWidgetTooltipText :: (IsWidget o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “tooltip-text” property. This is rarely needed directly, but it is used by new.

getWidgetTooltipText :: (MonadIO m, IsWidget o) => o -> m (Maybe Text)

Get the value of the “tooltip-text” property. When overloading is enabled, this is equivalent to

get widget #tooltipText

setWidgetTooltipText :: (MonadIO m, IsWidget o) => o -> Text -> m ()

Set the value of the “tooltip-text” property. When overloading is enabled, this is equivalent to

set widget [ #tooltipText := value ]

valign

How to distribute vertical space if widget gets extra space.

constructWidgetValign :: (IsWidget o, MonadIO m) => Align -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “valign” property. This is rarely needed directly, but it is used by new.

getWidgetValign :: (MonadIO m, IsWidget o) => o -> m Align

Get the value of the “valign” property. When overloading is enabled, this is equivalent to

get widget #valign

setWidgetValign :: (MonadIO m, IsWidget o) => o -> Align -> m ()

Set the value of the “valign” property. When overloading is enabled, this is equivalent to

set widget [ #valign := value ]

vexpand

Whether to expand vertically.

constructWidgetVexpand :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “vexpand” property. This is rarely needed directly, but it is used by new.

getWidgetVexpand :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “vexpand” property. When overloading is enabled, this is equivalent to

get widget #vexpand

setWidgetVexpand :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “vexpand” property. When overloading is enabled, this is equivalent to

set widget [ #vexpand := value ]

vexpandSet

Whether to use the vexpand property.

constructWidgetVexpandSet :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “vexpand-set” property. This is rarely needed directly, but it is used by new.

getWidgetVexpandSet :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “vexpand-set” property. When overloading is enabled, this is equivalent to

get widget #vexpandSet

setWidgetVexpandSet :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “vexpand-set” property. When overloading is enabled, this is equivalent to

set widget [ #vexpandSet := value ]

visible

Whether the widget is visible.

constructWidgetVisible :: (IsWidget o, MonadIO m) => Bool -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “visible” property. This is rarely needed directly, but it is used by new.

getWidgetVisible :: (MonadIO m, IsWidget o) => o -> m Bool

Get the value of the “visible” property. When overloading is enabled, this is equivalent to

get widget #visible

setWidgetVisible :: (MonadIO m, IsWidget o) => o -> Bool -> m ()

Set the value of the “visible” property. When overloading is enabled, this is equivalent to

set widget [ #visible := value ]

widthRequest

Override for width request of the widget.

If this is -1, the natural request will be used.

constructWidgetWidthRequest :: (IsWidget o, MonadIO m) => Int32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “width-request” property. This is rarely needed directly, but it is used by new.

getWidgetWidthRequest :: (MonadIO m, IsWidget o) => o -> m Int32

Get the value of the “width-request” property. When overloading is enabled, this is equivalent to

get widget #widthRequest

setWidgetWidthRequest :: (MonadIO m, IsWidget o) => o -> Int32 -> m ()

Set the value of the “width-request” property. When overloading is enabled, this is equivalent to

set widget [ #widthRequest := value ]

Signals

destroy

type WidgetDestroyCallback = IO ()

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

afterWidgetDestroy :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetDestroyCallback) -> m SignalHandlerId

Connect a signal handler for the destroy signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #destroy callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetDestroy :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetDestroyCallback) -> m SignalHandlerId

Connect a signal handler for the destroy signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #destroy callback

directionChanged

type WidgetDirectionChangedCallback

Arguments

 = TextDirection

previousDirection: the previous text direction of widget

-> IO ()

Emitted when the text direction of a widget changes.

afterWidgetDirectionChanged :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetDirectionChangedCallback) -> m SignalHandlerId

Connect a signal handler for the directionChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #directionChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetDirectionChanged :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetDirectionChangedCallback) -> m SignalHandlerId

Connect a signal handler for the directionChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #directionChanged callback

hide

type WidgetHideCallback = IO ()

Emitted when widget is hidden.

afterWidgetHide :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetHideCallback) -> m SignalHandlerId

Connect a signal handler for the hide signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #hide callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetHide :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetHideCallback) -> m SignalHandlerId

Connect a signal handler for the hide signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #hide callback

keynavFailed

type WidgetKeynavFailedCallback

Arguments

 = DirectionType

direction: the direction of movement

-> IO Bool

Returns: True if stopping keyboard navigation is fine, False if the emitting widget should try to handle the keyboard navigation attempt in its parent widget(s).

Emitted if keyboard navigation fails.

See widgetKeynavFailed for details.

afterWidgetKeynavFailed :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetKeynavFailedCallback) -> m SignalHandlerId

Connect a signal handler for the keynavFailed signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #keynavFailed callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetKeynavFailed :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetKeynavFailedCallback) -> m SignalHandlerId

Connect a signal handler for the keynavFailed signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #keynavFailed callback

map

type WidgetMapCallback = IO ()

Emitted when widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with Widget:visible) and all its parents up to the toplevel widget are also visible.

The map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of Widget::unmap.

afterWidgetMap :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetMapCallback) -> m SignalHandlerId

Connect a signal handler for the map signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #map callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetMap :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetMapCallback) -> m SignalHandlerId

Connect a signal handler for the map signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #map callback

mnemonicActivate

type WidgetMnemonicActivateCallback

Arguments

 = Bool

groupCycling: True if there are other widgets with the same mnemonic

-> IO Bool

Returns: True to stop other handlers from being invoked for the event. False to propagate the event further.

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates widget if groupCycling is False, or just makes widget grab focus if groupCycling is True.

afterWidgetMnemonicActivate :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetMnemonicActivateCallback) -> m SignalHandlerId

Connect a signal handler for the mnemonicActivate signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #mnemonicActivate callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetMnemonicActivate :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetMnemonicActivateCallback) -> m SignalHandlerId

Connect a signal handler for the mnemonicActivate signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #mnemonicActivate callback

moveFocus

type WidgetMoveFocusCallback

Arguments

 = DirectionType

direction: the direction of the focus move

-> IO ()

Emitted when the focus is moved.

afterWidgetMoveFocus :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetMoveFocusCallback) -> m SignalHandlerId

Connect a signal handler for the moveFocus signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #moveFocus callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetMoveFocus :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetMoveFocusCallback) -> m SignalHandlerId

Connect a signal handler for the moveFocus signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #moveFocus callback

queryTooltip

type WidgetQueryTooltipCallback

Arguments

 = Int32

x: the x coordinate of the cursor position where the request has been emitted, relative to widget's left side

-> Int32

y: the y coordinate of the cursor position where the request has been emitted, relative to widget's top

-> Bool

keyboardMode: True if the tooltip was triggered using the keyboard

-> Tooltip

tooltip: a GtkTooltip

-> IO Bool

Returns: True if tooltip should be shown right now, False otherwise.

Emitted when the widgets tooltip is about to be shown.

This happens when the Widget:hasTooltip property is True and the hover timeout has expired with the cursor hovering "above" widget; or emitted when widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for widget. If this is the case True should be returned, False otherwise. Note that if keyboardMode is True, the values of x and y are undefined and should not be used.

The signal handler is free to manipulate tooltip with the therefore destined function calls.

afterWidgetQueryTooltip :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetQueryTooltipCallback) -> m SignalHandlerId

Connect a signal handler for the queryTooltip signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #queryTooltip callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetQueryTooltip :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetQueryTooltipCallback) -> m SignalHandlerId

Connect a signal handler for the queryTooltip signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #queryTooltip callback

realize

type WidgetRealizeCallback = IO ()

Emitted when widget is associated with a GdkSurface.

This means that widgetRealize has been called or the widget has been mapped (that is, it is going to be drawn).

afterWidgetRealize :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetRealizeCallback) -> m SignalHandlerId

Connect a signal handler for the realize signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #realize callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetRealize :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetRealizeCallback) -> m SignalHandlerId

Connect a signal handler for the realize signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #realize callback

show

type WidgetShowCallback = IO ()

Emitted when widget is shown.

afterWidgetShow :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetShowCallback) -> m SignalHandlerId

Connect a signal handler for the show signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #show callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetShow :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetShowCallback) -> m SignalHandlerId

Connect a signal handler for the show signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #show callback

stateFlagsChanged

type WidgetStateFlagsChangedCallback

Arguments

 = [StateFlags]

flags: The previous state flags.

-> IO ()

Emitted when the widget state changes.

See widgetGetStateFlags.

afterWidgetStateFlagsChanged :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetStateFlagsChangedCallback) -> m SignalHandlerId

Connect a signal handler for the stateFlagsChanged signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #stateFlagsChanged callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetStateFlagsChanged :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetStateFlagsChangedCallback) -> m SignalHandlerId

Connect a signal handler for the stateFlagsChanged signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #stateFlagsChanged callback

unmap

type WidgetUnmapCallback = IO ()

Emitted when widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

afterWidgetUnmap :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetUnmapCallback) -> m SignalHandlerId

Connect a signal handler for the unmap signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #unmap callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetUnmap :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetUnmapCallback) -> m SignalHandlerId

Connect a signal handler for the unmap signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #unmap callback

unrealize

type WidgetUnrealizeCallback = IO ()

Emitted when the GdkSurface associated with widget is destroyed.

This means that widgetUnrealize has been called or the widget has been unmapped (that is, it is going to be hidden).

afterWidgetUnrealize :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetUnrealizeCallback) -> m SignalHandlerId

Connect a signal handler for the unrealize signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after widget #unrealize callback

By default the object invoking the signal is not passed to the callback. If you need to access it, you can use the implit ?self parameter. Note that this requires activating the ImplicitParams GHC extension.

onWidgetUnrealize :: (IsWidget a, MonadIO m) => a -> ((?self :: a) => WidgetUnrealizeCallback) -> m SignalHandlerId

Connect a signal handler for the unrealize signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on widget #unrealize callback