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 |
- Exported types
- Methods
- activate
- activateCell
- add
- addFocusSibling
- applyAttributes
- attributeConnect
- attributeDisconnect
- attributeGetColumn
- cellGetProperty
- cellSetProperty
- copyContext
- createContext
- event
- focus
- foreach
- foreachAlloc
- getCellAllocation
- getCellAtPosition
- getCurrentPathString
- getEditWidget
- getEditedCell
- getFocusCell
- getFocusFromSibling
- getFocusSiblings
- getPreferredHeight
- getPreferredHeightForWidth
- getPreferredWidth
- getPreferredWidthForHeight
- getRequestMode
- hasRenderer
- innerCellArea
- isActivatable
- isFocusSibling
- remove
- removeFocusSibling
- render
- requestRenderer
- setFocusCell
- stopEditing
- Properties
- Signals
The CellArea
is an abstract class for CellLayout
widgets
(also referred to as "layouting widgets") to interface with an
arbitrary number of GtkCellRenderers
and interact with the user
for a given TreeModel
row.
The cell area handles events, focus navigation, drawing and size requests and allocations for a given row of data.
Usually users dont have to interact with the CellArea
directly
unless they are implementing a cell-layouting widget themselves.
Requesting area sizes
As outlined in
[GtkWidget’s geometry management section][geometry-management],
GTK+ uses a height-for-width
geometry management system to compute the sizes of widgets and user
interfaces. CellArea
uses the same semantics to calculate the
size of an area for an arbitrary number of TreeModel
rows.
When requesting the size of a cell area one needs to calculate
the size for a handful of rows, and this will be done differently by
different layouting widgets. For instance a TreeViewColumn
always lines up the areas from top to bottom while a IconView
on the other hand might enforce that all areas received the same
width and wrap the areas around, requesting height for more cell
areas when allocated less width.
It’s also important for areas to maintain some cell
alignments with areas rendered for adjacent rows (cells can
appear “columnized” inside an area even when the size of
cells are different in each row). For this reason the CellArea
uses a CellAreaContext
object to store the alignments
and sizes along the way (as well as the overall largest minimum
and natural size for all the rows which have been calculated
with the said context).
The CellAreaContext
is an opaque object specific to the
CellArea
which created it (see cellAreaCreateContext
).
The owning cell-layouting widget can create as many contexts as
it wishes to calculate sizes of rows which should receive the
same size in at least one orientation (horizontally or vertically),
However, it’s important that the same CellAreaContext
which
was used to request the sizes for a given TreeModel
row be
used when rendering or processing events for that row.
In order to request the width of all the rows at the root level
of a TreeModel
one would do the following:
C code
GtkTreeIter iter; gint minimum_width; gint natural_width; valid = gtk_tree_model_get_iter_first (model, &iter); while (valid) { gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE); gtk_cell_area_get_preferred_width (area, context, widget, NULL, NULL); valid = gtk_tree_model_iter_next (model, &iter); } gtk_cell_area_context_get_preferred_width (context, &minimum_width, &natural_width);
Note that in this example it’s not important to observe the
returned minimum and natural width of the area for each row
unless the cell-layouting object is actually interested in the
widths of individual rows. The overall width is however stored
in the accompanying CellAreaContext
object and can be consulted
at any time.
This can be useful since CellLayout
widgets usually have to
support requesting and rendering rows in treemodels with an
exceedingly large amount of rows. The CellLayout
widget in
that case would calculate the required width of the rows in an
idle or timeout source (see g_timeout_add()
) and when the widget
is requested its actual width in WidgetClass
.get_preferred_width
()
it can simply consult the width accumulated so far in the
CellAreaContext
object.
A simple example where rows are rendered from top to bottom and take up the full width of the layouting widget would look like:
C code
static void foo_get_preferred_width (GtkWidget *widget, gint *minimum_size, gint *natural_size) { Foo *foo = FOO (widget); FooPrivate *priv = foo->priv; foo_ensure_at_least_one_handfull_of_rows_have_been_requested (foo); gtk_cell_area_context_get_preferred_width (priv->context, minimum_size, natural_size); }
In the above example the Foo widget has to make sure that some
row sizes have been calculated (the amount of rows that Foo judged
was appropriate to request space for in a single timeout iteration)
before simply returning the amount of space required by the area via
the CellAreaContext
.
Requesting the height for width (or width for height) of an area is
a similar task except in this case the CellAreaContext
does not
store the data (actually, it does not know how much space the layouting
widget plans to allocate it for every row. It’s up to the layouting
widget to render each row of data with the appropriate height and
width which was requested by the CellArea
).
In order to request the height for width of all the rows at the
root level of a TreeModel
one would do the following:
C code
GtkTreeIter iter; gint minimum_height; gint natural_height; gint full_minimum_height = 0; gint full_natural_height = 0; valid = gtk_tree_model_get_iter_first (model, &iter); while (valid) { gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE); gtk_cell_area_get_preferred_height_for_width (area, context, widget, width, &minimum_height, &natural_height); if (width_is_for_allocation) cache_row_height (&iter, minimum_height, natural_height); full_minimum_height += minimum_height; full_natural_height += natural_height; valid = gtk_tree_model_iter_next (model, &iter); }
Note that in the above example we would need to cache the heights returned for each row so that we would know what sizes to render the areas for each row. However we would only want to really cache the heights if the request is intended for the layouting widgets real allocation.
In some cases the layouting widget is requested the height for an
arbitrary for_width, this is a special case for layouting widgets
who need to request size for tens of thousands of rows. For this
case it’s only important that the layouting widget calculate
one reasonably sized chunk of rows and return that height
synchronously. The reasoning here is that any layouting widget is
at least capable of synchronously calculating enough height to fill
the screen height (or scrolled window height) in response to a single
call to WidgetClass
.get_preferred_height_for_width
(). Returning
a perfect height for width that is larger than the screen area is
inconsequential since after the layouting receives an allocation
from a scrolled window it simply continues to drive the scrollbar
values while more and more height is required for the row heights
that are calculated in the background.
Rendering Areas
Once area sizes have been aquired at least for the rows in the
visible area of the layouting widget they can be rendered at
WidgetClass
.draw
() time.
A crude example of how to render all the rows at the root level runs as follows:
C code
GtkAllocation allocation; GdkRectangle cell_area = { 0, }; GtkTreeIter iter; gint minimum_width; gint natural_width; gtk_widget_get_allocation (widget, &allocation); cell_area.width = allocation.width; valid = gtk_tree_model_get_iter_first (model, &iter); while (valid) { cell_area.height = get_cached_height_for_row (&iter); gtk_cell_area_apply_attributes (area, model, &iter, FALSE, FALSE); gtk_cell_area_render (area, context, widget, cr, &cell_area, &cell_area, state_flags, FALSE); cell_area.y += cell_area.height; valid = gtk_tree_model_iter_next (model, &iter); }
Note that the cached height in this example really depends on how
the layouting widget works. The layouting widget might decide to
give every row its minimum or natural height or, if the model content
is expected to fit inside the layouting widget without scrolling, it
would make sense to calculate the allocation for each row at
Widget
::size-allocate
time using distributeNaturalAllocation
.
Handling Events and Driving Keyboard Focus
Passing events to the area is as simple as handling events on any
normal widget and then passing them to the cellAreaEvent
API as they come in. Usually CellArea
is only interested in
button events, however some customized derived areas can be implemented
who are interested in handling other events. Handling an event can
trigger the CellArea
::focus-changed
signal to fire; as well as
CellArea
::add-editable
in the case that an editable cell was
clicked and needs to start editing. You can call
cellAreaStopEditing
at any time to cancel any cell editing
that is currently in progress.
The CellArea
drives keyboard focus from cell to cell in a way
similar to Widget
. For layouting widgets that support giving
focus to cells it’s important to remember to pass CellRendererStateFocused
to the area functions for the row that has focus and to tell the
area to paint the focus at render time.
Layouting widgets that accept focus on cells should implement the
WidgetClass
.focus
() virtual method. The layouting widget is always
responsible for knowing where TreeModel
rows are rendered inside
the widget, so at WidgetClass
.focus
() time the layouting widget
should use the CellArea
methods to navigate focus inside the area
and then observe the GtkDirectionType to pass the focus to adjacent
rows and areas.
A basic example of how the WidgetClass
.focus
() virtual method
should be implemented:
C code
static gboolean foo_focus (GtkWidget *widget, GtkDirectionType direction) { Foo *foo = FOO (widget); FooPrivate *priv = foo->priv; gint focus_row; gboolean have_focus = FALSE; focus_row = priv->focus_row; if (!gtk_widget_has_focus (widget)) gtk_widget_grab_focus (widget); valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, priv->focus_row); while (valid) { gtk_cell_area_apply_attributes (priv->area, priv->model, &iter, FALSE, FALSE); if (gtk_cell_area_focus (priv->area, direction)) { priv->focus_row = focus_row; have_focus = TRUE; break; } else { if (direction == GTK_DIR_RIGHT || direction == GTK_DIR_LEFT) break; else if (direction == GTK_DIR_UP || direction == GTK_DIR_TAB_BACKWARD) { if (focus_row == 0) break; else { focus_row--; valid = gtk_tree_model_iter_nth_child (priv->model, &iter, NULL, focus_row); } } else { if (focus_row == last_row) break; else { focus_row++; valid = gtk_tree_model_iter_next (priv->model, &iter); } } } } return have_focus; }
Note that the layouting widget is responsible for matching the GtkDirectionType values to the way it lays out its cells.
Cell Properties
The CellArea
introduces cell properties for GtkCellRenderers
in very much the same way that Container
introduces
[child properties][child-properties]
for GtkWidgets
. This provides some general interfaces for defining
the relationship cell areas have with their cells. For instance in a
CellAreaBox
a cell might “expand” and receive extra space when
the area is allocated more than its full natural request, or a cell
might be configured to “align” with adjacent rows which were requested
and rendered with the same CellAreaContext
.
Use cellAreaClassInstallCellProperty
to install cell
properties for a cell area class and cellAreaClassFindCellProperty
or cellAreaClassListCellProperties
to get information about
existing cell properties.
To set the value of a cell property, use cellAreaCellSetProperty
,
gtk_cell_area_cell_set()
or gtk_cell_area_cell_set_valist()
. To obtain
the value of a cell property, use cellAreaCellGetProperty
,
gtk_cell_area_cell_get()
or gtk_cell_area_cell_get_valist()
.
- newtype CellArea = CellArea (ManagedPtr CellArea)
- class GObject o => IsCellArea o
- toCellArea :: IsCellArea o => o -> IO CellArea
- noCellArea :: Maybe CellArea
- data CellAreaActivateMethodInfo
- cellAreaActivate :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> Rectangle -> [CellRendererState] -> Bool -> m Bool
- data CellAreaActivateCellMethodInfo
- cellAreaActivateCell :: (HasCallStack, MonadIO m, IsCellArea a, IsWidget b, IsCellRenderer c) => a -> b -> c -> Event -> Rectangle -> [CellRendererState] -> m Bool
- data CellAreaAddMethodInfo
- cellAreaAdd :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> m ()
- data CellAreaAddFocusSiblingMethodInfo
- cellAreaAddFocusSibling :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) => a -> b -> c -> m ()
- data CellAreaApplyAttributesMethodInfo
- cellAreaApplyAttributes :: (HasCallStack, MonadIO m, IsCellArea a, IsTreeModel b) => a -> b -> TreeIter -> Bool -> Bool -> m ()
- data CellAreaAttributeConnectMethodInfo
- cellAreaAttributeConnect :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> Text -> Int32 -> m ()
- data CellAreaAttributeDisconnectMethodInfo
- cellAreaAttributeDisconnect :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> Text -> m ()
- data CellAreaAttributeGetColumnMethodInfo
- cellAreaAttributeGetColumn :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> Text -> m Int32
- data CellAreaCellGetPropertyMethodInfo
- cellAreaCellGetProperty :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> Text -> GValue -> m ()
- data CellAreaCellSetPropertyMethodInfo
- cellAreaCellSetProperty :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> Text -> GValue -> m ()
- data CellAreaCopyContextMethodInfo
- cellAreaCopyContext :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b) => a -> b -> m CellAreaContext
- data CellAreaCreateContextMethodInfo
- cellAreaCreateContext :: (HasCallStack, MonadIO m, IsCellArea a) => a -> m CellAreaContext
- data CellAreaEventMethodInfo
- cellAreaEvent :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> Event -> Rectangle -> [CellRendererState] -> m Int32
- data CellAreaFocusMethodInfo
- cellAreaFocus :: (HasCallStack, MonadIO m, IsCellArea a) => a -> DirectionType -> m Bool
- data CellAreaForeachMethodInfo
- cellAreaForeach :: (HasCallStack, MonadIO m, IsCellArea a) => a -> CellCallback -> m ()
- data CellAreaForeachAllocMethodInfo
- cellAreaForeachAlloc :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> Rectangle -> Rectangle -> CellAllocCallback -> m ()
- data CellAreaGetCellAllocationMethodInfo
- cellAreaGetCellAllocation :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c, IsCellRenderer d) => a -> b -> c -> d -> Rectangle -> m Rectangle
- data CellAreaGetCellAtPositionMethodInfo
- cellAreaGetCellAtPosition :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> Rectangle -> Int32 -> Int32 -> m (CellRenderer, Rectangle)
- data CellAreaGetCurrentPathStringMethodInfo
- cellAreaGetCurrentPathString :: (HasCallStack, MonadIO m, IsCellArea a) => a -> m Text
- data CellAreaGetEditWidgetMethodInfo
- cellAreaGetEditWidget :: (HasCallStack, MonadIO m, IsCellArea a) => a -> m CellEditable
- data CellAreaGetEditedCellMethodInfo
- cellAreaGetEditedCell :: (HasCallStack, MonadIO m, IsCellArea a) => a -> m CellRenderer
- data CellAreaGetFocusCellMethodInfo
- cellAreaGetFocusCell :: (HasCallStack, MonadIO m, IsCellArea a) => a -> m CellRenderer
- data CellAreaGetFocusFromSiblingMethodInfo
- cellAreaGetFocusFromSibling :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> m (Maybe CellRenderer)
- data CellAreaGetFocusSiblingsMethodInfo
- cellAreaGetFocusSiblings :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> m [CellRenderer]
- data CellAreaGetPreferredHeightMethodInfo
- cellAreaGetPreferredHeight :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> m (Int32, Int32)
- data CellAreaGetPreferredHeightForWidthMethodInfo
- cellAreaGetPreferredHeightForWidth :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> Int32 -> m (Int32, Int32)
- data CellAreaGetPreferredWidthMethodInfo
- cellAreaGetPreferredWidth :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> m (Int32, Int32)
- data CellAreaGetPreferredWidthForHeightMethodInfo
- cellAreaGetPreferredWidthForHeight :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> Int32 -> m (Int32, Int32)
- data CellAreaGetRequestModeMethodInfo
- cellAreaGetRequestMode :: (HasCallStack, MonadIO m, IsCellArea a) => a -> m SizeRequestMode
- data CellAreaHasRendererMethodInfo
- cellAreaHasRenderer :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> m Bool
- data CellAreaInnerCellAreaMethodInfo
- cellAreaInnerCellArea :: (HasCallStack, MonadIO m, IsCellArea a, IsWidget b) => a -> b -> Rectangle -> m Rectangle
- data CellAreaIsActivatableMethodInfo
- cellAreaIsActivatable :: (HasCallStack, MonadIO m, IsCellArea a) => a -> m Bool
- data CellAreaIsFocusSiblingMethodInfo
- cellAreaIsFocusSibling :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) => a -> b -> c -> m Bool
- data CellAreaRemoveMethodInfo
- cellAreaRemove :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> m ()
- data CellAreaRemoveFocusSiblingMethodInfo
- cellAreaRemoveFocusSibling :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) => a -> b -> c -> m ()
- data CellAreaRenderMethodInfo
- cellAreaRender :: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => a -> b -> c -> Context -> Rectangle -> Rectangle -> [CellRendererState] -> Bool -> m ()
- data CellAreaRequestRendererMethodInfo
- cellAreaRequestRenderer :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsWidget c) => a -> b -> Orientation -> c -> Int32 -> m (Int32, Int32)
- data CellAreaSetFocusCellMethodInfo
- cellAreaSetFocusCell :: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) => a -> b -> m ()
- data CellAreaStopEditingMethodInfo
- cellAreaStopEditing :: (HasCallStack, MonadIO m, IsCellArea a) => a -> Bool -> m ()
- data CellAreaEditWidgetPropertyInfo
- cellAreaEditWidget :: AttrLabelProxy "editWidget"
- getCellAreaEditWidget :: (MonadIO m, IsCellArea o) => o -> m CellEditable
- data CellAreaEditedCellPropertyInfo
- cellAreaEditedCell :: AttrLabelProxy "editedCell"
- getCellAreaEditedCell :: (MonadIO m, IsCellArea o) => o -> m CellRenderer
- data CellAreaFocusCellPropertyInfo
- cellAreaFocusCell :: AttrLabelProxy "focusCell"
- constructCellAreaFocusCell :: (IsCellArea o, IsCellRenderer a) => a -> IO (GValueConstruct o)
- getCellAreaFocusCell :: (MonadIO m, IsCellArea o) => o -> m CellRenderer
- setCellAreaFocusCell :: (MonadIO m, IsCellArea o, IsCellRenderer a) => o -> a -> m ()
- type C_CellAreaAddEditableCallback = Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr Rectangle -> CString -> Ptr () -> IO ()
- type CellAreaAddEditableCallback = CellRenderer -> CellEditable -> Rectangle -> Text -> IO ()
- data CellAreaAddEditableSignalInfo
- afterCellAreaAddEditable :: (GObject a, MonadIO m) => a -> CellAreaAddEditableCallback -> m SignalHandlerId
- genClosure_CellAreaAddEditable :: CellAreaAddEditableCallback -> IO Closure
- mk_CellAreaAddEditableCallback :: C_CellAreaAddEditableCallback -> IO (FunPtr C_CellAreaAddEditableCallback)
- noCellAreaAddEditableCallback :: Maybe CellAreaAddEditableCallback
- onCellAreaAddEditable :: (GObject a, MonadIO m) => a -> CellAreaAddEditableCallback -> m SignalHandlerId
- wrap_CellAreaAddEditableCallback :: CellAreaAddEditableCallback -> Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr Rectangle -> CString -> Ptr () -> IO ()
- type C_CellAreaApplyAttributesCallback = Ptr () -> Ptr TreeModel -> Ptr TreeIter -> CInt -> CInt -> Ptr () -> IO ()
- type CellAreaApplyAttributesCallback = TreeModel -> TreeIter -> Bool -> Bool -> IO ()
- data CellAreaApplyAttributesSignalInfo
- afterCellAreaApplyAttributes :: (GObject a, MonadIO m) => a -> CellAreaApplyAttributesCallback -> m SignalHandlerId
- genClosure_CellAreaApplyAttributes :: CellAreaApplyAttributesCallback -> IO Closure
- mk_CellAreaApplyAttributesCallback :: C_CellAreaApplyAttributesCallback -> IO (FunPtr C_CellAreaApplyAttributesCallback)
- noCellAreaApplyAttributesCallback :: Maybe CellAreaApplyAttributesCallback
- onCellAreaApplyAttributes :: (GObject a, MonadIO m) => a -> CellAreaApplyAttributesCallback -> m SignalHandlerId
- wrap_CellAreaApplyAttributesCallback :: CellAreaApplyAttributesCallback -> Ptr () -> Ptr TreeModel -> Ptr TreeIter -> CInt -> CInt -> Ptr () -> IO ()
- type C_CellAreaFocusChangedCallback = Ptr () -> Ptr CellRenderer -> CString -> Ptr () -> IO ()
- type CellAreaFocusChangedCallback = CellRenderer -> Text -> IO ()
- data CellAreaFocusChangedSignalInfo
- afterCellAreaFocusChanged :: (GObject a, MonadIO m) => a -> CellAreaFocusChangedCallback -> m SignalHandlerId
- genClosure_CellAreaFocusChanged :: CellAreaFocusChangedCallback -> IO Closure
- mk_CellAreaFocusChangedCallback :: C_CellAreaFocusChangedCallback -> IO (FunPtr C_CellAreaFocusChangedCallback)
- noCellAreaFocusChangedCallback :: Maybe CellAreaFocusChangedCallback
- onCellAreaFocusChanged :: (GObject a, MonadIO m) => a -> CellAreaFocusChangedCallback -> m SignalHandlerId
- wrap_CellAreaFocusChangedCallback :: CellAreaFocusChangedCallback -> Ptr () -> Ptr CellRenderer -> CString -> Ptr () -> IO ()
- type C_CellAreaRemoveEditableCallback = Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr () -> IO ()
- type CellAreaRemoveEditableCallback = CellRenderer -> CellEditable -> IO ()
- data CellAreaRemoveEditableSignalInfo
- afterCellAreaRemoveEditable :: (GObject a, MonadIO m) => a -> CellAreaRemoveEditableCallback -> m SignalHandlerId
- genClosure_CellAreaRemoveEditable :: CellAreaRemoveEditableCallback -> IO Closure
- mk_CellAreaRemoveEditableCallback :: C_CellAreaRemoveEditableCallback -> IO (FunPtr C_CellAreaRemoveEditableCallback)
- noCellAreaRemoveEditableCallback :: Maybe CellAreaRemoveEditableCallback
- onCellAreaRemoveEditable :: (GObject a, MonadIO m) => a -> CellAreaRemoveEditableCallback -> m SignalHandlerId
- wrap_CellAreaRemoveEditableCallback :: CellAreaRemoveEditableCallback -> Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr () -> IO ()
Exported types
GObject CellArea Source # | |
IsObject CellArea Source # | |
IsCellArea CellArea Source # | |
IsCellLayout CellArea Source # | |
IsBuildable CellArea Source # | |
((~) * info (ResolveCellAreaMethod t CellArea), MethodInfo * info CellArea p) => IsLabel t (CellArea -> p) Source # | |
((~) * info (ResolveCellAreaMethod t CellArea), MethodInfo * info CellArea p) => IsLabelProxy t (CellArea -> p) Source # | |
HasAttributeList * CellArea Source # | |
type AttributeList CellArea Source # | |
type SignalList CellArea Source # | |
class GObject o => IsCellArea o Source #
toCellArea :: IsCellArea o => o -> IO CellArea Source #
Methods
activate
data CellAreaActivateMethodInfo Source #
((~) * signature (b -> c -> Rectangle -> [CellRendererState] -> Bool -> m Bool), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaActivateMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> Rectangle |
|
-> [CellRendererState] |
|
-> Bool |
|
-> m Bool | Returns: Whether |
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.
Since: 3.0
activateCell
data CellAreaActivateCellMethodInfo Source #
((~) * signature (b -> c -> Event -> Rectangle -> [CellRendererState] -> m Bool), MonadIO m, IsCellArea a, IsWidget b, IsCellRenderer c) => MethodInfo * CellAreaActivateCellMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsWidget b, IsCellRenderer c) | |
=> a |
|
-> b |
|
-> c |
|
-> Event |
|
-> Rectangle |
|
-> [CellRendererState] |
|
-> m Bool | Returns: whether cell activation was successful |
add
data CellAreaAddMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaAddMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> m () |
Adds renderer
to area
with the default child cell properties.
Since: 3.0
addFocusSibling
data CellAreaAddFocusSiblingMethodInfo Source #
((~) * signature (b -> c -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) => MethodInfo * CellAreaAddFocusSiblingMethodInfo a signature Source # | |
cellAreaAddFocusSibling Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) | |
=> a |
|
-> b |
|
-> c |
|
-> m () |
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.
Events handled by focus siblings can also activate the given
focusable renderer
.
Since: 3.0
applyAttributes
data CellAreaApplyAttributesMethodInfo Source #
((~) * signature (b -> TreeIter -> Bool -> Bool -> m ()), MonadIO m, IsCellArea a, IsTreeModel b) => MethodInfo * CellAreaApplyAttributesMethodInfo a signature Source # | |
cellAreaApplyAttributes Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsTreeModel b) | |
=> a |
|
-> b |
|
-> TreeIter |
|
-> Bool |
|
-> Bool |
|
-> m () |
Applies any connected attributes to the renderers in
area
by pulling the values from treeModel
.
Since: 3.0
attributeConnect
data CellAreaAttributeConnectMethodInfo Source #
((~) * signature (b -> Text -> Int32 -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaAttributeConnectMethodInfo a signature Source # | |
cellAreaAttributeConnect Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> Text |
|
-> Int32 |
|
-> m () |
Connects an attribute
to apply values from column
for the
TreeModel
in use.
Since: 3.0
attributeDisconnect
data CellAreaAttributeDisconnectMethodInfo Source #
((~) * signature (b -> Text -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaAttributeDisconnectMethodInfo a signature Source # | |
cellAreaAttributeDisconnect Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> Text |
|
-> m () |
Disconnects attribute
for the renderer
in area
so that
attribute will no longer be updated with values from the
model.
Since: 3.0
attributeGetColumn
data CellAreaAttributeGetColumnMethodInfo Source #
((~) * signature (b -> Text -> m Int32), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaAttributeGetColumnMethodInfo a signature Source # | |
cellAreaAttributeGetColumn Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> Text |
|
-> m Int32 | Returns: the model column, or -1 |
Returns the model column that an attribute has been mapped to, or -1 if the attribute is not mapped.
Since: 3.14
cellGetProperty
data CellAreaCellGetPropertyMethodInfo Source #
((~) * signature (b -> Text -> GValue -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaCellGetPropertyMethodInfo a signature Source # | |
cellAreaCellGetProperty Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> Text |
|
-> GValue |
|
-> m () |
Gets the value of a cell property for renderer
in area
.
Since: 3.0
cellSetProperty
data CellAreaCellSetPropertyMethodInfo Source #
((~) * signature (b -> Text -> GValue -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaCellSetPropertyMethodInfo a signature Source # | |
cellAreaCellSetProperty Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> Text |
|
-> GValue |
|
-> m () |
Sets a cell property for renderer
in area
.
Since: 3.0
copyContext
data CellAreaCopyContextMethodInfo Source #
((~) * signature (b -> m CellAreaContext), MonadIO m, IsCellArea a, IsCellAreaContext b) => MethodInfo * CellAreaCopyContextMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b) | |
=> a |
|
-> b |
|
-> m CellAreaContext | Returns: a newly created |
This is sometimes needed for cases where rows need to share alignments in one orientation but may be separately grouped in the opposing orientation.
For instance, IconView
creates all icons (rows) to have
the same width and the cells theirin to have the same
horizontal alignments. However each row of icons may have
a separate collective height. IconView
uses this to
request the heights of each row based on a context which
was already used to request all the row widths that are
to be displayed.
Since: 3.0
createContext
data CellAreaCreateContextMethodInfo Source #
((~) * signature (m CellAreaContext), MonadIO m, IsCellArea a) => MethodInfo * CellAreaCreateContextMethodInfo a signature Source # | |
cellAreaCreateContext Source #
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> m CellAreaContext | Returns: a newly created |
Creates a CellAreaContext
to be used with area
for
all purposes. 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 CellAreaContext
which was used to request the size of those rows of data).
Since: 3.0
event
data CellAreaEventMethodInfo Source #
((~) * signature (b -> c -> Event -> Rectangle -> [CellRendererState] -> m Int32), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaEventMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> Event |
|
-> Rectangle |
|
-> [CellRendererState] |
|
-> m Int32 | Returns: |
Delegates event handling to a CellArea
.
Since: 3.0
focus
data CellAreaFocusMethodInfo Source #
((~) * signature (DirectionType -> m Bool), MonadIO m, IsCellArea a) => MethodInfo * CellAreaFocusMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> DirectionType |
|
-> m Bool | Returns: |
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.
Implementing CellArea
classes should implement this
method to receive and navigate focus in its own way particular
to how it lays out cells.
Since: 3.0
foreach
data CellAreaForeachMethodInfo Source #
((~) * signature (CellCallback -> m ()), MonadIO m, IsCellArea a) => MethodInfo * CellAreaForeachMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> CellCallback |
|
-> m () |
Calls callback
for every CellRenderer
in area
.
Since: 3.0
foreachAlloc
data CellAreaForeachAllocMethodInfo Source #
((~) * signature (b -> c -> Rectangle -> Rectangle -> CellAllocCallback -> m ()), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaForeachAllocMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> Rectangle |
|
-> Rectangle |
|
-> CellAllocCallback |
|
-> m () |
Calls callback
for every CellRenderer
in area
with the
allocated rectangle inside cellArea
.
Since: 3.0
getCellAllocation
data CellAreaGetCellAllocationMethodInfo Source #
((~) * signature (b -> c -> d -> Rectangle -> m Rectangle), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c, IsCellRenderer d) => MethodInfo * CellAreaGetCellAllocationMethodInfo a signature Source # | |
cellAreaGetCellAllocation Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c, IsCellRenderer d) | |
=> a |
|
-> b |
|
-> c |
|
-> d |
|
-> Rectangle |
|
-> m Rectangle |
Derives the allocation of renderer
inside area
if area
were to be renderered in cellArea
.
Since: 3.0
getCellAtPosition
data CellAreaGetCellAtPositionMethodInfo Source #
((~) * signature (b -> c -> Rectangle -> Int32 -> Int32 -> m (CellRenderer, Rectangle)), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaGetCellAtPositionMethodInfo a signature Source # | |
cellAreaGetCellAtPosition Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> Rectangle |
|
-> Int32 |
|
-> Int32 |
|
-> m (CellRenderer, Rectangle) | Returns: the |
Gets the CellRenderer
at x
and y
coordinates inside area
and optionally
returns the full cell allocation for it inside cellArea
.
Since: 3.0
getCurrentPathString
data CellAreaGetCurrentPathStringMethodInfo Source #
((~) * signature (m Text), MonadIO m, IsCellArea a) => MethodInfo * CellAreaGetCurrentPathStringMethodInfo a signature Source # | |
cellAreaGetCurrentPathString Source #
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> m Text | Returns: The current |
Gets the current TreePath
string for the currently
applied TreeIter
, this is implicitly updated when
cellAreaApplyAttributes
is called and can be
used to interact with renderers from CellArea
subclasses.
Since: 3.0
getEditWidget
data CellAreaGetEditWidgetMethodInfo Source #
((~) * signature (m CellEditable), MonadIO m, IsCellArea a) => MethodInfo * CellAreaGetEditWidgetMethodInfo a signature Source # | |
cellAreaGetEditWidget Source #
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> m CellEditable | Returns: The currently active |
Gets the CellEditable
widget currently used
to edit the currently edited cell.
Since: 3.0
getEditedCell
data CellAreaGetEditedCellMethodInfo Source #
((~) * signature (m CellRenderer), MonadIO m, IsCellArea a) => MethodInfo * CellAreaGetEditedCellMethodInfo a signature Source # | |
cellAreaGetEditedCell Source #
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> m CellRenderer | Returns: The currently edited |
Gets the CellRenderer
in area
that is currently
being edited.
Since: 3.0
getFocusCell
data CellAreaGetFocusCellMethodInfo Source #
((~) * signature (m CellRenderer), MonadIO m, IsCellArea a) => MethodInfo * CellAreaGetFocusCellMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> m CellRenderer | Returns: the currently focused cell in |
Retrieves the currently focused cell for area
Since: 3.0
getFocusFromSibling
data CellAreaGetFocusFromSiblingMethodInfo Source #
((~) * signature (b -> m (Maybe CellRenderer)), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaGetFocusFromSiblingMethodInfo a signature Source # | |
cellAreaGetFocusFromSibling Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> m (Maybe CellRenderer) | Returns: the |
Gets the CellRenderer
which is expected to be focusable
for which renderer
is, or may be a sibling.
This is handy for CellArea
subclasses when handling events,
after determining the renderer at the event location it can
then chose to activate the focus cell for which the event
cell may have been a sibling.
Since: 3.0
getFocusSiblings
data CellAreaGetFocusSiblingsMethodInfo Source #
((~) * signature (b -> m [CellRenderer]), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaGetFocusSiblingsMethodInfo a signature Source # | |
cellAreaGetFocusSiblings Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> m [CellRenderer] | Returns: A |
Gets the focus sibling cell renderers for renderer
.
Since: 3.0
getPreferredHeight
data CellAreaGetPreferredHeightMethodInfo Source #
((~) * signature (b -> c -> m (Int32, Int32)), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaGetPreferredHeightMethodInfo a signature Source # | |
cellAreaGetPreferredHeight Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> m (Int32, Int32) |
Retrieves a cell area’s initial minimum and natural height.
area
will store some geometrical information in context
along the way;
when requesting sizes over an arbitrary number of rows, it’s not important
to check the minimumHeight
and naturalHeight
of this call but rather to
consult cellAreaContextGetPreferredHeight
after a series of
requests.
Since: 3.0
getPreferredHeightForWidth
data CellAreaGetPreferredHeightForWidthMethodInfo Source #
((~) * signature (b -> c -> Int32 -> m (Int32, Int32)), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaGetPreferredHeightForWidthMethodInfo a signature Source # | |
cellAreaGetPreferredHeightForWidth Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> Int32 |
|
-> m (Int32, Int32) |
Retrieves a cell area’s minimum and natural height if it would be given
the specified width
.
area
stores some geometrical information in context
along the way
while calling cellAreaGetPreferredWidth
. It’s important to
perform a series of cellAreaGetPreferredWidth
requests with
context
first and then call cellAreaGetPreferredHeightForWidth
on each cell area individually to get the height for width of each
fully requested row.
If at some point, the width of a single row changes, it should be
requested with cellAreaGetPreferredWidth
again and then
the full width of the requested rows checked again with
cellAreaContextGetPreferredWidth
.
Since: 3.0
getPreferredWidth
data CellAreaGetPreferredWidthMethodInfo Source #
((~) * signature (b -> c -> m (Int32, Int32)), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaGetPreferredWidthMethodInfo a signature Source # | |
cellAreaGetPreferredWidth Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> m (Int32, Int32) |
Retrieves a cell area’s initial minimum and natural width.
area
will store some geometrical information in context
along the way;
when requesting sizes over an arbitrary number of rows, it’s not important
to check the minimumWidth
and naturalWidth
of this call but rather to
consult cellAreaContextGetPreferredWidth
after a series of
requests.
Since: 3.0
getPreferredWidthForHeight
data CellAreaGetPreferredWidthForHeightMethodInfo Source #
((~) * signature (b -> c -> Int32 -> m (Int32, Int32)), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaGetPreferredWidthForHeightMethodInfo a signature Source # | |
cellAreaGetPreferredWidthForHeight Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> Int32 |
|
-> m (Int32, Int32) |
Retrieves a cell area’s minimum and natural width if it would be given
the specified height
.
area
stores some geometrical information in context
along the way
while calling cellAreaGetPreferredHeight
. It’s important to
perform a series of cellAreaGetPreferredHeight
requests with
context
first and then call cellAreaGetPreferredWidthForHeight
on each cell area individually to get the height for width of each
fully requested row.
If at some point, the height of a single row changes, it should be
requested with cellAreaGetPreferredHeight
again and then
the full height of the requested rows checked again with
cellAreaContextGetPreferredHeight
.
Since: 3.0
getRequestMode
data CellAreaGetRequestModeMethodInfo Source #
((~) * signature (m SizeRequestMode), MonadIO m, IsCellArea a) => MethodInfo * CellAreaGetRequestModeMethodInfo a signature Source # | |
cellAreaGetRequestMode Source #
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> m SizeRequestMode | Returns: The |
Gets whether the area prefers a height-for-width layout or a width-for-height layout.
Since: 3.0
hasRenderer
data CellAreaHasRendererMethodInfo Source #
((~) * signature (b -> m Bool), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaHasRendererMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> m Bool | Returns: |
Checks if area
contains renderer
.
Since: 3.0
innerCellArea
data CellAreaInnerCellAreaMethodInfo Source #
((~) * signature (b -> Rectangle -> m Rectangle), MonadIO m, IsCellArea a, IsWidget b) => MethodInfo * CellAreaInnerCellAreaMethodInfo a signature Source # | |
cellAreaInnerCellArea Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsWidget b) | |
=> a |
|
-> b |
|
-> Rectangle |
|
-> m Rectangle |
This is a convenience function for CellArea
implementations
to get the inner area where a given CellRenderer
will be
rendered. It removes any padding previously added by cellAreaRequestRenderer
.
Since: 3.0
isActivatable
data CellAreaIsActivatableMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsCellArea a) => MethodInfo * CellAreaIsActivatableMethodInfo a signature Source # | |
cellAreaIsActivatable Source #
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> m Bool | Returns: whether |
Returns whether the area can do anything when activated,
after applying new attributes to area
.
Since: 3.0
isFocusSibling
data CellAreaIsFocusSiblingMethodInfo Source #
((~) * signature (b -> c -> m Bool), MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) => MethodInfo * CellAreaIsFocusSiblingMethodInfo a signature Source # | |
cellAreaIsFocusSibling Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) | |
=> a |
|
-> b |
|
-> c |
|
-> m Bool | Returns: |
Returns whether sibling
is one of renderer
’s focus siblings
(see cellAreaAddFocusSibling
).
Since: 3.0
remove
data CellAreaRemoveMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaRemoveMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> m () |
Removes renderer
from area
.
Since: 3.0
removeFocusSibling
data CellAreaRemoveFocusSiblingMethodInfo Source #
((~) * signature (b -> c -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) => MethodInfo * CellAreaRemoveFocusSiblingMethodInfo a signature Source # | |
cellAreaRemoveFocusSibling Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsCellRenderer c) | |
=> a |
|
-> b |
|
-> c |
|
-> m () |
Removes sibling
from renderer
’s focus sibling list
(see cellAreaAddFocusSibling
).
Since: 3.0
render
data CellAreaRenderMethodInfo Source #
((~) * signature (b -> c -> Context -> Rectangle -> Rectangle -> [CellRendererState] -> Bool -> m ()), MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) => MethodInfo * CellAreaRenderMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellAreaContext b, IsWidget c) | |
=> a |
|
-> b |
|
-> c |
|
-> Context |
|
-> Rectangle |
|
-> Rectangle |
|
-> [CellRendererState] |
|
-> Bool |
|
-> m () |
Renders area
’s cells according to area
’s layout onto widget
at
the given coordinates.
Since: 3.0
requestRenderer
data CellAreaRequestRendererMethodInfo Source #
((~) * signature (b -> Orientation -> c -> Int32 -> m (Int32, Int32)), MonadIO m, IsCellArea a, IsCellRenderer b, IsWidget c) => MethodInfo * CellAreaRequestRendererMethodInfo a signature Source # | |
cellAreaRequestRenderer Source #
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b, IsWidget c) | |
=> a |
|
-> b |
|
-> Orientation |
|
-> c |
|
-> Int32 |
|
-> m (Int32, Int32) |
This is a convenience function for CellArea
implementations
to request size for cell renderers. It’s important to use this
function to request size and then use cellAreaInnerCellArea
at render and event time since this function will add padding
around the cell for focus painting.
Since: 3.0
setFocusCell
data CellAreaSetFocusCellMethodInfo Source #
((~) * signature (b -> m ()), MonadIO m, IsCellArea a, IsCellRenderer b) => MethodInfo * CellAreaSetFocusCellMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a, IsCellRenderer b) | |
=> a |
|
-> b |
|
-> m () |
Explicitly sets the currently focused cell to renderer
.
This is generally called by implementations of
CellAreaClass
.focus
() or CellAreaClass
.event
(),
however it can also be used to implement functions such
as treeViewSetCursorOnCell
.
Since: 3.0
stopEditing
data CellAreaStopEditingMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsCellArea a) => MethodInfo * CellAreaStopEditingMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellArea a) | |
=> a |
|
-> Bool |
|
-> m () |
Explicitly stops the editing of the currently edited cell.
If canceled
is True
, the currently edited cell renderer
will emit the ::editing-canceled signal, otherwise the
the ::editing-done signal will be emitted on the current
edit widget.
See cellAreaGetEditedCell
and cellAreaGetEditWidget
.
Since: 3.0
Properties
editWidget
data CellAreaEditWidgetPropertyInfo Source #
cellAreaEditWidget :: AttrLabelProxy "editWidget" Source #
getCellAreaEditWidget :: (MonadIO m, IsCellArea o) => o -> m CellEditable Source #
editedCell
data CellAreaEditedCellPropertyInfo Source #
cellAreaEditedCell :: AttrLabelProxy "editedCell" Source #
getCellAreaEditedCell :: (MonadIO m, IsCellArea o) => o -> m CellRenderer Source #
focusCell
data CellAreaFocusCellPropertyInfo Source #
cellAreaFocusCell :: AttrLabelProxy "focusCell" Source #
constructCellAreaFocusCell :: (IsCellArea o, IsCellRenderer a) => a -> IO (GValueConstruct o) Source #
getCellAreaFocusCell :: (MonadIO m, IsCellArea o) => o -> m CellRenderer Source #
setCellAreaFocusCell :: (MonadIO m, IsCellArea o, IsCellRenderer a) => o -> a -> m () Source #
Signals
addEditable
type C_CellAreaAddEditableCallback = Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr Rectangle -> CString -> Ptr () -> IO () Source #
type CellAreaAddEditableCallback = CellRenderer -> CellEditable -> Rectangle -> Text -> IO () Source #
afterCellAreaAddEditable :: (GObject a, MonadIO m) => a -> CellAreaAddEditableCallback -> m SignalHandlerId Source #
mk_CellAreaAddEditableCallback :: C_CellAreaAddEditableCallback -> IO (FunPtr C_CellAreaAddEditableCallback) Source #
onCellAreaAddEditable :: (GObject a, MonadIO m) => a -> CellAreaAddEditableCallback -> m SignalHandlerId Source #
wrap_CellAreaAddEditableCallback :: CellAreaAddEditableCallback -> Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr Rectangle -> CString -> Ptr () -> IO () Source #
applyAttributes
type C_CellAreaApplyAttributesCallback = Ptr () -> Ptr TreeModel -> Ptr TreeIter -> CInt -> CInt -> Ptr () -> IO () Source #
afterCellAreaApplyAttributes :: (GObject a, MonadIO m) => a -> CellAreaApplyAttributesCallback -> m SignalHandlerId Source #
mk_CellAreaApplyAttributesCallback :: C_CellAreaApplyAttributesCallback -> IO (FunPtr C_CellAreaApplyAttributesCallback) Source #
onCellAreaApplyAttributes :: (GObject a, MonadIO m) => a -> CellAreaApplyAttributesCallback -> m SignalHandlerId Source #
wrap_CellAreaApplyAttributesCallback :: CellAreaApplyAttributesCallback -> Ptr () -> Ptr TreeModel -> Ptr TreeIter -> CInt -> CInt -> Ptr () -> IO () Source #
focusChanged
type C_CellAreaFocusChangedCallback = Ptr () -> Ptr CellRenderer -> CString -> Ptr () -> IO () Source #
type CellAreaFocusChangedCallback = CellRenderer -> Text -> IO () Source #
afterCellAreaFocusChanged :: (GObject a, MonadIO m) => a -> CellAreaFocusChangedCallback -> m SignalHandlerId Source #
mk_CellAreaFocusChangedCallback :: C_CellAreaFocusChangedCallback -> IO (FunPtr C_CellAreaFocusChangedCallback) Source #
onCellAreaFocusChanged :: (GObject a, MonadIO m) => a -> CellAreaFocusChangedCallback -> m SignalHandlerId Source #
wrap_CellAreaFocusChangedCallback :: CellAreaFocusChangedCallback -> Ptr () -> Ptr CellRenderer -> CString -> Ptr () -> IO () Source #
removeEditable
type C_CellAreaRemoveEditableCallback = Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr () -> IO () Source #
type CellAreaRemoveEditableCallback = CellRenderer -> CellEditable -> IO () Source #
afterCellAreaRemoveEditable :: (GObject a, MonadIO m) => a -> CellAreaRemoveEditableCallback -> m SignalHandlerId Source #
mk_CellAreaRemoveEditableCallback :: C_CellAreaRemoveEditableCallback -> IO (FunPtr C_CellAreaRemoveEditableCallback) Source #
onCellAreaRemoveEditable :: (GObject a, MonadIO m) => a -> CellAreaRemoveEditableCallback -> m SignalHandlerId Source #
wrap_CellAreaRemoveEditableCallback :: CellAreaRemoveEditableCallback -> Ptr () -> Ptr CellRenderer -> Ptr CellEditable -> Ptr () -> IO () Source #