|
Graphics.UI.Gtk.SourceView.SourceMark | Portability | portable (depends on GHC) | Stability | provisional | Maintainer | gtk2hs-users@lists.sourceforge.net |
|
|
|
|
|
Description |
|
|
Synopsis |
|
|
|
|
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
|
|
|
Instances | |
|
|
|
| Instances | |
|
|
Methods
|
|
|
|
|
:: 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.
|
|
|
|
|
|
|
|
|
|
|
|
Attributes
|
|
|
The category of the SourceMark, classifies the mark and controls which pixbuf is used and with
which priority it is drawn.
Default value: ""
|
|
Produced by Haddock version 2.6.1 |