GI.Gtk.Structs.ContainerClass

Base class for containers.

Exported types

newtype ContainerClass

Memory-managed wrapper type.

Constructors

ContainerClass (ManagedPtr ContainerClass)

Instances

Eq ContainerClass

Defined in GI.Gtk.Structs.ContainerClass

Methods

(==) :: ContainerClass -> ContainerClass -> Bool

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

BoxedPtr ContainerClass

Defined in GI.Gtk.Structs.ContainerClass

Methods

boxedPtrCopy :: ContainerClass -> IO ContainerClass

boxedPtrFree :: ContainerClass -> IO ()

CallocPtr ContainerClass

Defined in GI.Gtk.Structs.ContainerClass

Methods

boxedPtrCalloc :: IO (Ptr ContainerClass)

ManagedPtrNewtype ContainerClass

Defined in GI.Gtk.Structs.ContainerClass

Methods

toManagedPtr :: ContainerClass -> ManagedPtr ContainerClass

tag ~ 'AttrSet => Constructible ContainerClass tag

Defined in GI.Gtk.Structs.ContainerClass

Methods

new :: MonadIO m => (ManagedPtr ContainerClass -> ContainerClass) -> [AttrOp ContainerClass tag] -> m ContainerClass

newZeroContainerClass :: MonadIO m => m ContainerClass

Construct a ContainerClass struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Methods

findChildProperty, handleBorderWidth, installChildProperty.

Getters

None.

Setters

None.

findChildProperty

containerClassFindChildProperty

Arguments

:: (HasCallStack, MonadIO m)

=> ContainerClass

cclass: a ContainerClass

-> Text

propertyName: the name of the child property to find

-> m (Maybe GParamSpec)

Returns: the ParamSpec of the child property or Nothing if class has no child property with that name.

Finds a child property of a container class by name.

handleBorderWidth

containerClassHandleBorderWidth

Arguments

:: (HasCallStack, MonadIO m)

=> ContainerClass

klass: the class struct of a Container subclass

-> m ()

Modifies a subclass of ContainerClass to automatically add and remove the border-width setting on GtkContainer. This allows the subclass to ignore the border width in its size request and allocate methods. The intent is for a subclass to invoke this in its class_init function.

containerClassHandleBorderWidth is necessary because it would break API too badly to make this behavior the default. So subclasses must “opt in” to the parent class handling border_width for them.

installChildProperty

containerClassInstallChildProperty

Arguments

:: (HasCallStack, MonadIO m)

=> ContainerClass

cclass: a ContainerClass

-> Word32

propertyId: the id for the property

-> GParamSpec

pspec: the ParamSpec for the property

-> m ()

Installs a child property on a container class.

Properties

add

Signal emitted when a widget is added to container.

clearContainerClassAdd :: MonadIO m => ContainerClass -> m ()

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

clear #add

getContainerClassAdd :: MonadIO m => ContainerClass -> m (Maybe ContainerClassAddFieldCallback)

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

get containerClass #add

setContainerClassAdd :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassAddFieldCallback -> m ()

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

set containerClass [ #add := value ]

checkResize

Signal emitted when a size recalculation is needed.

clearContainerClassCheckResize :: MonadIO m => ContainerClass -> m ()

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

clear #checkResize

getContainerClassCheckResize :: MonadIO m => ContainerClass -> m (Maybe ContainerClassCheckResizeFieldCallback)

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

get containerClass #checkResize

setContainerClassCheckResize :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassCheckResizeFieldCallback -> m ()

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

set containerClass [ #checkResize := value ]

childType

Returns the type of the children supported by the container.

clearContainerClassChildType :: MonadIO m => ContainerClass -> m ()

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

clear #childType

getContainerClassChildType :: MonadIO m => ContainerClass -> m (Maybe ContainerClassChildTypeFieldCallback)

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

get containerClass #childType

setContainerClassChildType :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassChildTypeFieldCallback -> m ()

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

set containerClass [ #childType := value ]

compositeName

Gets a widget’s composite name. Deprecated: 3.10.

clearContainerClassCompositeName :: MonadIO m => ContainerClass -> m ()

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

clear #compositeName

getContainerClassCompositeName :: MonadIO m => ContainerClass -> m (Maybe ContainerClassCompositeNameFieldCallback)

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

get containerClass #compositeName

setContainerClassCompositeName :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassCompositeNameFieldCallback -> m ()

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

set containerClass [ #compositeName := value ]

forall

Invokes callback on each child of container. The callback handler may remove the child.

clearContainerClassForall :: MonadIO m => ContainerClass -> m ()

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

clear #forall

getContainerClassForall :: MonadIO m => ContainerClass -> m (Maybe ContainerClassForallFieldCallback_WithClosures)

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

get containerClass #forall

setContainerClassForall :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassForallFieldCallback -> m ()

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

set containerClass [ #forall := value ]

getChildProperty

Get a property from a child of container.

clearContainerClassGetChildProperty :: MonadIO m => ContainerClass -> m ()

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

clear #getChildProperty

getContainerClassGetChildProperty :: MonadIO m => ContainerClass -> m (Maybe ContainerClassGetChildPropertyFieldCallback)

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

get containerClass #getChildProperty

setContainerClassGetChildProperty :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassGetChildPropertyFieldCallback -> m ()

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

set containerClass [ #getChildProperty := value ]

getPathForChild

Get path representing entire widget hierarchy from the toplevel down to and including child.

clearContainerClassGetPathForChild :: MonadIO m => ContainerClass -> m ()

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

clear #getPathForChild

getContainerClassGetPathForChild :: MonadIO m => ContainerClass -> m (Maybe ContainerClassGetPathForChildFieldCallback)

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

get containerClass #getPathForChild

setContainerClassGetPathForChild :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassGetPathForChildFieldCallback -> m ()

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

set containerClass [ #getPathForChild := value ]

parentClass

The parent class.

getContainerClassParentClass :: MonadIO m => ContainerClass -> m WidgetClass

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

get containerClass #parentClass

remove

Signal emitted when a widget is removed from container.

clearContainerClassRemove :: MonadIO m => ContainerClass -> m ()

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

clear #remove

getContainerClassRemove :: MonadIO m => ContainerClass -> m (Maybe ContainerClassRemoveFieldCallback)

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

get containerClass #remove

setContainerClassRemove :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassRemoveFieldCallback -> m ()

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

set containerClass [ #remove := value ]

setChildProperty

Set a property on a child of container.

clearContainerClassSetChildProperty :: MonadIO m => ContainerClass -> m ()

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

clear #setChildProperty

getContainerClassSetChildProperty :: MonadIO m => ContainerClass -> m (Maybe ContainerClassSetChildPropertyFieldCallback)

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

get containerClass #setChildProperty

setContainerClassSetChildProperty :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassSetChildPropertyFieldCallback -> m ()

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

set containerClass [ #setChildProperty := value ]

setFocusChild

Sets the focused child of container.

clearContainerClassSetFocusChild :: MonadIO m => ContainerClass -> m ()

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

clear #setFocusChild

getContainerClassSetFocusChild :: MonadIO m => ContainerClass -> m (Maybe ContainerClassSetFocusChildFieldCallback)

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

get containerClass #setFocusChild

setContainerClassSetFocusChild :: MonadIO m => ContainerClass -> FunPtr C_ContainerClassSetFocusChildFieldCallback -> m ()

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

set containerClass [ #setFocusChild := value ]