| Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
|---|---|
| License | LGPL-2.1 |
| Maintainer | Iñaki García Etxebarria |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
GI.Gtk.Objects.CellAreaBox
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, IsDescendantOf CellAreaBox o) => IsCellAreaBox o
- toCellAreaBox :: (MonadIO m, IsCellAreaBox o) => o -> m 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, MonadIO m) => Int32 -> m (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
| Eq CellAreaBox Source # | |
Defined in GI.Gtk.Objects.CellAreaBox | |
| GObject CellAreaBox Source # | |
Defined in GI.Gtk.Objects.CellAreaBox | |
| ManagedPtrNewtype CellAreaBox Source # | |
Defined in GI.Gtk.Objects.CellAreaBox Methods toManagedPtr :: CellAreaBox -> ManagedPtr CellAreaBox | |
| TypedObject CellAreaBox Source # | |
Defined in GI.Gtk.Objects.CellAreaBox | |
| HasParentTypes CellAreaBox Source # | |
Defined in GI.Gtk.Objects.CellAreaBox | |
| IsGValue (Maybe CellAreaBox) Source # | Convert |
Defined in GI.Gtk.Objects.CellAreaBox Methods gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe CellAreaBox -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe CellAreaBox) | |
| type ParentTypes CellAreaBox Source # | |
Defined in GI.Gtk.Objects.CellAreaBox | |
class (GObject o, IsDescendantOf CellAreaBox o) => IsCellAreaBox o Source #
Type class for types which can be safely cast to CellAreaBox, for instance with toCellAreaBox.
Instances
| (GObject o, IsDescendantOf CellAreaBox o) => IsCellAreaBox o Source # | |
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.
Methods
Click to display all available methods, including inherited ones
Methods
activate, activateCell, add, addAttribute, addChild, addFocusSibling, applyAttributes, attributeConnect, attributeDisconnect, attributeGetColumn, bindProperty, bindPropertyFull, cellGetProperty, cellSetProperty, clear, clearAttributes, constructChild, copyContext, createContext, customFinished, customTagEnd, customTagStart, event, focus, forceFloating, foreach, foreachAlloc, freezeNotify, getv, hasRenderer, innerCellArea, isActivatable, isFloating, isFocusSibling, notify, notifyByPspec, packEnd, packStart, parserFinished, ref, refSink, remove, removeFocusSibling, render, reorder, requestRenderer, runDispose, stealData, stealQdata, stopEditing, thawNotify, unref, watchClosure.
Getters
getArea, getCellAllocation, getCellAtPosition, getCells, getCurrentPathString, getData, getEditWidget, getEditedCell, getFocusCell, getFocusFromSibling, getFocusSiblings, getInternalChild, getName, getOrientation, getPreferredHeight, getPreferredHeightForWidth, getPreferredWidth, getPreferredWidthForHeight, getProperty, getQdata, getRequestMode, getSpacing.
Setters
setBuildableProperty, setCellDataFunc, setData, setDataFull, setFocusCell, setName, setOrientation, setProperty, setSpacing.
getSpacing
cellAreaBoxGetSpacing Source #
Arguments
| :: (HasCallStack, MonadIO m, IsCellAreaBox a) | |
| => a |
|
| -> m Int32 | Returns: the space added between cell renderers in |
Gets the spacing added between cell renderers.
Since: 3.0
new
Arguments
| :: (HasCallStack, MonadIO m) | |
| => m CellAreaBox | Returns: a newly created |
Creates a new CellAreaBox.
Since: 3.0
packEnd
Arguments
| :: (HasCallStack, MonadIO m, IsCellAreaBox a, IsCellRenderer b) | |
| => a |
|
| -> b |
|
| -> Bool |
|
| -> Bool |
|
| -> Bool |
|
| -> 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
Arguments
| :: (HasCallStack, MonadIO m, IsCellAreaBox a, IsCellRenderer b) | |
| => a |
|
| -> b |
|
| -> Bool |
|
| -> Bool |
|
| -> Bool |
|
| -> 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 |
|
| -> Int32 |
|
| -> 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, MonadIO m) => Int32 -> m (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
setcellAreaBox [ #spacing:=value ]