gi-gtk-3.0.17: Gtk bindings

CopyrightWill Thompson Iñaki García Etxebarria and Jonas Platte
LicenseLGPL-2.1
MaintainerIñaki García Etxebarria (garetxe@gmail.com)
Safe HaskellNone
LanguageHaskell2010

GI.Gtk.Objects.TextTag

Contents

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.

Tags should be in the TextTagTable for a given TextBuffer before using them with that buffer.

gtk_text_buffer_create_tag() is the best way to create tags. See “gtk3-demo” for numerous examples.

For each property of TextTag, there is a “set” property, e.g. “font-set” corresponds to “font”. These “set” properties reflect whether a property has been set or not. They are maintained by GTK+ and you should not set them independently.

Synopsis

Exported types

Methods

changed

textTagChanged Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTag a) 
=> a

tag: a TextTag.

-> Bool

sizeChanged: whether the change affects the TextView layout.

-> m () 

Emits the TextTagTable::tag-changed signal on the TextTagTable where the tag is included.

The signal is already emitted when setting a TextTag property. This function is useful for a TextTag subclass.

Since: 3.20

event

textTagEvent Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTag a, IsObject b) 
=> a

tag: a TextTag

-> b

eventObject: object that received the event, such as a widget

-> Event

event: the event

-> TextIter

iter: location where the event was received

-> m Bool

Returns: result of signal emission (whether the event was handled)

Emits the “event” signal on the TextTag.

getPriority

textTagGetPriority Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTag a) 
=> a

tag: a TextTag

-> m Int32

Returns: The tag’s priority.

Get the tag priority.

new

textTagNew Source #

Arguments

:: (HasCallStack, MonadIO m) 
=> Maybe Text

name: tag name, or Nothing

-> m TextTag

Returns: a new TextTag

Creates a TextTag. Configure the tag using object arguments, i.e. using g_object_set().

setPriority

textTagSetPriority Source #

Arguments

:: (HasCallStack, MonadIO m, IsTextTag a) 
=> a

tag: a TextTag

-> Int32

priority: the new priority

-> m () 

Sets the priority of a TextTag. Valid priorities start at 0 and go to one less than textTagTableGetSize. Each tag in a table has a unique priority; setting the priority of one tag shifts the priorities of all the other tags in the table to maintain a unique priority for each tag. Higher priority tags “win” if two tags both set the same text attribute. When adding a tag to a tag table, it will be assigned the highest priority in the table by default; so normally the precedence of a set of tags is the order in which they were added to the table, or created with gtk_text_buffer_create_tag(), which adds the tag to the buffer’s table automatically.

Properties

accumulativeMargin

background

backgroundFullHeight

backgroundFullHeightSet

backgroundGdk

backgroundRgba

backgroundSet

direction

editable

setTextTagEditable :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

editableSet

fallback

setTextTagFallback :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

fallbackSet

family

setTextTagFamily :: (MonadIO m, IsTextTag o) => o -> Text -> m () Source #

familySet

setTextTagFamilySet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

font

clearTextTagFont :: (MonadIO m, IsTextTag o) => o -> m () Source #

setTextTagFont :: (MonadIO m, IsTextTag o) => o -> Text -> m () Source #

fontDesc

fontFeatures

fontFeaturesSet

foreground

foregroundGdk

foregroundRgba

foregroundSet

indent

setTextTagIndent :: (MonadIO m, IsTextTag o) => o -> Int32 -> m () Source #

indentSet

setTextTagIndentSet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

invisible

setTextTagInvisible :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

invisibleSet

justification

justificationSet

language

setTextTagLanguage :: (MonadIO m, IsTextTag o) => o -> Text -> m () Source #

languageSet

leftMargin

leftMarginSet

letterSpacing

letterSpacingSet

name

paragraphBackground

paragraphBackgroundGdk

paragraphBackgroundRgba

paragraphBackgroundSet

pixelsAboveLines

pixelsAboveLinesSet

pixelsBelowLines

pixelsBelowLinesSet

pixelsInsideWrap

pixelsInsideWrapSet

rightMargin

rightMarginSet

rise

setTextTagRise :: (MonadIO m, IsTextTag o) => o -> Int32 -> m () Source #

riseSet

setTextTagRiseSet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

scale

setTextTagScale :: (MonadIO m, IsTextTag o) => o -> Double -> m () Source #

scaleSet

setTextTagScaleSet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

size

setTextTagSize :: (MonadIO m, IsTextTag o) => o -> Int32 -> m () Source #

sizePoints

sizeSet

setTextTagSizeSet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

stretch

stretchSet

strikethrough

strikethroughRgba

strikethroughRgbaSet

strikethroughSet

style

setTextTagStyle :: (MonadIO m, IsTextTag o) => o -> Style -> m () Source #

styleSet

setTextTagStyleSet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

tabs

clearTextTagTabs :: (MonadIO m, IsTextTag o) => o -> m () Source #

setTextTagTabs :: (MonadIO m, IsTextTag o) => o -> TabArray -> m () Source #

tabsSet

setTextTagTabsSet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

underline

underlineRgba

underlineRgbaSet

underlineSet

variant

variantSet

weight

setTextTagWeight :: (MonadIO m, IsTextTag o) => o -> Int32 -> m () Source #

weightSet

setTextTagWeightSet :: (MonadIO m, IsTextTag o) => o -> Bool -> m () Source #

wrapMode

wrapModeSet

Signals

event