Copyright	Will Thompson Iñaki García Etxebarria and Jonas Platte
License	LGPL-2.1
Maintainer	Iñaki García Etxebarria (garetxe@gmail.com)
Safe Haskell	None
Language	Haskell2010

GI.Gtk.Objects.TextTagTable

Contents

Exported types
Methods
Signals

Description

You may wish to begin by reading the [text widget conceptual overview][TextWidget] which gives an overview of all the objects and data types related to the text widget and how they work together.

GtkTextTagTables as GtkBuildable

The GtkTextTagTable implementation of the GtkBuildable interface supports adding tags by specifying “tag” as the “type” attribute of a <child> element.

An example of a UI definition fragment specifying tags: > >class="GtkTextTagTable" > type="tag" > class="GtkTextTag"/ > /child >/object

Synopsis

newtype TextTagTable = TextTagTable (ManagedPtr TextTagTable)
class GObject o => IsTextTagTable o
toTextTagTable :: (MonadIO m, IsTextTagTable o) => o -> m TextTagTable
noTextTagTable :: Maybe TextTagTable
textTagTableAdd :: (HasCallStack, MonadIO m, IsTextTagTable a, IsTextTag b) => a -> b -> m Bool
textTagTableForeach :: (HasCallStack, MonadIO m, IsTextTagTable a) => a -> TextTagTableForeach -> m ()
textTagTableGetSize :: (HasCallStack, MonadIO m, IsTextTagTable a) => a -> m Int32
textTagTableLookup :: (HasCallStack, MonadIO m, IsTextTagTable a) => a -> Text -> m (Maybe TextTag)
textTagTableNew :: (HasCallStack, MonadIO m) => m TextTagTable
textTagTableRemove :: (HasCallStack, MonadIO m, IsTextTagTable a, IsTextTag b) => a -> b -> m ()
type C_TextTagTableTagAddedCallback = Ptr () -> Ptr TextTag -> Ptr () -> IO ()
type TextTagTableTagAddedCallback = TextTag -> IO ()
afterTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId
genClosure_TextTagTableTagAdded :: TextTagTableTagAddedCallback -> IO Closure
mk_TextTagTableTagAddedCallback :: C_TextTagTableTagAddedCallback -> IO (FunPtr C_TextTagTableTagAddedCallback)
noTextTagTableTagAddedCallback :: Maybe TextTagTableTagAddedCallback
onTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId
wrap_TextTagTableTagAddedCallback :: TextTagTableTagAddedCallback -> C_TextTagTableTagAddedCallback
type C_TextTagTableTagChangedCallback = Ptr () -> Ptr TextTag -> CInt -> Ptr () -> IO ()
type TextTagTableTagChangedCallback = TextTag -> Bool -> IO ()
afterTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId
genClosure_TextTagTableTagChanged :: TextTagTableTagChangedCallback -> IO Closure
mk_TextTagTableTagChangedCallback :: C_TextTagTableTagChangedCallback -> IO (FunPtr C_TextTagTableTagChangedCallback)
noTextTagTableTagChangedCallback :: Maybe TextTagTableTagChangedCallback
onTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId
wrap_TextTagTableTagChangedCallback :: TextTagTableTagChangedCallback -> C_TextTagTableTagChangedCallback
type C_TextTagTableTagRemovedCallback = Ptr () -> Ptr TextTag -> Ptr () -> IO ()
type TextTagTableTagRemovedCallback = TextTag -> IO ()
afterTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId
genClosure_TextTagTableTagRemoved :: TextTagTableTagRemovedCallback -> IO Closure
mk_TextTagTableTagRemovedCallback :: C_TextTagTableTagRemovedCallback -> IO (FunPtr C_TextTagTableTagRemovedCallback)
noTextTagTableTagRemovedCallback :: Maybe TextTagTableTagRemovedCallback
onTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId
wrap_TextTagTableTagRemovedCallback :: TextTagTableTagRemovedCallback -> C_TextTagTableTagRemovedCallback

Exported types

newtype TextTagTable Source #

Memory-managed wrapper type.

Constructors

TextTagTable (ManagedPtr TextTagTable)

Instances

GObject TextTagTable Source #
Instance details Defined in GI.Gtk.Objects.TextTagTable Methods gobjectType :: TextTagTable -> IO GType #
IsObject TextTagTable Source #
Instance details Defined in GI.Gtk.Objects.TextTagTable
IsBuildable TextTagTable Source #
Instance details Defined in GI.Gtk.Objects.TextTagTable
IsTextTagTable TextTagTable Source #
Instance details Defined in GI.Gtk.Objects.TextTagTable

class GObject o => IsTextTagTable o Source #

Type class for types which can be safely cast to TextTagTable, for instance with toTextTagTable.

Instances

(GObject a, (UnknownAncestorError TextTagTable a :: Constraint)) => IsTextTagTable a Source #
Instance details Defined in GI.Gtk.Objects.TextTagTable
IsTextTagTable TextTagTable Source #
Instance details Defined in GI.Gtk.Objects.TextTagTable

toTextTagTable :: (MonadIO m, IsTextTagTable o) => o -> m TextTagTable Source #

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

noTextTagTable :: Maybe TextTagTable Source #

A convenience alias for Nothing :: Maybe TextTagTable.

Methods

add

textTagTableAdd Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a, IsTextTag b)
=> a	`table`: a `TextTagTable`
-> b	`tag`: a `TextTag`
-> m Bool	Returns: `True` on success.

Add a tag to the table. The tag is assigned the highest priority in the table.

tag must not be in a tag table already, and may not have the same name as an already-added tag.

foreach

textTagTableForeach Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a)
=> a	`table`: a `TextTagTable`
-> TextTagTableForeach	`func`: a function to call on each tag
-> m ()

Calls func on each tag in table, with user data data. Note that the table may not be modified while iterating over it (you can’t add/remove tags).

getSize

textTagTableGetSize Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a)
=> a	`table`: a `TextTagTable`
-> m Int32	Returns: number of tags in `table`

Returns the size of the table (number of tags)

new

textTagTableNew Source #

Arguments

:: (HasCallStack, MonadIO m)
=> m TextTagTable	Returns: a new `TextTagTable`

Creates a new TextTagTable. The table contains no tags by default.

remove

textTagTableRemove Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTagTable a, IsTextTag b)
=> a	`table`: a `TextTagTable`
-> b	`tag`: a `TextTag`
-> m ()

Remove a tag from the table. If a TextBuffer has table as its tag table, the tag is removed from the buffer. The table’s reference to the tag is removed, so the tag will end up destroyed if you don’t have a reference to it.

Signals

tagAdded

type C_TextTagTableTagAddedCallback = Ptr () -> Ptr TextTag -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TextTagTableTagAddedCallback Source #

Arguments

= TextTag	`tag`: the added tag.
-> IO ()

No description available in the introspection data.

afterTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “tag-added” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagAdded callback

genClosure_TextTagTableTagAdded :: TextTagTableTagAddedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_TextTagTableTagAddedCallback :: C_TextTagTableTagAddedCallback -> IO (FunPtr C_TextTagTableTagAddedCallback) Source #

Generate a function pointer callable from C code, from a C_TextTagTableTagAddedCallback.

noTextTagTableTagAddedCallback :: Maybe TextTagTableTagAddedCallback Source #

A convenience synonym for Nothing :: Maybe TextTagTableTagAddedCallback.

onTextTagTableTagAdded :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagAddedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “tag-added” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagAdded callback

wrap_TextTagTableTagAddedCallback :: TextTagTableTagAddedCallback -> C_TextTagTableTagAddedCallback Source #

Wrap a TextTagTableTagAddedCallback into a C_TextTagTableTagAddedCallback.

tagChanged

type C_TextTagTableTagChangedCallback = Ptr () -> Ptr TextTag -> CInt -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TextTagTableTagChangedCallback Source #

Arguments

= TextTag	`tag`: the changed tag.
-> Bool	`sizeChanged`: whether the change affects the `TextView` layout.
-> IO ()

No description available in the introspection data.

afterTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “tag-changed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagChanged callback

genClosure_TextTagTableTagChanged :: TextTagTableTagChangedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_TextTagTableTagChangedCallback :: C_TextTagTableTagChangedCallback -> IO (FunPtr C_TextTagTableTagChangedCallback) Source #

Generate a function pointer callable from C code, from a C_TextTagTableTagChangedCallback.

noTextTagTableTagChangedCallback :: Maybe TextTagTableTagChangedCallback Source #

A convenience synonym for Nothing :: Maybe TextTagTableTagChangedCallback.

onTextTagTableTagChanged :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagChangedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “tag-changed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagChanged callback

wrap_TextTagTableTagChangedCallback :: TextTagTableTagChangedCallback -> C_TextTagTableTagChangedCallback Source #

Wrap a TextTagTableTagChangedCallback into a C_TextTagTableTagChangedCallback.

tagRemoved

type C_TextTagTableTagRemovedCallback = Ptr () -> Ptr TextTag -> Ptr () -> IO () Source #

Type for the callback on the (unwrapped) C side.

type TextTagTableTagRemovedCallback Source #

Arguments

= TextTag	`tag`: the removed tag.
-> IO ()

No description available in the introspection data.

afterTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “tag-removed” signal, to be run after the default handler. When overloading is enabled, this is equivalent to

after textTagTable #tagRemoved callback

genClosure_TextTagTableTagRemoved :: TextTagTableTagRemovedCallback -> IO Closure Source #

Wrap the callback into a Closure.

mk_TextTagTableTagRemovedCallback :: C_TextTagTableTagRemovedCallback -> IO (FunPtr C_TextTagTableTagRemovedCallback) Source #

Generate a function pointer callable from C code, from a C_TextTagTableTagRemovedCallback.

noTextTagTableTagRemovedCallback :: Maybe TextTagTableTagRemovedCallback Source #

A convenience synonym for Nothing :: Maybe TextTagTableTagRemovedCallback.

onTextTagTableTagRemoved :: (IsTextTagTable a, MonadIO m) => a -> TextTagTableTagRemovedCallback -> m SignalHandlerId Source #

Connect a signal handler for the “tag-removed” signal, to be run before the default handler. When overloading is enabled, this is equivalent to

on textTagTable #tagRemoved callback

wrap_TextTagTableTagRemovedCallback :: TextTagTableTagRemovedCallback -> C_TextTagTableTagRemovedCallback Source #

Wrap a TextTagTableTagRemovedCallback into a C_TextTagTableTagRemovedCallback.