gi-gtksource-3.0.15: GtkSource bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.GtkSource.Objects.StyleSchemeManager

Contents

Description

 

Synopsis

Exported types

Methods

appendSearchPath

styleSchemeManagerAppendSearchPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsStyleSchemeManager a) 
=> a

manager: a StyleSchemeManager.

-> Text

path: a directory or a filename.

-> m () 

Appends path to the list of directories where the manager looks for style scheme files. See styleSchemeManagerSetSearchPath for details.

forceRescan

styleSchemeManagerForceRescan Source #

Arguments

:: (HasCallStack, MonadIO m, IsStyleSchemeManager a) 
=> a

manager: a StyleSchemeManager.

-> m () 

Mark any currently cached information about the available style scehems as invalid. All the available style schemes will be reloaded next time the manager is accessed.

getDefault

styleSchemeManagerGetDefault Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m StyleSchemeManager

Returns: a StyleSchemeManager. Return value is owned by GtkSourceView library and must not be unref'ed.

Returns the default StyleSchemeManager instance.

getScheme

styleSchemeManagerGetScheme Source #

Arguments

:: (HasCallStack, MonadIO m, IsStyleSchemeManager a) 
=> a

manager: a StyleSchemeManager.

-> Text

schemeId: style scheme id to find.

-> m StyleScheme

Returns: a StyleScheme object. Returned value is owned by manager and must not be unref'ed.

Looks up style scheme by id.

getSchemeIds

styleSchemeManagerGetSchemeIds Source #

Arguments

:: (HasCallStack, MonadIO m, IsStyleSchemeManager a) 
=> a

manager: a StyleSchemeManager.

-> m (Maybe [Text])

Returns: a Nothing-terminated array of strings containing the ids of the available style schemes or Nothing if no style scheme is available. The array is sorted alphabetically according to the scheme name. The array is owned by the manager and must not be modified.

Returns the ids of the available style schemes.

getSearchPath

styleSchemeManagerGetSearchPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsStyleSchemeManager a) 
=> a

manager: a StyleSchemeManager.

-> m [Text]

Returns: a Nothing-terminated array of string containing the search path. The array is owned by the manager and must not be modified.

Returns the current search path for the manager. See styleSchemeManagerSetSearchPath for details.

new

styleSchemeManagerNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> m StyleSchemeManager

Returns: a new StyleSchemeManager.

Creates a new style manager. If you do not need more than one style manager then use styleSchemeManagerGetDefault instead.

prependSearchPath

styleSchemeManagerPrependSearchPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsStyleSchemeManager a) 
=> a

manager: a StyleSchemeManager.

-> Text

path: a directory or a filename.

-> m () 

Prepends path to the list of directories where the manager looks for style scheme files. See styleSchemeManagerSetSearchPath for details.

setSearchPath

styleSchemeManagerSetSearchPath Source #

Arguments

:: (HasCallStack, MonadIO m, IsStyleSchemeManager a) 
=> a

manager: a StyleSchemeManager.

-> Maybe [Text]

path: a Nothing-terminated array of strings or Nothing.

-> m () 

Sets the list of directories where the manager looks for style scheme files. If path is Nothing, the search path is reset to default.

Properties

schemeIds

searchPath