gi-gtk4-4.0.12: Gtk 4.x bindings

Copyright | Will Thompson and Iñaki García Etxebarria
License | LGPL-2.1
Maintainer | Iñaki García Etxebarria
Safe Haskell | None
Language | Haskell2010

GI.Gtk.Structs.WidgetClass

Contents

- Exported types
- Methods
  - addShortcut
  - bindTemplateCallbackFull
  - bindTemplateChildFull
  - getAccessibleRole
  - getActivateSignal
  - getCssName
  - getLayoutManagerType
  - installAction
  - installPropertyAction
  - queryAction
  - setAccessibleRole
  - setActivateSignal
  - setActivateSignalFromName
  - setCssName
  - setLayoutManagerType
  - setTemplate
  - setTemplateFromResource
  - setTemplateScope
- Properties
  - computeExpand
  - contains
  - cssChanged
  - directionChanged
  - focus
  - getRequestMode
  - grabFocus
  - hide
  - keynavFailed
  - map
  - measure
  - mnemonicActivate
  - moveFocus
  - parentClass
  - queryTooltip
  - realize
  - root
  - setFocusChild
  - show
  - sizeAllocate
  - snapshot
  - stateFlagsChanged
  - systemSettingChanged
  - unmap
  - unrealize
  - unroot

Description

No description available in the introspection data.

Synopsis

- newtype WidgetClass = WidgetClass (ManagedPtr WidgetClass)
- newZeroWidgetClass :: MonadIO m => m WidgetClass
- widgetClassAddShortcut :: (HasCallStack, MonadIO m, IsShortcut a) => WidgetClass -> a -> m ()
- widgetClassBindTemplateCallbackFull :: (HasCallStack, MonadIO m) => WidgetClass -> Text -> Callback -> m ()
- widgetClassBindTemplateChildFull :: (HasCallStack, MonadIO m) => WidgetClass -> Text -> Bool -> Int64 -> m ()
- widgetClassGetAccessibleRole :: (HasCallStack, MonadIO m) => WidgetClass -> m AccessibleRole
- widgetClassGetActivateSignal :: (HasCallStack, MonadIO m) => WidgetClass -> m Word32
- widgetClassGetCssName :: (HasCallStack, MonadIO m) => WidgetClass -> m Text
- widgetClassGetLayoutManagerType :: (HasCallStack, MonadIO m) => WidgetClass -> m GType
- widgetClassInstallAction :: (HasCallStack, MonadIO m) => WidgetClass -> Text -> Maybe Text -> WidgetActionActivateFunc -> m ()
- widgetClassInstallPropertyAction :: (HasCallStack, MonadIO m) => WidgetClass -> Text -> Text -> m ()
- widgetClassQueryAction :: (HasCallStack, MonadIO m) => WidgetClass -> Word32 -> m (Bool, GType, Text, Maybe VariantType, Maybe Text)
- widgetClassSetAccessibleRole :: (HasCallStack, MonadIO m) => WidgetClass -> AccessibleRole -> m ()
- widgetClassSetActivateSignal :: (HasCallStack, MonadIO m) => WidgetClass -> Word32 -> m ()
- widgetClassSetActivateSignalFromName :: (HasCallStack, MonadIO m) => WidgetClass -> Text -> m ()
- widgetClassSetCssName :: (HasCallStack, MonadIO m) => WidgetClass -> Text -> m ()
- widgetClassSetLayoutManagerType :: (HasCallStack, MonadIO m) => WidgetClass -> GType -> m ()
- widgetClassSetTemplate :: (HasCallStack, MonadIO m) => WidgetClass -> Bytes -> m ()
- widgetClassSetTemplateFromResource :: (HasCallStack, MonadIO m) => WidgetClass -> Text -> m ()
- widgetClassSetTemplateScope :: (HasCallStack, MonadIO m, IsBuilderScope a) => WidgetClass -> a -> m ()
- clearWidgetClassComputeExpand :: MonadIO m => WidgetClass -> m ()
- getWidgetClassComputeExpand :: MonadIO m => WidgetClass -> m (Maybe WidgetClassComputeExpandFieldCallback)
- setWidgetClassComputeExpand :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassComputeExpandFieldCallback -> m ()
- clearWidgetClassContains :: MonadIO m => WidgetClass -> m ()
- getWidgetClassContains :: MonadIO m => WidgetClass -> m (Maybe WidgetClassContainsFieldCallback)
- setWidgetClassContains :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassContainsFieldCallback -> m ()
- clearWidgetClassCssChanged :: MonadIO m => WidgetClass -> m ()
- getWidgetClassCssChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassCssChangedFieldCallback)
- setWidgetClassCssChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassCssChangedFieldCallback -> m ()
- clearWidgetClassDirectionChanged :: MonadIO m => WidgetClass -> m ()
- getWidgetClassDirectionChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassDirectionChangedFieldCallback)
- setWidgetClassDirectionChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassDirectionChangedFieldCallback -> m ()
- clearWidgetClassFocus :: MonadIO m => WidgetClass -> m ()
- getWidgetClassFocus :: MonadIO m => WidgetClass -> m (Maybe WidgetClassFocusFieldCallback)
- setWidgetClassFocus :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassFocusFieldCallback -> m ()
- clearWidgetClassGetRequestMode :: MonadIO m => WidgetClass -> m ()
- getWidgetClassGetRequestMode :: MonadIO m => WidgetClass -> m (Maybe WidgetClassGetRequestModeFieldCallback)
- setWidgetClassGetRequestMode :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassGetRequestModeFieldCallback -> m ()
- clearWidgetClassGrabFocus :: MonadIO m => WidgetClass -> m ()
- getWidgetClassGrabFocus :: MonadIO m => WidgetClass -> m (Maybe WidgetClassGrabFocusFieldCallback)
- setWidgetClassGrabFocus :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassGrabFocusFieldCallback -> m ()
- clearWidgetClassHide :: MonadIO m => WidgetClass -> m ()
- getWidgetClassHide :: MonadIO m => WidgetClass -> m (Maybe WidgetClassHideFieldCallback)
- setWidgetClassHide :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassHideFieldCallback -> m ()
- clearWidgetClassKeynavFailed :: MonadIO m => WidgetClass -> m ()
- getWidgetClassKeynavFailed :: MonadIO m => WidgetClass -> m (Maybe WidgetClassKeynavFailedFieldCallback)
- setWidgetClassKeynavFailed :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassKeynavFailedFieldCallback -> m ()
- clearWidgetClassMap :: MonadIO m => WidgetClass -> m ()
- getWidgetClassMap :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMapFieldCallback)
- setWidgetClassMap :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMapFieldCallback -> m ()
- clearWidgetClassMeasure :: MonadIO m => WidgetClass -> m ()
- getWidgetClassMeasure :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMeasureFieldCallback)
- setWidgetClassMeasure :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMeasureFieldCallback -> m ()
- clearWidgetClassMnemonicActivate :: MonadIO m => WidgetClass -> m ()
- getWidgetClassMnemonicActivate :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMnemonicActivateFieldCallback)
- setWidgetClassMnemonicActivate :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMnemonicActivateFieldCallback -> m ()
- clearWidgetClassMoveFocus :: MonadIO m => WidgetClass -> m ()
- getWidgetClassMoveFocus :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMoveFocusFieldCallback)
- setWidgetClassMoveFocus :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMoveFocusFieldCallback -> m ()
- getWidgetClassParentClass :: MonadIO m => WidgetClass -> m InitiallyUnownedClass
- clearWidgetClassQueryTooltip :: MonadIO m => WidgetClass -> m ()
- getWidgetClassQueryTooltip :: MonadIO m => WidgetClass -> m (Maybe WidgetClassQueryTooltipFieldCallback)
- setWidgetClassQueryTooltip :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassQueryTooltipFieldCallback -> m ()
- clearWidgetClassRealize :: MonadIO m => WidgetClass -> m ()
- getWidgetClassRealize :: MonadIO m => WidgetClass -> m (Maybe WidgetClassRealizeFieldCallback)
- setWidgetClassRealize :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassRealizeFieldCallback -> m ()
- clearWidgetClassRoot :: MonadIO m => WidgetClass -> m ()
- getWidgetClassRoot :: MonadIO m => WidgetClass -> m (Maybe WidgetClassRootFieldCallback)
- setWidgetClassRoot :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassRootFieldCallback -> m ()
- clearWidgetClassSetFocusChild :: MonadIO m => WidgetClass -> m ()
- getWidgetClassSetFocusChild :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSetFocusChildFieldCallback)
- setWidgetClassSetFocusChild :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSetFocusChildFieldCallback -> m ()
- clearWidgetClassShow :: MonadIO m => WidgetClass -> m ()
- getWidgetClassShow :: MonadIO m => WidgetClass -> m (Maybe WidgetClassShowFieldCallback)
- setWidgetClassShow :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassShowFieldCallback -> m ()
- clearWidgetClassSizeAllocate :: MonadIO m => WidgetClass -> m ()
- getWidgetClassSizeAllocate :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSizeAllocateFieldCallback)
- setWidgetClassSizeAllocate :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSizeAllocateFieldCallback -> m ()
- clearWidgetClassSnapshot :: MonadIO m => WidgetClass -> m ()
- getWidgetClassSnapshot :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSnapshotFieldCallback)
- setWidgetClassSnapshot :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSnapshotFieldCallback -> m ()
- clearWidgetClassStateFlagsChanged :: MonadIO m => WidgetClass -> m ()
- getWidgetClassStateFlagsChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassStateFlagsChangedFieldCallback)
- setWidgetClassStateFlagsChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassStateFlagsChangedFieldCallback -> m ()
- clearWidgetClassSystemSettingChanged :: MonadIO m => WidgetClass -> m ()
- getWidgetClassSystemSettingChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSystemSettingChangedFieldCallback)
- setWidgetClassSystemSettingChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSystemSettingChangedFieldCallback -> m ()
- clearWidgetClassUnmap :: MonadIO m => WidgetClass -> m ()
- getWidgetClassUnmap :: MonadIO m => WidgetClass -> m (Maybe WidgetClassUnmapFieldCallback)
- setWidgetClassUnmap :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassUnmapFieldCallback -> m ()
- clearWidgetClassUnrealize :: MonadIO m => WidgetClass -> m ()
- getWidgetClassUnrealize :: MonadIO m => WidgetClass -> m (Maybe WidgetClassUnrealizeFieldCallback)
- setWidgetClassUnrealize :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassUnrealizeFieldCallback -> m ()
- clearWidgetClassUnroot :: MonadIO m => WidgetClass -> m ()
- getWidgetClassUnroot :: MonadIO m => WidgetClass -> m (Maybe WidgetClassUnrootFieldCallback)
- setWidgetClassUnroot :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassUnrootFieldCallback -> m ()

# Exported types

newtype WidgetClass Source #

Memory-managed wrapper type.

Constructors

WidgetClass (ManagedPtr WidgetClass) |

#### Instances

Instances details

Eq WidgetClass Source # |
Instance details Defined in GI.Gtk.Structs.WidgetClass Methods (==) :: WidgetClass -> WidgetClass -> Bool Source # (/=) :: WidgetClass -> WidgetClass -> Bool Source #
BoxedPtr WidgetClass Source # |
Instance details Defined in GI.Gtk.Structs.WidgetClass Methods boxedPtrCopy :: WidgetClass -> IO WidgetClass Source # boxedPtrFree :: WidgetClass -> IO () Source #
CallocPtr WidgetClass Source # |
Instance details Defined in GI.Gtk.Structs.WidgetClass Methods boxedPtrCalloc :: IO (Ptr WidgetClass) Source #
ManagedPtrNewtype WidgetClass Source # |
Instance details Defined in GI.Gtk.Structs.WidgetClass Methods toManagedPtr :: WidgetClass -> ManagedPtr WidgetClass Source #
tag ~ 'AttrSet => Constructible WidgetClass tag Source # |
Instance details Defined in GI.Gtk.Structs.WidgetClass Methods new :: MonadIO m => (ManagedPtr WidgetClass -> WidgetClass) -> [AttrOp WidgetClass tag] -> m WidgetClass Source #

newZeroWidgetClass :: MonadIO m => m WidgetClass Source #

Construct a `WidgetClass` struct initialized to zero.

# Methods

### Click to display all available methods, including inherited ones

Expand

#### Methods

addShortcut, bindTemplateCallbackFull, bindTemplateChildFull, installAction, installPropertyAction, queryAction.

#### Getters

getAccessibleRole, getActivateSignal, getCssName, getLayoutManagerType.

#### Setters

setAccessibleRole, setActivateSignal, setActivateSignalFromName, setCssName, setLayoutManagerType, setTemplate, setTemplateFromResource, setTemplateScope.

## addShortcut

widgetClassAddShortcut Source #

Arguments

:: (HasCallStack, MonadIO m, IsShortcut a) |
=> WidgetClass | `widgetClass`: the class to add the shortcut to
-> a | `shortcut`: the shortcut to add
-> m () |

Installs a shortcut in `widgetClass`.

Every instance created for `widgetClass` or its subclasses will inherit this shortcut and trigger it.

Shortcuts added this way will be triggered in the `PropagationPhaseBubble` phase, which means they may also trigger if child widgets have focus.

This function must only be used in class initialization functions otherwise it is not guaranteed that the shortcut will be installed.

## bindTemplateCallbackFull

widgetClassBindTemplateCallbackFull Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Text | `callbackName`: name of the callback as expected in the template XML
-> Callback | `callbackSymbol`: the callback symbol
-> m () |

Associates a name to be used in GtkBuilder XML with a symbol.

This function is not supported after `widgetClassSetTemplateScope` has been used on `widgetClass`.

See `builderCScopeAddCallbackSymbol`.

Note that this must be called from a composite widget classes class initializer after calling `widgetClassSetTemplate`.

## bindTemplateChildFull

widgetClassBindTemplateChildFull Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Text | `name`: ID of the child defined in the template XML
-> Bool | `internalChild`: whether the child should be accessible as an “internal-child” when this class is used in GtkBuilder XML
-> Int64 | `structOffset`: The offset into the composite widget’s instance public or private structure where the automated child pointer should be set, or 0 to not assign the pointer
-> m () |

Assigns an object declared in the class template XML to be set to a location on a freshly built instance’s private data, or alternatively accessible via `widgetGetTemplateChild`.

The struct can point either into the public instance, then you should use `G_STRUCT_OFFSET(WidgetType, member)` for `structOffset`, or in the private struct, then you should use `G_PRIVATE_OFFSET(WidgetType, member)`.

An explicit strong reference will be held automatically for the duration of your instance’s life cycle, it will be released automatically when `GObjectClass.dispose()` runs on your instance and if a nonzero `structOffset` is specified, then the automatic location in your instance public or private data will be set to `NULL`. You can however access an automated child pointer the first time your classes `GObjectClass.dispose()` runs, or alternatively in Widget::destroy.

If `internalChild` is specified, `Buildable`.`get_internal_child`() will be automatically implemented by the widget class so there is no need to implement it manually.

The wrapper macros `Gtk.widget_class_bind_template_child`, `Gtk.widget_class_bind_template_child_internal`, `Gtk.widget_class_bind_template_child_private` and `Gtk.widget_class_bind_template_child_internal_private` might be more convenient to use.

Note that this must be called from a composite widget classes class initializer after calling `widgetClassSetTemplate`.

## getAccessibleRole

widgetClassGetAccessibleRole Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> m AccessibleRole | Returns: the accessible role for the widget class

Retrieves the accessible role used by the given widget class.

Different accessible roles have different states, and are rendered differently by assistive technologies.

See also: `accessibleGetAccessibleRole`.

## getActivateSignal

widgetClassGetActivateSignal Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> m Word32 | Returns: a signal id, or 0 if the widget class does not specify an activation signal

Retrieves the signal id for the activation signal.

The activation signal is set using `widgetClassSetActivateSignal`.

## getCssName

widgetClassGetCssName Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: class to set the name on
-> m Text | Returns: the CSS name of the given class

Gets the name used by this class for matching in CSS code.

See `widgetClassSetCssName` for details.

## getLayoutManagerType

widgetClassGetLayoutManagerType Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> m GType | Returns: type of a `GtkLayoutManager` subclass, or `G_TYPE_INVALID`

Retrieves the type of the `LayoutManager` used by widgets of class `widgetClass`.

See also: `widgetClassSetLayoutManagerType`.

## installAction

widgetClassInstallAction Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Text | `actionName`: a prefixed action name, such as "clipboard.paste"
-> Maybe Text | `parameterType`: the parameter type
-> WidgetActionActivateFunc | `activate`: callback to use when the action is activated
-> m () |

Adds an action for all instances of a widget class.

This function should be called at class initialization time.

Actions installed by this function are stateless. The only state they have is whether they are enabled or not (which can be changed with `widgetActionSetEnabled`).

## installPropertyAction

widgetClassInstallPropertyAction Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Text | `actionName`: name of the action
-> Text | `propertyName`: name of a property in instances of `widgetClass` or any parent class
-> m () |

Installs an action called `actionName` on `widgetClass` and binds its state to the value of the `propertyName` property.

This function will perform a few sanity checks on the property selected via `propertyName`. Namely, the property must exist, must be readable, writable and must not be construct-only. There are also restrictions on the type of the given property, it must be boolean, int, unsigned int, double or string. If any of these conditions are not met, a critical warning will be printed and no action will be added.

The state type of the action matches the property type.

If the property is boolean, the action will have no parameter and toggle the property value. Otherwise, the action will have a parameter of the same type as the property.

## queryAction

widgetClassQueryAction Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Word32 | `index_`: position of the action to query
-> m (Bool, GType, Text, Maybe VariantType, Maybe Text) | Returns: true if the action was found

Returns details about an action that has been installed for `widgetClass`.

See `widgetClassInstallAction` for details on how to install actions.

Note that this function will also return actions defined by parent classes. You can identify those by looking at `owner`.

## setAccessibleRole

widgetClassSetAccessibleRole Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> AccessibleRole | `accessibleRole`: the accessible role to use
-> m () |

Sets the accessible role used by the given widget class.

Different accessible roles have different states, and are rendered differently by assistive technologies.

## setActivateSignal

widgetClassSetActivateSignal Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Word32 | `signalId`: the id for the activate signal
-> m () |

Sets the activation signal for a widget class.

The signal will be emitted when calling `widgetActivate`.

The `signalId` must have been registered with [function.GObject.signal_new] or `GObject.signal_newv` before calling this function.

## setActivateSignalFromName

widgetClassSetActivateSignalFromName Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Text | `signalName`: the name of the activate signal of `widgetType`
-> m () |

Sets the activation signal for a widget class.

The signal id will by looked up by `signalName`.

The signal will be emitted when calling `widgetActivate`.

The `signalName` must have been registered with [function.GObject.signal_new] or `GObject.signal_newv` before calling this function.

## setCssName

widgetClassSetCssName Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: class to set the name on
-> Text | `name`: name to use
-> m () |

Sets the name to be used for CSS matching of widgets.

If this function is not called for a given class, the name set on the parent class is used. By default, `GtkWidget` uses the name "widget".

## setLayoutManagerType

widgetClassSetLayoutManagerType Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> GType | `type`: the object type that implements the `GtkLayoutManager` for `widgetClass`
-> m () |

Sets the type to be used for creating layout managers for widgets of `widgetClass`.

The given `type` must be a subtype of `LayoutManager`.

This function should only be called from class init functions of widgets.

## setTemplate

widgetClassSetTemplate Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Bytes | `templateBytes`: `GBytes` holding the `GtkBuilder` XML
-> m () |

This should be called at class initialization time to specify the `GtkBuilder` XML to be used to extend a widget.

For convenience, `widgetClassSetTemplateFromResource` is also provided.

Note that any class that installs templates must call `widgetInitTemplate` in the widget’s instance initializer.

## setTemplateFromResource

widgetClassSetTemplateFromResource Source #

Arguments

:: (HasCallStack, MonadIO m) |
=> WidgetClass | `widgetClass`: a widget class
-> Text | `resourceName`: resource path to load the template from
-> m () |

A convenience function that calls `widgetClassSetTemplate` with the contents of a resource.

Note that any class that installs templates must call `widgetInitTemplate` in the widget’s instance initializer.

## setTemplateScope

widgetClassSetTemplateScope Source #

Arguments

:: (HasCallStack, MonadIO m, IsBuilderScope a) |
=> WidgetClass | `widgetClass`: a widget class
-> a | `scope`: `GtkBuilderScope` to use when loading the class template
-> m () |

Overrides the default scope to be used when parsing the class template.

This function is intended for language bindings.

Note that this must be called from a composite widget classes class initializer after calling `widgetClassSetTemplate`.

# Properties

## computeExpand

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

clearWidgetClassComputeExpand :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`compute_expand`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #computeExpand

getWidgetClassComputeExpand :: MonadIO m => WidgetClass -> m (Maybe WidgetClassComputeExpandFieldCallback) Source #

Get the value of the “`compute_expand`” field. When overloading is enabled, this is equivalent to

    get widgetClass #computeExpand

setWidgetClassComputeExpand :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassComputeExpandFieldCallback -> m () Source #

Set the value of the “`compute_expand`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #computeExpand := value ]

## contains

Vfunc for `widgetContains`.

clearWidgetClassContains :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`contains`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #contains

getWidgetClassContains :: MonadIO m => WidgetClass -> m (Maybe WidgetClassContainsFieldCallback) Source #

Get the value of the “`contains`” field. When overloading is enabled, this is equivalent to

    get widgetClass #contains

setWidgetClassContains :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassContainsFieldCallback -> m () Source #

Set the value of the “`contains`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #contains := value ]

## cssChanged

Vfunc called when the CSS used by widget was changed. Widgets should then discard their caches that depend on CSS and queue resizes or redraws accordingly. The default implementation will take care of this for all the default CSS properties, so implementations must chain up.

clearWidgetClassCssChanged :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`css_changed`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #cssChanged

getWidgetClassCssChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassCssChangedFieldCallback) Source #

Get the value of the “`css_changed`” field. When overloading is enabled, this is equivalent to

    get widgetClass #cssChanged

setWidgetClassCssChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassCssChangedFieldCallback -> m () Source #

Set the value of the “`css_changed`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #cssChanged := value ]

## directionChanged

Signal emitted when the text direction of a widget changes.

clearWidgetClassDirectionChanged :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`direction_changed`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #directionChanged

getWidgetClassDirectionChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassDirectionChangedFieldCallback) Source #

Get the value of the “`direction_changed`” field. When overloading is enabled, this is equivalent to

    get widgetClass #directionChanged

setWidgetClassDirectionChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassDirectionChangedFieldCallback -> m () Source #

Set the value of the “`direction_changed`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #directionChanged := value ]

## focus

Vfunc for `widgetChildFocus`

clearWidgetClassFocus :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`focus`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #focus

getWidgetClassFocus :: MonadIO m => WidgetClass -> m (Maybe WidgetClassFocusFieldCallback) Source #

Get the value of the “`focus`” field. When overloading is enabled, this is equivalent to

    get widgetClass #focus

setWidgetClassFocus :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassFocusFieldCallback -> m () Source #

Set the value of the “`focus`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #focus := value ]

## getRequestMode

Called to get the request mode, if the widget does not have a layout manager. This allows a widget to tell its parent container whether it prefers to be allocated in `SizeRequestModeHeightForWidth` or `SizeRequestModeWidthForHeight` mode. `SizeRequestModeHeightForWidth` means the widget prefers to have `GtkWidgetClass.measure()` called first to get the default width (passing a for_size of -1), then again to get the height for said default width. `SizeRequestModeConstantSize` disables any height-for-width or width-for-height geometry management for said widget and is the default return. It’s important to note that any widget which trades height-for-width or width-for-height must respond properly to a for_size value >= -1 passed to `GtkWidgetClass.measure`, for both possible orientations.

clearWidgetClassGetRequestMode :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`get_request_mode`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #getRequestMode

getWidgetClassGetRequestMode :: MonadIO m => WidgetClass -> m (Maybe WidgetClassGetRequestModeFieldCallback) Source #

Get the value of the “`get_request_mode`” field. When overloading is enabled, this is equivalent to

    get widgetClass #getRequestMode

setWidgetClassGetRequestMode :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassGetRequestModeFieldCallback -> m () Source #

Set the value of the “`get_request_mode`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #getRequestMode := value ]

## grabFocus

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

clearWidgetClassGrabFocus :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`grab_focus`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #grabFocus

getWidgetClassGrabFocus :: MonadIO m => WidgetClass -> m (Maybe WidgetClassGrabFocusFieldCallback) Source #

Get the value of the “`grab_focus`” field. When overloading is enabled, this is equivalent to

    get widgetClass #grabFocus

setWidgetClassGrabFocus :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassGrabFocusFieldCallback -> m () Source #

Set the value of the “`grab_focus`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #grabFocus := value ]

## hide

Signal emitted when widget is hidden.

clearWidgetClassHide :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`hide`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #hide

getWidgetClassHide :: MonadIO m => WidgetClass -> m (Maybe WidgetClassHideFieldCallback) Source #

Get the value of the “`hide`” field. When overloading is enabled, this is equivalent to

    get widgetClass #hide

setWidgetClassHide :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassHideFieldCallback -> m () Source #

Set the value of the “`hide`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #hide := value ]

## keynavFailed

Signal emitted if keyboard navigation fails.

clearWidgetClassKeynavFailed :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`keynav_failed`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #keynavFailed

getWidgetClassKeynavFailed :: MonadIO m => WidgetClass -> m (Maybe WidgetClassKeynavFailedFieldCallback) Source #

Get the value of the “`keynav_failed`” field. When overloading is enabled, this is equivalent to

    get widgetClass #keynavFailed

setWidgetClassKeynavFailed :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassKeynavFailedFieldCallback -> m () Source #

Set the value of the “`keynav_failed`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #keynavFailed := value ]

## map

Signal emitted when widget is going to be mapped, that is when the widget is visible (which is controlled with `widgetSetVisible`) and all its parents up to the toplevel widget are also visible.

clearWidgetClassMap :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`map`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #map

getWidgetClassMap :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMapFieldCallback) Source #

Get the value of the “`map`” field. When overloading is enabled, this is equivalent to

    get widgetClass #map

setWidgetClassMap :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMapFieldCallback -> m () Source #

Set the value of the “`map`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #map := value ]

## measure

Called to obtain the minimum and natural size of the widget, if the widget does not have a layout manager. Depending on the orientation parameter, the passed for_size can be interpreted as width or height. A widget will never be allocated less than its minimum size.

clearWidgetClassMeasure :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`measure`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #measure

getWidgetClassMeasure :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMeasureFieldCallback) Source #

Get the value of the “`measure`” field. When overloading is enabled, this is equivalent to

    get widgetClass #measure

setWidgetClassMeasure :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMeasureFieldCallback -> m () Source #

Set the value of the “`measure`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #measure := value ]

## mnemonicActivate

Activates the `widget` if `groupCycling` is `False`, and just grabs the focus if `groupCycling` is `True`.

clearWidgetClassMnemonicActivate :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`mnemonic_activate`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #mnemonicActivate

getWidgetClassMnemonicActivate :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMnemonicActivateFieldCallback) Source #

Get the value of the “`mnemonic_activate`” field. When overloading is enabled, this is equivalent to

    get widgetClass #mnemonicActivate

setWidgetClassMnemonicActivate :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMnemonicActivateFieldCallback -> m () Source #

Set the value of the “`mnemonic_activate`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #mnemonicActivate := value ]

## moveFocus

Signal emitted when a change of focus is requested

clearWidgetClassMoveFocus :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`move_focus`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #moveFocus

getWidgetClassMoveFocus :: MonadIO m => WidgetClass -> m (Maybe WidgetClassMoveFocusFieldCallback) Source #

Get the value of the “`move_focus`” field. When overloading is enabled, this is equivalent to

    get widgetClass #moveFocus

setWidgetClassMoveFocus :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassMoveFocusFieldCallback -> m () Source #

Set the value of the “`move_focus`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #moveFocus := value ]

## parentClass

The object class structure needs to be the first element in the widget class structure in order for the class mechanism to work correctly. This allows a GtkWidgetClass pointer to be cast to a GObjectClass pointer.

getWidgetClassParentClass :: MonadIO m => WidgetClass -> m InitiallyUnownedClass Source #

Get the value of the “`parent_class`” field. When overloading is enabled, this is equivalent to

    get widgetClass #parentClass

## queryTooltip

Signal emitted when “has-tooltip” is `True` and the hover timeout has expired with the cursor hovering “above” widget; or emitted when widget got focus in keyboard mode.

clearWidgetClassQueryTooltip :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`query_tooltip`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #queryTooltip

getWidgetClassQueryTooltip :: MonadIO m => WidgetClass -> m (Maybe WidgetClassQueryTooltipFieldCallback) Source #

Get the value of the “`query_tooltip`” field. When overloading is enabled, this is equivalent to

    get widgetClass #queryTooltip

setWidgetClassQueryTooltip :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassQueryTooltipFieldCallback -> m () Source #

Set the value of the “`query_tooltip`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #queryTooltip := value ]

## realize

Signal emitted when widget is associated with a `GdkSurface`, which means that `widgetRealize` has been called or the widget has been mapped (that is, it is going to be drawn).

clearWidgetClassRealize :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`realize`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #realize

getWidgetClassRealize :: MonadIO m => WidgetClass -> m (Maybe WidgetClassRealizeFieldCallback) Source #

Get the value of the “`realize`” field. When overloading is enabled, this is equivalent to

    get widgetClass #realize

setWidgetClassRealize :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassRealizeFieldCallback -> m () Source #

Set the value of the “`realize`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #realize := value ]

## root

Called when the widget gets added to a `GtkRoot` widget. Must chain up

clearWidgetClassRoot :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`root`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #root

getWidgetClassRoot :: MonadIO m => WidgetClass -> m (Maybe WidgetClassRootFieldCallback) Source #

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

    get widgetClass #root

setWidgetClassRoot :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassRootFieldCallback -> m () Source #

Set the value of the “`root`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #root := value ]

## setFocusChild

Sets the focused child of a widget. Must chain up

clearWidgetClassSetFocusChild :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`set_focus_child`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #setFocusChild

getWidgetClassSetFocusChild :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSetFocusChildFieldCallback) Source #

Get the value of the “`set_focus_child`” field. When overloading is enabled, this is equivalent to

    get widgetClass #setFocusChild

setWidgetClassSetFocusChild :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSetFocusChildFieldCallback -> m () Source #

Set the value of the “`set_focus_child`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #setFocusChild := value ]

## show

Signal emitted when widget is shown

clearWidgetClassShow :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`show`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #show

getWidgetClassShow :: MonadIO m => WidgetClass -> m (Maybe WidgetClassShowFieldCallback) Source #

Get the value of the “`show`” field. When overloading is enabled, this is equivalent to

    get widgetClass #show

setWidgetClassShow :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassShowFieldCallback -> m () Source #

Set the value of the “`show`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #show := value ]

## sizeAllocate

Called to set the allocation, if the widget does not have a layout manager.

clearWidgetClassSizeAllocate :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`size_allocate`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #sizeAllocate

getWidgetClassSizeAllocate :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSizeAllocateFieldCallback) Source #

Get the value of the “`size_allocate`” field. When overloading is enabled, this is equivalent to

    get widgetClass #sizeAllocate

setWidgetClassSizeAllocate :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSizeAllocateFieldCallback -> m () Source #

Set the value of the “`size_allocate`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #sizeAllocate := value ]

## snapshot

Vfunc called when a new snapshot of the widget has to be taken.

clearWidgetClassSnapshot :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`snapshot`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #snapshot

getWidgetClassSnapshot :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSnapshotFieldCallback) Source #

Get the value of the “`snapshot`” field. When overloading is enabled, this is equivalent to

    get widgetClass #snapshot

setWidgetClassSnapshot :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSnapshotFieldCallback -> m () Source #

Set the value of the “`snapshot`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #snapshot := value ]

## stateFlagsChanged

Signal emitted when the widget state changes, see `widgetGetStateFlags`.

clearWidgetClassStateFlagsChanged :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`state_flags_changed`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #stateFlagsChanged

getWidgetClassStateFlagsChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassStateFlagsChangedFieldCallback) Source #

Get the value of the “`state_flags_changed`” field. When overloading is enabled, this is equivalent to

    get widgetClass #stateFlagsChanged

setWidgetClassStateFlagsChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassStateFlagsChangedFieldCallback -> m () Source #

Set the value of the “`state_flags_changed`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #stateFlagsChanged := value ]

## systemSettingChanged

Emitted when a system setting was changed. Must chain up.

clearWidgetClassSystemSettingChanged :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`system_setting_changed`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #systemSettingChanged

getWidgetClassSystemSettingChanged :: MonadIO m => WidgetClass -> m (Maybe WidgetClassSystemSettingChangedFieldCallback) Source #

Get the value of the “`system_setting_changed`” field. When overloading is enabled, this is equivalent to

    get widgetClass #systemSettingChanged

setWidgetClassSystemSettingChanged :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassSystemSettingChangedFieldCallback -> m () Source #

Set the value of the “`system_setting_changed`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #systemSettingChanged := value ]

## unmap

Signal emitted when widget is going to be unmapped, which means that either it or any of its parents up to the toplevel widget have been set as hidden.

clearWidgetClassUnmap :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`unmap`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #unmap

getWidgetClassUnmap :: MonadIO m => WidgetClass -> m (Maybe WidgetClassUnmapFieldCallback) Source #

Get the value of the “`unmap`” field. When overloading is enabled, this is equivalent to

    get widgetClass #unmap

setWidgetClassUnmap :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassUnmapFieldCallback -> m () Source #

Set the value of the “`unmap`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #unmap := value ]

## unrealize

Signal emitted when the GdkSurface associated with widget is destroyed, which means that `widgetUnrealize` has been called or the widget has been unmapped (that is, it is going to be hidden).

clearWidgetClassUnrealize :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`unrealize`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #unrealize

getWidgetClassUnrealize :: MonadIO m => WidgetClass -> m (Maybe WidgetClassUnrealizeFieldCallback) Source #

Get the value of the “`unrealize`” field. When overloading is enabled, this is equivalent to

    get widgetClass #unrealize

setWidgetClassUnrealize :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassUnrealizeFieldCallback -> m () Source #

Set the value of the “`unrealize`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #unrealize := value ]

## unroot

Called when the widget is about to be removed from its `GtkRoot` widget. Must chain up

clearWidgetClassUnroot :: MonadIO m => WidgetClass -> m () Source #

Set the value of the “`unroot`” field to `Nothing`. When overloading is enabled, this is equivalent to

    clear #unroot

getWidgetClassUnroot :: MonadIO m => WidgetClass -> m (Maybe WidgetClassUnrootFieldCallback) Source #

Get the value of the “`unroot`” field. When overloading is enabled, this is equivalent to

    get widgetClass #unroot

setWidgetClassUnroot :: MonadIO m => WidgetClass -> FunPtr C_WidgetClassUnrootFieldCallback -> m () Source #

Set the value of the “`unroot`” field. When overloading is enabled, this is equivalent to

    set widgetClass [ #unroot := value ]