cluttermm: Clutter::ActorMeta Class Reference

Clutter::ActorMeta is an abstract class providing a common API for modifiers of Clutter::Actor activity, appearance or layout. More...

Inheritance diagram for Clutter::ActorMeta:
Collaboration diagram for Clutter::ActorMeta:

Public Member Functions

virtual ~ActorMeta ()
 
ClutterActorMeta* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterActorMeta* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterActorMeta* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...

 
void set_name (const Glib::ustring& name)
 Sets the name of meta. More...

 
Glib::ustring get_name () const
 Retrieves the name set using set_name() More...

 
void set_enabled (bool is_enabled=true)
 Sets whether meta should be enabled or not. More...

 
bool get_enabled () const
 Retrieves whether meta is enabled. More...

 
Glib::RefPtr< Actorget_actor ()
 Retrieves a pointer to the Clutter::Actor that owns meta. More...

 
Glib::RefPtr< const Actorget_actor () const
 Retrieves a pointer to the Clutter::Actor that owns meta. More...

 

Static Public Member Functions

static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

 ActorMeta ()
 
virtual void set_actor_vfunc (const Glib::RefPtr< const Actor >& actor)
 
Glib::PropertyProxy_ReadOnly

< Glib::RefPtr< Actor > > 
property_actor () const
 The actor attached to the meta. More...

 
Glib::PropertyProxy< bool > property_enabled ()
 Whether the meta is enabled. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_enabled () const
 Whether the meta is enabled. More...

 
Glib::PropertyProxy

< Glib::ustring
property_name ()
 The name of the meta. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::ustring
property_name () const
 The name of the meta. More...

 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Clutter::ActorMetawrap (ClutterActorMeta* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Detailed Description

Clutter::ActorMeta is an abstract class providing a common API for modifiers of Clutter::Actor activity, appearance or layout.

A Clutter::ActorMeta can only be owned by a single Clutter::Actor at any time.

Every sub-class of Clutter::ActorMeta should check if the “enabled” property is set to true before applying any kind of modification.

Clutter::ActorMeta is available since Clutter 1.4

Constructor & Destructor Documentation

virtual Clutter::ActorMeta::~ActorMeta ( )
virtual
Clutter::ActorMeta::ActorMeta ( )
protected

Member Function Documentation

Glib::RefPtr<Actor> Clutter::ActorMeta::get_actor ( )

Retrieves a pointer to the Clutter::Actor that owns meta.

Since cluttermm 1.4:
Returns
A pointer to a Clutter::Actor or 0.
Glib::RefPtr<const Actor> Clutter::ActorMeta::get_actor ( ) const

Retrieves a pointer to the Clutter::Actor that owns meta.

Since cluttermm 1.4:
Returns
A pointer to a Clutter::Actor or 0.
bool Clutter::ActorMeta::get_enabled ( ) const

Retrieves whether meta is enabled.

Since cluttermm 1.4:
Returns
true if the Clutter::ActorMeta instance is enabled.
Glib::ustring Clutter::ActorMeta::get_name ( ) const

Retrieves the name set using set_name()

Since cluttermm 1.4:
Returns
The name of the Clutter::ActorMeta instance, or 0 if none was set. The returned string is owned by the Clutter::ActorMeta instance and it should not be modified or freed.
static GType Clutter::ActorMeta::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

ClutterActorMeta* Clutter::ActorMeta::gobj ( )
inline

Provides access to the underlying C GObject.

const ClutterActorMeta* Clutter::ActorMeta::gobj ( ) const
inline

Provides access to the underlying C GObject.

ClutterActorMeta* Clutter::ActorMeta::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_ReadOnly< Glib::RefPtr<Actor> > Clutter::ActorMeta::property_actor ( ) const
protected

The actor attached to the meta.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Clutter::ActorMeta::property_enabled ( )
protected

Whether the meta is enabled.

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 value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Clutter::ActorMeta::property_enabled ( ) const
protected

Whether the meta is enabled.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< Glib::ustring > Clutter::ActorMeta::property_name ( )
protected

The name of the meta.

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 value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< Glib::ustring > Clutter::ActorMeta::property_name ( ) const
protected

The name of the meta.

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

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
virtual void Clutter::ActorMeta::set_actor_vfunc ( const Glib::RefPtr< const Actor >&  actor)
protectedvirtual
void Clutter::ActorMeta::set_enabled ( bool  is_enabled = true)

Sets whether meta should be enabled or not.

Since cluttermm 1.4:
Parameters
is_enabledWhether meta is enabled.
void Clutter::ActorMeta::set_name ( const Glib::ustring name)

Sets the name of meta.

The name can be used to identify the Clutter::ActorMeta instance

Since cluttermm 1.4:
Parameters
nameThe name of meta.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::ActorMeta > wrap ( ClutterActorMeta *  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:
  • cluttermm/actor-meta.h