gtksourceview2-0.13.0.0: Binding to the GtkSourceView library.

Maintainergtk2hs-users@lists.sourceforge.net
Stabilityprovisional
Portabilityportable (depends on GHC)
Safe HaskellNone
LanguageHaskell98

Graphics.UI.Gtk.SourceView.SourceStyleScheme

Contents

Description

 

Synopsis

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

Methods

sourceStyleSchemeGetId Source

Arguments

:: (SourceStyleSchemeClass sss, GlibString string) 
=> sss 
-> IO string

returns scheme id.

sourceStyleSchemeGetName Source

Arguments

:: (SourceStyleSchemeClass sss, GlibString string) 
=> sss 
-> IO string

returns scheme name.

sourceStyleSchemeGetDescription Source

Arguments

:: (SourceStyleSchemeClass sss, GlibString string) 
=> sss 
-> IO string

returns scheme description (if defined) or empty.

sourceStyleSchemeGetAuthors Source

Arguments

:: (SourceStyleSchemeClass sss, GlibString string) 
=> sss 
-> IO [string]

returns an array containing the scheme authors or empty if no author is specified by the style scheme.

sourceStyleSchemeGetFilename Source

Arguments

:: (SourceStyleSchemeClass sss, GlibString string) 
=> sss 
-> IO string

returns scheme file name if the scheme was created parsing a style scheme file or empty in the other cases.

sourceStyleSchemeGetStyle Source

Arguments

:: (SourceStyleSchemeClass sss, GlibString string) 
=> sss 
-> string

styleId id of the style to retrieve.

-> IO SourceStyle

returns style which corresponds to styleId in the scheme

Attributes

sourceStyleSchemeDescription :: (SourceStyleSchemeClass sss, GlibString string) => ReadAttr sss string Source

Style scheme description.

Default value: ""

sourceStyleSchemeFilename :: (SourceStyleSchemeClass sss, GlibFilePath fp) => ReadAttr sss fp Source

Style scheme filename or Nothing.

Default value: ""

sourceStyleSchemeId :: (SourceStyleSchemeClass sss, GlibString string) => ReadAttr sss string Source

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

Default value: ""

sourceStyleSchemeName :: (SourceStyleSchemeClass sss, GlibString string) => ReadAttr sss string Source

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

Default value: ""