gtksourceview2-0.12.1: Binding to the GtkSourceView library.Source codeContentsIndex
Graphics.UI.Gtk.SourceView.SourceStyleScheme
Portabilityportable (depends on GHC)
Stabilityprovisional
Maintainergtk2hs-users@lists.sourceforge.net
Contents
Description
Types
Methods
Attributes
Description
Synopsis
data SourceStyleScheme
class GObjectClass o => SourceStyleSchemeClass o
castToSourceStyleScheme :: GObjectClass obj => obj -> SourceStyleScheme
sourceStyleSchemeGetId :: SourceStyleSchemeClass sss => sss -> IO String
sourceStyleSchemeGetName :: SourceStyleSchemeClass sss => sss -> IO String
sourceStyleSchemeGetDescription :: SourceStyleSchemeClass sss => sss -> IO String
sourceStyleSchemeGetAuthors :: SourceStyleSchemeClass sss => sss -> IO [String]
sourceStyleSchemeGetFilename :: SourceStyleSchemeClass sss => sss -> IO String
sourceStyleSchemeGetStyle :: SourceStyleSchemeClass sss => sss -> String -> IO SourceStyle
sourceStyleSchemeDescription :: SourceStyleSchemeClass sss => ReadAttr sss String
sourceStyleSchemeFilename :: SourceStyleSchemeClass sss => ReadAttr sss FilePath
sourceStyleSchemeId :: SourceStyleSchemeClass sss => ReadAttr sss String
sourceStyleSchemeName :: SourceStyleSchemeClass sss => ReadAttr sss String
Description

SourceStyleScheme contains all the text styles to be used in SourceView and SourceBuffer. For instance, it contains text styles for syntax highlighting, it may contain foreground and background color for non-highlighted text, color for the line numbers, etc.

Style schemes are stored in XML files. The format of a scheme file is the documented in the style scheme reference.

Types
data SourceStyleScheme Source
show/hide Instances
class GObjectClass o => SourceStyleSchemeClass o Source
show/hide Instances
Methods
castToSourceStyleScheme :: GObjectClass obj => obj -> SourceStyleSchemeSource
sourceStyleSchemeGetIdSource
:: SourceStyleSchemeClass sss
=> sss
-> IO Stringreturns scheme id.
sourceStyleSchemeGetNameSource
:: SourceStyleSchemeClass sss
=> sss
-> IO Stringreturns scheme name.
sourceStyleSchemeGetDescriptionSource
:: SourceStyleSchemeClass sss
=> sss
-> IO Stringreturns scheme description (if defined) or empty.
sourceStyleSchemeGetAuthorsSource
:: SourceStyleSchemeClass sss
=> sss
-> IO [String]returns an array containing the scheme authors or empty if no author is specified by the style scheme.
sourceStyleSchemeGetFilenameSource
:: SourceStyleSchemeClass sss
=> sss
-> IO Stringreturns scheme file name if the scheme was created parsing a style scheme file or empty in the other cases.
sourceStyleSchemeGetStyleSource
:: SourceStyleSchemeClass sss
=> sss
-> StringstyleId id of the style to retrieve.
-> IO SourceStylereturns style which corresponds to styleId in the scheme
Attributes
sourceStyleSchemeDescription :: SourceStyleSchemeClass sss => ReadAttr sss StringSource

Style scheme description.

Default value: ""

sourceStyleSchemeFilename :: SourceStyleSchemeClass sss => ReadAttr sss FilePathSource

Style scheme filename or Nothing.

Default value: ""

sourceStyleSchemeId :: SourceStyleSchemeClass sss => ReadAttr sss StringSource

Style scheme id, a unique string used to identify the style scheme in SourceStyleSchemeManager.

Default value: ""

sourceStyleSchemeName :: SourceStyleSchemeClass sss => ReadAttr sss StringSource

Style scheme name, a translatable string to present to user.

Default value: ""

Produced by Haddock version 2.6.1