Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Controls the appearance of [classview
].
StyleScheme
contains all the text styles to be used in
[classview
] and [classbuffer
]. 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, current line highlighting,
bracket matching, etc.
Style schemes are stored in XML files. The format of a scheme file is documented in the style scheme reference.
The two style schemes with IDs "classic" and "tango" follow more closely the GTK theme (for example for the background color).
Synopsis
- newtype StyleScheme = StyleScheme (ManagedPtr StyleScheme)
- class (GObject o, IsDescendantOf StyleScheme o) => IsStyleScheme o
- toStyleScheme :: (MonadIO m, IsStyleScheme o) => o -> m StyleScheme
- styleSchemeGetAuthors :: (HasCallStack, MonadIO m, IsStyleScheme a) => a -> m (Maybe [Text])
- styleSchemeGetDescription :: (HasCallStack, MonadIO m, IsStyleScheme a) => a -> m (Maybe Text)
- styleSchemeGetFilename :: (HasCallStack, MonadIO m, IsStyleScheme a) => a -> m (Maybe Text)
- styleSchemeGetId :: (HasCallStack, MonadIO m, IsStyleScheme a) => a -> m Text
- styleSchemeGetMetadata :: (HasCallStack, MonadIO m, IsStyleScheme a) => a -> Text -> m (Maybe Text)
- styleSchemeGetName :: (HasCallStack, MonadIO m, IsStyleScheme a) => a -> m Text
- styleSchemeGetStyle :: (HasCallStack, MonadIO m, IsStyleScheme a) => a -> Text -> m (Maybe Style)
- getStyleSchemeDescription :: (MonadIO m, IsStyleScheme o) => o -> m (Maybe Text)
- getStyleSchemeFilename :: (MonadIO m, IsStyleScheme o) => o -> m (Maybe Text)
- constructStyleSchemeId :: (IsStyleScheme o, MonadIO m) => Text -> m (GValueConstruct o)
- getStyleSchemeId :: (MonadIO m, IsStyleScheme o) => o -> m Text
- getStyleSchemeName :: (MonadIO m, IsStyleScheme o) => o -> m Text
Exported types
newtype StyleScheme Source #
Memory-managed wrapper type.
StyleScheme (ManagedPtr StyleScheme) |
Instances
Eq StyleScheme Source # | |
Defined in GI.GtkSource.Objects.StyleScheme (==) :: StyleScheme -> StyleScheme -> Bool # (/=) :: StyleScheme -> StyleScheme -> Bool # | |
GObject StyleScheme Source # | |
Defined in GI.GtkSource.Objects.StyleScheme | |
ManagedPtrNewtype StyleScheme Source # | |
Defined in GI.GtkSource.Objects.StyleScheme toManagedPtr :: StyleScheme -> ManagedPtr StyleScheme | |
TypedObject StyleScheme Source # | |
Defined in GI.GtkSource.Objects.StyleScheme | |
HasParentTypes StyleScheme Source # | |
Defined in GI.GtkSource.Objects.StyleScheme | |
IsGValue (Maybe StyleScheme) Source # | Convert |
Defined in GI.GtkSource.Objects.StyleScheme gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe StyleScheme -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe StyleScheme) | |
type ParentTypes StyleScheme Source # | |
Defined in GI.GtkSource.Objects.StyleScheme type ParentTypes StyleScheme = '[Object] |
class (GObject o, IsDescendantOf StyleScheme o) => IsStyleScheme o Source #
Type class for types which can be safely cast to StyleScheme
, for instance with toStyleScheme
.
Instances
(GObject o, IsDescendantOf StyleScheme o) => IsStyleScheme o Source # | |
Defined in GI.GtkSource.Objects.StyleScheme |
toStyleScheme :: (MonadIO m, IsStyleScheme o) => o -> m StyleScheme Source #
Cast to StyleScheme
, for types for which this is known to be safe. For general casts, use castTo
.
Methods
Click to display all available methods, including inherited ones
Methods
bindProperty, bindPropertyFull, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.
Getters
getAuthors, getData, getDescription, getFilename, getId, getMetadata, getName, getProperty, getQdata, getStyle.
Setters
getAuthors
styleSchemeGetAuthors Source #
:: (HasCallStack, MonadIO m, IsStyleScheme a) | |
=> a |
|
-> m (Maybe [Text]) | Returns: a
|
No description available in the introspection data.
getDescription
styleSchemeGetDescription Source #
:: (HasCallStack, MonadIO m, IsStyleScheme a) | |
=> a |
|
-> m (Maybe Text) | Returns: |
No description available in the introspection data.
getFilename
styleSchemeGetFilename Source #
:: (HasCallStack, MonadIO m, IsStyleScheme a) | |
=> a |
|
-> m (Maybe Text) | Returns: |
No description available in the introspection data.
getId
:: (HasCallStack, MonadIO m, IsStyleScheme a) | |
=> a |
|
-> m Text | Returns: |
No description available in the introspection data.
getMetadata
styleSchemeGetMetadata Source #
:: (HasCallStack, MonadIO m, IsStyleScheme a) | |
=> a |
|
-> Text |
|
-> m (Maybe Text) | Returns: value of property |
Gets a metadata property from the style scheme.
Since: 5.4
getName
:: (HasCallStack, MonadIO m, IsStyleScheme a) | |
=> a |
|
-> m Text | Returns: |
No description available in the introspection data.
getStyle
:: (HasCallStack, MonadIO m, IsStyleScheme a) | |
=> a |
|
-> Text |
|
-> m (Maybe Style) | Returns: style which corresponds to |
No description available in the introspection data.
Properties
description
Style scheme description, a translatable string to present to the user.
getStyleSchemeDescription :: (MonadIO m, IsStyleScheme o) => o -> m (Maybe Text) Source #
Get the value of the “description
” property.
When overloading is enabled, this is equivalent to
get
styleScheme #description
filename
Style scheme filename or Nothing
.
getStyleSchemeFilename :: (MonadIO m, IsStyleScheme o) => o -> m (Maybe Text) Source #
Get the value of the “filename
” property.
When overloading is enabled, this is equivalent to
get
styleScheme #filename
id
Style scheme id, a unique string used to identify the style scheme
in [classstyleSchemeManager
].
constructStyleSchemeId :: (IsStyleScheme o, MonadIO m) => Text -> m (GValueConstruct o) Source #
Construct a GValueConstruct
with valid value for the “id
” property. This is rarely needed directly, but it is used by new
.
getStyleSchemeId :: (MonadIO m, IsStyleScheme o) => o -> m Text Source #
Get the value of the “id
” property.
When overloading is enabled, this is equivalent to
get
styleScheme #id
name
Style scheme name, a translatable string to present to the user.
getStyleSchemeName :: (MonadIO m, IsStyleScheme o) => o -> m Text Source #
Get the value of the “name
” property.
When overloading is enabled, this is equivalent to
get
styleScheme #name