GI.Pango.Structs.AttrShape

The AttrShape structure is used to represent attributes which impose shape restrictions.

Exported types

newtype AttrShape

Memory-managed wrapper type.

Constructors

AttrShape (ManagedPtr AttrShape)

Instances

Eq AttrShape

Defined in GI.Pango.Structs.AttrShape

Methods

(==) :: AttrShape -> AttrShape -> Bool

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

ManagedPtrNewtype AttrShape

Defined in GI.Pango.Structs.AttrShape

Methods

toManagedPtr :: AttrShape -> ManagedPtr AttrShape

BoxedPtr AttrShape

Defined in GI.Pango.Structs.AttrShape

Methods

boxedPtrCopy :: AttrShape -> IO AttrShape

boxedPtrFree :: AttrShape -> IO ()

CallocPtr AttrShape

Defined in GI.Pango.Structs.AttrShape

Methods

boxedPtrCalloc :: IO (Ptr AttrShape)

tag ~ 'AttrSet => Constructible AttrShape tag

Defined in GI.Pango.Structs.AttrShape

Methods

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

newZeroAttrShape :: MonadIO m => m AttrShape

Construct a AttrShape struct initialized to zero.

Methods

Overloaded methods

new

attrShapeNew

Arguments

:: (HasCallStack, MonadIO m)

=> Rectangle

inkRect: ink rectangle to assign to each character

-> Rectangle

logicalRect: logical rectangle to assign to each character

-> m Attribute

Returns: the newly allocated Attribute, which should be freed with attributeDestroy.

Create a new shape attribute. A shape is used to impose a particular ink and logical rectangle on the result of shaping a particular glyph. This might be used, for instance, for embedding a picture or a widget inside a Layout.

newWithData

attrShapeNewWithData

Arguments

:: (HasCallStack, MonadIO m)

=> Rectangle

inkRect: ink rectangle to assign to each character

-> Rectangle

logicalRect: logical rectangle to assign to each character

-> Ptr ()

data: user data pointer

-> Maybe AttrDataCopyFunc

copyFunc: function to copy data when the attribute is copied. If Nothing, data is simply copied as a pointer.

-> Maybe DestroyNotify

destroyFunc: function to free data when the attribute is freed, or Nothing

-> m Attribute

Returns: the newly allocated Attribute, which should be freed with attributeDestroy.

Like attrShapeNew, but a user data pointer is also provided; this pointer can be accessed when later rendering the glyph.

Since: 1.8

Properties

attr

the common portion of the attribute

getAttrShapeAttr :: MonadIO m => AttrShape -> m Attribute

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

get attrShape #attr

copyFunc

copy function for the user data

clearAttrShapeCopyFunc :: MonadIO m => AttrShape -> m ()

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

clear #copyFunc

getAttrShapeCopyFunc :: MonadIO m => AttrShape -> m (Maybe AttrDataCopyFunc_WithClosures)

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

get attrShape #copyFunc

setAttrShapeCopyFunc :: MonadIO m => AttrShape -> FunPtr C_AttrDataCopyFunc -> m ()

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

set attrShape [ #copyFunc := value ]

data

user data set (see attrShapeNewWithData)

clearAttrShapeData :: MonadIO m => AttrShape -> m ()

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

clear #data

getAttrShapeData :: MonadIO m => AttrShape -> m (Ptr ())

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

get attrShape #data

setAttrShapeData :: MonadIO m => AttrShape -> Ptr () -> m ()

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

set attrShape [ #data := value ]

destroyFunc

destroy function for the user data

clearAttrShapeDestroyFunc :: MonadIO m => AttrShape -> m ()

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

clear #destroyFunc

getAttrShapeDestroyFunc :: MonadIO m => AttrShape -> m (Maybe DestroyNotify)

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

get attrShape #destroyFunc

setAttrShapeDestroyFunc :: MonadIO m => AttrShape -> FunPtr C_DestroyNotify -> m ()

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

set attrShape [ #destroyFunc := value ]

inkRect

the ink rectangle to restrict to

getAttrShapeInkRect :: MonadIO m => AttrShape -> m Rectangle

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

get attrShape #inkRect

logicalRect

the logical rectangle to restrict to

getAttrShapeLogicalRect :: MonadIO m => AttrShape -> m Rectangle

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

get attrShape #logicalRect