GI.GtkSource.Objects.GutterRenderer

Exported types

newtype GutterRenderer

Constructors

GutterRenderer (ManagedPtr GutterRenderer)

Instances

GObject GutterRenderer

Methods

gobjectType :: GutterRenderer -> IO GType

IsObject GutterRenderer

IsGutterRenderer GutterRenderer

class GObject o => IsGutterRenderer o

Instances

(GObject a, UnknownAncestorError Constraint GutterRenderer a) => IsGutterRenderer a

IsGutterRenderer GutterRenderer

IsGutterRenderer GutterRendererPixbuf

IsGutterRenderer GutterRendererText

toGutterRenderer :: (MonadIO m, IsGutterRenderer o) => o -> m GutterRenderer

noGutterRenderer :: Maybe GutterRenderer

Methods

activate

gutterRendererActivate

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> TextIter

iter: a TextIter at the start of the line where the renderer is activated

-> Rectangle

area: a Rectangle of the cell area where the renderer is activated

-> Event

event: the event that triggered the activation

-> m ()

Emits the GutterRenderer::activate signal of the renderer. This is called from Gutter and should never have to be called manually.

begin

gutterRendererBegin

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> Context

cr: a Context

-> Rectangle

backgroundArea: a Rectangle

-> Rectangle

cellArea: a Rectangle

-> TextIter

start: a TextIter

-> TextIter

end: a 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

gutterRendererDraw

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> Context

cr: the cairo render context

-> Rectangle

backgroundArea: a Rectangle indicating the total area to be drawn

-> Rectangle

cellArea: a Rectangle indicating the area to draw content

-> TextIter

start: a TextIter

-> TextIter

end: a TextIter

-> [GutterRendererState]

state: a 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

gutterRendererEnd

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m ()

Called when drawing a region of lines has ended.

getAlignmentMode

gutterRendererGetAlignmentMode

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m GutterRendererAlignmentMode

Returns: a GutterRendererAlignmentMode

Get the alignment mode. The alignment mode describes the manner in which the renderer is aligned (see :xalign and :yalign).

getBackground

gutterRendererGetBackground

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m (Bool, RGBA)

Returns: True if the background color is set, False otherwise

Get the background color of the renderer.

getSize

gutterRendererGetSize

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m Int32

Returns: the size of the renderer.

Get the size of the renderer.

getView

gutterRendererGetView

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m TextView

Returns: a TextView

Get the view associated to the gutter renderer

getVisible

gutterRendererGetVisible

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m Bool

Returns: True if the renderer is visible, False otherwise

Get whether the gutter renderer is visible.

getWindowType

gutterRendererGetWindowType

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m TextWindowType

Returns: a TextWindowType

Get the TextWindowType associated with the gutter renderer.

queryActivatable

gutterRendererQueryActivatable

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> TextIter

iter: a TextIter at the start of the line to be activated

-> Rectangle

area: a Rectangle of the cell area to be activated

-> Event

event: the event that triggered the query

-> m Bool

Returns: True if the renderer can be activated, False otherwise

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

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer.

-> TextIter

start: a TextIter.

-> TextIter

end: a TextIter.

-> [GutterRendererState]

state: a GutterRendererState.

-> m ()

Emit the GutterRenderer::query-data signal. This function is called to query for data just before rendering a cell. This is called from the Gutter. Implementations can override the default signal handler or can connect a signal handler externally to the GutterRenderer::query-data signal.

queryTooltip

gutterRendererQueryTooltip

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a, IsTooltip b)

=> a

renderer: a GutterRenderer.

-> TextIter

iter: a TextIter.

-> Rectangle

area: a Rectangle.

-> Int32

x: The x position of the tooltip.

-> Int32

y: The y position of the tooltip.

-> b

tooltip: a Tooltip.

-> m Bool

Returns: True if the tooltip has been set, False otherwise

Emits the GutterRenderer::query-tooltip signal. This function is called from Gutter. Implementations can override the default signal handler or can connect to the signal externally.

queueDraw

gutterRendererQueueDraw

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> m ()

Emits the GutterRenderer::queue-draw signal of the renderer. Call this from an implementation to inform that the renderer has changed such that it needs to redraw.

setAlignment

gutterRendererSetAlignment

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> Float

xalign: the x-alignment

-> Float

yalign: the y-alignment

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> GutterRendererAlignmentMode

mode: 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

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> Maybe RGBA

color: a RGBA or Nothing

-> m ()

Set the background color of the renderer. If color is set to Nothing, the renderer will not have a background color.

setPadding

gutterRendererSetPadding

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> Int32

xpad: the x-padding

-> Int32

ypad: the y-padding

-> 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

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> Int32

size: the size

-> m ()

Sets the size of the renderer. A value of -1 specifies that the size is to be determined dynamically.

setVisible

gutterRendererSetVisible

Arguments

:: (HasCallStack, MonadIO m, IsGutterRenderer a)

=> a

renderer: a GutterRenderer

-> Bool

visible: the visibility

-> m ()

Set whether the gutter renderer is visible.

Properties

alignmentMode

constructGutterRendererAlignmentMode :: IsGutterRenderer o => GutterRendererAlignmentMode -> IO (GValueConstruct o)

getGutterRendererAlignmentMode :: (MonadIO m, IsGutterRenderer o) => o -> m GutterRendererAlignmentMode

setGutterRendererAlignmentMode :: (MonadIO m, IsGutterRenderer o) => o -> GutterRendererAlignmentMode -> m ()

backgroundRgba

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 ()

backgroundSet

constructGutterRendererBackgroundSet :: IsGutterRenderer o => Bool -> IO (GValueConstruct o)

getGutterRendererBackgroundSet :: (MonadIO m, IsGutterRenderer o) => o -> m Bool

setGutterRendererBackgroundSet :: (MonadIO m, IsGutterRenderer o) => o -> Bool -> m ()

size

constructGutterRendererSize :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o)

getGutterRendererSize :: (MonadIO m, IsGutterRenderer o) => o -> m Int32

setGutterRendererSize :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m ()

view

getGutterRendererView :: (MonadIO m, IsGutterRenderer o) => o -> m TextView

visible

constructGutterRendererVisible :: IsGutterRenderer o => Bool -> IO (GValueConstruct o)

getGutterRendererVisible :: (MonadIO m, IsGutterRenderer o) => o -> m Bool

setGutterRendererVisible :: (MonadIO m, IsGutterRenderer o) => o -> Bool -> m ()

windowType

getGutterRendererWindowType :: (MonadIO m, IsGutterRenderer o) => o -> m TextWindowType

xalign

constructGutterRendererXalign :: IsGutterRenderer o => Float -> IO (GValueConstruct o)

getGutterRendererXalign :: (MonadIO m, IsGutterRenderer o) => o -> m Float

setGutterRendererXalign :: (MonadIO m, IsGutterRenderer o) => o -> Float -> m ()

xpad

constructGutterRendererXpad :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o)

getGutterRendererXpad :: (MonadIO m, IsGutterRenderer o) => o -> m Int32

setGutterRendererXpad :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m ()

yalign

constructGutterRendererYalign :: IsGutterRenderer o => Float -> IO (GValueConstruct o)

getGutterRendererYalign :: (MonadIO m, IsGutterRenderer o) => o -> m Float

setGutterRendererYalign :: (MonadIO m, IsGutterRenderer o) => o -> Float -> m ()

ypad

constructGutterRendererYpad :: IsGutterRenderer o => Int32 -> IO (GValueConstruct o)

getGutterRendererYpad :: (MonadIO m, IsGutterRenderer o) => o -> m Int32

setGutterRendererYpad :: (MonadIO m, IsGutterRenderer o) => o -> Int32 -> m ()

Signals

activate

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 :: GutterRendererActivateCallback -> IO Closure

mk_GutterRendererActivateCallback :: C_GutterRendererActivateCallback -> IO (FunPtr C_GutterRendererActivateCallback)

noGutterRendererActivateCallback :: Maybe GutterRendererActivateCallback

onGutterRendererActivate :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererActivateCallback -> m SignalHandlerId

wrap_GutterRendererActivateCallback :: GutterRendererActivateCallback -> Ptr () -> Ptr TextIter -> Ptr Rectangle -> Ptr Event -> Ptr () -> IO ()

queryActivatable

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 :: GutterRendererQueryActivatableCallback -> IO Closure

mk_GutterRendererQueryActivatableCallback :: C_GutterRendererQueryActivatableCallback -> IO (FunPtr C_GutterRendererQueryActivatableCallback)

noGutterRendererQueryActivatableCallback :: Maybe GutterRendererQueryActivatableCallback

onGutterRendererQueryActivatable :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryActivatableCallback -> m SignalHandlerId

wrap_GutterRendererQueryActivatableCallback :: GutterRendererQueryActivatableCallback -> Ptr () -> Ptr TextIter -> Ptr Rectangle -> Ptr Event -> Ptr () -> IO CInt

queryData

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 :: GutterRendererQueryDataCallback -> IO Closure

mk_GutterRendererQueryDataCallback :: C_GutterRendererQueryDataCallback -> IO (FunPtr C_GutterRendererQueryDataCallback)

noGutterRendererQueryDataCallback :: Maybe GutterRendererQueryDataCallback

onGutterRendererQueryData :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryDataCallback -> m SignalHandlerId

wrap_GutterRendererQueryDataCallback :: GutterRendererQueryDataCallback -> Ptr () -> Ptr TextIter -> Ptr TextIter -> CUInt -> Ptr () -> IO ()

queryTooltip

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 :: GutterRendererQueryTooltipCallback -> IO Closure

mk_GutterRendererQueryTooltipCallback :: C_GutterRendererQueryTooltipCallback -> IO (FunPtr C_GutterRendererQueryTooltipCallback)

noGutterRendererQueryTooltipCallback :: Maybe GutterRendererQueryTooltipCallback

onGutterRendererQueryTooltip :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueryTooltipCallback -> m SignalHandlerId

wrap_GutterRendererQueryTooltipCallback :: GutterRendererQueryTooltipCallback -> Ptr () -> Ptr TextIter -> Ptr Rectangle -> Int32 -> Int32 -> Ptr Tooltip -> Ptr () -> IO CInt

queueDraw

type C_GutterRendererQueueDrawCallback = Ptr () -> Ptr () -> IO ()

type GutterRendererQueueDrawCallback = IO ()

afterGutterRendererQueueDraw :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueueDrawCallback -> m SignalHandlerId

genClosure_GutterRendererQueueDraw :: GutterRendererQueueDrawCallback -> IO Closure

mk_GutterRendererQueueDrawCallback :: C_GutterRendererQueueDrawCallback -> IO (FunPtr C_GutterRendererQueueDrawCallback)

noGutterRendererQueueDrawCallback :: Maybe GutterRendererQueueDrawCallback

onGutterRendererQueueDraw :: (IsGutterRenderer a, MonadIO m) => a -> GutterRendererQueueDrawCallback -> m SignalHandlerId

wrap_GutterRendererQueueDrawCallback :: GutterRendererQueueDrawCallback -> Ptr () -> Ptr () -> IO ()