CellAreaBox

A cell area that renders GtkCellRenderers into a row or a column

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

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

Alignments of gtk.cell_renderer.CellRenderers rendered in adjacent rows can be configured by configuring the gtk.cell_area_box.CellAreaBox align child cell property with gtk.cell_area.CellArea.cellSetProperty or by specifying the "align" argument to gtk.cell_area_box.CellAreaBox.packStart and gtk.cell_area_box.CellAreaBox.packEnd.

More...

Constructors

this
this()

Creates a new gtk.cell_area_box.CellAreaBox.

Members

Functions

getSpacing
int getSpacing()

Gets the spacing added between cell renderers.

packEnd
void packEnd(gtk.cell_renderer.CellRenderer renderer, bool expand, bool align_, bool fixed)

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

packStart
void packStart(gtk.cell_renderer.CellRenderer renderer, bool expand, bool align_, bool fixed)

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

setSpacing
void setSpacing(int spacing)

Sets the spacing to add between cell renderers in box.

Mixed In Members

From mixin OrientableT!()

getOrientation
gtk.types.Orientation getOrientation()

Retrieves the orientation of the orientable.

setOrientation
void setOrientation(gtk.types.Orientation orientation)

Sets the orientation of the orientable.

Inherited Members

From CellArea

activate
bool activate(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags, bool editOnly)

Activates area, usually by activating the currently focused cell, however some subclasses which embed widgets in the area can also activate a widget if it currently has the focus.

activateCell
bool activateCell(gtk.widget.Widget widget, gtk.cell_renderer.CellRenderer renderer, gdk.event.Event event, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags)

This is used by gtk.cell_area.CellArea subclasses when handling events to activate cells, the base gtk.cell_area.CellArea class activates cells for keyboard events for free in its own GtkCellArea->activate() implementation.

add
void add(gtk.cell_renderer.CellRenderer renderer)

Adds renderer to area with the default child cell properties.

addFocusSibling
void addFocusSibling(gtk.cell_renderer.CellRenderer renderer, gtk.cell_renderer.CellRenderer sibling)

Adds sibling to renderer’s focusable area, focus will be drawn around renderer and all of its siblings if renderer can focus for a given row.

applyAttributes
void applyAttributes(gtk.tree_model.TreeModel treeModel, gtk.tree_iter.TreeIter iter, bool isExpander, bool isExpanded)

Applies any connected attributes to the renderers in area by pulling the values from tree_model.

attributeConnect
void attributeConnect(gtk.cell_renderer.CellRenderer renderer, string attribute, int column)

Connects an attribute to apply values from column for the gtk.tree_model.TreeModel in use.

attributeDisconnect
void attributeDisconnect(gtk.cell_renderer.CellRenderer renderer, string attribute)

Disconnects attribute for the renderer in area so that attribute will no longer be updated with values from the model.

attributeGetColumn
int attributeGetColumn(gtk.cell_renderer.CellRenderer renderer, string attribute)

Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped.

cellGetProperty
void cellGetProperty(gtk.cell_renderer.CellRenderer renderer, string propertyName, gobject.value.Value value)

Gets the value of a cell property for renderer in area.

cellSetProperty
void cellSetProperty(gtk.cell_renderer.CellRenderer renderer, string propertyName, gobject.value.Value value)

Sets a cell property for renderer in area.

copyContext
gtk.cell_area_context.CellAreaContext copyContext(gtk.cell_area_context.CellAreaContext context)

This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation.

createContext
gtk.cell_area_context.CellAreaContext createContext()

Creates a gtk.cell_area.CellAreaContext to be used with area for all purposes. gtk.cell_area.CellAreaContext stores geometry information for rows for which it was operated on, it is important to use the same context for the same row of data at all times (i.e. one should render and handle events with the same gtk.cell_area.CellAreaContext which was used to request the size of those rows of data).

event
int event(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, gdk.event.Event event, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags)

Delegates event handling to a gtk.cell_area.CellArea.

focus
bool focus(gtk.types.DirectionType direction)

This should be called by the area’s owning layout widget when focus is to be passed to area, or moved within area for a given direction and row data.

foreach_
void foreach_(gtk.types.CellCallback callback)

Calls callback for every gtk.cell_renderer.CellRenderer in area.

foreachAlloc
void foreachAlloc(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, gdk.rectangle.Rectangle cellArea, gdk.rectangle.Rectangle backgroundArea, gtk.types.CellAllocCallback callback)

Calls callback for every gtk.cell_renderer.CellRenderer in area with the allocated rectangle inside cell_area.

getCellAllocation
void getCellAllocation(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, gtk.cell_renderer.CellRenderer renderer, gdk.rectangle.Rectangle cellArea, gdk.rectangle.Rectangle allocation)

Derives the allocation of renderer inside area if area were to be rendered in cell_area.

getCellAtPosition
gtk.cell_renderer.CellRenderer getCellAtPosition(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, gdk.rectangle.Rectangle cellArea, int x, int y, gdk.rectangle.Rectangle allocArea)

Gets the gtk.cell_renderer.CellRenderer at x and y coordinates inside area and optionally returns the full cell allocation for it inside cell_area.

getCurrentPathString
string getCurrentPathString()

Gets the current gtk.tree_path.TreePath string for the currently applied gtk.tree_iter.TreeIter, this is implicitly updated when gtk.cell_area.CellArea.applyAttributes is called and can be used to interact with renderers from gtk.cell_area.CellArea subclasses.

getEditWidget
gtk.cell_editable.CellEditable getEditWidget()

Gets the gtk.cell_editable.CellEditable widget currently used to edit the currently edited cell.

getEditedCell
gtk.cell_renderer.CellRenderer getEditedCell()

Gets the gtk.cell_renderer.CellRenderer in area that is currently being edited.

getFocusCell
gtk.cell_renderer.CellRenderer getFocusCell()

Retrieves the currently focused cell for area

getFocusFromSibling
gtk.cell_renderer.CellRenderer getFocusFromSibling(gtk.cell_renderer.CellRenderer renderer)

Gets the gtk.cell_renderer.CellRenderer which is expected to be focusable for which renderer is, or may be a sibling.

getFocusSiblings
gtk.cell_renderer.CellRenderer[] getFocusSiblings(gtk.cell_renderer.CellRenderer renderer)

Gets the focus sibling cell renderers for renderer.

getPreferredHeight
void getPreferredHeight(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, int minimumHeight, int naturalHeight)

Retrieves a cell area’s initial minimum and natural height.

getPreferredHeightForWidth
void getPreferredHeightForWidth(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, int width, int minimumHeight, int naturalHeight)

Retrieves a cell area’s minimum and natural height if it would be given the specified width.

getPreferredWidth
void getPreferredWidth(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, int minimumWidth, int naturalWidth)

Retrieves a cell area’s initial minimum and natural width.

getPreferredWidthForHeight
void getPreferredWidthForHeight(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, int height, int minimumWidth, int naturalWidth)

Retrieves a cell area’s minimum and natural width if it would be given the specified height.

getRequestMode
gtk.types.SizeRequestMode getRequestMode()

Gets whether the area prefers a height-for-width layout or a width-for-height layout.

hasRenderer
bool hasRenderer(gtk.cell_renderer.CellRenderer renderer)

Checks if area contains renderer.

innerCellArea
void innerCellArea(gtk.widget.Widget widget, gdk.rectangle.Rectangle cellArea, gdk.rectangle.Rectangle innerArea)

This is a convenience function for gtk.cell_area.CellArea implementations to get the inner area where a given gtk.cell_renderer.CellRenderer will be rendered. It removes any padding previously added by gtk.cell_area.CellArea.requestRenderer.

isActivatable
bool isActivatable()

Returns whether the area can do anything when activated, after applying new attributes to area.

isFocusSibling
bool isFocusSibling(gtk.cell_renderer.CellRenderer renderer, gtk.cell_renderer.CellRenderer sibling)

Returns whether sibling is one of renderer’s focus siblings (see gtk.cell_area.CellArea.addFocusSibling).

remove
void remove(gtk.cell_renderer.CellRenderer renderer)

Removes renderer from area.

removeFocusSibling
void removeFocusSibling(gtk.cell_renderer.CellRenderer renderer, gtk.cell_renderer.CellRenderer sibling)

Removes sibling from renderer’s focus sibling list (see gtk.cell_area.CellArea.addFocusSibling).

requestRenderer
void requestRenderer(gtk.cell_renderer.CellRenderer renderer, gtk.types.Orientation orientation, gtk.widget.Widget widget, int forSize, int minimumSize, int naturalSize)

This is a convenience function for gtk.cell_area.CellArea implementations to request size for cell renderers. It’s important to use this function to request size and then use gtk.cell_area.CellArea.innerCellArea at render and event time since this function will add padding around the cell for focus painting.

setFocusCell
void setFocusCell(gtk.cell_renderer.CellRenderer renderer)

Explicitly sets the currently focused cell to renderer.

snapshot
void snapshot(gtk.cell_area_context.CellAreaContext context, gtk.widget.Widget widget, gtk.snapshot.Snapshot snapshot, gdk.rectangle.Rectangle backgroundArea, gdk.rectangle.Rectangle cellArea, gtk.types.CellRendererState flags, bool paintFocus)

Snapshots area’s cells according to area’s layout onto at the given coordinates.

stopEditing
void stopEditing(bool canceled)

Explicitly stops the editing of the currently edited cell.

connectAddEditable
ulong connectAddEditable(T callback, Flag!"After" after)

Connect to AddEditable signal.

connectApplyAttributes
ulong connectApplyAttributes(T callback, Flag!"After" after)

Connect to ApplyAttributes signal.

connectFocusChanged
ulong connectFocusChanged(T callback, Flag!"After" after)

Connect to FocusChanged signal.

connectRemoveEditable
ulong connectRemoveEditable(T callback, Flag!"After" after)

Connect to RemoveEditable signal.

From Orientable

getOrientation
gtk.types.Orientation getOrientation()

Retrieves the orientation of the orientable.

setOrientation
void setOrientation(gtk.types.Orientation orientation)

Sets the orientation of the orientable.

Detailed Description

Deprecated: List views use widgets for displaying their contents