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
- getAlignedArea
- getAlignment
- getFixedSize
- getPadding
- getPreferredHeight
- getPreferredHeightForWidth
- getPreferredSize
- getPreferredWidth
- getPreferredWidthForHeight
- getRequestMode
- getSensitive
- getSize
- getState
- getVisible
- isActivatable
- render
- setAlignment
- setFixedSize
- setPadding
- setSensitive
- setVisible
- startEditing
- stopEditing
- Properties
- Signals
The CellRenderer
is a base class of a set of objects used for
rendering a cell to a Context
. These objects are used primarily by
the TreeView
widget, though they aren’t tied to them in any
specific way. It is worth noting that CellRenderer
is not a
Widget
and cannot be treated as such.
The primary use of a CellRenderer
is for drawing a certain graphical
elements on a Context
. Typically, one cell renderer is used to
draw many cells on the screen. To this extent, it isn’t expected that a
CellRenderer keep any permanent state around. Instead, any state is set
just prior to use using GObjects
property system. Then, the
cell is measured using cellRendererGetSize
. Finally, the cell
is rendered in the correct location using cellRendererRender
.
There are a number of rules that must be followed when writing a new
CellRenderer
. First and foremost, it’s important that a certain set
of properties will always yield a cell renderer of the same size,
barring a Style
change. The CellRenderer
also has a number of
generic properties that are expected to be honored by all children.
Beyond merely rendering a cell, cell renderers can optionally
provide active user interface elements. A cell renderer can be
“activatable” like CellRendererToggle
,
which toggles when it gets activated by a mouse click, or it can be
“editable” like CellRendererText
, which
allows the user to edit the text using a Entry
.
To make a cell renderer activatable or editable, you have to
implement the CellRendererClass
.activate
or
CellRendererClass
.start_editing
virtual functions, respectively.
Many properties of CellRenderer
and its subclasses have a
corresponding “set” property, e.g. “cell-background-set” corresponds
to “cell-background”. These “set” properties reflect whether a property
has been set or not. You should not set them independently.
- newtype CellRenderer = CellRenderer (ManagedPtr CellRenderer)
- class GObject o => IsCellRenderer o
- toCellRenderer :: IsCellRenderer o => o -> IO CellRenderer
- noCellRenderer :: Maybe CellRenderer
- data CellRendererActivateMethodInfo
- cellRendererActivate :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> Event -> b -> Text -> Rectangle -> Rectangle -> [CellRendererState] -> m Bool
- data CellRendererGetAlignedAreaMethodInfo
- cellRendererGetAlignedArea :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> b -> [CellRendererState] -> Rectangle -> m Rectangle
- data CellRendererGetAlignmentMethodInfo
- cellRendererGetAlignment :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> m (Float, Float)
- data CellRendererGetFixedSizeMethodInfo
- cellRendererGetFixedSize :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> m (Int32, Int32)
- data CellRendererGetPaddingMethodInfo
- cellRendererGetPadding :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> m (Int32, Int32)
- data CellRendererGetPreferredHeightMethodInfo
- cellRendererGetPreferredHeight :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> b -> m (Int32, Int32)
- data CellRendererGetPreferredHeightForWidthMethodInfo
- cellRendererGetPreferredHeightForWidth :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> b -> Int32 -> m (Int32, Int32)
- data CellRendererGetPreferredSizeMethodInfo
- cellRendererGetPreferredSize :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> b -> m (Requisition, Requisition)
- data CellRendererGetPreferredWidthMethodInfo
- cellRendererGetPreferredWidth :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> b -> m (Int32, Int32)
- data CellRendererGetPreferredWidthForHeightMethodInfo
- cellRendererGetPreferredWidthForHeight :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> b -> Int32 -> m (Int32, Int32)
- data CellRendererGetRequestModeMethodInfo
- cellRendererGetRequestMode :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> m SizeRequestMode
- data CellRendererGetSensitiveMethodInfo
- cellRendererGetSensitive :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> m Bool
- data CellRendererGetSizeMethodInfo
- cellRendererGetSize :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> b -> Maybe Rectangle -> m (Int32, Int32, Int32, Int32)
- data CellRendererGetStateMethodInfo
- cellRendererGetState :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> Maybe b -> [CellRendererState] -> m [StateFlags]
- data CellRendererGetVisibleMethodInfo
- cellRendererGetVisible :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> m Bool
- data CellRendererIsActivatableMethodInfo
- cellRendererIsActivatable :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> m Bool
- data CellRendererRenderMethodInfo
- cellRendererRender :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> Context -> b -> Rectangle -> Rectangle -> [CellRendererState] -> m ()
- data CellRendererSetAlignmentMethodInfo
- cellRendererSetAlignment :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> Float -> Float -> m ()
- data CellRendererSetFixedSizeMethodInfo
- cellRendererSetFixedSize :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> Int32 -> Int32 -> m ()
- data CellRendererSetPaddingMethodInfo
- cellRendererSetPadding :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> Int32 -> Int32 -> m ()
- data CellRendererSetSensitiveMethodInfo
- cellRendererSetSensitive :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> Bool -> m ()
- data CellRendererSetVisibleMethodInfo
- cellRendererSetVisible :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> Bool -> m ()
- data CellRendererStartEditingMethodInfo
- cellRendererStartEditing :: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) => a -> Maybe Event -> b -> Text -> Rectangle -> Rectangle -> [CellRendererState] -> m (Maybe CellEditable)
- data CellRendererStopEditingMethodInfo
- cellRendererStopEditing :: (HasCallStack, MonadIO m, IsCellRenderer a) => a -> Bool -> m ()
- data CellRendererCellBackgroundPropertyInfo
- cellRendererCellBackground :: AttrLabelProxy "cellBackground"
- clearCellRendererCellBackground :: (MonadIO m, IsCellRenderer o) => o -> m ()
- constructCellRendererCellBackground :: IsCellRenderer o => Text -> IO (GValueConstruct o)
- setCellRendererCellBackground :: (MonadIO m, IsCellRenderer o) => o -> Text -> m ()
- data CellRendererCellBackgroundGdkPropertyInfo
- cellRendererCellBackgroundGdk :: AttrLabelProxy "cellBackgroundGdk"
- clearCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> m ()
- constructCellRendererCellBackgroundGdk :: IsCellRenderer o => Color -> IO (GValueConstruct o)
- getCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> m (Maybe Color)
- setCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> Color -> m ()
- data CellRendererCellBackgroundRgbaPropertyInfo
- cellRendererCellBackgroundRgba :: AttrLabelProxy "cellBackgroundRgba"
- clearCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> m ()
- constructCellRendererCellBackgroundRgba :: IsCellRenderer o => RGBA -> IO (GValueConstruct o)
- getCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> m (Maybe RGBA)
- setCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> RGBA -> m ()
- data CellRendererCellBackgroundSetPropertyInfo
- cellRendererCellBackgroundSet :: AttrLabelProxy "cellBackgroundSet"
- constructCellRendererCellBackgroundSet :: IsCellRenderer o => Bool -> IO (GValueConstruct o)
- getCellRendererCellBackgroundSet :: (MonadIO m, IsCellRenderer o) => o -> m Bool
- setCellRendererCellBackgroundSet :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()
- data CellRendererEditingPropertyInfo
- cellRendererEditing :: AttrLabelProxy "editing"
- getCellRendererEditing :: (MonadIO m, IsCellRenderer o) => o -> m Bool
- data CellRendererHeightPropertyInfo
- cellRendererHeight :: AttrLabelProxy "height"
- constructCellRendererHeight :: IsCellRenderer o => Int32 -> IO (GValueConstruct o)
- getCellRendererHeight :: (MonadIO m, IsCellRenderer o) => o -> m Int32
- setCellRendererHeight :: (MonadIO m, IsCellRenderer o) => o -> Int32 -> m ()
- data CellRendererIsExpandedPropertyInfo
- cellRendererIsExpanded :: AttrLabelProxy "isExpanded"
- constructCellRendererIsExpanded :: IsCellRenderer o => Bool -> IO (GValueConstruct o)
- getCellRendererIsExpanded :: (MonadIO m, IsCellRenderer o) => o -> m Bool
- setCellRendererIsExpanded :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()
- data CellRendererIsExpanderPropertyInfo
- cellRendererIsExpander :: AttrLabelProxy "isExpander"
- constructCellRendererIsExpander :: IsCellRenderer o => Bool -> IO (GValueConstruct o)
- getCellRendererIsExpander :: (MonadIO m, IsCellRenderer o) => o -> m Bool
- setCellRendererIsExpander :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()
- data CellRendererModePropertyInfo
- cellRendererMode :: AttrLabelProxy "mode"
- constructCellRendererMode :: IsCellRenderer o => CellRendererMode -> IO (GValueConstruct o)
- getCellRendererMode :: (MonadIO m, IsCellRenderer o) => o -> m CellRendererMode
- setCellRendererMode :: (MonadIO m, IsCellRenderer o) => o -> CellRendererMode -> m ()
- data CellRendererSensitivePropertyInfo
- cellRendererSensitive :: AttrLabelProxy "sensitive"
- constructCellRendererSensitive :: IsCellRenderer o => Bool -> IO (GValueConstruct o)
- getCellRendererSensitive :: (MonadIO m, IsCellRenderer o) => o -> m Bool
- setCellRendererSensitive :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()
- data CellRendererVisiblePropertyInfo
- cellRendererVisible :: AttrLabelProxy "visible"
- constructCellRendererVisible :: IsCellRenderer o => Bool -> IO (GValueConstruct o)
- getCellRendererVisible :: (MonadIO m, IsCellRenderer o) => o -> m Bool
- setCellRendererVisible :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m ()
- data CellRendererWidthPropertyInfo
- cellRendererWidth :: AttrLabelProxy "width"
- constructCellRendererWidth :: IsCellRenderer o => Int32 -> IO (GValueConstruct o)
- getCellRendererWidth :: (MonadIO m, IsCellRenderer o) => o -> m Int32
- setCellRendererWidth :: (MonadIO m, IsCellRenderer o) => o -> Int32 -> m ()
- data CellRendererXalignPropertyInfo
- cellRendererXalign :: AttrLabelProxy "xalign"
- constructCellRendererXalign :: IsCellRenderer o => Float -> IO (GValueConstruct o)
- getCellRendererXalign :: (MonadIO m, IsCellRenderer o) => o -> m Float
- setCellRendererXalign :: (MonadIO m, IsCellRenderer o) => o -> Float -> m ()
- data CellRendererXpadPropertyInfo
- cellRendererXpad :: AttrLabelProxy "xpad"
- constructCellRendererXpad :: IsCellRenderer o => Word32 -> IO (GValueConstruct o)
- getCellRendererXpad :: (MonadIO m, IsCellRenderer o) => o -> m Word32
- setCellRendererXpad :: (MonadIO m, IsCellRenderer o) => o -> Word32 -> m ()
- data CellRendererYalignPropertyInfo
- cellRendererYalign :: AttrLabelProxy "yalign"
- constructCellRendererYalign :: IsCellRenderer o => Float -> IO (GValueConstruct o)
- getCellRendererYalign :: (MonadIO m, IsCellRenderer o) => o -> m Float
- setCellRendererYalign :: (MonadIO m, IsCellRenderer o) => o -> Float -> m ()
- data CellRendererYpadPropertyInfo
- cellRendererYpad :: AttrLabelProxy "ypad"
- constructCellRendererYpad :: IsCellRenderer o => Word32 -> IO (GValueConstruct o)
- getCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> m Word32
- setCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> Word32 -> m ()
- type C_CellRendererEditingCanceledCallback = Ptr () -> Ptr () -> IO ()
- type CellRendererEditingCanceledCallback = IO ()
- data CellRendererEditingCanceledSignalInfo
- afterCellRendererEditingCanceled :: (GObject a, MonadIO m) => a -> CellRendererEditingCanceledCallback -> m SignalHandlerId
- genClosure_CellRendererEditingCanceled :: CellRendererEditingCanceledCallback -> IO Closure
- mk_CellRendererEditingCanceledCallback :: C_CellRendererEditingCanceledCallback -> IO (FunPtr C_CellRendererEditingCanceledCallback)
- noCellRendererEditingCanceledCallback :: Maybe CellRendererEditingCanceledCallback
- onCellRendererEditingCanceled :: (GObject a, MonadIO m) => a -> CellRendererEditingCanceledCallback -> m SignalHandlerId
- wrap_CellRendererEditingCanceledCallback :: CellRendererEditingCanceledCallback -> Ptr () -> Ptr () -> IO ()
- type C_CellRendererEditingStartedCallback = Ptr () -> Ptr CellEditable -> CString -> Ptr () -> IO ()
- type CellRendererEditingStartedCallback = CellEditable -> Text -> IO ()
- data CellRendererEditingStartedSignalInfo
- afterCellRendererEditingStarted :: (GObject a, MonadIO m) => a -> CellRendererEditingStartedCallback -> m SignalHandlerId
- genClosure_CellRendererEditingStarted :: CellRendererEditingStartedCallback -> IO Closure
- mk_CellRendererEditingStartedCallback :: C_CellRendererEditingStartedCallback -> IO (FunPtr C_CellRendererEditingStartedCallback)
- noCellRendererEditingStartedCallback :: Maybe CellRendererEditingStartedCallback
- onCellRendererEditingStarted :: (GObject a, MonadIO m) => a -> CellRendererEditingStartedCallback -> m SignalHandlerId
- wrap_CellRendererEditingStartedCallback :: CellRendererEditingStartedCallback -> Ptr () -> Ptr CellEditable -> CString -> Ptr () -> IO ()
Exported types
newtype CellRenderer Source #
GObject CellRenderer Source # | |
IsObject CellRenderer Source # | |
IsCellRenderer CellRenderer Source # | |
((~) * info (ResolveCellRendererMethod t CellRenderer), MethodInfo * info CellRenderer p) => IsLabel t (CellRenderer -> p) Source # | |
((~) * info (ResolveCellRendererMethod t CellRenderer), MethodInfo * info CellRenderer p) => IsLabelProxy t (CellRenderer -> p) Source # | |
HasAttributeList * CellRenderer Source # | |
type AttributeList CellRenderer Source # | |
type SignalList CellRenderer Source # | |
class GObject o => IsCellRenderer o Source #
toCellRenderer :: IsCellRenderer o => o -> IO CellRenderer Source #
Methods
activate
data CellRendererActivateMethodInfo Source #
((~) * signature (Event -> b -> Text -> Rectangle -> Rectangle -> [CellRendererState] -> m Bool), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererActivateMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> Event |
|
-> b |
|
-> Text |
|
-> Rectangle |
|
-> Rectangle |
|
-> [CellRendererState] |
|
-> m Bool | Returns: |
Passes an activate event to the cell renderer for possible processing.
Some cell renderers may use events; for example, CellRendererToggle
toggles when it gets a mouse click.
getAlignedArea
data CellRendererGetAlignedAreaMethodInfo Source #
((~) * signature (b -> [CellRendererState] -> Rectangle -> m Rectangle), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetAlignedAreaMethodInfo a signature Source # | |
cellRendererGetAlignedArea Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> b |
|
-> [CellRendererState] |
|
-> Rectangle |
|
-> m Rectangle |
Gets the aligned area used by cell
inside cellArea
. Used for finding
the appropriate edit and focus rectangle.
Since: 3.0
getAlignment
data CellRendererGetAlignmentMethodInfo Source #
((~) * signature (m (Float, Float)), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererGetAlignmentMethodInfo a signature Source # | |
cellRendererGetAlignment Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> m (Float, Float) |
Fills in xalign
and yalign
with the appropriate values of cell
.
Since: 2.18
getFixedSize
data CellRendererGetFixedSizeMethodInfo Source #
((~) * signature (m (Int32, Int32)), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererGetFixedSizeMethodInfo a signature Source # | |
cellRendererGetFixedSize Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> m (Int32, Int32) |
Fills in width
and height
with the appropriate size of cell
.
getPadding
data CellRendererGetPaddingMethodInfo Source #
((~) * signature (m (Int32, Int32)), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererGetPaddingMethodInfo a signature Source # | |
cellRendererGetPadding Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> m (Int32, Int32) |
Fills in xpad
and ypad
with the appropriate values of cell
.
Since: 2.18
getPreferredHeight
data CellRendererGetPreferredHeightMethodInfo Source #
((~) * signature (b -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetPreferredHeightMethodInfo a signature Source # | |
cellRendererGetPreferredHeight Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> b |
|
-> m (Int32, Int32) |
Retreives a renderer’s natural size when rendered to widget
.
Since: 3.0
getPreferredHeightForWidth
data CellRendererGetPreferredHeightForWidthMethodInfo Source #
((~) * signature (b -> Int32 -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetPreferredHeightForWidthMethodInfo a signature Source # | |
cellRendererGetPreferredHeightForWidth Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> m (Int32, Int32) |
Retreives a cell renderers’s minimum and natural height if it were rendered to
widget
with the specified width
.
Since: 3.0
getPreferredSize
data CellRendererGetPreferredSizeMethodInfo Source #
((~) * signature (b -> m (Requisition, Requisition)), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetPreferredSizeMethodInfo a signature Source # | |
cellRendererGetPreferredSize Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> b |
|
-> m (Requisition, Requisition) |
Retrieves the minimum and natural size of a cell taking into account the widget’s preference for height-for-width management.
Since: 3.0
getPreferredWidth
data CellRendererGetPreferredWidthMethodInfo Source #
((~) * signature (b -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetPreferredWidthMethodInfo a signature Source # | |
cellRendererGetPreferredWidth Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> b |
|
-> m (Int32, Int32) |
Retreives a renderer’s natural size when rendered to widget
.
Since: 3.0
getPreferredWidthForHeight
data CellRendererGetPreferredWidthForHeightMethodInfo Source #
((~) * signature (b -> Int32 -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetPreferredWidthForHeightMethodInfo a signature Source # | |
cellRendererGetPreferredWidthForHeight Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> b |
|
-> Int32 |
|
-> m (Int32, Int32) |
Retreives a cell renderers’s minimum and natural width if it were rendered to
widget
with the specified height
.
Since: 3.0
getRequestMode
data CellRendererGetRequestModeMethodInfo Source #
((~) * signature (m SizeRequestMode), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererGetRequestModeMethodInfo a signature Source # | |
cellRendererGetRequestMode Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> m SizeRequestMode | Returns: The |
Gets whether the cell renderer prefers a height-for-width layout or a width-for-height layout.
Since: 3.0
getSensitive
data CellRendererGetSensitiveMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererGetSensitiveMethodInfo a signature Source # | |
cellRendererGetSensitive Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> m Bool | Returns: |
Returns the cell renderer’s sensitivity.
Since: 2.18
getSize
data CellRendererGetSizeMethodInfo Source #
((~) * signature (b -> Maybe Rectangle -> m (Int32, Int32, Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetSizeMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> b |
|
-> Maybe Rectangle |
|
-> m (Int32, Int32, Int32, Int32) |
Deprecated: (Since version 3.0)Use cellRendererGetPreferredSize
instead.
Obtains the width and height needed to render the cell. Used by view
widgets to determine the appropriate size for the cell_area passed to
cellRendererRender
. If cellArea
is not Nothing
, fills in the
x and y offsets (if set) of the cell relative to this location.
Please note that the values set in width
and height
, as well as those
in xOffset
and yOffset
are inclusive of the xpad and ypad properties.
getState
data CellRendererGetStateMethodInfo Source #
((~) * signature (Maybe b -> [CellRendererState] -> m [StateFlags]), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererGetStateMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> Maybe b | |
-> [CellRendererState] |
|
-> m [StateFlags] | Returns: the widget state flags applying to |
Translates the cell renderer state to StateFlags
,
based on the cell renderer and widget sensitivity, and
the given CellRendererState
.
Since: 3.0
getVisible
data CellRendererGetVisibleMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererGetVisibleMethodInfo a signature Source # | |
cellRendererGetVisible Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> m Bool | Returns: |
Returns the cell renderer’s visibility.
Since: 2.18
isActivatable
data CellRendererIsActivatableMethodInfo Source #
((~) * signature (m Bool), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererIsActivatableMethodInfo a signature Source # | |
cellRendererIsActivatable Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> m Bool | Returns: |
Checks whether the cell renderer can do something when activated.
Since: 3.0
render
data CellRendererRenderMethodInfo Source #
((~) * signature (Context -> b -> Rectangle -> Rectangle -> [CellRendererState] -> m ()), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererRenderMethodInfo a signature Source # | |
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> Context |
|
-> b |
|
-> Rectangle |
|
-> Rectangle |
|
-> [CellRendererState] |
|
-> m () |
Invokes the virtual render function of the CellRenderer
. The three
passed-in rectangles are areas in cr
. Most renderers will draw within
cellArea
; the xalign, yalign, xpad, and ypad fields of the CellRenderer
should be honored with respect to cellArea
. backgroundArea
includes the
blank space around the cell, and also the area containing the tree expander;
so the backgroundArea
rectangles for all cells tile to cover the entire
window
.
setAlignment
data CellRendererSetAlignmentMethodInfo Source #
((~) * signature (Float -> Float -> m ()), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererSetAlignmentMethodInfo a signature Source # | |
cellRendererSetAlignment Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> Float |
|
-> Float |
|
-> m () |
Sets the renderer’s alignment within its available space.
Since: 2.18
setFixedSize
data CellRendererSetFixedSizeMethodInfo Source #
((~) * signature (Int32 -> Int32 -> m ()), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererSetFixedSizeMethodInfo a signature Source # | |
cellRendererSetFixedSize Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Sets the renderer size to be explicit, independent of the properties set.
setPadding
data CellRendererSetPaddingMethodInfo Source #
((~) * signature (Int32 -> Int32 -> m ()), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererSetPaddingMethodInfo a signature Source # | |
cellRendererSetPadding Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Sets the renderer’s padding.
Since: 2.18
setSensitive
data CellRendererSetSensitiveMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererSetSensitiveMethodInfo a signature Source # | |
cellRendererSetSensitive Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets the cell renderer’s sensitivity.
Since: 2.18
setVisible
data CellRendererSetVisibleMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererSetVisibleMethodInfo a signature Source # | |
cellRendererSetVisible Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> Bool |
|
-> m () |
Sets the cell renderer’s visibility.
Since: 2.18
startEditing
data CellRendererStartEditingMethodInfo Source #
((~) * signature (Maybe Event -> b -> Text -> Rectangle -> Rectangle -> [CellRendererState] -> m (Maybe CellEditable)), MonadIO m, IsCellRenderer a, IsWidget b) => MethodInfo * CellRendererStartEditingMethodInfo a signature Source # | |
cellRendererStartEditing Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b) | |
=> a |
|
-> Maybe Event |
|
-> b |
|
-> Text |
|
-> Rectangle |
|
-> Rectangle |
|
-> [CellRendererState] |
|
-> m (Maybe CellEditable) | Returns: A new |
Passes an activate event to the cell renderer for possible processing.
stopEditing
data CellRendererStopEditingMethodInfo Source #
((~) * signature (Bool -> m ()), MonadIO m, IsCellRenderer a) => MethodInfo * CellRendererStopEditingMethodInfo a signature Source # | |
cellRendererStopEditing Source #
:: (HasCallStack, MonadIO m, IsCellRenderer a) | |
=> a |
|
-> Bool |
|
-> m () |
Informs the cell renderer that the editing is stopped.
If canceled
is True
, the cell renderer will emit the
CellRenderer
::editing-canceled
signal.
This function should be called by cell renderer implementations
in response to the CellEditable
::editing-done
signal of
CellEditable
.
Since: 2.6
Properties
cellBackground
data CellRendererCellBackgroundPropertyInfo Source #
cellRendererCellBackground :: AttrLabelProxy "cellBackground" Source #
clearCellRendererCellBackground :: (MonadIO m, IsCellRenderer o) => o -> m () Source #
constructCellRendererCellBackground :: IsCellRenderer o => Text -> IO (GValueConstruct o) Source #
setCellRendererCellBackground :: (MonadIO m, IsCellRenderer o) => o -> Text -> m () Source #
cellBackgroundGdk
data CellRendererCellBackgroundGdkPropertyInfo Source #
cellRendererCellBackgroundGdk :: AttrLabelProxy "cellBackgroundGdk" Source #
clearCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> m () Source #
constructCellRendererCellBackgroundGdk :: IsCellRenderer o => Color -> IO (GValueConstruct o) Source #
getCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> m (Maybe Color) Source #
setCellRendererCellBackgroundGdk :: (MonadIO m, IsCellRenderer o) => o -> Color -> m () Source #
cellBackgroundRgba
data CellRendererCellBackgroundRgbaPropertyInfo Source #
cellRendererCellBackgroundRgba :: AttrLabelProxy "cellBackgroundRgba" Source #
clearCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> m () Source #
constructCellRendererCellBackgroundRgba :: IsCellRenderer o => RGBA -> IO (GValueConstruct o) Source #
getCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> m (Maybe RGBA) Source #
setCellRendererCellBackgroundRgba :: (MonadIO m, IsCellRenderer o) => o -> RGBA -> m () Source #
cellBackgroundSet
data CellRendererCellBackgroundSetPropertyInfo Source #
cellRendererCellBackgroundSet :: AttrLabelProxy "cellBackgroundSet" Source #
constructCellRendererCellBackgroundSet :: IsCellRenderer o => Bool -> IO (GValueConstruct o) Source #
getCellRendererCellBackgroundSet :: (MonadIO m, IsCellRenderer o) => o -> m Bool Source #
setCellRendererCellBackgroundSet :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m () Source #
editing
data CellRendererEditingPropertyInfo Source #
cellRendererEditing :: AttrLabelProxy "editing" Source #
getCellRendererEditing :: (MonadIO m, IsCellRenderer o) => o -> m Bool Source #
height
data CellRendererHeightPropertyInfo Source #
cellRendererHeight :: AttrLabelProxy "height" Source #
constructCellRendererHeight :: IsCellRenderer o => Int32 -> IO (GValueConstruct o) Source #
getCellRendererHeight :: (MonadIO m, IsCellRenderer o) => o -> m Int32 Source #
setCellRendererHeight :: (MonadIO m, IsCellRenderer o) => o -> Int32 -> m () Source #
isExpanded
data CellRendererIsExpandedPropertyInfo Source #
cellRendererIsExpanded :: AttrLabelProxy "isExpanded" Source #
constructCellRendererIsExpanded :: IsCellRenderer o => Bool -> IO (GValueConstruct o) Source #
getCellRendererIsExpanded :: (MonadIO m, IsCellRenderer o) => o -> m Bool Source #
setCellRendererIsExpanded :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m () Source #
isExpander
data CellRendererIsExpanderPropertyInfo Source #
cellRendererIsExpander :: AttrLabelProxy "isExpander" Source #
constructCellRendererIsExpander :: IsCellRenderer o => Bool -> IO (GValueConstruct o) Source #
getCellRendererIsExpander :: (MonadIO m, IsCellRenderer o) => o -> m Bool Source #
setCellRendererIsExpander :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m () Source #
mode
data CellRendererModePropertyInfo Source #
cellRendererMode :: AttrLabelProxy "mode" Source #
constructCellRendererMode :: IsCellRenderer o => CellRendererMode -> IO (GValueConstruct o) Source #
getCellRendererMode :: (MonadIO m, IsCellRenderer o) => o -> m CellRendererMode Source #
setCellRendererMode :: (MonadIO m, IsCellRenderer o) => o -> CellRendererMode -> m () Source #
sensitive
data CellRendererSensitivePropertyInfo Source #
cellRendererSensitive :: AttrLabelProxy "sensitive" Source #
constructCellRendererSensitive :: IsCellRenderer o => Bool -> IO (GValueConstruct o) Source #
getCellRendererSensitive :: (MonadIO m, IsCellRenderer o) => o -> m Bool Source #
setCellRendererSensitive :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m () Source #
visible
data CellRendererVisiblePropertyInfo Source #
cellRendererVisible :: AttrLabelProxy "visible" Source #
constructCellRendererVisible :: IsCellRenderer o => Bool -> IO (GValueConstruct o) Source #
getCellRendererVisible :: (MonadIO m, IsCellRenderer o) => o -> m Bool Source #
setCellRendererVisible :: (MonadIO m, IsCellRenderer o) => o -> Bool -> m () Source #
width
data CellRendererWidthPropertyInfo Source #
cellRendererWidth :: AttrLabelProxy "width" Source #
constructCellRendererWidth :: IsCellRenderer o => Int32 -> IO (GValueConstruct o) Source #
getCellRendererWidth :: (MonadIO m, IsCellRenderer o) => o -> m Int32 Source #
setCellRendererWidth :: (MonadIO m, IsCellRenderer o) => o -> Int32 -> m () Source #
xalign
data CellRendererXalignPropertyInfo Source #
cellRendererXalign :: AttrLabelProxy "xalign" Source #
constructCellRendererXalign :: IsCellRenderer o => Float -> IO (GValueConstruct o) Source #
getCellRendererXalign :: (MonadIO m, IsCellRenderer o) => o -> m Float Source #
setCellRendererXalign :: (MonadIO m, IsCellRenderer o) => o -> Float -> m () Source #
xpad
data CellRendererXpadPropertyInfo Source #
cellRendererXpad :: AttrLabelProxy "xpad" Source #
constructCellRendererXpad :: IsCellRenderer o => Word32 -> IO (GValueConstruct o) Source #
getCellRendererXpad :: (MonadIO m, IsCellRenderer o) => o -> m Word32 Source #
setCellRendererXpad :: (MonadIO m, IsCellRenderer o) => o -> Word32 -> m () Source #
yalign
data CellRendererYalignPropertyInfo Source #
cellRendererYalign :: AttrLabelProxy "yalign" Source #
constructCellRendererYalign :: IsCellRenderer o => Float -> IO (GValueConstruct o) Source #
getCellRendererYalign :: (MonadIO m, IsCellRenderer o) => o -> m Float Source #
setCellRendererYalign :: (MonadIO m, IsCellRenderer o) => o -> Float -> m () Source #
ypad
data CellRendererYpadPropertyInfo Source #
cellRendererYpad :: AttrLabelProxy "ypad" Source #
constructCellRendererYpad :: IsCellRenderer o => Word32 -> IO (GValueConstruct o) Source #
getCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> m Word32 Source #
setCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> Word32 -> m () Source #
Signals
editingCanceled
type CellRendererEditingCanceledCallback = IO () Source #
afterCellRendererEditingCanceled :: (GObject a, MonadIO m) => a -> CellRendererEditingCanceledCallback -> m SignalHandlerId Source #
genClosure_CellRendererEditingCanceled :: CellRendererEditingCanceledCallback -> IO Closure Source #
mk_CellRendererEditingCanceledCallback :: C_CellRendererEditingCanceledCallback -> IO (FunPtr C_CellRendererEditingCanceledCallback) Source #
onCellRendererEditingCanceled :: (GObject a, MonadIO m) => a -> CellRendererEditingCanceledCallback -> m SignalHandlerId Source #
wrap_CellRendererEditingCanceledCallback :: CellRendererEditingCanceledCallback -> Ptr () -> Ptr () -> IO () Source #
editingStarted
type C_CellRendererEditingStartedCallback = Ptr () -> Ptr CellEditable -> CString -> Ptr () -> IO () Source #
type CellRendererEditingStartedCallback = CellEditable -> Text -> IO () Source #
afterCellRendererEditingStarted :: (GObject a, MonadIO m) => a -> CellRendererEditingStartedCallback -> m SignalHandlerId Source #
mk_CellRendererEditingStartedCallback :: C_CellRendererEditingStartedCallback -> IO (FunPtr C_CellRendererEditingStartedCallback) Source #
onCellRendererEditingStarted :: (GObject a, MonadIO m) => a -> CellRendererEditingStartedCallback -> m SignalHandlerId Source #
wrap_CellRendererEditingStartedCallback :: CellRendererEditingStartedCallback -> Ptr () -> Ptr CellEditable -> CString -> Ptr () -> IO () Source #