Maintainer	gtk2hs-users@lists.sourceforge.net
Stability	provisional
Portability	portable (depends on GHC)
Safe Haskell	None
Language	Haskell98

Graphics.UI.Gtk.SourceView.SourceStyleScheme

Contents

Description
Types
Methods
Attributes

Description

Synopsis

data SourceStyleScheme
class GObjectClass o => SourceStyleSchemeClass o
castToSourceStyleScheme :: GObjectClass obj => obj -> SourceStyleScheme
gTypeSourceStyleScheme :: GType
toSourceStyleScheme :: SourceStyleSchemeClass o => o -> SourceStyleScheme
sourceStyleSchemeGetId :: (SourceStyleSchemeClass sss, GlibString string) => sss -> IO string
sourceStyleSchemeGetName :: (SourceStyleSchemeClass sss, GlibString string) => sss -> IO string
sourceStyleSchemeGetDescription :: (SourceStyleSchemeClass sss, GlibString string) => sss -> IO string
sourceStyleSchemeGetAuthors :: (SourceStyleSchemeClass sss, GlibString string) => sss -> IO [string]
sourceStyleSchemeGetFilename :: (SourceStyleSchemeClass sss, GlibString string) => sss -> IO string
sourceStyleSchemeGetStyle :: (SourceStyleSchemeClass sss, GlibString string) => sss -> string -> IO SourceStyle
sourceStyleSchemeDescription :: (SourceStyleSchemeClass sss, GlibString string) => ReadAttr sss string
sourceStyleSchemeFilename :: (SourceStyleSchemeClass sss, GlibFilePath fp) => ReadAttr sss fp
sourceStyleSchemeId :: (SourceStyleSchemeClass sss, GlibString string) => ReadAttr sss string
sourceStyleSchemeName :: (SourceStyleSchemeClass sss, GlibString string) => 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 #

Instances

Eq SourceStyleScheme #
Instance details Defined in Graphics.UI.Gtk.SourceView.Types Methods (==) :: SourceStyleScheme -> SourceStyleScheme -> Bool # (/=) :: SourceStyleScheme -> SourceStyleScheme -> Bool #
Ord SourceStyleScheme #
Instance details Defined in Graphics.UI.Gtk.SourceView.Types Methods compare :: SourceStyleScheme -> SourceStyleScheme -> Ordering # (<) :: SourceStyleScheme -> SourceStyleScheme -> Bool # (<=) :: SourceStyleScheme -> SourceStyleScheme -> Bool # (>) :: SourceStyleScheme -> SourceStyleScheme -> Bool # (>=) :: SourceStyleScheme -> SourceStyleScheme -> Bool # max :: SourceStyleScheme -> SourceStyleScheme -> SourceStyleScheme # min :: SourceStyleScheme -> SourceStyleScheme -> SourceStyleScheme #
GObjectClass SourceStyleScheme #
Instance details Defined in Graphics.UI.Gtk.SourceView.Types Methods toGObject :: SourceStyleScheme -> GObject # unsafeCastGObject :: GObject -> SourceStyleScheme #
SourceStyleSchemeClass SourceStyleScheme #
Instance details Defined in Graphics.UI.Gtk.SourceView.Types

class GObjectClass o => SourceStyleSchemeClass o #

Instances

SourceStyleSchemeClass SourceStyleScheme #
Instance details Defined in Graphics.UI.Gtk.SourceView.Types

Methods

castToSourceStyleScheme :: GObjectClass obj => obj -> SourceStyleScheme #

gTypeSourceStyleScheme :: GType #

toSourceStyleScheme :: SourceStyleSchemeClass o => o -> SourceStyleScheme #

sourceStyleSchemeGetId #

Arguments

:: (SourceStyleSchemeClass sss, GlibString string)
=> sss
-> IO string	returns scheme id.

sourceStyleSchemeGetName #

Arguments

:: (SourceStyleSchemeClass sss, GlibString string)
=> sss
-> IO string	returns scheme name.

sourceStyleSchemeGetDescription #

Arguments

:: (SourceStyleSchemeClass sss, GlibString string)
=> sss
-> IO string	returns scheme description (if defined) or empty.

sourceStyleSchemeGetAuthors #

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 #

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 #

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 #

Style scheme description.

Default value: ""

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

Style scheme filename or Nothing.

Default value: ""

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

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

Default value: ""

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

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

Default value: ""