Copyright | Will Thompson Iñaki García Etxebarria and Jonas Platte |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
GI.Poppler.Structs.TextAttributes
Description
A TextAttributes
is used to describe text attributes of a range of text
Since: 0.18
Synopsis
- newtype TextAttributes = TextAttributes (ManagedPtr TextAttributes)
- newZeroTextAttributes :: MonadIO m => m TextAttributes
- textAttributesCopy :: (HasCallStack, MonadIO m) => TextAttributes -> m TextAttributes
- textAttributesFree :: (HasCallStack, MonadIO m) => TextAttributes -> m ()
- textAttributesNew :: (HasCallStack, MonadIO m) => m TextAttributes
- getTextAttributesColor :: MonadIO m => TextAttributes -> m Color
- getTextAttributesEndIndex :: MonadIO m => TextAttributes -> m Int32
- setTextAttributesEndIndex :: MonadIO m => TextAttributes -> Int32 -> m ()
- clearTextAttributesFontName :: MonadIO m => TextAttributes -> m ()
- getTextAttributesFontName :: MonadIO m => TextAttributes -> m (Maybe Text)
- setTextAttributesFontName :: MonadIO m => TextAttributes -> CString -> m ()
- getTextAttributesFontSize :: MonadIO m => TextAttributes -> m Double
- setTextAttributesFontSize :: MonadIO m => TextAttributes -> Double -> m ()
- getTextAttributesIsUnderlined :: MonadIO m => TextAttributes -> m Bool
- setTextAttributesIsUnderlined :: MonadIO m => TextAttributes -> Bool -> m ()
- getTextAttributesStartIndex :: MonadIO m => TextAttributes -> m Int32
- setTextAttributesStartIndex :: MonadIO m => TextAttributes -> Int32 -> m ()
Exported types
newtype TextAttributes Source #
Memory-managed wrapper type.
Constructors
TextAttributes (ManagedPtr TextAttributes) |
Instances
newZeroTextAttributes :: MonadIO m => m TextAttributes Source #
Construct a TextAttributes
struct initialized to zero.
Methods
Click to display all available methods, including inherited ones
copy
Arguments
:: (HasCallStack, MonadIO m) | |
=> TextAttributes |
|
-> m TextAttributes | Returns: a new allocated copy of |
Creates a copy of textAttrs
Since: 0.18
free
Arguments
:: (HasCallStack, MonadIO m) | |
=> TextAttributes |
|
-> m () |
Frees the given TextAttributes
Since: 0.18
new
Arguments
:: (HasCallStack, MonadIO m) | |
=> m TextAttributes | Returns: a new |
Creates a new TextAttributes
Since: 0.18
Properties
color
a Color
, the foreground color
getTextAttributesColor :: MonadIO m => TextAttributes -> m Color Source #
Get the value of the “color
” field.
When overloading is enabled, this is equivalent to
get
textAttributes #color
endIndex
end position this text attributes apply
getTextAttributesEndIndex :: MonadIO m => TextAttributes -> m Int32 Source #
Get the value of the “end_index
” field.
When overloading is enabled, this is equivalent to
get
textAttributes #endIndex
setTextAttributesEndIndex :: MonadIO m => TextAttributes -> Int32 -> m () Source #
Set the value of the “end_index
” field.
When overloading is enabled, this is equivalent to
set
textAttributes [ #endIndex:=
value ]
fontName
font name
clearTextAttributesFontName :: MonadIO m => TextAttributes -> m () Source #
Set the value of the “font_name
” field to Nothing
.
When overloading is enabled, this is equivalent to
clear
#fontName
getTextAttributesFontName :: MonadIO m => TextAttributes -> m (Maybe Text) Source #
Get the value of the “font_name
” field.
When overloading is enabled, this is equivalent to
get
textAttributes #fontName
setTextAttributesFontName :: MonadIO m => TextAttributes -> CString -> m () Source #
Set the value of the “font_name
” field.
When overloading is enabled, this is equivalent to
set
textAttributes [ #fontName:=
value ]
fontSize
font size
getTextAttributesFontSize :: MonadIO m => TextAttributes -> m Double Source #
Get the value of the “font_size
” field.
When overloading is enabled, this is equivalent to
get
textAttributes #fontSize
setTextAttributesFontSize :: MonadIO m => TextAttributes -> Double -> m () Source #
Set the value of the “font_size
” field.
When overloading is enabled, this is equivalent to
set
textAttributes [ #fontSize:=
value ]
isUnderlined
if text is underlined
getTextAttributesIsUnderlined :: MonadIO m => TextAttributes -> m Bool Source #
Get the value of the “is_underlined
” field.
When overloading is enabled, this is equivalent to
get
textAttributes #isUnderlined
setTextAttributesIsUnderlined :: MonadIO m => TextAttributes -> Bool -> m () Source #
Set the value of the “is_underlined
” field.
When overloading is enabled, this is equivalent to
set
textAttributes [ #isUnderlined:=
value ]
startIndex
start position this text attributes apply
getTextAttributesStartIndex :: MonadIO m => TextAttributes -> m Int32 Source #
Get the value of the “start_index
” field.
When overloading is enabled, this is equivalent to
get
textAttributes #startIndex
setTextAttributesStartIndex :: MonadIO m => TextAttributes -> Int32 -> m () Source #
Set the value of the “start_index
” field.
When overloading is enabled, this is equivalent to
set
textAttributes [ #startIndex:=
value ]