Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.CellAreaBox

Contents

Exported types
Methods
Properties
- spacing

Description

The CellAreaBox renders cell renderers into a row or a column depending on its Orientation.

GtkCellAreaBox uses a notion of packing. Packing refers to adding cell renderers with reference to a particular position in a CellAreaBox. There are two reference positions: the start and the end of the box. When the CellAreaBox is oriented in the OrientationVertical orientation, the start is defined as the top of the box and the end is defined as the bottom. In the OrientationHorizontal orientation start is defined as the left side and the end is defined as the right side.

Alignments of GtkCellRenderers rendered in adjacent rows can be configured by configuring the CellAreaBox align child cell property with cellAreaCellSetProperty or by specifying the "align" argument to cellAreaBoxPackStart and cellAreaBoxPackEnd.

Synopsis

newtype CellAreaBox = CellAreaBox (ManagedPtr CellAreaBox)
class GObject o => IsCellAreaBox o
toCellAreaBox :: (MonadIO m, IsCellAreaBox o) => o -> m CellAreaBox
noCellAreaBox :: Maybe CellAreaBox
cellAreaBoxGetSpacing :: (HasCallStack, MonadIO m, IsCellAreaBox a) => a -> m Int32
cellAreaBoxNew :: (HasCallStack, MonadIO m) => m CellAreaBox
cellAreaBoxPackEnd :: (HasCallStack, MonadIO m, IsCellAreaBox a, IsCellRenderer b) => a -> b -> Bool -> Bool -> Bool -> m ()
cellAreaBoxPackStart :: (HasCallStack, MonadIO m, IsCellAreaBox a, IsCellRenderer b) => a -> b -> Bool -> Bool -> Bool -> m ()
cellAreaBoxSetSpacing :: (HasCallStack, MonadIO m, IsCellAreaBox a) => a -> Int32 -> m ()
constructCellAreaBoxSpacing :: IsCellAreaBox o => Int32 -> IO (GValueConstruct o)
getCellAreaBoxSpacing :: (MonadIO m, IsCellAreaBox o) => o -> m Int32
setCellAreaBoxSpacing :: (MonadIO m, IsCellAreaBox o) => o -> Int32 -> m ()

Exported types

newtype CellAreaBox Source #

Memory-managed wrapper type.

Constructors

CellAreaBox (ManagedPtr CellAreaBox)

Instances

GObject CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox Methods gobjectType :: CellAreaBox -> IO GType #
IsObject CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox
IsBuildable CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox
IsCellLayout CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox
IsOrientable CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox
IsCellArea CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox
IsCellAreaBox CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox

class GObject o => IsCellAreaBox o Source #

Type class for types which can be safely cast to CellAreaBox, for instance with toCellAreaBox.

Instances

(GObject a, (UnknownAncestorError CellAreaBox a :: Constraint)) => IsCellAreaBox a Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox
IsCellAreaBox CellAreaBox Source #
Instance details Defined in GI.Gtk.Objects.CellAreaBox

toCellAreaBox :: (MonadIO m, IsCellAreaBox o) => o -> m CellAreaBox Source #

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

noCellAreaBox :: Maybe CellAreaBox Source #

A convenience alias for Nothing :: Maybe CellAreaBox.

Methods

getSpacing

cellAreaBoxGetSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellAreaBox a)
=> a	`box`: a `CellAreaBox`
-> m Int32	Returns: the space added between cell renderers in `box`.

Gets the spacing added between cell renderers.

Since: 3.0

new

cellAreaBoxNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m CellAreaBox	Returns: a newly created `CellAreaBox`

Creates a new CellAreaBox.

Since: 3.0

packEnd

cellAreaBoxPackEnd Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellAreaBox a, IsCellRenderer b)
=> a	`box`: a `CellAreaBox`
-> b	`renderer`: the `CellRenderer` to add
-> Bool	`expand`: whether `renderer` should receive extra space when the area receives more than its natural size
-> Bool	`align`: whether `renderer` should be aligned in adjacent rows
-> Bool	`fixed`: whether `renderer` should have the same size in all rows
-> m ()

Adds renderer to box, packed with reference to the end of box.

The renderer is packed after (away from end of) any other CellRenderer packed with reference to the end of box.

Since: 3.0

packStart

cellAreaBoxPackStart Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellAreaBox a, IsCellRenderer b)
=> a	`box`: a `CellAreaBox`
-> b	`renderer`: the `CellRenderer` to add
-> Bool	`expand`: whether `renderer` should receive extra space when the area receives more than its natural size
-> Bool	`align`: whether `renderer` should be aligned in adjacent rows
-> Bool	`fixed`: whether `renderer` should have the same size in all rows
-> m ()

Adds renderer to box, packed with reference to the start of box.

The renderer is packed after any other CellRenderer packed with reference to the start of box.

Since: 3.0

setSpacing

cellAreaBoxSetSpacing Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellAreaBox a)
=> a	`box`: a `CellAreaBox`
-> Int32	`spacing`: the space to add between `GtkCellRenderers`
-> m ()

Sets the spacing to add between cell renderers in box.

Since: 3.0

Properties

spacing

The amount of space to reserve between cells.

Since: 3.0

constructCellAreaBoxSpacing :: IsCellAreaBox o => Int32 -> IO (GValueConstruct o) Source #

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

getCellAreaBoxSpacing :: (MonadIO m, IsCellAreaBox o) => o -> m Int32 Source #

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

get cellAreaBox #spacing

setCellAreaBoxSpacing :: (MonadIO m, IsCellAreaBox o) => o -> Int32 -> m () Source #

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

set cellAreaBox [ #spacing := value ]