gstreamermm  0.10.10.2
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Gst::TextRender Class Reference

A Wrapper for the textrender plugin. More...

Inheritance diagram for Gst::TextRender:
Inheritance graph
[legend]
Collaboration diagram for Gst::TextRender:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~TextRender ()
GstTextRender* gobj ()
 Provides access to the underlying C GObject.
const GstTextRender* gobj () const
 Provides access to the underlying C GObject.
GstTextRender* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy
< Gst::TextRenderHAlign
property_halignment ()
 Horizontal alignment of the text.
Glib::PropertyProxy_ReadOnly
< Gst::TextRenderHAlign
property_halignment () const
 Horizontal alignment of the text.
Glib::PropertyProxy
< Gst::TextRenderVAlign
property_valignment ()
 Vertical alignment of the text.
Glib::PropertyProxy_ReadOnly
< Gst::TextRenderVAlign
property_valignment () const
 Vertical alignment of the text.
Glib::PropertyProxy
< Gst::TextRenderLineAlign
property_line_alignment ()
 Alignment of text lines relative to each other.
Glib::PropertyProxy_ReadOnly
< Gst::TextRenderLineAlign
property_line_alignment () const
 Alignment of text lines relative to each other.
Glib::PropertyProxy< int > property_xpad ()
 Horizontal paddding when using left/right alignment.
Glib::PropertyProxy_ReadOnly< int > property_xpad () const
 Horizontal paddding when using left/right alignment.
Glib::PropertyProxy< int > property_ypad ()
 Vertical padding when using top/bottom alignment.
Glib::PropertyProxy_ReadOnly< int > property_ypad () const
 Vertical padding when using top/bottom alignment.
Glib::PropertyProxy_WriteOnly
< Glib::ustring
property_font_desc ()
 Pango font description of font to be used for rendering.

Static Public Member Functions

static Glib::RefPtr< TextRendercreate ()
 Creates a new textrender plugin with a unique name.
static Glib::RefPtr< TextRendercreate (const Glib::ustring& name)
 Creates a new textrender plugin with the given name.

Protected Member Functions

 TextRender ()
 TextRender (const Glib::ustring& name)

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Gst::TextRenderwrap (GstTextRender* object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

A Wrapper for the textrender plugin.

Please note that, though using the underlying GObject is fine, using its C type is not guaranteed to be API stable across releases because it is not guaranteed to always remain the same. Also, not all plug-ins are available on all systems so care must be taken that they exist before they are used, otherwise there will be errors and possibly a crash.


Constructor & Destructor Documentation

virtual Gst::TextRender::~TextRender ( ) [virtual]
Gst::TextRender::TextRender ( ) [protected]
Gst::TextRender::TextRender ( const Glib::ustring name) [explicit, protected]

Member Function Documentation

Creates a new textrender plugin with a unique name.

static Glib::RefPtr<TextRender> Gst::TextRender::create ( const Glib::ustring name) [static]

Creates a new textrender plugin with the given name.

GstTextRender* Gst::TextRender::gobj ( ) [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::Element.

const GstTextRender* Gst::TextRender::gobj ( ) const [inline]

Provides access to the underlying C GObject.

Reimplemented from Gst::Element.

GstTextRender* Gst::TextRender::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

Reimplemented from Gst::Element.

Pango font description of font to be used for rendering.

See documentation of pango_font_description_from_string for syntax.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Horizontal alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Horizontal alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Alignment of text lines relative to each other.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Alignment of text lines relative to each other.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Vertical alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Vertical alignment of the text.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Horizontal paddding when using left/right alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Horizontal paddding when using left/right alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Vertical padding when using top/bottom alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Vertical padding when using top/bottom alignment.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes.

Friends And Related Function Documentation

Glib::RefPtr< Gst::TextRender > wrap ( GstTextRender *  object,
bool  take_copy = false 
) [related]

A Glib::wrap() method for this object.

Parameters:
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns:
A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file: