GI.Gtk.Structs.TextAttributes

Using TextAttributes directly should rarely be necessary. It’s primarily useful with textIterGetAttributes. As with most GTK+ structs, the fields in this struct should only be read, never modified directly.

Exported types

newtype TextAttributes

Memory-managed wrapper type.

Constructors

TextAttributes (ManagedPtr TextAttributes)

Instances

BoxedObject TextAttributes

Defined in GI.Gtk.Structs.TextAttributes

Methods

boxedType :: TextAttributes -> IO GType

tag ~ AttrSet => Constructible TextAttributes tag

Defined in GI.Gtk.Structs.TextAttributes

Methods

new :: MonadIO m => (ManagedPtr TextAttributes -> TextAttributes) -> [AttrOp TextAttributes tag] -> m TextAttributes

newZeroTextAttributes :: MonadIO m => m TextAttributes

Construct a TextAttributes struct initialized to zero.

noTextAttributes :: Maybe TextAttributes

A convenience alias for Nothing :: Maybe TextAttributes.

Methods

copy

textAttributesCopy

Arguments

:: (HasCallStack, MonadIO m)

=> TextAttributes

src: a TextAttributes to be copied

-> m TextAttributes

Returns: a copy of src, free with textAttributesUnref

Copies src and returns a new TextAttributes.

copyValues

textAttributesCopyValues

Arguments

:: (HasCallStack, MonadIO m)

=> TextAttributes

src: a TextAttributes

-> TextAttributes

dest: another TextAttributes

-> m ()

Copies the values from src to dest so that dest has the same values as src. Frees existing values in dest.

new

textAttributesNew

Arguments

:: (HasCallStack, MonadIO m)

=> m TextAttributes

Returns: a new TextAttributes, free with textAttributesUnref.

Creates a TextAttributes, which describes a set of properties on some text.

ref

textAttributesRef

Arguments

:: (HasCallStack, MonadIO m)

=> TextAttributes

values: a TextAttributes

-> m TextAttributes

Returns: the TextAttributes that were passed in

Increments the reference count on values.

unref

textAttributesUnref

Arguments

:: (HasCallStack, MonadIO m)

=> TextAttributes

values: a TextAttributes

-> m ()

Decrements the reference count on values, freeing the structure if the reference count reaches 0.

Properties

appearance

TextAppearance for text.

getTextAttributesAppearance :: MonadIO m => TextAttributes -> m TextAppearance

Get the value of the “appearance” field. When overloading is enabled, this is equivalent to

get textAttributes #appearance

bgFullHeight

Background is fit to full line height rather than baseline +/- ascent/descent (font height).

getTextAttributesBgFullHeight :: MonadIO m => TextAttributes -> m Word32

Get the value of the “bg_full_height” field. When overloading is enabled, this is equivalent to

get textAttributes #bgFullHeight

setTextAttributesBgFullHeight :: MonadIO m => TextAttributes -> Word32 -> m ()

Set the value of the “bg_full_height” field. When overloading is enabled, this is equivalent to

set textAttributes [ #bgFullHeight := value ]

direction

TextDirection for text.

getTextAttributesDirection :: MonadIO m => TextAttributes -> m TextDirection

Get the value of the “direction” field. When overloading is enabled, this is equivalent to

get textAttributes #direction

setTextAttributesDirection :: MonadIO m => TextAttributes -> TextDirection -> m ()

Set the value of the “direction” field. When overloading is enabled, this is equivalent to

set textAttributes [ #direction := value ]

editable

Can edit this text.

getTextAttributesEditable :: MonadIO m => TextAttributes -> m Word32

Get the value of the “editable” field. When overloading is enabled, this is equivalent to

get textAttributes #editable

setTextAttributesEditable :: MonadIO m => TextAttributes -> Word32 -> m ()

Set the value of the “editable” field. When overloading is enabled, this is equivalent to

set textAttributes [ #editable := value ]

font

FontDescription for text.

clearTextAttributesFont :: MonadIO m => TextAttributes -> m ()

Set the value of the “font” field to Nothing. When overloading is enabled, this is equivalent to

clear #font

getTextAttributesFont :: MonadIO m => TextAttributes -> m (Maybe FontDescription)

Get the value of the “font” field. When overloading is enabled, this is equivalent to

get textAttributes #font

setTextAttributesFont :: MonadIO m => TextAttributes -> Ptr FontDescription -> m ()

Set the value of the “font” field. When overloading is enabled, this is equivalent to

set textAttributes [ #font := value ]

fontScale

Font scale factor.

getTextAttributesFontScale :: MonadIO m => TextAttributes -> m Double

Get the value of the “font_scale” field. When overloading is enabled, this is equivalent to

get textAttributes #fontScale

setTextAttributesFontScale :: MonadIO m => TextAttributes -> Double -> m ()

Set the value of the “font_scale” field. When overloading is enabled, this is equivalent to

set textAttributes [ #fontScale := value ]

indent

Amount to indent the paragraph, in pixels.

getTextAttributesIndent :: MonadIO m => TextAttributes -> m Int32

Get the value of the “indent” field. When overloading is enabled, this is equivalent to

get textAttributes #indent

setTextAttributesIndent :: MonadIO m => TextAttributes -> Int32 -> m ()

Set the value of the “indent” field. When overloading is enabled, this is equivalent to

set textAttributes [ #indent := value ]

invisible

Hide the text.

getTextAttributesInvisible :: MonadIO m => TextAttributes -> m Word32

Get the value of the “invisible” field. When overloading is enabled, this is equivalent to

get textAttributes #invisible

setTextAttributesInvisible :: MonadIO m => TextAttributes -> Word32 -> m ()

Set the value of the “invisible” field. When overloading is enabled, this is equivalent to

set textAttributes [ #invisible := value ]

justification

Justification for text.

getTextAttributesJustification :: MonadIO m => TextAttributes -> m Justification

Get the value of the “justification” field. When overloading is enabled, this is equivalent to

get textAttributes #justification

setTextAttributesJustification :: MonadIO m => TextAttributes -> Justification -> m ()

Set the value of the “justification” field. When overloading is enabled, this is equivalent to

set textAttributes [ #justification := value ]

language

Language for text.

clearTextAttributesLanguage :: MonadIO m => TextAttributes -> m ()

Set the value of the “language” field to Nothing. When overloading is enabled, this is equivalent to

clear #language

getTextAttributesLanguage :: MonadIO m => TextAttributes -> m (Maybe Language)

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

get textAttributes #language

setTextAttributesLanguage :: MonadIO m => TextAttributes -> Ptr Language -> m ()

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

set textAttributes [ #language := value ]

leftMargin

Width of the left margin in pixels.

getTextAttributesLeftMargin :: MonadIO m => TextAttributes -> m Int32

Get the value of the “left_margin” field. When overloading is enabled, this is equivalent to

get textAttributes #leftMargin

setTextAttributesLeftMargin :: MonadIO m => TextAttributes -> Int32 -> m ()

Set the value of the “left_margin” field. When overloading is enabled, this is equivalent to

set textAttributes [ #leftMargin := value ]

letterSpacing

Extra space to insert between graphemes, in Pango units

getTextAttributesLetterSpacing :: MonadIO m => TextAttributes -> m Int32

Get the value of the “letter_spacing” field. When overloading is enabled, this is equivalent to

get textAttributes #letterSpacing

setTextAttributesLetterSpacing :: MonadIO m => TextAttributes -> Int32 -> m ()

Set the value of the “letter_spacing” field. When overloading is enabled, this is equivalent to

set textAttributes [ #letterSpacing := value ]

noFallback

Whether to disable font fallback.

getTextAttributesNoFallback :: MonadIO m => TextAttributes -> m Word32

Get the value of the “no_fallback” field. When overloading is enabled, this is equivalent to

get textAttributes #noFallback

setTextAttributesNoFallback :: MonadIO m => TextAttributes -> Word32 -> m ()

Set the value of the “no_fallback” field. When overloading is enabled, this is equivalent to

set textAttributes [ #noFallback := value ]

pixelsAboveLines

Pixels of blank space above paragraphs.

getTextAttributesPixelsAboveLines :: MonadIO m => TextAttributes -> m Int32

Get the value of the “pixels_above_lines” field. When overloading is enabled, this is equivalent to

get textAttributes #pixelsAboveLines

setTextAttributesPixelsAboveLines :: MonadIO m => TextAttributes -> Int32 -> m ()

Set the value of the “pixels_above_lines” field. When overloading is enabled, this is equivalent to

set textAttributes [ #pixelsAboveLines := value ]

pixelsBelowLines

Pixels of blank space below paragraphs.

getTextAttributesPixelsBelowLines :: MonadIO m => TextAttributes -> m Int32

Get the value of the “pixels_below_lines” field. When overloading is enabled, this is equivalent to

get textAttributes #pixelsBelowLines

setTextAttributesPixelsBelowLines :: MonadIO m => TextAttributes -> Int32 -> m ()

Set the value of the “pixels_below_lines” field. When overloading is enabled, this is equivalent to

set textAttributes [ #pixelsBelowLines := value ]

pixelsInsideWrap

Pixels of blank space between wrapped lines in a paragraph.

getTextAttributesPixelsInsideWrap :: MonadIO m => TextAttributes -> m Int32

Get the value of the “pixels_inside_wrap” field. When overloading is enabled, this is equivalent to

get textAttributes #pixelsInsideWrap

setTextAttributesPixelsInsideWrap :: MonadIO m => TextAttributes -> Int32 -> m ()

Set the value of the “pixels_inside_wrap” field. When overloading is enabled, this is equivalent to

set textAttributes [ #pixelsInsideWrap := value ]

rightMargin

Width of the right margin in pixels.

getTextAttributesRightMargin :: MonadIO m => TextAttributes -> m Int32

Get the value of the “right_margin” field. When overloading is enabled, this is equivalent to

get textAttributes #rightMargin

setTextAttributesRightMargin :: MonadIO m => TextAttributes -> Int32 -> m ()

Set the value of the “right_margin” field. When overloading is enabled, this is equivalent to

set textAttributes [ #rightMargin := value ]

tabs

Custom TabArray for this text.

clearTextAttributesTabs :: MonadIO m => TextAttributes -> m ()

Set the value of the “tabs” field to Nothing. When overloading is enabled, this is equivalent to

clear #tabs

getTextAttributesTabs :: MonadIO m => TextAttributes -> m (Maybe TabArray)

Get the value of the “tabs” field. When overloading is enabled, this is equivalent to

get textAttributes #tabs

setTextAttributesTabs :: MonadIO m => TextAttributes -> Ptr TabArray -> m ()

Set the value of the “tabs” field. When overloading is enabled, this is equivalent to

set textAttributes [ #tabs := value ]

wrapMode

WrapMode for text.

getTextAttributesWrapMode :: MonadIO m => TextAttributes -> m WrapMode

Get the value of the “wrap_mode” field. When overloading is enabled, this is equivalent to

get textAttributes #wrapMode

setTextAttributesWrapMode :: MonadIO m => TextAttributes -> WrapMode -> m ()

Set the value of the “wrap_mode” field. When overloading is enabled, this is equivalent to

set textAttributes [ #wrapMode := value ]