Copyright	Will Thompson and Iñaki García Etxebarria
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.CellRenderer

Contents

Exported types
Methods
Properties
Signals
- editingCanceled
- editingStarted

Description

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 widget implementing the CellEditable interface, e.g. 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.

Synopsis

newtype CellRenderer = CellRenderer (ManagedPtr CellRenderer)
class (GObject o, IsDescendantOf CellRenderer o) => IsCellRenderer o
toCellRenderer :: (MonadIO m, IsCellRenderer o) => o -> m CellRenderer
type family ResolveCellRendererMethod (t :: Symbol) o where ...
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) => Maybe 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, MonadIO m) => Text -> m (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, MonadIO m) => Color -> m (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, MonadIO m) => RGBA -> m (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, MonadIO m) => Bool -> m (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, MonadIO m) => Int32 -> m (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, MonadIO m) => Bool -> m (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, MonadIO m) => Bool -> m (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, MonadIO m) => CellRendererMode -> m (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, MonadIO m) => Bool -> m (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, MonadIO m) => Bool -> m (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, MonadIO m) => Int32 -> m (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, MonadIO m) => Float -> m (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, MonadIO m) => Word32 -> m (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, MonadIO m) => Float -> m (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, MonadIO m) => Word32 -> m (GValueConstruct o)
getCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> m Word32
setCellRendererYpad :: (MonadIO m, IsCellRenderer o) => o -> Word32 -> m ()
type CellRendererEditingCanceledCallback = IO ()
data CellRendererEditingCanceledSignalInfo
afterCellRendererEditingCanceled :: (IsCellRenderer a, MonadIO m) => a -> ((?self :: a) => CellRendererEditingCanceledCallback) -> m SignalHandlerId
onCellRendererEditingCanceled :: (IsCellRenderer a, MonadIO m) => a -> ((?self :: a) => CellRendererEditingCanceledCallback) -> m SignalHandlerId
type CellRendererEditingStartedCallback = CellEditable -> Text -> IO ()
data CellRendererEditingStartedSignalInfo
afterCellRendererEditingStarted :: (IsCellRenderer a, MonadIO m) => a -> ((?self :: a) => CellRendererEditingStartedCallback) -> m SignalHandlerId
onCellRendererEditingStarted :: (IsCellRenderer a, MonadIO m) => a -> ((?self :: a) => CellRendererEditingStartedCallback) -> m SignalHandlerId

Exported types

newtype CellRenderer Source #

Memory-managed wrapper type.

Constructors

CellRenderer (ManagedPtr CellRenderer)

Instances

Instances details

Eq CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods (==) :: CellRenderer -> CellRenderer -> Bool # (/=) :: CellRenderer -> CellRenderer -> Bool #
GObject CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer
ManagedPtrNewtype CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods toManagedPtr :: CellRenderer -> ManagedPtr CellRenderer #
TypedObject CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods glibType :: IO GType #
HasParentTypes CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer
HasAttributeList CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer
(info ~ ResolveCellRendererMethod t CellRenderer, OverloadedMethod info CellRenderer p, HasField t CellRenderer p) => HasField (t :: Symbol) CellRenderer (p :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods getField :: CellRenderer -> p #
(info ~ ResolveCellRendererMethod t CellRenderer, OverloadedMethodInfo info CellRenderer) => IsLabel t (MethodProxy info CellRenderer) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods fromLabel :: MethodProxy info CellRenderer #
(info ~ ResolveCellRendererMethod t CellRenderer, OverloadedMethod info CellRenderer p) => IsLabel t (CellRenderer -> p) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods fromLabel :: CellRenderer -> p #
IsGValue (Maybe CellRenderer) Source #	Convert `CellRenderer` to and from `GValue`. See `toGValue` and `fromGValue`.
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods gvalueGType_ :: IO GType # gvalueSet_ :: Ptr GValue -> Maybe CellRenderer -> IO () # gvalueGet_ :: Ptr GValue -> IO (Maybe CellRenderer) #
type AttributeList CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer type AttributeList CellRenderer
type ParentTypes CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer type ParentTypes CellRenderer = '[Object]
type SignalList CellRenderer Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer type SignalList CellRenderer

class (GObject o, IsDescendantOf CellRenderer o) => IsCellRenderer o Source #

Type class for types which can be safely cast to CellRenderer, for instance with toCellRenderer.

Instances

Instances details

(GObject o, IsDescendantOf CellRenderer o) => IsCellRenderer o Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer

toCellRenderer :: (MonadIO m, IsCellRenderer o) => o -> m CellRenderer Source #

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

Methods

Click to display all available methods, including inherited ones

Expand

Equations

ResolveCellRendererMethod "activate" o = CellRendererActivateMethodInfo
ResolveCellRendererMethod "bindProperty" o = ObjectBindPropertyMethodInfo
ResolveCellRendererMethod "bindPropertyFull" o = ObjectBindPropertyFullMethodInfo
ResolveCellRendererMethod "forceFloating" o = ObjectForceFloatingMethodInfo
ResolveCellRendererMethod "freezeNotify" o = ObjectFreezeNotifyMethodInfo
ResolveCellRendererMethod "getv" o = ObjectGetvMethodInfo
ResolveCellRendererMethod "isActivatable" o = CellRendererIsActivatableMethodInfo
ResolveCellRendererMethod "isFloating" o = ObjectIsFloatingMethodInfo
ResolveCellRendererMethod "notify" o = ObjectNotifyMethodInfo
ResolveCellRendererMethod "notifyByPspec" o = ObjectNotifyByPspecMethodInfo
ResolveCellRendererMethod "ref" o = ObjectRefMethodInfo
ResolveCellRendererMethod "refSink" o = ObjectRefSinkMethodInfo
ResolveCellRendererMethod "render" o = CellRendererRenderMethodInfo
ResolveCellRendererMethod "runDispose" o = ObjectRunDisposeMethodInfo
ResolveCellRendererMethod "startEditing" o = CellRendererStartEditingMethodInfo
ResolveCellRendererMethod "stealData" o = ObjectStealDataMethodInfo
ResolveCellRendererMethod "stealQdata" o = ObjectStealQdataMethodInfo
ResolveCellRendererMethod "stopEditing" o = CellRendererStopEditingMethodInfo
ResolveCellRendererMethod "thawNotify" o = ObjectThawNotifyMethodInfo
ResolveCellRendererMethod "unref" o = ObjectUnrefMethodInfo
ResolveCellRendererMethod "watchClosure" o = ObjectWatchClosureMethodInfo
ResolveCellRendererMethod "getAlignedArea" o = CellRendererGetAlignedAreaMethodInfo
ResolveCellRendererMethod "getAlignment" o = CellRendererGetAlignmentMethodInfo
ResolveCellRendererMethod "getData" o = ObjectGetDataMethodInfo
ResolveCellRendererMethod "getFixedSize" o = CellRendererGetFixedSizeMethodInfo
ResolveCellRendererMethod "getPadding" o = CellRendererGetPaddingMethodInfo
ResolveCellRendererMethod "getPreferredHeight" o = CellRendererGetPreferredHeightMethodInfo
ResolveCellRendererMethod "getPreferredHeightForWidth" o = CellRendererGetPreferredHeightForWidthMethodInfo
ResolveCellRendererMethod "getPreferredSize" o = CellRendererGetPreferredSizeMethodInfo
ResolveCellRendererMethod "getPreferredWidth" o = CellRendererGetPreferredWidthMethodInfo
ResolveCellRendererMethod "getPreferredWidthForHeight" o = CellRendererGetPreferredWidthForHeightMethodInfo
ResolveCellRendererMethod "getProperty" o = ObjectGetPropertyMethodInfo
ResolveCellRendererMethod "getQdata" o = ObjectGetQdataMethodInfo
ResolveCellRendererMethod "getRequestMode" o = CellRendererGetRequestModeMethodInfo
ResolveCellRendererMethod "getSensitive" o = CellRendererGetSensitiveMethodInfo
ResolveCellRendererMethod "getSize" o = CellRendererGetSizeMethodInfo
ResolveCellRendererMethod "getState" o = CellRendererGetStateMethodInfo
ResolveCellRendererMethod "getVisible" o = CellRendererGetVisibleMethodInfo
ResolveCellRendererMethod "setAlignment" o = CellRendererSetAlignmentMethodInfo
ResolveCellRendererMethod "setData" o = ObjectSetDataMethodInfo
ResolveCellRendererMethod "setDataFull" o = ObjectSetDataFullMethodInfo
ResolveCellRendererMethod "setFixedSize" o = CellRendererSetFixedSizeMethodInfo
ResolveCellRendererMethod "setPadding" o = CellRendererSetPaddingMethodInfo
ResolveCellRendererMethod "setProperty" o = ObjectSetPropertyMethodInfo
ResolveCellRendererMethod "setSensitive" o = CellRendererSetSensitiveMethodInfo
ResolveCellRendererMethod "setVisible" o = CellRendererSetVisibleMethodInfo
ResolveCellRendererMethod l o = MethodResolutionFailed l o :: Type

activate

data CellRendererActivateMethodInfo Source #

Instances

Instances details

(signature ~ (Event -> b -> Text -> Rectangle -> Rectangle -> [CellRendererState] -> m Bool), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererActivateMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererActivateMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererActivate Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer`
-> Event	`event`: a `Event`
-> b	`widget`: widget that received the event
-> Text	`path`: widget-dependent string representation of the event location; e.g. for `TreeView`, a string representation of `TreePath`
-> Rectangle	`backgroundArea`: background area as passed to `cellRendererRender`
-> Rectangle	`cellArea`: cell area as passed to `cellRendererRender`
-> [CellRendererState]	`flags`: render flags
-> m Bool	Returns: `True` if the event was consumed/handled

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 #

Instances

Instances details

(signature ~ (b -> [CellRendererState] -> Rectangle -> m Rectangle), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetAlignedAreaMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetAlignedAreaMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetAlignedArea Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer` instance
-> b	`widget`: the `Widget` this cell will be rendering to
-> [CellRendererState]	`flags`: render flags
-> Rectangle	`cellArea`: cell area which would be passed to `cellRendererRender`
-> 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 #

Instances

Instances details

(signature ~ m (Float, Float), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererGetAlignmentMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetAlignmentMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetAlignment Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> m (Float, Float)

Fills in xalign and yalign with the appropriate values of cell.

Since: 2.18

getFixedSize

data CellRendererGetFixedSizeMethodInfo Source #

Instances

Instances details

(signature ~ m (Int32, Int32), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererGetFixedSizeMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetFixedSizeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetFixedSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> m (Int32, Int32)

Fills in width and height with the appropriate size of cell.

getPadding

data CellRendererGetPaddingMethodInfo Source #

Instances

Instances details

(signature ~ m (Int32, Int32), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererGetPaddingMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetPaddingMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetPadding Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> m (Int32, Int32)

Fills in xpad and ypad with the appropriate values of cell.

Since: 2.18

getPreferredHeight

data CellRendererGetPreferredHeightMethodInfo Source #

Instances

Instances details

(signature ~ (b -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetPreferredHeightMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetPreferredHeightMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetPreferredHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer` instance
-> b	`widget`: the `Widget` this cell will be rendering to
-> m (Int32, Int32)

Retreives a renderer’s natural size when rendered to widget.

Since: 3.0

getPreferredHeightForWidth

data CellRendererGetPreferredHeightForWidthMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Int32 -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetPreferredHeightForWidthMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetPreferredHeightForWidthMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetPreferredHeightForWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer` instance
-> b	`widget`: the `Widget` this cell will be rendering to
-> Int32	`width`: the size which is available for allocation
-> 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 #

Instances

Instances details

(signature ~ (b -> m (Requisition, Requisition)), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetPreferredSizeMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetPreferredSizeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetPreferredSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer` instance
-> b	`widget`: the `Widget` this cell will be rendering to
-> 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 #

Instances

Instances details

(signature ~ (b -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetPreferredWidthMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetPreferredWidthMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetPreferredWidth Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer` instance
-> b	`widget`: the `Widget` this cell will be rendering to
-> m (Int32, Int32)

Retreives a renderer’s natural size when rendered to widget.

Since: 3.0

getPreferredWidthForHeight

data CellRendererGetPreferredWidthForHeightMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Int32 -> m (Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetPreferredWidthForHeightMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetPreferredWidthForHeightMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetPreferredWidthForHeight Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer` instance
-> b	`widget`: the `Widget` this cell will be rendering to
-> Int32	`height`: the size which is available for allocation
-> 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 #

Instances

Instances details

(signature ~ m SizeRequestMode, MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererGetRequestModeMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetRequestModeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetRequestMode Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: a `CellRenderer` instance
-> m SizeRequestMode	Returns: The `SizeRequestMode` preferred by this renderer.

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

Since: 3.0

getSensitive

data CellRendererGetSensitiveMethodInfo Source #

Instances

Instances details

(signature ~ m Bool, MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererGetSensitiveMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetSensitiveMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetSensitive Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> m Bool	Returns: `True` if the cell renderer is sensitive

Returns the cell renderer’s sensitivity.

Since: 2.18

getSize

data CellRendererGetSizeMethodInfo Source #

Instances

Instances details

(signature ~ (b -> Maybe Rectangle -> m (Int32, Int32, Int32, Int32)), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetSizeMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetSizeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer`
-> b	`widget`: the widget the renderer is rendering to
-> Maybe Rectangle	`cellArea`: The area a cell will be allocated, or `Nothing`
-> 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 #

Instances

Instances details

(signature ~ (Maybe b -> [CellRendererState] -> m [StateFlags]), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererGetStateMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetStateMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetState Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> Maybe a	`cell`: a `CellRenderer`, or `Nothing`
-> Maybe b	`widget`: a `Widget`, or `Nothing`
-> [CellRendererState]	`cellState`: cell renderer state
-> m [StateFlags]	Returns: the widget state flags applying to `cell`

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 #

Instances

Instances details

(signature ~ m Bool, MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererGetVisibleMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererGetVisibleMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererGetVisible Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> m Bool	Returns: `True` if the cell renderer is visible

Returns the cell renderer’s visibility.

Since: 2.18

isActivatable

data CellRendererIsActivatableMethodInfo Source #

Instances

Instances details

(signature ~ m Bool, MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererIsActivatableMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererIsActivatableMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererIsActivatable Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> m Bool	Returns: `True` if the cell renderer can do anything when activated

Checks whether the cell renderer can do something when activated.

Since: 3.0

render

data CellRendererRenderMethodInfo Source #

Instances

Instances details

(signature ~ (Context -> b -> Rectangle -> Rectangle -> [CellRendererState] -> m ()), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererRenderMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererRenderMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererRender Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer`
-> Context	`cr`: a cairo context to draw to
-> b	`widget`: the widget owning `window`
-> Rectangle	`backgroundArea`: entire cell area (including tree expanders and maybe padding on the sides)
-> Rectangle	`cellArea`: area normally rendered by a cell renderer
-> [CellRendererState]	`flags`: flags that affect rendering
-> 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 #

Instances

Instances details

(signature ~ (Float -> Float -> m ()), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererSetAlignmentMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererSetAlignmentMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererSetAlignment Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> Float	`xalign`: the x alignment of the cell renderer
-> Float	`yalign`: the y alignment of the cell renderer
-> m ()

Sets the renderer’s alignment within its available space.

Since: 2.18

setFixedSize

data CellRendererSetFixedSizeMethodInfo Source #

Instances

Instances details

(signature ~ (Int32 -> Int32 -> m ()), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererSetFixedSizeMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererSetFixedSizeMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererSetFixedSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> Int32	`width`: the width of the cell renderer, or -1
-> Int32	`height`: the height of the cell renderer, or -1
-> m ()

Sets the renderer size to be explicit, independent of the properties set.

setPadding

data CellRendererSetPaddingMethodInfo Source #

Instances

Instances details

(signature ~ (Int32 -> Int32 -> m ()), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererSetPaddingMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererSetPaddingMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererSetPadding Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> Int32	`xpad`: the x padding of the cell renderer
-> Int32	`ypad`: the y padding of the cell renderer
-> m ()

Sets the renderer’s padding.

Since: 2.18

setSensitive

data CellRendererSetSensitiveMethodInfo Source #

Instances

Instances details

(signature ~ (Bool -> m ()), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererSetSensitiveMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererSetSensitiveMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererSetSensitive Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> Bool	`sensitive`: the sensitivity of the cell
-> m ()

Sets the cell renderer’s sensitivity.

Since: 2.18

setVisible

data CellRendererSetVisibleMethodInfo Source #

Instances

Instances details

(signature ~ (Bool -> m ()), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererSetVisibleMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererSetVisibleMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererSetVisible Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> Bool	`visible`: the visibility of the cell
-> m ()

Sets the cell renderer’s visibility.

Since: 2.18

startEditing

data CellRendererStartEditingMethodInfo Source #

Instances

Instances details

(signature ~ (Maybe Event -> b -> Text -> Rectangle -> Rectangle -> [CellRendererState] -> m (Maybe CellEditable)), MonadIO m, IsCellRenderer a, IsWidget b) => OverloadedMethod CellRendererStartEditingMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererStartEditingMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererStartEditing Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a, IsWidget b)
=> a	`cell`: a `CellRenderer`
-> Maybe Event	`event`: a `Event`
-> b	`widget`: widget that received the event
-> Text	`path`: widget-dependent string representation of the event location; e.g. for `TreeView`, a string representation of `TreePath`
-> Rectangle	`backgroundArea`: background area as passed to `cellRendererRender`
-> Rectangle	`cellArea`: cell area as passed to `cellRendererRender`
-> [CellRendererState]	`flags`: render flags
-> m (Maybe CellEditable)	Returns: A new `CellEditable` for editing this `cell`, or `Nothing` if editing is not possible

Starts editing the contents of this cell, through a new CellEditable widget created by the CellRendererClass.start_editing virtual function.

stopEditing

data CellRendererStopEditingMethodInfo Source #

Instances

Instances details

(signature ~ (Bool -> m ()), MonadIO m, IsCellRenderer a) => OverloadedMethod CellRendererStopEditingMethodInfo a signature Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethod :: a -> signature #
OverloadedMethodInfo CellRendererStopEditingMethodInfo (a :: Type) Source #
Instance details Defined in GI.Gtk.Objects.CellRenderer Methods overloadedMethodInfo :: Maybe ResolvedSymbolInfo #

cellRendererStopEditing Source #

Arguments

:: (HasCallStack, MonadIO m, IsCellRenderer a)
=> a	`cell`: A `CellRenderer`
-> Bool	`canceled`: `True` if the editing has been canceled
-> m ()

Informs the cell renderer that the editing is stopped. If canceled is True, the cell renderer will emit the CellRenderer::editingCanceled signal.

This function should be called by cell renderer implementations in response to the CellEditable::editingDone signal of CellEditable.

Since: 2.6

Properties

cellBackground

No description available in the introspection data.

data CellRendererCellBackgroundPropertyInfo Source #

Instances

Instances details

AttrInfo CellRendererCellBackgroundPropertyInfo Source #

Instance details

= CellEditable	`editable`: the `CellEditable`
-> Text	`path`: the path identifying the edited cell
-> IO ()

Exported types

Instances

Instances

Methods

Click to display all available methods, including inherited ones

Methods

Getters

Setters

activate

Instances

getAlignedArea

Instances

getAlignment

Instances

getFixedSize

Instances

getPadding

Instances

getPreferredHeight

Instances

getPreferredHeightForWidth

Instances

getPreferredSize

Instances

getPreferredWidth

Instances

getPreferredWidthForHeight

Instances

getRequestMode

Instances

getSensitive

Instances

getSize

Instances

getState

Instances

getVisible

Instances

isActivatable

Instances

render

Instances

setAlignment

Instances

setFixedSize

Instances

setPadding

Instances

setSensitive

Instances

setVisible

Instances

startEditing

Instances

stopEditing

Instances

Properties

cellBackground

Instances

cellBackgroundGdk

Instances

cellBackgroundRgba

Instances

cellBackgroundSet

Instances

editing

Instances

height

Instances

isExpanded

Instances

isExpander

Instances

mode

Instances

sensitive

Instances

visible

Instances

width