gi-gtk-3.0.43: Gtk bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Structs.ContainerClass

Description

Base class for containers.

Synopsis

Exported types

newZeroContainerClass :: MonadIO m => m ContainerClass Source #

Construct a ContainerClass struct initialized to zero.

Methods

Click to display all available methods, including inherited ones

Expand

Methods

findChildProperty, handleBorderWidth, installChildProperty.

Getters

None.

Setters

None.

findChildProperty

containerClassFindChildProperty Source #

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

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

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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 () Source #

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) Source #

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 () Source #

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

set containerClass [ #setFocusChild := value ]