GI.GES.Objects.TitleClip

Renders the given text in the specified font, at specified position, and with the specified background pattern.

Exported types

newtype TitleClip

Memory-managed wrapper type.

Constructors

TitleClip (ManagedPtr TitleClip)

Instances

Eq TitleClip

Defined in GI.GES.Objects.TitleClip

Methods

(==) :: TitleClip -> TitleClip -> Bool

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

GObject TitleClip

Defined in GI.GES.Objects.TitleClip

ManagedPtrNewtype TitleClip

Defined in GI.GES.Objects.TitleClip

Methods

toManagedPtr :: TitleClip -> ManagedPtr TitleClip

TypedObject TitleClip

Defined in GI.GES.Objects.TitleClip

Methods

glibType :: IO GType

HasParentTypes TitleClip

Defined in GI.GES.Objects.TitleClip

IsGValue (Maybe TitleClip)

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

Defined in GI.GES.Objects.TitleClip

Methods

gvalueGType_ :: IO GType

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

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

type ParentTypes TitleClip

Defined in GI.GES.Objects.TitleClip

type ParentTypes TitleClip = '[SourceClip, Clip, Container, TimelineElement, Object, Extractable, MetaContainer]

class (GObject o, IsDescendantOf TitleClip o) => IsTitleClip o

Type class for types which can be safely cast to TitleClip, for instance with toTitleClip.

Instances

(GObject o, IsDescendantOf TitleClip o) => IsTitleClip o

Defined in GI.GES.Objects.TitleClip

toTitleClip :: (MonadIO m, IsTitleClip o) => o -> m TitleClip

Cast to TitleClip, 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, getBackgroundColor, getBoolean, getChildProperty, getChildPropertyByPspec, getChildren, 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, getTextColor, getTimeline, getTimelineTimeFromInternalTime, getTimelineTimeFromSourceFrame, getTopEffectIndex, getTopEffectPosition, getTopEffects, getToplevelParent, getTrackTypes, getUint, getUint64, getValignment, getXpos, getYpos.

Setters

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

getBackgroundColor

titleClipGetBackgroundColor

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m Word32

Returns: The color used by self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_properties instead.See TitleSource for more information about exposed properties

Get the background used by self.

getFontDesc

titleClipGetFontDesc

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m (Maybe Text)

Returns: The pango font description used by self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_properties instead.See TitleSource for more information about exposed properties

Get the pango font description used by self.

getHalignment

titleClipGetHalignment

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m TextHAlign

Returns: The horizontal aligment used by self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_properties instead.See TitleSource for more information about exposed properties

Get the horizontal aligment used by self.

getText

titleClipGetText

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m (Maybe Text)

Returns: The text currently set on self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_properties instead.See TitleSource for more information about exposed properties

Get the text currently set on self.

getTextColor

titleClipGetTextColor

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m Word32

Returns: The color used by self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_properties instead.See TitleSource for more information about exposed properties

Get the color used by self.

getValignment

titleClipGetValignment

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m TextVAlign

Returns: The vertical aligment used by self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_properties instead.See TitleSource for more information about exposed properties

Get the vertical aligment used by self.

getXpos

titleClipGetXpos

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m Double

Returns: The horizontal position used by self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_properties instead.See TitleSource for more information about exposed properties

Get the horizontal position used by self.

getYpos

titleClipGetYpos

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: a TitleClip

-> m Double

Returns: The vertical position used by self.

Deprecated: (Since version 1.6)use ges_timeline_element_get_children_property instead

Get the vertical position used by self.

new

titleClipNew

Arguments

:: (HasCallStack, MonadIO m)

=> m (Maybe TitleClip)

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

Creates a new TitleClip

setBackground

titleClipSetBackground

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: the TitleClip* to set

-> Word32

background: The color self is being set to

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the background of the text.

setColor

titleClipSetColor

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: the TitleClip* to set

-> Word32

color: The color self is being set to

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the color of the text.

setFontDesc

titleClipSetFontDesc

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: the TitleClip*

-> Maybe Text

fontDesc: the pango font description

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the pango font description of the text.

setHalignment

titleClipSetHalignment

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

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

-> TextHAlign

halign: TextHAlign

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the horizontal aligment of the text.

setText

titleClipSetText

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: the TitleClip* to set text on

-> Maybe Text

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

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the text this clip will render.

setValignment

titleClipSetValignment

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

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

-> TextVAlign

valign: TextVAlign

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the vertical aligment of the text.

setXpos

titleClipSetXpos

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: the TitleClip* to set

-> Double

position: The horizontal position self is being set to

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the horizontal position of the text.

setYpos

titleClipSetYpos

Arguments

:: (HasCallStack, MonadIO m, IsTitleClip a)

=> a

self: the TitleClip* to set

-> Double

position: The vertical position self is being set to

-> m ()

Deprecated: (Since version 1.6)use ges_timeline_element_set_children_properties instead.See TitleSource for more information about exposed properties

Sets the vertical position of the text.

Properties

background

The background of the text

constructTitleClipBackground :: (IsTitleClip o, MonadIO m) => Word32 -> m (GValueConstruct o)

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

getTitleClipBackground :: (MonadIO m, IsTitleClip o) => o -> m Word32

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

get titleClip #background

setTitleClipBackground :: (MonadIO m, IsTitleClip o) => o -> Word32 -> m ()

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

set titleClip [ #background := value ]

color

The color of the text

constructTitleClipColor :: (IsTitleClip 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.

getTitleClipColor :: (MonadIO m, IsTitleClip o) => o -> m Word32

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

get titleClip #color

setTitleClipColor :: (MonadIO m, IsTitleClip o) => o -> Word32 -> m ()

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

set titleClip [ #color := value ]

fontDesc

Pango font description string

clearTitleClipFontDesc :: (MonadIO m, IsTitleClip o) => o -> m ()

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

clear #fontDesc

constructTitleClipFontDesc :: (IsTitleClip 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.

getTitleClipFontDesc :: (MonadIO m, IsTitleClip o) => o -> m (Maybe Text)

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

get titleClip #fontDesc

setTitleClipFontDesc :: (MonadIO m, IsTitleClip o) => o -> Text -> m ()

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

set titleClip [ #fontDesc := value ]

halignment

Horizontal alignment of the text

constructTitleClipHalignment :: (IsTitleClip 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.

getTitleClipHalignment :: (MonadIO m, IsTitleClip o) => o -> m TextHAlign

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

get titleClip #halignment

setTitleClipHalignment :: (MonadIO m, IsTitleClip o) => o -> TextHAlign -> m ()

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

set titleClip [ #halignment := value ]

text

The text to diplay

clearTitleClipText :: (MonadIO m, IsTitleClip o) => o -> m ()

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

clear #text

constructTitleClipText :: (IsTitleClip 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.

getTitleClipText :: (MonadIO m, IsTitleClip o) => o -> m (Maybe Text)

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

get titleClip #text

setTitleClipText :: (MonadIO m, IsTitleClip o) => o -> Text -> m ()

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

set titleClip [ #text := value ]

valignment

Vertical alignent of the text

constructTitleClipValignment :: (IsTitleClip 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.

getTitleClipValignment :: (MonadIO m, IsTitleClip o) => o -> m TextVAlign

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

get titleClip #valignment

setTitleClipValignment :: (MonadIO m, IsTitleClip o) => o -> TextVAlign -> m ()

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

set titleClip [ #valignment := value ]

xpos

The horizontal position of the text

constructTitleClipXpos :: (IsTitleClip 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.

getTitleClipXpos :: (MonadIO m, IsTitleClip o) => o -> m Double

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

get titleClip #xpos

setTitleClipXpos :: (MonadIO m, IsTitleClip o) => o -> Double -> m ()

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

set titleClip [ #xpos := value ]

ypos

The vertical position of the text

constructTitleClipYpos :: (IsTitleClip 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.

getTitleClipYpos :: (MonadIO m, IsTitleClip o) => o -> m Double

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

get titleClip #ypos

setTitleClipYpos :: (MonadIO m, IsTitleClip o) => o -> Double -> m ()

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

set titleClip [ #ypos := value ]