Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | None |
Language | Haskell2010 |
No description available in the introspection data.
Synopsis
- newtype GutterRenderer = GutterRenderer (ManagedPtr GutterRenderer)
- class (GObject o, IsDescendantOf GutterRenderer o) => IsGutterRenderer o
- toGutterRenderer :: (MonadIO m, IsGutterRenderer o) => o -> m GutterRenderer
- noGutterRenderer :: Maybe GutterRenderer
- gutterRendererActivate :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> TextIter -> Rectangle -> Event -> m ()
- gutterRendererBegin :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> Context -> Rectangle -> Rectangle -> TextIter -> TextIter -> m ()
- gutterRendererDraw :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> Context -> Rectangle -> Rectangle -> TextIter -> TextIter -> [GutterRendererState] -> m ()
- gutterRendererEnd :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m ()
- gutterRendererGetAlignmentMode :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m GutterRendererAlignmentMode
- gutterRendererGetBackground :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m (Bool, RGBA)
- gutterRendererGetSize :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m Int32
- gutterRendererGetView :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m TextView
- gutterRendererGetVisible :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m Bool
- gutterRendererGetWindowType :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m TextWindowType
- gutterRendererQueryActivatable :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> TextIter -> Rectangle -> Event -> m Bool
- gutterRendererQueryData :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> TextIter -> TextIter -> [GutterRendererState] -> m ()
- gutterRendererQueryTooltip :: (HasCallStack, MonadIO m, IsGutterRenderer a, IsTooltip b) => a -> TextIter -> Rectangle -> Int32 -> Int32 -> b -> m Bool
- gutterRendererQueueDraw :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> m ()
- gutterRendererSetAlignment :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> Float -> Float -> m ()
- gutterRendererSetAlignmentMode :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> GutterRendererAlignmentMode -> m ()
- gutterRendererSetBackground :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> Maybe RGBA -> m ()
- gutterRendererSetPadding :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> Int32 -> Int32 -> m ()
- gutterRendererSetSize :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> Int32 -> m ()
- gutterRendererSetVisible :: (HasCallStack, MonadIO m, IsGutterRenderer a) => a -> Bool -> m ()
- constructGutterRendererAlignmentMode :: IsGutterRenderer o => GutterRendererAlignmentMode -> IO (GValueConstruct o)
- getGutterRendererAlignmentMode :: (MonadIO m, IsGutterRenderer o) => o -> m GutterRendererAlignmentMode
- setGutterRendererAlignmentMode :: (MonadIO m, IsGutterRenderer o) => o -> GutterRendererAlignmentMode -> m ()
- clearGutterRendererBackgroundRgba :: (MonadIO m, IsGutterRenderer o) => o -> m ()
- constructGutterRendererBackgroundRgba :: IsGutterRenderer o => RGBA -> IO (GValueConstruct o)
- getGutterRendererBackgroundRgba :: (MonadIO m, IsGutterRenderer o) => o -> m (Maybe RGBA)
- setGutterRendererBackgroundRgba :: (MonadIO m, IsGutterRenderer o) => o -> RGBA -> m ()
- constructGutterRendererBackgroundSet :: IsGutterRenderer o => Bool -> IO (GValueConstruct o)
- getGutterRendererBackgroundSet :: (MonadIO m, IsGutterRenderer o) => o -> m Bool
- setGutterRendererBackgroundSet :: (MonadIO m, IsGutterRenderer o) => o -> Bool -> m ()
- constructGutterRendererSize :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o)
- getGutterRendererSize :: (MonadIO m, IsGutterRenderer o) => o -> m Int32
- setGutterRendererSize :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m ()
- getGutterRendererView :: (MonadIO m, IsGutterRenderer o) => o -> m TextView
- constructGutterRendererVisible :: IsGutterRenderer o => Bool -> IO (GValueConstruct o)
- getGutterRendererVisible :: (MonadIO m, IsGutterRenderer o) => o -> m Bool
- setGutterRendererVisible :: (MonadIO m, IsGutterRenderer o) => o -> Bool -> m ()
- getGutterRendererWindowType :: (MonadIO m, IsGutterRenderer o) => o -> m TextWindowType
- constructGutterRendererXalign :: IsGutterRenderer o => Float -> IO (GValueConstruct o)
- getGutterRendererXalign :: (MonadIO m, IsGutterRenderer o) => o -> m Float
- setGutterRendererXalign :: (MonadIO m, IsGutterRenderer o) => o -> Float -> m ()
- constructGutterRendererXpad :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o)
- getGutterRendererXpad :: (MonadIO m, IsGutterRenderer o) => o -> m Int32
- setGutterRendererXpad :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m ()
- constructGutterRendererYalign :: IsGutterRenderer o => Float -> IO (GValueConstruct o)
- getGutterRendererYalign :: (MonadIO m, IsGutterRenderer o) => o -> m Float
- setGutterRendererYalign :: (MonadIO m, IsGutterRenderer o) => o -> Float -> m ()
- constructGutterRendererYpad :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o)
- getGutterRendererYpad :: (MonadIO m, IsGutterRenderer o) => o -> m Int32
- setGutterRendererYpad :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m ()
- type C_GutterRendererActivateCallback = Ptr () -> Ptr TextIter -> Ptr Rectangle -> Ptr Event -> Ptr () -> IO ()
- type GutterRendererActivateCallback = TextIter -> Rectangle -> Event -> IO ()
- afterGutterRendererActivate :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererActivateCallback -> m SignalHandlerId
- genClosure_GutterRendererActivate :: MonadIO m => GutterRendererActivateCallback -> m (GClosure C_GutterRendererActivateCallback)
- mk_GutterRendererActivateCallback :: C_GutterRendererActivateCallback -> IO (FunPtr C_GutterRendererActivateCallback)
- noGutterRendererActivateCallback :: Maybe GutterRendererActivateCallback
- onGutterRendererActivate :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererActivateCallback -> m SignalHandlerId
- wrap_GutterRendererActivateCallback :: GutterRendererActivateCallback -> C_GutterRendererActivateCallback
- type C_GutterRendererQueryActivatableCallback = Ptr () -> Ptr TextIter -> Ptr Rectangle -> Ptr Event -> Ptr () -> IO CInt
- type GutterRendererQueryActivatableCallback = TextIter -> Rectangle -> Event -> IO Bool
- afterGutterRendererQueryActivatable :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryActivatableCallback -> m SignalHandlerId
- genClosure_GutterRendererQueryActivatable :: MonadIO m => GutterRendererQueryActivatableCallback -> m (GClosure C_GutterRendererQueryActivatableCallback)
- mk_GutterRendererQueryActivatableCallback :: C_GutterRendererQueryActivatableCallback -> IO (FunPtr C_GutterRendererQueryActivatableCallback)
- noGutterRendererQueryActivatableCallback :: Maybe GutterRendererQueryActivatableCallback
- onGutterRendererQueryActivatable :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryActivatableCallback -> m SignalHandlerId
- wrap_GutterRendererQueryActivatableCallback :: GutterRendererQueryActivatableCallback -> C_GutterRendererQueryActivatableCallback
- type C_GutterRendererQueryDataCallback = Ptr () -> Ptr TextIter -> Ptr TextIter -> CUInt -> Ptr () -> IO ()
- type GutterRendererQueryDataCallback = TextIter -> TextIter -> [GutterRendererState] -> IO ()
- afterGutterRendererQueryData :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryDataCallback -> m SignalHandlerId
- genClosure_GutterRendererQueryData :: MonadIO m => GutterRendererQueryDataCallback -> m (GClosure C_GutterRendererQueryDataCallback)
- mk_GutterRendererQueryDataCallback :: C_GutterRendererQueryDataCallback -> IO (FunPtr C_GutterRendererQueryDataCallback)
- noGutterRendererQueryDataCallback :: Maybe GutterRendererQueryDataCallback
- onGutterRendererQueryData :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryDataCallback -> m SignalHandlerId
- wrap_GutterRendererQueryDataCallback :: GutterRendererQueryDataCallback -> C_GutterRendererQueryDataCallback
- type C_GutterRendererQueryTooltipCallback = Ptr () -> Ptr TextIter -> Ptr Rectangle -> Int32 -> Int32 -> Ptr Tooltip -> Ptr () -> IO CInt
- type GutterRendererQueryTooltipCallback = TextIter -> Rectangle -> Int32 -> Int32 -> Tooltip -> IO Bool
- afterGutterRendererQueryTooltip :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryTooltipCallback -> m SignalHandlerId
- genClosure_GutterRendererQueryTooltip :: MonadIO m => GutterRendererQueryTooltipCallback -> m (GClosure C_GutterRendererQueryTooltipCallback)
- mk_GutterRendererQueryTooltipCallback :: C_GutterRendererQueryTooltipCallback -> IO (FunPtr C_GutterRendererQueryTooltipCallback)
- noGutterRendererQueryTooltipCallback :: Maybe GutterRendererQueryTooltipCallback
- onGutterRendererQueryTooltip :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryTooltipCallback -> m SignalHandlerId
- wrap_GutterRendererQueryTooltipCallback :: GutterRendererQueryTooltipCallback -> C_GutterRendererQueryTooltipCallback
- type C_GutterRendererQueueDrawCallback = Ptr () -> Ptr () -> IO ()
- type GutterRendererQueueDrawCallback = IO ()
- afterGutterRendererQueueDraw :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueueDrawCallback -> m SignalHandlerId
- genClosure_GutterRendererQueueDraw :: MonadIO m => GutterRendererQueueDrawCallback -> m (GClosure C_GutterRendererQueueDrawCallback)
- mk_GutterRendererQueueDrawCallback :: C_GutterRendererQueueDrawCallback -> IO (FunPtr C_GutterRendererQueueDrawCallback)
- noGutterRendererQueueDrawCallback :: Maybe GutterRendererQueueDrawCallback
- onGutterRendererQueueDraw :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueueDrawCallback -> m SignalHandlerId
- wrap_GutterRendererQueueDrawCallback :: GutterRendererQueueDrawCallback -> C_GutterRendererQueueDrawCallback
Exported types
newtype GutterRenderer Source #
Memory-managed wrapper type.
Instances
Eq GutterRenderer Source # | |
Defined in GI.GtkSource.Objects.GutterRenderer (==) :: GutterRenderer -> GutterRenderer -> Bool # (/=) :: GutterRenderer -> GutterRenderer -> Bool # | |
IsGValue GutterRenderer Source # | Convert |
Defined in GI.GtkSource.Objects.GutterRenderer toGValue :: GutterRenderer -> IO GValue # fromGValue :: GValue -> IO GutterRenderer # | |
GObject GutterRenderer Source # | |
Defined in GI.GtkSource.Objects.GutterRenderer gobjectType :: IO GType # | |
HasParentTypes GutterRenderer Source # | |
Defined in GI.GtkSource.Objects.GutterRenderer | |
type ParentTypes GutterRenderer Source # | |
Defined in GI.GtkSource.Objects.GutterRenderer |
class (GObject o, IsDescendantOf GutterRenderer o) => IsGutterRenderer o Source #
Type class for types which can be safely cast to GutterRenderer
, for instance with toGutterRenderer
.
Instances
(GObject o, IsDescendantOf GutterRenderer o) => IsGutterRenderer o Source # | |
Defined in GI.GtkSource.Objects.GutterRenderer |
toGutterRenderer :: (MonadIO m, IsGutterRenderer o) => o -> m GutterRenderer Source #
Cast to GutterRenderer
, for types for which this is known to be safe. For general casts, use castTo
.
noGutterRenderer :: Maybe GutterRenderer Source #
A convenience alias for Nothing
:: Maybe
GutterRenderer
.
Methods
Overloaded methods
activate
gutterRendererActivate Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> TextIter |
|
-> Rectangle |
|
-> Event |
|
-> m () |
begin
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> Context |
|
-> Rectangle |
|
-> Rectangle |
|
-> TextIter |
|
-> TextIter |
|
-> m () |
Called when drawing a region begins. The region to be drawn is indicated
by start
and end
. The purpose is to allow the implementation to precompute
some state before the draw method is called for each cell.
draw
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> Context |
|
-> Rectangle |
|
-> Rectangle |
|
-> TextIter |
|
-> TextIter |
|
-> [GutterRendererState] |
|
-> m () |
Main renderering method. Implementations should implement this method to draw
onto the cairo context. The backgroundArea
indicates the total area of the
cell to be drawn. The cellArea
indicates the area where content can be
drawn (text, images, etc).
The backgroundArea
is the cellArea
plus the padding on each side (two
times the GutterRenderer
:xpad
horizontally and two times the
GutterRenderer
:ypad
vertically, so that the cellArea
is centered
inside backgroundArea
).
The state
argument indicates the current state of the renderer and should
be taken into account to properly draw the different possible states
(cursor, prelit, selected) if appropriate.
end
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m () |
Called when drawing a region of lines has ended.
getAlignmentMode
gutterRendererGetAlignmentMode Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m GutterRendererAlignmentMode | Returns: a |
Get the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).
getBackground
gutterRendererGetBackground Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m (Bool, RGBA) | Returns: |
Get the background color of the renderer.
getSize
gutterRendererGetSize Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m Int32 | Returns: the size of the renderer. |
Get the size of the renderer.
getView
gutterRendererGetView Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m TextView | Returns: a |
Get the view associated to the gutter renderer
getVisible
gutterRendererGetVisible Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m Bool |
Get whether the gutter renderer is visible.
getWindowType
gutterRendererGetWindowType Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m TextWindowType | Returns: a |
Get the TextWindowType
associated with the gutter renderer.
queryActivatable
gutterRendererQueryActivatable Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> TextIter |
|
-> Rectangle |
|
-> Event |
|
-> m Bool | Returns: |
Get whether the renderer is activatable at the location in event
. This is
called from Gutter
to determine whether a renderer is activatable
using the mouse pointer.
queryData
gutterRendererQueryData Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> TextIter |
|
-> TextIter |
|
-> [GutterRendererState] |
|
-> m () |
queryTooltip
gutterRendererQueryTooltip Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a, IsTooltip b) | |
=> a |
|
-> TextIter |
|
-> Rectangle |
|
-> Int32 |
|
-> Int32 |
|
-> b |
|
-> m Bool |
Emits the queryTooltip signal. This function is
called from Gutter
. Implementations can override the default signal
handler or can connect to the signal externally.
queueDraw
gutterRendererQueueDraw Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> m () |
Emits the queueDraw signal of the renderer. Call this from an implementation to inform that the renderer has changed such that it needs to redraw.
setAlignment
gutterRendererSetAlignment Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> Float |
|
-> Float |
|
-> m () |
Set the alignment of the gutter renderer. Both xalign
and yalign
can be
-1, which means the values will not be changed (this allows changing only
one of the values).
xalign
is the horizontal alignment. Set to 0 for a left alignment. 1 for a
right alignment. And 0.5 for centering the cells. yalign
is the vertical
alignment. Set to 0 for a top alignment. 1 for a bottom alignment.
setAlignmentMode
gutterRendererSetAlignmentMode Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> GutterRendererAlignmentMode |
|
-> m () |
Set the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).
setBackground
gutterRendererSetBackground Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> Maybe RGBA | |
-> m () |
Set the background color of the renderer. If color
is set to Nothing
, the
renderer will not have a background color.
setPadding
gutterRendererSetPadding Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> Int32 |
|
-> Int32 |
|
-> m () |
Set the padding of the gutter renderer. Both xpad
and ypad
can be
-1, which means the values will not be changed (this allows changing only
one of the values).
xpad
is the left and right padding. ypad
is the top and bottom padding.
setSize
gutterRendererSetSize Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> Int32 |
|
-> m () |
Sets the size of the renderer. A value of -1 specifies that the size is to be determined dynamically.
setVisible
gutterRendererSetVisible Source #
:: (HasCallStack, MonadIO m, IsGutterRenderer a) | |
=> a |
|
-> Bool |
|
-> m () |
Set whether the gutter renderer is visible.
Properties
alignmentMode
The alignment mode of the renderer. This can be used to indicate that in the case a cell spans multiple lines (due to text wrapping) the alignment should work on either the full cell, the first line or the last line.
constructGutterRendererAlignmentMode :: IsGutterRenderer o => GutterRendererAlignmentMode -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “alignment-mode
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererAlignmentMode :: (MonadIO m, IsGutterRenderer o) => o -> m GutterRendererAlignmentMode Source #
Get the value of the “alignment-mode
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #alignmentMode
setGutterRendererAlignmentMode :: (MonadIO m, IsGutterRenderer o) => o -> GutterRendererAlignmentMode -> m () Source #
Set the value of the “alignment-mode
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #alignmentMode:=
value ]
backgroundRgba
No description available in the introspection data.
clearGutterRendererBackgroundRgba :: (MonadIO m, IsGutterRenderer o) => o -> m () Source #
Set the value of the “background-rgba
” property to Nothing
.
When overloading is enabled, this is equivalent to
clear
#backgroundRgba
constructGutterRendererBackgroundRgba :: IsGutterRenderer o => RGBA -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “background-rgba
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererBackgroundRgba :: (MonadIO m, IsGutterRenderer o) => o -> m (Maybe RGBA) Source #
Get the value of the “background-rgba
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #backgroundRgba
setGutterRendererBackgroundRgba :: (MonadIO m, IsGutterRenderer o) => o -> RGBA -> m () Source #
Set the value of the “background-rgba
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #backgroundRgba:=
value ]
backgroundSet
No description available in the introspection data.
constructGutterRendererBackgroundSet :: IsGutterRenderer o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “background-set
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererBackgroundSet :: (MonadIO m, IsGutterRenderer o) => o -> m Bool Source #
Get the value of the “background-set
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #backgroundSet
setGutterRendererBackgroundSet :: (MonadIO m, IsGutterRenderer o) => o -> Bool -> m () Source #
Set the value of the “background-set
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #backgroundSet:=
value ]
size
No description available in the introspection data.
constructGutterRendererSize :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “size
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererSize :: (MonadIO m, IsGutterRenderer o) => o -> m Int32 Source #
Get the value of the “size
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #size
setGutterRendererSize :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m () Source #
Set the value of the “size
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #size:=
value ]
view
The view on which the renderer is placed.
getGutterRendererView :: (MonadIO m, IsGutterRenderer o) => o -> m TextView Source #
Get the value of the “view
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #view
visible
The visibility of the renderer.
constructGutterRendererVisible :: IsGutterRenderer o => Bool -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “visible
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererVisible :: (MonadIO m, IsGutterRenderer o) => o -> m Bool Source #
Get the value of the “visible
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #visible
setGutterRendererVisible :: (MonadIO m, IsGutterRenderer o) => o -> Bool -> m () Source #
Set the value of the “visible
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #visible:=
value ]
windowType
The window type of the view on which the renderer is placed (left, or right).
getGutterRendererWindowType :: (MonadIO m, IsGutterRenderer o) => o -> m TextWindowType Source #
Get the value of the “window-type
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #windowType
xalign
The horizontal alignment of the renderer. Set to 0 for a left alignment. 1 for a right alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment.
constructGutterRendererXalign :: IsGutterRenderer o => Float -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “xalign
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererXalign :: (MonadIO m, IsGutterRenderer o) => o -> m Float Source #
Get the value of the “xalign
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #xalign
setGutterRendererXalign :: (MonadIO m, IsGutterRenderer o) => o -> Float -> m () Source #
Set the value of the “xalign
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #xalign:=
value ]
xpad
The left and right padding of the renderer.
constructGutterRendererXpad :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “xpad
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererXpad :: (MonadIO m, IsGutterRenderer o) => o -> m Int32 Source #
Get the value of the “xpad
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #xpad
setGutterRendererXpad :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m () Source #
Set the value of the “xpad
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #xpad:=
value ]
yalign
The vertical alignment of the renderer. Set to 0 for a top alignment. 1 for a bottom alignment. And 0.5 for centering the cells. A value lower than 0 doesn't modify the alignment.
constructGutterRendererYalign :: IsGutterRenderer o => Float -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “yalign
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererYalign :: (MonadIO m, IsGutterRenderer o) => o -> m Float Source #
Get the value of the “yalign
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #yalign
setGutterRendererYalign :: (MonadIO m, IsGutterRenderer o) => o -> Float -> m () Source #
Set the value of the “yalign
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #yalign:=
value ]
ypad
The top and bottom padding of the renderer.
constructGutterRendererYpad :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “ypad
” property. This is rarely needed directly, but it is used by new
.
getGutterRendererYpad :: (MonadIO m, IsGutterRenderer o) => o -> m Int32 Source #
Get the value of the “ypad
” property.
When overloading is enabled, this is equivalent to
get
gutterRenderer #ypad
setGutterRendererYpad :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m () Source #
Set the value of the “ypad
” property.
When overloading is enabled, this is equivalent to
set
gutterRenderer [ #ypad:=
value ]
Signals
activate
type C_GutterRendererActivateCallback = Ptr () -> Ptr TextIter -> Ptr Rectangle -> Ptr Event -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type GutterRendererActivateCallback Source #
= TextIter |
|
-> Rectangle |
|
-> Event |
|
-> IO () |
The activate signal is emitted when the renderer is activated.
afterGutterRendererActivate :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererActivateCallback -> m SignalHandlerId Source #
Connect a signal handler for the activate signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
gutterRenderer #activate callback
genClosure_GutterRendererActivate :: MonadIO m => GutterRendererActivateCallback -> m (GClosure C_GutterRendererActivateCallback) Source #
Wrap the callback into a GClosure
.
mk_GutterRendererActivateCallback :: C_GutterRendererActivateCallback -> IO (FunPtr C_GutterRendererActivateCallback) Source #
Generate a function pointer callable from C code, from a C_GutterRendererActivateCallback
.
noGutterRendererActivateCallback :: Maybe GutterRendererActivateCallback Source #
A convenience synonym for
.Nothing
:: Maybe
GutterRendererActivateCallback
onGutterRendererActivate :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererActivateCallback -> m SignalHandlerId Source #
Connect a signal handler for the activate signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
gutterRenderer #activate callback
wrap_GutterRendererActivateCallback :: GutterRendererActivateCallback -> C_GutterRendererActivateCallback Source #
Wrap a GutterRendererActivateCallback
into a C_GutterRendererActivateCallback
.
queryActivatable
type C_GutterRendererQueryActivatableCallback = Ptr () -> Ptr TextIter -> Ptr Rectangle -> Ptr Event -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type GutterRendererQueryActivatableCallback Source #
= TextIter |
|
-> Rectangle |
|
-> Event |
|
-> IO Bool |
The queryActivatable signal is emitted when the renderer can possibly be activated.
afterGutterRendererQueryActivatable :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryActivatableCallback -> m SignalHandlerId Source #
Connect a signal handler for the queryActivatable signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
gutterRenderer #queryActivatable callback
genClosure_GutterRendererQueryActivatable :: MonadIO m => GutterRendererQueryActivatableCallback -> m (GClosure C_GutterRendererQueryActivatableCallback) Source #
Wrap the callback into a GClosure
.
mk_GutterRendererQueryActivatableCallback :: C_GutterRendererQueryActivatableCallback -> IO (FunPtr C_GutterRendererQueryActivatableCallback) Source #
Generate a function pointer callable from C code, from a C_GutterRendererQueryActivatableCallback
.
noGutterRendererQueryActivatableCallback :: Maybe GutterRendererQueryActivatableCallback Source #
A convenience synonym for
.Nothing
:: Maybe
GutterRendererQueryActivatableCallback
onGutterRendererQueryActivatable :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryActivatableCallback -> m SignalHandlerId Source #
Connect a signal handler for the queryActivatable signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
gutterRenderer #queryActivatable callback
wrap_GutterRendererQueryActivatableCallback :: GutterRendererQueryActivatableCallback -> C_GutterRendererQueryActivatableCallback Source #
queryData
type C_GutterRendererQueryDataCallback = Ptr () -> Ptr TextIter -> Ptr TextIter -> CUInt -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type GutterRendererQueryDataCallback Source #
= TextIter |
|
-> TextIter |
|
-> [GutterRendererState] |
|
-> IO () |
The queryData signal is emitted when the renderer needs to be filled with data just before a cell is drawn. This can be used by general renderer implementations to allow render data to be filled in externally.
afterGutterRendererQueryData :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryDataCallback -> m SignalHandlerId Source #
Connect a signal handler for the queryData signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
gutterRenderer #queryData callback
genClosure_GutterRendererQueryData :: MonadIO m => GutterRendererQueryDataCallback -> m (GClosure C_GutterRendererQueryDataCallback) Source #
Wrap the callback into a GClosure
.
mk_GutterRendererQueryDataCallback :: C_GutterRendererQueryDataCallback -> IO (FunPtr C_GutterRendererQueryDataCallback) Source #
Generate a function pointer callable from C code, from a C_GutterRendererQueryDataCallback
.
noGutterRendererQueryDataCallback :: Maybe GutterRendererQueryDataCallback Source #
A convenience synonym for
.Nothing
:: Maybe
GutterRendererQueryDataCallback
onGutterRendererQueryData :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryDataCallback -> m SignalHandlerId Source #
Connect a signal handler for the queryData signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
gutterRenderer #queryData callback
wrap_GutterRendererQueryDataCallback :: GutterRendererQueryDataCallback -> C_GutterRendererQueryDataCallback Source #
Wrap a GutterRendererQueryDataCallback
into a C_GutterRendererQueryDataCallback
.
queryTooltip
type C_GutterRendererQueryTooltipCallback = Ptr () -> Ptr TextIter -> Ptr Rectangle -> Int32 -> Int32 -> Ptr Tooltip -> Ptr () -> IO CInt Source #
Type for the callback on the (unwrapped) C side.
type GutterRendererQueryTooltipCallback Source #
= TextIter |
|
-> Rectangle |
|
-> Int32 |
|
-> Int32 |
|
-> Tooltip |
|
-> IO Bool |
The queryTooltip signal is emitted when the renderer can show a tooltip.
afterGutterRendererQueryTooltip :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryTooltipCallback -> m SignalHandlerId Source #
Connect a signal handler for the queryTooltip signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
gutterRenderer #queryTooltip callback
genClosure_GutterRendererQueryTooltip :: MonadIO m => GutterRendererQueryTooltipCallback -> m (GClosure C_GutterRendererQueryTooltipCallback) Source #
Wrap the callback into a GClosure
.
mk_GutterRendererQueryTooltipCallback :: C_GutterRendererQueryTooltipCallback -> IO (FunPtr C_GutterRendererQueryTooltipCallback) Source #
Generate a function pointer callable from C code, from a C_GutterRendererQueryTooltipCallback
.
noGutterRendererQueryTooltipCallback :: Maybe GutterRendererQueryTooltipCallback Source #
A convenience synonym for
.Nothing
:: Maybe
GutterRendererQueryTooltipCallback
onGutterRendererQueryTooltip :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryTooltipCallback -> m SignalHandlerId Source #
Connect a signal handler for the queryTooltip signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
gutterRenderer #queryTooltip callback
wrap_GutterRendererQueryTooltipCallback :: GutterRendererQueryTooltipCallback -> C_GutterRendererQueryTooltipCallback Source #
queueDraw
type C_GutterRendererQueueDrawCallback = Ptr () -> Ptr () -> IO () Source #
Type for the callback on the (unwrapped) C side.
type GutterRendererQueueDrawCallback = IO () Source #
The queueDraw signal is emitted when the renderer needs
to be redrawn. Use gutterRendererQueueDraw
to emit this signal from an implementation of the
GutterRenderer
interface.
afterGutterRendererQueueDraw :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueueDrawCallback -> m SignalHandlerId Source #
Connect a signal handler for the queueDraw signal, to be run after the default handler. When overloading is enabled, this is equivalent to
after
gutterRenderer #queueDraw callback
genClosure_GutterRendererQueueDraw :: MonadIO m => GutterRendererQueueDrawCallback -> m (GClosure C_GutterRendererQueueDrawCallback) Source #
Wrap the callback into a GClosure
.
mk_GutterRendererQueueDrawCallback :: C_GutterRendererQueueDrawCallback -> IO (FunPtr C_GutterRendererQueueDrawCallback) Source #
Generate a function pointer callable from C code, from a C_GutterRendererQueueDrawCallback
.
noGutterRendererQueueDrawCallback :: Maybe GutterRendererQueueDrawCallback Source #
A convenience synonym for
.Nothing
:: Maybe
GutterRendererQueueDrawCallback
onGutterRendererQueueDraw :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueueDrawCallback -> m SignalHandlerId Source #
Connect a signal handler for the queueDraw signal, to be run before the default handler. When overloading is enabled, this is equivalent to
on
gutterRenderer #queueDraw callback