GI.GtkSource.Objects.Language

Exported types

newtype Language

Constructors

Language (ManagedPtr Language)

Instances

GObject Language

Methods

gobjectType :: Language -> IO GType

IsObject Language

IsLanguage Language

class GObject o => IsLanguage o

Instances

(GObject a, UnknownAncestorError Constraint Language a) => IsLanguage a

IsLanguage Language

toLanguage :: (MonadIO m, IsLanguage o) => o -> m Language

noLanguage :: Maybe Language

Methods

getGlobs

languageGetGlobs

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> m (Maybe [Text])

Returns: a newly-allocated Nothing terminated array containing the globs or Nothing if no globs are found. The returned array must be freed with strfreev.

Returns the globs associated to this language. This is just an utility wrapper around languageGetMetadata to retrieve the "globs" metadata property and split it into an array.

getHidden

languageGetHidden

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language

-> m Bool

Returns: True if the language should be hidden, False otherwise.

Returns whether the language should be hidden from the user.

getId

languageGetId

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> m Text

Returns: the ID of language.

Returns the ID of the language. The ID is not locale-dependent. The returned string is owned by language and should not be freed or modified.

getMetadata

languageGetMetadata

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> Text

name: metadata property name.

-> m (Maybe Text)

Returns: value of property name stored in the metadata of language or Nothing if language does not contain the specified metadata property. The returned string is owned by language and should not be freed or modified.

No description available in the introspection data.

getMimeTypes

languageGetMimeTypes

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> m (Maybe [Text])

Returns: a newly-allocated Nothing terminated array containing the mime types or Nothing if no mime types are found. The returned array must be freed with strfreev.

Returns the mime types associated to this language. This is just an utility wrapper around languageGetMetadata to retrieve the "mimetypes" metadata property and split it into an array.

getName

languageGetName

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> m Text

Returns: the name of language.

Returns the localized name of the language. The returned string is owned by language and should not be freed or modified.

getSection

languageGetSection

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> m Text

Returns: the section of language.

Returns the localized section of the language. Each language belong to a section (ex. HTML belogs to the Markup section). The returned string is owned by language and should not be freed or modified.

getStyleFallback

languageGetStyleFallback

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> Text

styleId: a style ID.

-> m (Maybe Text)

Returns: the ID of the style to use if the specified styleId is not present in the current style scheme or Nothing if the style has no fallback defined. The returned string is owned by the language and must not be modified.

Returns the ID of the style to use if the specified styleId is not present in the current style scheme.

Since: 3.4

getStyleIds

languageGetStyleIds

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> m (Maybe [Text])

Returns: a newly-allocated Nothing terminated array containing ids of the styles defined by this language or Nothing if no style is defined. The returned array must be freed with strfreev.

Returns the ids of the styles defined by this language.

getStyleName

languageGetStyleName

Arguments

:: (HasCallStack, MonadIO m, IsLanguage a)

=> a

language: a Language.

-> Text

styleId: a style ID.

-> m (Maybe Text)

Returns: the name of the style with ID styleId defined by this language or Nothing if the style has no name or there is no style with ID styleId defined by this language. The returned string is owned by the language and must not be modified.

Returns the name of the style with ID styleId defined by this language.

Properties

hidden

getLanguageHidden :: (MonadIO m, IsLanguage o) => o -> m Bool

id

getLanguageId :: (MonadIO m, IsLanguage o) => o -> m Text

name

getLanguageName :: (MonadIO m, IsLanguage o) => o -> m Text

section

getLanguageSection :: (MonadIO m, IsLanguage o) => o -> m Text