Graphics.UI.Gtk.SourceView.SourceMark

Description

A SourceMark marks a position in the text where you want to display additional info. It is based on TextMark and thus is still valid after the text has changed though its position may change.

SourceMarks are organised in categories which you have to set when you create the mark. Each category can have a pixbuf and a priority associated using gtkSourceViewSetMarkCategoryPixbuf and gtkSourceViewSetMarkCategoryPriority. The pixbuf will be displayed in the margin at the line where the mark residents if the showLineMarks property is set to True. If there are multiple marks in the same line, the pixbufs will be drawn on top of each other. The mark with the highest priority will be drawn on top.

Types

data SourceMark

Instances

Eq SourceMark

Ord SourceMark

GObjectClass SourceMark

TextMarkClass SourceMark

SourceMarkClass SourceMark

class TextMarkClass o => SourceMarkClass o

Instances

SourceMarkClass SourceMark

Methods

castToSourceMark :: GObjectClass obj => obj -> SourceMark

sourceMarkNew

Arguments

:: GlibString string

=> Maybe string

name Name of the SourceMark, can be Nothing when not using a name

-> string

category is used to classify marks according to common characteristics (e.g. all the marks representing a bookmark could

-> IO SourceMark

Creates a text mark. Add it to a buffer using textBufferAddMark. If name is Nothing, the mark is anonymous; otherwise, the mark can be retrieved by name using textBufferGetMark. Normally marks are created using the utility function sourceBufferCreateMark.

sourceMarkGetCategory

Arguments

:: (SourceMarkClass mark, GlibString string)

=> mark

-> IO string

returns the category of the SourceMark

Returns the mark category

sourceMarkNext

Arguments

:: (SourceMarkClass mark, GlibString string)

=> mark

-> Maybe string

category a string specifying the mark category or Nothing

-> IO (Maybe SourceMark)

returns the next SourceMark or Nothing

Returns the next SourceMark in the buffer or Nothing if the mark was not added to a buffer. If there is no next mark, Nothing will be returned.

If category is Nothing, looks for marks of any category

sourceMarkPrev

Arguments

:: (SourceMarkClass mark, GlibString string)

=> mark

-> Maybe string

category a string specifying the mark category or Nothing

-> IO (Maybe SourceMark)

returns the previous SourceMark or Nothing

Returns the previous SourceMark in the buffer or Nothing if the mark was not added to a buffer. If there is no previous mark, Nothing is returned.

If category is Nothing, looks for marks of any category

Attributes

sourceMarkCategory :: (SourceMarkClass mark, GlibString string) => Attr mark string

The category of the SourceMark, classifies the mark and controls which pixbuf is used and with which priority it is drawn. Default value: ""