<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Graphics.UI.Gtk.SourceView.SourceStyleScheme</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Graphics-UI-Gtk-SourceView-SourceStyleScheme.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">gtksourceview2-0.12.2: Binding to the GtkSourceView library.</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Portability</th><td>portable (depends on GHC)</td></tr><tr><th>Stability</th><td>provisional</td></tr><tr><th>Maintainer</th><td>gtk2hs-users@lists.sourceforge.net</td></tr></table><p class="caption">Graphics.UI.Gtk.SourceView.SourceStyleScheme</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">Description
</a></li><li><a href="#g:2">Types
</a></li><li><a href="#g:3">Methods
</a></li><li><a href="#g:4">Attributes
</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc empty"> </div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><span class="keyword">data</span> <a href="#t:SourceStyleScheme">SourceStyleScheme</a> </li><li class="src short"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a href="#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> o </li><li class="src short"><a href="#v:castToSourceStyleScheme">castToSourceStyleScheme</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a></li><li class="src short"><a href="#v:sourceStyleSchemeGetId">sourceStyleSchemeGetId</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => sss -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:sourceStyleSchemeGetName">sourceStyleSchemeGetName</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => sss -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:sourceStyleSchemeGetDescription">sourceStyleSchemeGetDescription</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => sss -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:sourceStyleSchemeGetAuthors">sourceStyleSchemeGetAuthors</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => sss -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</li><li class="src short"><a href="#v:sourceStyleSchemeGetFilename">sourceStyleSchemeGetFilename</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => sss -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:sourceStyleSchemeGetStyle">sourceStyleSchemeGetStyle</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => sss -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a> -> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-SourceView-SourceStyle.html#t:SourceStyle">SourceStyle</a></li><li class="src short"><a href="#v:sourceStyleSchemeDescription">sourceStyleSchemeDescription</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:sourceStyleSchemeFilename">sourceStyleSchemeFilename</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a></li><li class="src short"><a href="#v:sourceStyleSchemeId">sourceStyleSchemeId</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li><li class="src short"><a href="#v:sourceStyleSchemeName">sourceStyleSchemeName</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></li></ul></div><div id="interface"><h1 id="g:1">Description
</h1><div class="doc"><p><code><a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a></code> contains all the text styles to be used in <code><a href="Graphics-UI-Gtk-SourceView-SourceView.html#t:SourceView">SourceView</a></code> and
<code><a href="Graphics-UI-Gtk-SourceView-SourceBuffer.html#t:SourceBuffer">SourceBuffer</a></code>. 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.
</p><p>Style schemes are stored in XML files. The format of a scheme file is the documented in the style
scheme reference.
</p></div><h1 id="g:2">Types
</h1><div class="top"><p class="src"><span class="keyword">data</span> <a name="t:SourceStyleScheme" class="def">SourceStyleScheme</a> <a href="src/Graphics-UI-Gtk-SourceView-Types.html#SourceStyleScheme" class="link">Source</a></p><div class="subs instances"><p id="control.i:SourceStyleScheme" class="caption collapser" onclick="toggleSection('i:SourceStyleScheme')">Instances</p><div id="section.i:SourceStyleScheme" class="show"><table><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Eq.html#t:Eq">Eq</a> <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Ord.html#t:Ord">Ord</a> <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a></td><td class="doc empty"> </td></tr><tr><td class="src"><a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a></td><td class="doc empty"> </td></tr></table></div></div></div><div class="top"><p class="src"><span class="keyword">class</span> <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> o => <a name="t:SourceStyleSchemeClass" class="def">SourceStyleSchemeClass</a> o <a href="src/Graphics-UI-Gtk-SourceView-Types.html#SourceStyleSchemeClass" class="link">Source</a></p><div class="subs instances"><p id="control.i:SourceStyleSchemeClass" class="caption collapser" onclick="toggleSection('i:SourceStyleSchemeClass')">Instances</p><div id="section.i:SourceStyleSchemeClass" class="show"><table><tr><td class="src"><a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a></td><td class="doc empty"> </td></tr></table></div></div></div><h1 id="g:3">Methods
</h1><div class="top"><p class="src"><a name="v:castToSourceStyleScheme" class="def">castToSourceStyleScheme</a> :: <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-GObject.html#t:GObjectClass">GObjectClass</a> obj => obj -> <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleScheme">SourceStyleScheme</a><a href="src/Graphics-UI-Gtk-SourceView-Types.html#castToSourceStyleScheme" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeGetId" class="def">sourceStyleSchemeGetId</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeGetId" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss</td><td class="doc empty"> </td></tr><tr><td class="src">=> sss</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>returns scheme id.
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeGetName" class="def">sourceStyleSchemeGetName</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeGetName" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss</td><td class="doc empty"> </td></tr><tr><td class="src">=> sss</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>returns scheme name.
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeGetDescription" class="def">sourceStyleSchemeGetDescription</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeGetDescription" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss</td><td class="doc empty"> </td></tr><tr><td class="src">=> sss</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>returns scheme description (if defined) or empty.
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeGetAuthors" class="def">sourceStyleSchemeGetAuthors</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeGetAuthors" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss</td><td class="doc empty"> </td></tr><tr><td class="src">=> sss</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> [<a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a>]</td><td class="doc"><p>returns an array containing the scheme authors or empty if no author is specified by the style scheme.
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeGetFilename" class="def">sourceStyleSchemeGetFilename</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeGetFilename" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss</td><td class="doc empty"> </td></tr><tr><td class="src">=> sss</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p>returns scheme file name if the scheme was created parsing a style scheme file or empty in the other cases.
</p></td></tr></table></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeGetStyle" class="def">sourceStyleSchemeGetStyle</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeGetStyle" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss</td><td class="doc empty"> </td></tr><tr><td class="src">=> sss</td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a></td><td class="doc"><p><code>styleId</code> id of the style to retrieve.
</p></td></tr><tr><td class="src">-> <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:IO">IO</a> <a href="Graphics-UI-Gtk-SourceView-SourceStyle.html#t:SourceStyle">SourceStyle</a></td><td class="doc"><p>returns style which corresponds to <code>styleId</code> in the scheme
</p></td></tr></table></div></div><h1 id="g:4">Attributes
</h1><div class="top"><p class="src"><a name="v:sourceStyleSchemeDescription" class="def">sourceStyleSchemeDescription</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeDescription" class="link">Source</a></p><div class="doc"><p>Style scheme description.
</p><p>Default value: ""
</p></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeFilename" class="def">sourceStyleSchemeFilename</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/System-IO.html#t:FilePath">FilePath</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeFilename" class="link">Source</a></p><div class="doc"><p>Style scheme filename or <code><a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Maybe.html#v:Nothing">Nothing</a></code>.
</p><p>Default value: ""
</p></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeId" class="def">sourceStyleSchemeId</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeId" class="link">Source</a></p><div class="doc"><p>Style scheme id, a unique string used to identify the style scheme in <code><a href="Graphics-UI-Gtk-SourceView-SourceStyleSchemeManager.html#t:SourceStyleSchemeManager">SourceStyleSchemeManager</a></code>.
</p><p>Default value: ""
</p></div></div><div class="top"><p class="src"><a name="v:sourceStyleSchemeName" class="def">sourceStyleSchemeName</a> :: <a href="Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#t:SourceStyleSchemeClass">SourceStyleSchemeClass</a> sss => <a href="/usr/share/doc/ghc/html/libraries/glib-0.12.0/System-Glib-Attributes.html#t:ReadAttr">ReadAttr</a> sss <a href="/usr/share/doc/ghc/html/libraries/base-4.3.1.0/Data-Char.html#t:String">String</a><a href="src/Graphics-UI-Gtk-SourceView-SourceStyleScheme.html#sourceStyleSchemeName" class="link">Source</a></p><div class="doc"><p>Style scheme name, a translatable string to present to user.
</p><p>Default value: ""
</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.9.2</p></div></body></html>
