Copyright | Will Thompson and Iñaki García Etxebarria |
---|---|
License | LGPL-2.1 |
Maintainer | Iñaki García Etxebarria |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Renders the given text in the specified font, at specified position, and with the specified background pattern.
Synopsis
- newtype TitleClip = TitleClip (ManagedPtr TitleClip)
- class (GObject o, IsDescendantOf TitleClip o) => IsTitleClip o
- toTitleClip :: (MonadIO m, IsTitleClip o) => o -> m TitleClip
- titleClipGetBackgroundColor :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m Word32
- titleClipGetFontDesc :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m (Maybe Text)
- titleClipGetHalignment :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m TextHAlign
- titleClipGetText :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m (Maybe Text)
- titleClipGetTextColor :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m Word32
- titleClipGetValignment :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m TextVAlign
- titleClipGetXpos :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m Double
- titleClipGetYpos :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> m Double
- titleClipNew :: (HasCallStack, MonadIO m) => m (Maybe TitleClip)
- titleClipSetBackground :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> Word32 -> m ()
- titleClipSetColor :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> Word32 -> m ()
- titleClipSetFontDesc :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> Maybe Text -> m ()
- titleClipSetHalignment :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> TextHAlign -> m ()
- titleClipSetText :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> Maybe Text -> m ()
- titleClipSetValignment :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> TextVAlign -> m ()
- titleClipSetXpos :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> Double -> m ()
- titleClipSetYpos :: (HasCallStack, MonadIO m, IsTitleClip a) => a -> Double -> m ()
- constructTitleClipBackground :: (IsTitleClip o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getTitleClipBackground :: (MonadIO m, IsTitleClip o) => o -> m Word32
- setTitleClipBackground :: (MonadIO m, IsTitleClip o) => o -> Word32 -> m ()
- constructTitleClipColor :: (IsTitleClip o, MonadIO m) => Word32 -> m (GValueConstruct o)
- getTitleClipColor :: (MonadIO m, IsTitleClip o) => o -> m Word32
- setTitleClipColor :: (MonadIO m, IsTitleClip o) => o -> Word32 -> m ()
- clearTitleClipFontDesc :: (MonadIO m, IsTitleClip o) => o -> m ()
- constructTitleClipFontDesc :: (IsTitleClip o, MonadIO m) => Text -> m (GValueConstruct o)
- getTitleClipFontDesc :: (MonadIO m, IsTitleClip o) => o -> m (Maybe Text)
- setTitleClipFontDesc :: (MonadIO m, IsTitleClip o) => o -> Text -> m ()
- constructTitleClipHalignment :: (IsTitleClip o, MonadIO m) => TextHAlign -> m (GValueConstruct o)
- getTitleClipHalignment :: (MonadIO m, IsTitleClip o) => o -> m TextHAlign
- setTitleClipHalignment :: (MonadIO m, IsTitleClip o) => o -> TextHAlign -> m ()
- clearTitleClipText :: (MonadIO m, IsTitleClip o) => o -> m ()
- constructTitleClipText :: (IsTitleClip o, MonadIO m) => Text -> m (GValueConstruct o)
- getTitleClipText :: (MonadIO m, IsTitleClip o) => o -> m (Maybe Text)
- setTitleClipText :: (MonadIO m, IsTitleClip o) => o -> Text -> m ()
- constructTitleClipValignment :: (IsTitleClip o, MonadIO m) => TextVAlign -> m (GValueConstruct o)
- getTitleClipValignment :: (MonadIO m, IsTitleClip o) => o -> m TextVAlign
- setTitleClipValignment :: (MonadIO m, IsTitleClip o) => o -> TextVAlign -> m ()
- constructTitleClipXpos :: (IsTitleClip o, MonadIO m) => Double -> m (GValueConstruct o)
- getTitleClipXpos :: (MonadIO m, IsTitleClip o) => o -> m Double
- setTitleClipXpos :: (MonadIO m, IsTitleClip o) => o -> Double -> m ()
- constructTitleClipYpos :: (IsTitleClip o, MonadIO m) => Double -> m (GValueConstruct o)
- getTitleClipYpos :: (MonadIO m, IsTitleClip o) => o -> m Double
- setTitleClipYpos :: (MonadIO m, IsTitleClip o) => o -> Double -> m ()
Exported types
Memory-managed wrapper type.
Instances
Eq TitleClip Source # | |
GObject TitleClip Source # | |
Defined in GI.GES.Objects.TitleClip | |
ManagedPtrNewtype TitleClip Source # | |
Defined in GI.GES.Objects.TitleClip toManagedPtr :: TitleClip -> ManagedPtr TitleClip | |
TypedObject TitleClip Source # | |
Defined in GI.GES.Objects.TitleClip | |
HasParentTypes TitleClip Source # | |
Defined in GI.GES.Objects.TitleClip | |
IsGValue (Maybe TitleClip) Source # | Convert |
Defined in GI.GES.Objects.TitleClip gvalueGType_ :: IO GType gvalueSet_ :: Ptr GValue -> Maybe TitleClip -> IO () gvalueGet_ :: Ptr GValue -> IO (Maybe TitleClip) | |
type ParentTypes TitleClip Source # | |
Defined in GI.GES.Objects.TitleClip type ParentTypes TitleClip = '[SourceClip, Clip, Container, TimelineElement, Object, Extractable, MetaContainer] |
class (GObject o, IsDescendantOf TitleClip o) => IsTitleClip o Source #
Type class for types which can be safely cast to TitleClip
, for instance with toTitleClip
.
Instances
(GObject o, IsDescendantOf TitleClip o) => IsTitleClip o Source # | |
Defined in GI.GES.Objects.TitleClip |
toTitleClip :: (MonadIO m, IsTitleClip o) => o -> m TitleClip Source #
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 Source #
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m Word32 | Returns: The color used by |
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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m (Maybe Text) | Returns: The pango font description used by |
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 Source #
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m TextHAlign | Returns: The horizontal aligment used by |
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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m (Maybe Text) | Returns: The text currently set on |
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 Source #
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m Word32 | Returns: The color used by |
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 Source #
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m TextVAlign | Returns: The vertical aligment used by |
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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m Double | Returns: The horizontal position used by |
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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> m Double | Returns: The vertical position used by |
Deprecated: (Since version 1.6)use ges_timeline_element_get_children_property
instead
Get the vertical position used by self
.
new
:: (HasCallStack, MonadIO m) | |
=> m (Maybe TitleClip) | Returns: The newly created |
Creates a new TitleClip
setBackground
titleClipSetBackground Source #
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> Word32 |
|
-> 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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> Word32 |
|
-> 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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> Maybe Text |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> Maybe Text |
|
-> 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 Source #
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> 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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> Double |
|
-> 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
:: (HasCallStack, MonadIO m, IsTitleClip a) | |
=> a |
|
-> Double |
|
-> 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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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 () Source #
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) Source #
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) Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
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) Source #
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 Source #
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 () Source #
Set the value of the “ypos
” property.
When overloading is enabled, this is equivalent to
set
titleClip [ #ypos:=
value ]