GI.GES.Objects.TextOverlayClip

Renders text onto the next lower priority stream using textrender.

Exported types

newtype TextOverlayClip

Memory-managed wrapper type.

Constructors

TextOverlayClip (ManagedPtr TextOverlayClip)

Instances

Eq TextOverlayClip

Defined in GI.GES.Objects.TextOverlayClip

Methods

(==) :: TextOverlayClip -> TextOverlayClip -> Bool

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

GObject TextOverlayClip

Defined in GI.GES.Objects.TextOverlayClip

ManagedPtrNewtype TextOverlayClip

Defined in GI.GES.Objects.TextOverlayClip

Methods

toManagedPtr :: TextOverlayClip -> ManagedPtr TextOverlayClip

TypedObject TextOverlayClip

Defined in GI.GES.Objects.TextOverlayClip

Methods

glibType :: IO GType

HasParentTypes TextOverlayClip

Defined in GI.GES.Objects.TextOverlayClip

IsGValue (Maybe TextOverlayClip)

Convert TextOverlayClip to and from GValue. See toGValue and fromGValue.

Defined in GI.GES.Objects.TextOverlayClip

Methods

gvalueGType_ :: IO GType

gvalueSet_ :: Ptr GValue -> Maybe TextOverlayClip -> IO ()

gvalueGet_ :: Ptr GValue -> IO (Maybe TextOverlayClip)

type ParentTypes TextOverlayClip

Defined in GI.GES.Objects.TextOverlayClip

type ParentTypes TextOverlayClip = '[OverlayClip, OperationClip, Clip, Container, TimelineElement, Object, Extractable, MetaContainer]

class (GObject o, IsDescendantOf TextOverlayClip o) => IsTextOverlayClip o

Type class for types which can be safely cast to TextOverlayClip, for instance with toTextOverlayClip.

Instances

(GObject o, IsDescendantOf TextOverlayClip o) => IsTextOverlayClip o

Defined in GI.GES.Objects.TextOverlayClip

toTextOverlayClip :: (MonadIO m, IsTextOverlayClip o) => o -> m TextOverlayClip

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

Methods

Click to display all available methods, including inherited ones

Methods

add, addAsset, addChildProperty, addChildToTrack, addMetasFromString, addTopEffect, bindProperty, bindPropertyFull, checkMetaRegistered, copy, edit, editFull, findTrackElement, findTrackElements, forceFloating, foreach, freezeNotify, getv, isFloating, listChildrenProperties, lookupChild, metasToString, moveToLayer, moveToLayerFull, notify, notifyByPspec, paste, ref, refSink, registerMeta, registerMetaBoolean, registerMetaDate, registerMetaDateTime, registerMetaDouble, registerMetaFloat, registerMetaInt, registerMetaInt64, registerMetaString, registerMetaUint, registerMetaUint64, registerStaticMeta, remove, removeChildProperty, removeTopEffect, ripple, rippleEnd, rollEnd, rollStart, runDispose, split, splitFull, stealData, stealQdata, thawNotify, trim, ungroup, unref, watchClosure.

Getters

getAsset, getBoolean, getChildProperty, getChildPropertyByPspec, getChildren, getColor, getData, getDate, getDateTime, getDouble, getDuration, getDurationLimit, getFloat, getFontDesc, getHalignment, getId, getInpoint, getInt, getInt64, getInternalTimeFromTimelineTime, getLayer, getLayerPriority, getMarkerList, getMaxDuration, getMeta, getName, getNaturalFramerate, getParent, getPriority, getProperty, getQdata, getStart, getString, getSupportedFormats, getText, getTimeline, getTimelineTimeFromInternalTime, getTimelineTimeFromSourceFrame, getTopEffectIndex, getTopEffectPosition, getTopEffects, getToplevelParent, getTrackTypes, getUint, getUint64, getValignment, getXpos, getYpos.

Setters

setAsset, setBoolean, setChildProperty, setChildPropertyByPspec, setChildPropertyFull, setColor, setData, setDataFull, setDate, setDateTime, setDouble, setDuration, setFloat, setFontDesc, setHalign, setInpoint, setInt, setInt64, setMarkerList, setMaxDuration, setMeta, setName, setParent, setPriority, setProperty, setStart, setString, setSupportedFormats, setText, setTimeline, setTopEffectIndex, setTopEffectIndexFull, setTopEffectPriority, setUint, setUint64, setValign, setXpos, setYpos.

getColor

textOverlayClipGetColor

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: a TextOverlayClip

-> m Word32

Returns: The color used by source.

Get the color used by source.

getFontDesc

textOverlayClipGetFontDesc

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: a TextOverlayClip

-> m (Maybe Text)

Returns: The pango font description used by self.

Get the pango font description used by self.

getHalignment

textOverlayClipGetHalignment

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: a TextOverlayClip

-> m TextHAlign

Returns: The horizontal aligment used by self.

Get the horizontal aligment used by self.

getText

textOverlayClipGetText

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: a TextOverlayClip

-> m (Maybe Text)

Returns: The text currently set on self.

Get the text currently set on self.

getValignment

textOverlayClipGetValignment

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: a TextOverlayClip

-> m TextVAlign

Returns: The vertical aligment used by self.

Get the vertical aligment used by self.

getXpos

textOverlayClipGetXpos

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: a TextOverlayClip

-> m Double

Returns: The horizontal position used by source.

Get the horizontal position used by source.

getYpos

textOverlayClipGetYpos

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: a TextOverlayClip

-> m Double

Returns: The vertical position used by source.

Get the vertical position used by source.

new

textOverlayClipNew

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe TextOverlayClip)

Returns: The newly created TextOverlayClip, or Nothing if there was an error.

Creates a new TextOverlayClip

setColor

textOverlayClipSetColor

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: the TextOverlayClip* to set

-> Word32

color: The color self is being set to

-> m ()

Sets the color of the text.

setFontDesc

textOverlayClipSetFontDesc

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: the TextOverlayClip*

-> Maybe Text

fontDesc: the pango font description

-> m ()

Sets the pango font description of the text

setHalign

textOverlayClipSetHalign

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: the TextOverlayClip* to set horizontal alignement of text on

-> TextHAlign

halign: TextHAlign

-> m ()

Sets the horizontal aligment of the text.

setText

textOverlayClipSetText

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: the TextOverlayClip* to set text on

-> Maybe Text

text: the text to render. an internal copy of this text will be made.

-> m ()

Sets the text this clip will render.

setValign

textOverlayClipSetValign

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: the TextOverlayClip* to set vertical alignement of text on

-> TextVAlign

valign: TextVAlign

-> m ()

Sets the vertical aligment of the text.

setXpos

textOverlayClipSetXpos

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: the TextOverlayClip* to set

-> Double

position: The horizontal position self is being set to

-> m ()

Sets the horizontal position of the text.

setYpos

textOverlayClipSetYpos

Arguments

:: (HasCallStack, MonadIO m, IsTextOverlayClip a)

=> a

self: the TextOverlayClip* to set

-> Double

position: The vertical position self is being set to

-> m ()

Sets the vertical position of the text.

Properties

color

The color of the text

constructTextOverlayClipColor :: (IsTextOverlayClip o, MonadIO m) => Word32 -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “color” property. This is rarely needed directly, but it is used by new.

getTextOverlayClipColor :: (MonadIO m, IsTextOverlayClip o) => o -> m Word32

Get the value of the “color” property. When overloading is enabled, this is equivalent to

get textOverlayClip #color

setTextOverlayClipColor :: (MonadIO m, IsTextOverlayClip o) => o -> Word32 -> m ()

Set the value of the “color” property. When overloading is enabled, this is equivalent to

set textOverlayClip [ #color := value ]

fontDesc

Pango font description string

clearTextOverlayClipFontDesc :: (MonadIO m, IsTextOverlayClip o) => o -> m ()

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

clear #fontDesc

constructTextOverlayClipFontDesc :: (IsTextOverlayClip o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “font-desc” property. This is rarely needed directly, but it is used by new.

getTextOverlayClipFontDesc :: (MonadIO m, IsTextOverlayClip o) => o -> m (Maybe Text)

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

get textOverlayClip #fontDesc

setTextOverlayClipFontDesc :: (MonadIO m, IsTextOverlayClip o) => o -> Text -> m ()

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

set textOverlayClip [ #fontDesc := value ]

halignment

Horizontal alignment of the text

constructTextOverlayClipHalignment :: (IsTextOverlayClip o, MonadIO m) => TextHAlign -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “halignment” property. This is rarely needed directly, but it is used by new.

getTextOverlayClipHalignment :: (MonadIO m, IsTextOverlayClip o) => o -> m TextHAlign

Get the value of the “halignment” property. When overloading is enabled, this is equivalent to

get textOverlayClip #halignment

setTextOverlayClipHalignment :: (MonadIO m, IsTextOverlayClip o) => o -> TextHAlign -> m ()

Set the value of the “halignment” property. When overloading is enabled, this is equivalent to

set textOverlayClip [ #halignment := value ]

text

The text to diplay

clearTextOverlayClipText :: (MonadIO m, IsTextOverlayClip o) => o -> m ()

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

clear #text

constructTextOverlayClipText :: (IsTextOverlayClip o, MonadIO m) => Text -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “text” property. This is rarely needed directly, but it is used by new.

getTextOverlayClipText :: (MonadIO m, IsTextOverlayClip o) => o -> m (Maybe Text)

Get the value of the “text” property. When overloading is enabled, this is equivalent to

get textOverlayClip #text

setTextOverlayClipText :: (MonadIO m, IsTextOverlayClip o) => o -> Text -> m ()

Set the value of the “text” property. When overloading is enabled, this is equivalent to

set textOverlayClip [ #text := value ]

valignment

Vertical alignent of the text

constructTextOverlayClipValignment :: (IsTextOverlayClip o, MonadIO m) => TextVAlign -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “valignment” property. This is rarely needed directly, but it is used by new.

getTextOverlayClipValignment :: (MonadIO m, IsTextOverlayClip o) => o -> m TextVAlign

Get the value of the “valignment” property. When overloading is enabled, this is equivalent to

get textOverlayClip #valignment

setTextOverlayClipValignment :: (MonadIO m, IsTextOverlayClip o) => o -> TextVAlign -> m ()

Set the value of the “valignment” property. When overloading is enabled, this is equivalent to

set textOverlayClip [ #valignment := value ]

xpos

The horizontal position of the text

constructTextOverlayClipXpos :: (IsTextOverlayClip o, MonadIO m) => Double -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “xpos” property. This is rarely needed directly, but it is used by new.

getTextOverlayClipXpos :: (MonadIO m, IsTextOverlayClip o) => o -> m Double

Get the value of the “xpos” property. When overloading is enabled, this is equivalent to

get textOverlayClip #xpos

setTextOverlayClipXpos :: (MonadIO m, IsTextOverlayClip o) => o -> Double -> m ()

Set the value of the “xpos” property. When overloading is enabled, this is equivalent to

set textOverlayClip [ #xpos := value ]

ypos

The vertical position of the text

constructTextOverlayClipYpos :: (IsTextOverlayClip o, MonadIO m) => Double -> m (GValueConstruct o)

Construct a GValueConstruct with valid value for the “ypos” property. This is rarely needed directly, but it is used by new.

getTextOverlayClipYpos :: (MonadIO m, IsTextOverlayClip o) => o -> m Double

Get the value of the “ypos” property. When overloading is enabled, this is equivalent to

get textOverlayClip #ypos

setTextOverlayClipYpos :: (MonadIO m, IsTextOverlayClip o) => o -> Double -> m ()

Set the value of the “ypos” property. When overloading is enabled, this is equivalent to

set textOverlayClip [ #ypos := value ]