GI.GtkSource.Objects.StyleScheme

No description available in the introspection data.

Exported types

newtype StyleScheme

Memory-managed wrapper type.

Constructors

StyleScheme (ManagedPtr StyleScheme)

Instances

GObject StyleScheme

Defined in GI.GtkSource.Objects.StyleScheme

Methods

gobjectType :: StyleScheme -> IO GType

IsObject StyleScheme

Defined in GI.GtkSource.Objects.StyleScheme

IsStyleScheme StyleScheme

Defined in GI.GtkSource.Objects.StyleScheme

class GObject o => IsStyleScheme o

Type class for types which can be safely cast to StyleScheme, for instance with toStyleScheme.

Instances

(GObject a, (UnknownAncestorError StyleScheme a :: Constraint)) => IsStyleScheme a

Defined in GI.GtkSource.Objects.StyleScheme

IsStyleScheme StyleScheme

Defined in GI.GtkSource.Objects.StyleScheme

toStyleScheme :: (MonadIO m, IsStyleScheme o) => o -> m StyleScheme

Cast to StyleScheme, for types for which this is known to be safe. For general casts, use castTo.

noStyleScheme :: Maybe StyleScheme

A convenience alias for Nothing :: Maybe StyleScheme.

Methods

getAuthors

styleSchemeGetAuthors

Arguments

:: (HasCallStack, MonadIO m, IsStyleScheme a)

=> a

scheme: a StyleScheme.

-> m (Maybe [Text])

Returns: a Nothing-terminated array containing the scheme authors or Nothing if no author is specified by the style scheme.

No description available in the introspection data.

Since: 2.0

getDescription

styleSchemeGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsStyleScheme a)

=> a

scheme: a StyleScheme.

-> m (Maybe Text)

Returns: scheme description (if defined), or Nothing.

No description available in the introspection data.

Since: 2.0

getFilename

styleSchemeGetFilename

Arguments

:: (HasCallStack, MonadIO m, IsStyleScheme a)

=> a

scheme: a StyleScheme.

-> m (Maybe Text)

Returns: scheme file name if the scheme was created parsing a style scheme file or Nothing in the other cases.

No description available in the introspection data.

Since: 2.0

getId

styleSchemeGetId

Arguments

:: (HasCallStack, MonadIO m, IsStyleScheme a)

=> a

scheme: a StyleScheme.

-> m Text

Returns: scheme id.

No description available in the introspection data.

Since: 2.0

getName

styleSchemeGetName

Arguments

:: (HasCallStack, MonadIO m, IsStyleScheme a)

=> a

scheme: a StyleScheme.

-> m Text

Returns: scheme name.

No description available in the introspection data.

Since: 2.0

getStyle

styleSchemeGetStyle

Arguments

:: (HasCallStack, MonadIO m, IsStyleScheme a)

=> a

scheme: a StyleScheme.

-> Text

styleId: id of the style to retrieve.

-> m (Maybe Style)

Returns: style which corresponds to styleId in the scheme, or Nothing when no style with this name found. It is owned by scheme and may not be unref'ed.

No description available in the introspection data.

Since: 2.0

Properties

description

Style scheme description, a translatable string to present to the user.

getStyleSchemeDescription :: (MonadIO m, IsStyleScheme o) => o -> m (Maybe Text)

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)

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 StyleSchemeManager.

constructStyleSchemeId :: IsStyleScheme o => Text -> IO (GValueConstruct o)

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

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

Get the value of the “name” property. When overloading is enabled, this is equivalent to

get styleScheme #name