Clutter::Container Class Reference

#include <container.h>

Inheritance diagram for Clutter::Container:

Inheritance graph
[legend]

List of all members.

Public Types

typedef sigc::slot< void,
const Glib::RefPtr< Actor > & > 
SlotForEach
 For instance, void on_foreach(const Glib::RefPtr<Actor>& actor).

Public Member Functions

virtual ~Container ()
ClutterContainer * gobj ()
 Provides access to the underlying C GObject.
const ClutterContainer * gobj () const
 Provides access to the underlying C GObject.
void add_actor (const Glib::RefPtr< Actor > &actor)
 Adds a Clutter::Actor to container.
void remove_actor (const Glib::RefPtr< Actor > &actor)
 Removes actor from container.
void lower_child (const Glib::RefPtr< Actor > &actor, const Glib::RefPtr< Actor > &sibling)
 Lowers actor at sibling level, in the depth ordering.
void lower_child (const Glib::RefPtr< Actor > &actor)
void raise_child (const Glib::RefPtr< Actor > &actor, const Glib::RefPtr< Actor > &sibling)
 Raises actor at sibling level, in the depth ordering.
void raise_child (const Glib::RefPtr< Actor > &actor)
Glib::RefPtr< Actorfind_child (const Glib::ustring &child_name)
 Finds a child actor of a container by its name.
Glib::RefPtr< const Actorfind_child (const Glib::ustring &child_name) const
 Finds a child actor of a container by its name.
void foreach (const SlotForEach &slot)

Static Public Member Functions

static void add_interface (GType gtype_implementer)

Protected Member Functions

void sort_depth_order ()
 Sorts a container children using their depth.

Related Functions

(Note that these are not member functions.)

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


Member Typedef Documentation

typedef sigc::slot<void, const Glib::RefPtr<Actor>&> Clutter::Container::SlotForEach

For instance, void on_foreach(const Glib::RefPtr<Actor>& actor).


Constructor & Destructor Documentation

virtual Clutter::Container::~Container (  )  [virtual]


Member Function Documentation

static void Clutter::Container::add_interface ( GType  gtype_implementer  )  [static]

ClutterContainer* Clutter::Container::gobj (  )  [inline]

Provides access to the underlying C GObject.

Reimplemented in Clutter::Group, and Clutter::Stage.

const ClutterContainer* Clutter::Container::gobj (  )  const [inline]

Provides access to the underlying C GObject.

Reimplemented in Clutter::Group, and Clutter::Stage.

void Clutter::Container::add_actor ( const Glib::RefPtr< Actor > &  actor  ) 

Adds a Clutter::Actor to container.

This function will emit the "actor-added" signal is emitted. The actor should be parented to container. You cannot add a Clutter::Actor to more than one Clutter::Container.

Since: 0.4

Parameters:
actor The first Clutter::Actor to add.

void Clutter::Container::remove_actor ( const Glib::RefPtr< Actor > &  actor  ) 

Removes actor from container.

The actor should be unparented, so if you want to keep it around you must hold a reference to it yourself, using Glib::object_ref(). When the actor has been removed, the "actor-removed" signal is emitted by container.

Since: 0.4

Parameters:
actor A Clutter::Actor.

void Clutter::Container::lower_child ( const Glib::RefPtr< Actor > &  actor,
const Glib::RefPtr< Actor > &  sibling 
)

Lowers actor at sibling level, in the depth ordering.

Since: 0.6

Parameters:
actor The actor to raise.
sibling The sibling to lower to, or 0 to lower at the bottom.

void Clutter::Container::lower_child ( const Glib::RefPtr< Actor > &  actor  ) 

void Clutter::Container::raise_child ( const Glib::RefPtr< Actor > &  actor,
const Glib::RefPtr< Actor > &  sibling 
)

Raises actor at sibling level, in the depth ordering.

Since: 0.6

Parameters:
actor The actor to raise.
sibling The sibling to raise to, or 0 to raise at the top.

void Clutter::Container::raise_child ( const Glib::RefPtr< Actor > &  actor  ) 

Glib::RefPtr<Actor> Clutter::Container::find_child ( const Glib::ustring &  child_name  ) 

Finds a child actor of a container by its name.

Search recurses into any child container.

Parameters:
child_name The name of the requested child.
Returns:
The child actor with the requested name, or 0 if no actor with that name was found.
Since: 0.6.

Glib::RefPtr<const Actor> Clutter::Container::find_child ( const Glib::ustring &  child_name  )  const

Finds a child actor of a container by its name.

Search recurses into any child container.

Parameters:
child_name The name of the requested child.
Returns:
The child actor with the requested name, or 0 if no actor with that name was found.
Since: 0.6.

void Clutter::Container::foreach ( const SlotForEach slot  ) 

void Clutter::Container::sort_depth_order (  )  [protected]

Sorts a container children using their depth.

This function should not be normally used by applications.

Since: 0.6


Friends And Related Function Documentation

Glib::RefPtr< Clutter::Container > wrap ( ClutterContainer *  object,
bool  take_copy = false 
) [related]

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

Parameters:
object The C instance.
take_copy False 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:

Generated on Fri Jun 6 02:12:49 2008 for cluttermm by  doxygen 1.5.5