gtksourceview2-0.12.1: Binding to the GtkSourceView library.Source codeContentsIndex
Graphics.UI.Gtk.SourceView.SourceView
Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Contents
Description
Types
Enums
Methods
Attributes
Signals
Deprecated
Description
Synopsis
data SourceView
class TextViewClass o => SourceViewClass o
data SourceSmartHomeEndType
= SourceSmartHomeEndDisabled
| SourceSmartHomeEndBefore
| SourceSmartHomeEndAfter
| SourceSmartHomeEndAlways
data SourceDrawSpacesFlags
= SourceDrawSpacesSpace
| SourceDrawSpacesTab
| SourceDrawSpacesNewline
| SourceDrawSpacesNbsp
| SourceDrawSpacesLeading
| SourceDrawSpacesText
| SourceDrawSpacesTrailing
| SourceDrawSpacesAll
data SourceViewGutterPosition
= SourceViewGutterPositionLines
| SourceViewGutterPositionMarks
castToSourceView :: GObjectClass obj => obj -> SourceView
sourceViewNew :: IO SourceView
sourceViewNewWithBuffer :: SourceBuffer -> IO SourceView
sourceViewSetAutoIndent :: SourceViewClass sv => sv -> Bool -> IO ()
sourceViewGetAutoIndent :: SourceViewClass sv => sv -> IO Bool
sourceViewSetIndentOnTab :: SourceViewClass sv => sv -> Bool -> IO ()
sourceViewGetIndentOnTab :: SourceViewClass sv => sv -> IO Bool
sourceViewSetIndentWidth :: SourceViewClass sv => sv -> Int -> IO ()
sourceViewGetIndentWidth :: SourceViewClass sv => sv -> IO Int
sourceViewSetInsertSpacesInsteadOfTabs :: SourceViewClass sv => sv -> Bool -> IO ()
sourceViewGetInsertSpacesInsteadOfTabs :: SourceViewClass sv => sv -> IO Bool
sourceViewSetSmartHomeEnd :: SourceViewClass sv => sv -> SourceSmartHomeEndType -> IO ()
sourceViewGetSmartHomeEnd :: SourceViewClass sv => sv -> IO SourceSmartHomeEndType
sourceViewSetMarkCategoryPriority :: SourceViewClass sv => sv -> String -> Int -> IO ()
sourceViewGetMarkCategoryPriority :: SourceViewClass sv => sv -> String -> IO Int
sourceViewSetMarkCategoryIconFromPixbuf :: SourceViewClass sv => sv -> String -> Maybe Pixbuf -> IO ()
sourceViewSetMarkCategoryIconFromStock :: SourceViewClass sv => sv -> String -> Maybe String -> IO ()
sourceViewSetMarkCategoryIconFromIconName :: SourceViewClass sv => sv -> String -> Maybe String -> IO ()
sourceViewSetMarkCategoryBackground :: SourceViewClass sv => sv -> String -> Maybe Color -> IO ()
sourceViewGetMarkCategoryBackground :: SourceViewClass sv => sv -> String -> Color -> IO Bool
sourceViewSetHighlightCurrentLine :: SourceViewClass sv => sv -> Bool -> IO ()
sourceViewGetHighlightCurrentLine :: SourceViewClass sv => sv -> IO Bool
sourceViewSetShowLineMarks :: SourceViewClass sv => sv -> Bool -> IO ()
sourceViewGetShowLineMarks :: SourceViewClass sv => sv -> IO Bool
sourceViewSetShowLineNumbers :: SourceViewClass sv => sv -> Bool -> IO ()
sourceViewGetShowLineNumbers :: SourceViewClass sv => sv -> IO Bool
sourceViewSetShowRightMargin :: SourceViewClass sv => sv -> Bool -> IO ()
sourceViewGetShowRightMargin :: SourceViewClass sv => sv -> IO Bool
sourceViewSetRightMarginPosition :: SourceViewClass sv => sv -> Word -> IO ()
sourceViewGetRightMarginPosition :: SourceViewClass sv => sv -> IO Int
sourceViewSetTabWidth :: SourceViewClass sv => sv -> Int -> IO ()
sourceViewGetTabWidth :: SourceViewClass sv => sv -> IO Int
sourceViewSetDrawSpaces :: SourceViewClass sv => sv -> SourceDrawSpacesFlags -> IO ()
sourceViewGetDrawSpaces :: SourceViewClass sv => sv -> IO SourceDrawSpacesFlags
sourceViewGetGutter :: SourceViewClass sv => sv -> TextWindowType -> IO SourceGutter
sourceViewAutoIndent :: SourceViewClass sv => Attr sv Bool
sourceViewCompletion :: SourceViewClass sv => ReadAttr sv SourceCompletion
sourceViewDrawSpaces :: SourceViewClass sv => Attr sv SourceDrawSpacesFlags
sourceViewHighlightCurrentLine :: SourceViewClass sv => Attr sv Bool
sourceViewIndentOnTab :: SourceViewClass sv => Attr sv Bool
sourceViewIndentWidth :: SourceViewClass sv => Attr sv Int
sourceViewInsertSpacesInsteadOfTabs :: SourceViewClass sv => Attr sv Bool
sourceViewRightMarginPosition :: SourceViewClass sv => Attr sv Int
sourceViewShowLineNumbers :: SourceViewClass sv => Attr sv Bool
sourceViewShowRightMargin :: SourceViewClass sv => Attr sv Bool
sourceViewSmartHomeEnd :: SourceViewClass sv => Attr sv SourceSmartHomeEndType
sourceViewTabWidth :: SourceViewClass sv => Attr sv Int
sourceViewUndo :: SourceViewClass sv => Signal sv (IO ())
sourceViewRedo :: SourceViewClass sv => Signal sv (IO ())
sourceViewMoveLines :: SourceViewClass sv => Signal sv (Bool -> Int -> IO ())
sourceViewShowCompletion :: SourceViewClass sv => Signal sv (IO ())
sourceViewLineMarkActivated :: SourceViewClass sv => Signal sv (TextIter -> EventM EAny ())
sourceViewSetMarkCategoryPixbuf :: SourceViewClass sv => sv -> String -> Pixbuf -> IO ()
sourceViewGetMarkCategoryPixbuf :: SourceViewClass sv => sv -> String -> IO Pixbuf
Description
SourceView is the main object of the gtksourceview library. It provides a text view which syntax highlighting, undo/redo and text marks. Use a SourceBuffer to display text with a SourceView.
Types
data SourceView Source
show/hide Instances
class TextViewClass o => SourceViewClass o Source
show/hide Instances
Enums
data SourceSmartHomeEndType Source
Constructors
SourceSmartHomeEndDisabled
SourceSmartHomeEndBefore
SourceSmartHomeEndAfter
SourceSmartHomeEndAlways
show/hide Instances
data SourceDrawSpacesFlags Source
Constructors
SourceDrawSpacesSpace
SourceDrawSpacesTab
SourceDrawSpacesNewline
SourceDrawSpacesNbsp
SourceDrawSpacesLeading
SourceDrawSpacesText
SourceDrawSpacesTrailing
SourceDrawSpacesAll
show/hide Instances
data SourceViewGutterPosition Source
Constructors
SourceViewGutterPositionLines
SourceViewGutterPositionMarks
show/hide Instances
Methods
castToSourceView :: GObjectClass obj => obj -> SourceViewSource
sourceViewNew :: IO SourceViewSource
Create a new SourceView widget with a default SourceBuffer.
sourceViewNewWithBuffer :: SourceBuffer -> IO SourceViewSource
Create a new SourceView widget with the given SourceBuffer.
sourceViewSetAutoIndentSource
:: SourceViewClass sv
=> sv
-> Boolenable whether to enable auto indentation.
-> IO ()
If True auto indentation of text is enabled.
sourceViewGetAutoIndentSource
:: SourceViewClass sv
=> sv
-> IO Boolreturns True if auto indentation is enabled.
Returns whether auto indentation of text is enabled.
sourceViewSetIndentOnTabSource
:: SourceViewClass sv
=> sv
-> Boolenable whether to indent a block when tab is pressed.
-> IO ()
If True, when the tab key is pressed and there is a selection, the selected text is indented of one level instead of being replaced with the t characters. Shift+Tab unindents the selection.
sourceViewGetIndentOnTabSource
:: SourceViewClass sv
=> sv
-> IO Boolreturns True if the selection is indented when tab is pressed.
Returns whether when the tab key is pressed the current selection should get indented instead of replaced with the t character.
sourceViewSetIndentWidthSource
:: SourceViewClass sv
=> sv
-> Intwidth indent width in characters.
-> IO ()
Sets the number of spaces to use for each step of indent. If width is -1, the value of the tabWidth property will be used.
sourceViewGetIndentWidthSource
:: SourceViewClass sv
=> sv
-> IO Intreturns indent width.
Returns the number of spaces to use for each step of indent. See sourceViewSetIndentWidth for details.
sourceViewSetInsertSpacesInsteadOfTabsSource
:: SourceViewClass sv
=> sv
-> Boolenable whether to insert spaces instead of tabs.
-> IO ()
If True any tabulator character inserted is replaced by a group of space characters.
sourceViewGetInsertSpacesInsteadOfTabsSource
:: SourceViewClass sv
=> sv
-> IO Boolreturns True if spaces are inserted instead of tabs.
Returns whether when inserting a tabulator character it should be replaced by a group of space characters.
sourceViewSetSmartHomeEndSource
:: SourceViewClass sv
=> sv
-> SourceSmartHomeEndTypesmartHe the desired behavior among SourceSmartHomeEndType.
-> IO ()
Set the desired movement of the cursor when HOME and END keys are pressed.
sourceViewGetSmartHomeEndSource
:: SourceViewClass sv
=> sv
-> IO SourceSmartHomeEndTypereturns a SourceSmartHomeEndTypeend value.
Returns a SourceSmartHomeEndType end value specifying how the cursor will move when HOME and END keys are pressed.
sourceViewSetMarkCategoryPrioritySource
:: SourceViewClass sv
=> sv
-> Stringcategory a mark category.
-> Intpriority the priority for the category
-> IO ()
Set the priority for the given mark category. When there are multiple marks on the same line, marks of categories with higher priorities will be drawn on top.
sourceViewGetMarkCategoryPrioritySource
:: SourceViewClass sv
=> sv
-> Stringcategory a mark category.
-> IO Intreturns the priority or if category exists but no priority was set, it defaults to 0.
Gets the priority which is associated with the given category.
sourceViewSetMarkCategoryIconFromPixbufSource
:: SourceViewClass sv
=> sv
-> Stringcategory a mark category.
-> Maybe Pixbufpixbuf a Pixbuf or Nothing.
-> IO ()
Sets the icon to be used for category to pixbuf. If pixbuf is Nothing, the icon is unset.
sourceViewSetMarkCategoryIconFromStockSource
:: SourceViewClass sv
=> sv
-> Stringcategory a mark category.
-> Maybe StringstockId the stock id or Nothing.
-> IO ()
Sets the icon to be used for category to the stock item stockId. If stockId is Nothing, the icon is unset.
sourceViewSetMarkCategoryIconFromIconNameSource
:: SourceViewClass sv
=> sv
-> Stringcategory a mark category.
-> Maybe Stringname the themed icon name or Nothing.
-> IO ()
Sets the icon to be used for category to the named theme item name. If name is Nothing, the icon is unset.
sourceViewSetMarkCategoryBackgroundSource
:: SourceViewClass sv
=> sv
-> Stringcategory a mark category.
-> Maybe Colorcolor background color or Nothing to unset it.
-> IO ()
Sets given background color for mark category. If color is Nothing, the background color is unset.
sourceViewGetMarkCategoryBackgroundSource
:: SourceViewClass sv
=> sv
-> Stringcategory a mark category.
-> Colordest destination Color structure to fill in.
-> IO Boolreturns True if background color for category was set and dest is set to a valid color, or False otherwise.
Gets the background color associated with given category.
sourceViewSetHighlightCurrentLineSource
:: SourceViewClass sv
=> sv
-> Boolshow whether to highlight the current line
-> IO ()
If show is True the current line is highlighted.
sourceViewGetHighlightCurrentLineSource
:: SourceViewClass sv
=> sv
-> IO Boolreturns True if the current line is highlighted.
Returns whether the current line is highlighted
sourceViewSetShowLineMarksSource
:: SourceViewClass sv
=> sv
-> Boolshow whether line marks should be displayed.
-> IO ()
If True line marks will be displayed beside the text.
sourceViewGetShowLineMarksSource
:: SourceViewClass sv
=> sv
-> IO Boolreturns True if the line marks are displayed.
Returns whether line marks are displayed beside the text.
sourceViewSetShowLineNumbersSource
:: SourceViewClass sv
=> sv
-> Boolshow whether line numbers should be displayed.
-> IO ()
If True line numbers will be displayed beside the text.
sourceViewGetShowLineNumbersSource
:: SourceViewClass sv
=> sv
-> IO Boolreturns True if the line numbers are displayed.
Returns whether line numbers are displayed beside the text.
sourceViewSetShowRightMarginSource
:: SourceViewClass sv
=> sv
-> Boolshow whether to show a right margin.
-> IO ()
If True a right margin is displayed
sourceViewGetShowRightMarginSource
:: SourceViewClass sv
=> sv
-> IO Boolreturns True if the right margin is shown.
Returns whether a right margin is displayed.
sourceViewSetRightMarginPositionSource
:: SourceViewClass sv
=> sv
-> Wordpos the width in characters where to position the right margin.
-> IO ()
Sets the position of the right margin in the given view.
sourceViewGetRightMarginPositionSource
:: SourceViewClass sv
=> sv
-> IO Intreturns the position of the right margin.
Gets the position of the right margin in the given view.
sourceViewSetTabWidthSource
:: SourceViewClass sv
=> sv
-> Intwidth width of tab in characters.
-> IO ()
Sets the width of tabulation in characters.
sourceViewGetTabWidthSource
:: SourceViewClass sv
=> sv
-> IO Intreturns width of tab.
Returns the width of tabulation in characters.
sourceViewSetDrawSpacesSource
:: SourceViewClass sv
=> sv
-> SourceDrawSpacesFlagsflags SourceDrawSpacesFlags specifing how white spaces should be displayed
-> IO ()
Set if and how the spaces should be visualized. Specifying flags as 0 will disable display of spaces.
sourceViewGetDrawSpacesSource
:: SourceViewClass sv
=> sv
-> IO SourceDrawSpacesFlagsreturns the SourceDrawSpacesFlags, 0 if no spaces should be drawn.
Returns the SourceDrawSpacesFlags specifying if and how spaces should be displayed for this view.
sourceViewGetGutterSource
:: SourceViewClass sv
=> sv
-> TextWindowTypewindowType the gutter window type
-> IO SourceGutter
Returns the SourceGutter object associated with windowType for view. Only TextWindowLeft and TextWindowRight are supported, respectively corresponding to the left and right gutter. The line numbers and mark category icons are rendered in the gutter corresponding to TextWindowLeft.
Attributes
sourceViewAutoIndent :: SourceViewClass sv => Attr sv BoolSource

Whether to enable auto indentation.

Default value: False

sourceViewCompletion :: SourceViewClass sv => ReadAttr sv SourceCompletionSource
The completion object associated with the view.
sourceViewDrawSpaces :: SourceViewClass sv => Attr sv SourceDrawSpacesFlagsSource
Set if and how the spaces should be visualized.
sourceViewHighlightCurrentLine :: SourceViewClass sv => Attr sv BoolSource

Whether to highlight the current line.

Default value: False

sourceViewIndentOnTab :: SourceViewClass sv => Attr sv BoolSource

Whether to indent the selected text when the tab key is pressed.

Default value: True

sourceViewIndentWidth :: SourceViewClass sv => Attr sv IntSource

Width of an indentation step expressed in number of spaces.

Allowed values: [GMaxulong,32]

Default value: -1

sourceViewInsertSpacesInsteadOfTabs :: SourceViewClass sv => Attr sv BoolSource

Whether to insert spaces instead of tabs.

Default value: False

sourceViewRightMarginPosition :: SourceViewClass sv => Attr sv IntSource

Position of the right margin.

Allowed values: [1,200]

Default value: 80

sourceViewShowLineNumbers :: SourceViewClass sv => Attr sv BoolSource

Whether to display line numbers

Default value: False

sourceViewShowRightMargin :: SourceViewClass sv => Attr sv BoolSource

Whether to display line mark pixbufs

Default value: False

sourceViewSmartHomeEnd :: SourceViewClass sv => Attr sv SourceSmartHomeEndTypeSource

Set the behavior of the HOME and END keys.

Default value: SourceSmartHomeEndDisabled

Since 2.0

sourceViewTabWidth :: SourceViewClass sv => Attr sv IntSource

Width of an tab character expressed in number of spaces.

Allowed values: [1,32]

Default value: 8

Signals
sourceViewUndo :: SourceViewClass sv => Signal sv (IO ())Source
sourceViewRedo :: SourceViewClass sv => Signal sv (IO ())Source
sourceViewMoveLines :: SourceViewClass sv => Signal sv (Bool -> Int -> IO ())Source
The moveLines signal is a keybinding which gets emitted when the user initiates moving a line. The default binding key is Alt+Up/Down arrow. And moves the currently selected lines, or the current line by count. For the moment, only count of -1 or 1 is valid.
sourceViewShowCompletion :: SourceViewClass sv => Signal sv (IO ())Source

The showCompletion signal is a keybinding signal which gets emitted when the user initiates a completion in default mode.

Applications should not connect to it, but may emit it with gSignalEmitByName if they need to control the default mode completion activation.

sourceViewLineMarkActivated :: SourceViewClass sv => Signal sv (TextIter -> EventM EAny ())Source
Emitted when a line mark has been activated (for instance when there was a button press in the line marks gutter). You can use iter to determine on which line the activation took place.
Deprecated
sourceViewSetMarkCategoryPixbuf :: SourceViewClass sv => sv -> String -> Pixbuf -> IO ()Source
sourceViewSetMarkCategoryPixbuf is deprecated and should not be used in newly-written code. Use sourceViewSetMarkCategoryIconFromPixbuf instead
sourceViewGetMarkCategoryPixbuf :: SourceViewClass sv => sv -> String -> IO PixbufSource
sourceViewGetMarkCategoryPixbuf is deprecated and should not be used in newly-written code.
Produced by Haddock version 2.6.1