gi-gtksource-3.0.25: GtkSource bindings
CopyrightWill Thompson and Iñaki García Etxebarria
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria
Safe HaskellSafe-Inferred
LanguageHaskell2010

GI.GtkSource.Objects.Language

Description

No description available in the introspection data.

Synopsis

Exported types

newtype Language Source #

Memory-managed wrapper type.

Constructors

Language (ManagedPtr Language) 

class (GObject o, IsDescendantOf Language o) => IsLanguage o Source #

Type class for types which can be safely cast to Language, for instance with toLanguage.

Instances

Instances details
(GObject o, IsDescendantOf Language o) => IsLanguage o Source # 
Instance details

Defined in GI.GtkSource.Objects.Language

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

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

Methods

getGlobs

languageGetGlobs Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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 Source #

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

No description available in the introspection data.

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

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

get language #hidden

id

No description available in the introspection data.

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

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

get language #id

name

No description available in the introspection data.

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

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

get language #name

section

No description available in the introspection data.

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

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

get language #section