| Portability | portable (depends on GHC) |
|---|---|
| Stability | provisional |
| Maintainer | gtk2hs-users@lists.sourceforge.net |
| Safe Haskell | Safe-Infered |
Graphics.UI.Gtk.SourceView.SourceStyleScheme
Contents
Description
- 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
class GObjectClass o => SourceStyleSchemeClass o Source
Instances
Methods
castToSourceStyleScheme :: GObjectClass obj => obj -> SourceStyleSchemeSource
Arguments
| :: SourceStyleSchemeClass sss | |
| => sss | |
| -> IO String | returns scheme id. |
sourceStyleSchemeGetNameSource
Arguments
| :: SourceStyleSchemeClass sss | |
| => sss | |
| -> IO String | returns scheme name. |
sourceStyleSchemeGetDescriptionSource
Arguments
| :: SourceStyleSchemeClass sss | |
| => sss | |
| -> IO String | returns scheme description (if defined) or empty. |
sourceStyleSchemeGetAuthorsSource
Arguments
| :: SourceStyleSchemeClass sss | |
| => sss | |
| -> IO [String] | returns an array containing the scheme authors or empty if no author is specified by the style scheme. |
sourceStyleSchemeGetFilenameSource
Arguments
| :: SourceStyleSchemeClass sss | |
| => sss | |
| -> IO String | returns scheme file name if the scheme was created parsing a style scheme file or empty in the other cases. |
sourceStyleSchemeGetStyleSource
Arguments
| :: SourceStyleSchemeClass sss | |
| => sss | |
| -> String |
|
| -> IO SourceStyle | returns style which corresponds to |
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: ""