GI.GtkSource.Objects.Snippet

Quick insertion code snippets.

The GtkSourceSnippet represents a series of chunks that can quickly be inserted into the [classview].

Snippets are defined in XML files which are loaded by the [classsnippetManager]. Alternatively, applications can create snippets on demand and insert them into the [classview] using [methodview.push_snippet].

Snippet chunks can reference other snippet chunks as well as post-process the values from other chunks such as capitalization.

Exported types

newtype Snippet

Memory-managed wrapper type.

Constructors

Snippet (ManagedPtr Snippet)

Instances

Eq Snippet

Defined in GI.GtkSource.Objects.Snippet

Methods

(==) :: Snippet -> Snippet -> Bool

(/=) :: Snippet -> Snippet -> Bool

GObject Snippet

Defined in GI.GtkSource.Objects.Snippet

ManagedPtrNewtype Snippet

Defined in GI.GtkSource.Objects.Snippet

Methods

toManagedPtr :: Snippet -> ManagedPtr Snippet

TypedObject Snippet

Defined in GI.GtkSource.Objects.Snippet

Methods

glibType :: IO GType

HasParentTypes Snippet

Defined in GI.GtkSource.Objects.Snippet

IsGValue (Maybe Snippet)

Convert Snippet to and from GValue. See toGValue and fromGValue.

Defined in GI.GtkSource.Objects.Snippet

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe Snippet -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe Snippet)

type ParentTypes Snippet

Defined in GI.GtkSource.Objects.Snippet

type ParentTypes Snippet = '[Object]

class (GObject o, IsDescendantOf Snippet o) => IsSnippet o

Type class for types which can be safely cast to Snippet, for instance with toSnippet.

Instances

(GObject o, IsDescendantOf Snippet o) => IsSnippet o

Defined in GI.GtkSource.Objects.Snippet

toSnippet :: (MonadIO m, IsSnippet o) => o -> m Snippet

Cast to Snippet, 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

addChunk, bindProperty, bindPropertyFull, copy, forceFloating, freezeNotify, getv, isFloating, notify, notifyByPspec, ref, refSink, runDispose, stealData, stealQdata, thawNotify, unref, watchClosure.

Getters

getContext, getData, getDescription, getFocusPosition, getLanguageId, getNChunks, getName, getNthChunk, getProperty, getQdata, getTrigger.

Setters

setData, setDataFull, setDescription, setLanguageId, setName, setProperty, setTrigger.

addChunk

snippetAddChunk

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a, IsSnippetChunk b)

=> a

snippet: a Snippet

-> b

chunk: a SnippetChunk

-> m ()

Appends chunk to the snippet.

This may only be called before the snippet has been expanded.

copy

snippetCopy

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> m Snippet

Returns: A new Snippet

Does a deep copy of the snippet.

getContext

snippetGetContext

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: an Snippet

-> m (Maybe SnippetContext)

Returns: an SnippetContext

Gets the context used for expanding the snippet.

getDescription

snippetGetDescription

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> m Text

Gets the description for the snippet.

getFocusPosition

snippetGetFocusPosition

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> m Int32

Returns: The focus position, or -1 if unset.

Gets the current focus for the snippet.

This is changed as the user tabs through focus locations.

getLanguageId

snippetGetLanguageId

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> m Text

Returns: the language identifier

Gets the language-id used for the source snippet.

The language identifier should be one that matches a source language [propertylanguage:id] property.

getNChunks

snippetGetNChunks

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> m Word32

Returns: The number of chunks.

Gets the number of chunks in the snippet.

Note that not all chunks are editable.

getName

snippetGetName

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> m Text

Gets the name for the snippet.

getNthChunk

snippetGetNthChunk

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> Word32

nth: the nth chunk to get

-> m SnippetChunk

Returns: an SnippetChunk

Gets the chunk at nth.

getTrigger

snippetGetTrigger

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> m (Maybe Text)

Returns: A string or Nothing

Gets the trigger for the source snippet.

A trigger is a word that can be expanded into the full snippet when the user presses Tab.

new

snippetNew

Arguments

:: (HasCallStack, MonadIO m)

=> Maybe Text

trigger: the trigger word

-> Maybe Text

languageId: the source language

-> m Snippet

Returns: A new Snippet

Creates a new Snippet

newParsed

snippetNewParsed

Arguments

:: (HasCallStack, MonadIO m)

=> Text

text: the formatted snippet text to parse

-> m Snippet

Returns: the newly parsed Snippet, or Nothing upon failure and error is set. (Can throw GError)

Parses the snippet formatted text into a series of chunks and adds them to a new Snippet.

Since: 5.6

setDescription

snippetSetDescription

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> Text

description: the snippet description

-> m ()

Sets the description for the snippet.

setLanguageId

snippetSetLanguageId

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> Text

languageId: the language identifier for the snippet

-> m ()

Sets the language identifier for the snippet.

This should match the [propertylanguage:id] identifier.

setName

snippetSetName

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> Text

name: the snippet name

-> m ()

Sets the name for the snippet.

setTrigger

snippetSetTrigger

Arguments

:: (HasCallStack, MonadIO m, IsSnippet a)

=> a

snippet: a Snippet

-> Text

trigger: the trigger word

-> m ()

Sets the trigger for the snippet.

Properties

buffer

No description available in the introspection data.

getSnippetBuffer :: (MonadIO m, IsSnippet o) => o -> m (Maybe TextBuffer)

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

get snippet #buffer

description

No description available in the introspection data.

constructSnippetDescription :: (IsSnippet o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “description” property. This is rarely needed directly, but it is used by new.

getSnippetDescription :: (MonadIO m, IsSnippet o) => o -> m Text

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

get snippet #description

setSnippetDescription :: (MonadIO m, IsSnippet o) => o -> Text -> m ()

Set the value of the “description” property. When overloading is enabled, this is equivalent to

set snippet [ #description := value ]

focusPosition

No description available in the introspection data.

getSnippetFocusPosition :: (MonadIO m, IsSnippet o) => o -> m Int32

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

get snippet #focusPosition

languageId

No description available in the introspection data.

constructSnippetLanguageId :: (IsSnippet o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “language-id” property. This is rarely needed directly, but it is used by new.

getSnippetLanguageId :: (MonadIO m, IsSnippet o) => o -> m Text

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

get snippet #languageId

setSnippetLanguageId :: (MonadIO m, IsSnippet o) => o -> Text -> m ()

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

set snippet [ #languageId := value ]

name

No description available in the introspection data.

constructSnippetName :: (IsSnippet o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “name” property. This is rarely needed directly, but it is used by new.

getSnippetName :: (MonadIO m, IsSnippet o) => o -> m Text

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

get snippet #name

setSnippetName :: (MonadIO m, IsSnippet o) => o -> Text -> m ()

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

set snippet [ #name := value ]

trigger

No description available in the introspection data.

constructSnippetTrigger :: (IsSnippet o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “trigger” property. This is rarely needed directly, but it is used by new.

getSnippetTrigger :: (MonadIO m, IsSnippet o) => o -> m (Maybe Text)

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

get snippet #trigger

setSnippetTrigger :: (MonadIO m, IsSnippet o) => o -> Text -> m ()

Set the value of the “trigger” property. When overloading is enabled, this is equivalent to

set snippet [ #trigger := value ]