clutter-gtkmm 0.91.8
Public Member Functions | Related Functions
Clutter::Gtk::Embed Class Reference

This widget embeds a Clutter::Stage, allowing you to build, show and interact with a scene built using Clutter, inside a gtkmm application. More...

Inheritance diagram for Clutter::Gtk::Embed:
Inheritance graph
[legend]
Collaboration diagram for Clutter::Gtk::Embed:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~Embed ()
GtkClutterEmbed* gobj ()
 Provides access to the underlying C GObject.
const GtkClutterEmbed* gobj () const
 Provides access to the underlying C GObject.
GtkClutterEmbed* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
 Embed ()
Glib::RefPtr< Stageget_stage ()
 Retrieves the Clutter::Stage from embed.
Glib::RefPtr< const Stageget_stage () const
 Retrieves the Clutter::Stage from embed.

Related Functions

(Note that these are not member functions.)

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

Detailed Description

This widget embeds a Clutter::Stage, allowing you to build, show and interact with a scene built using Clutter, inside a gtkmm application.

Note:
To avoid flickering on show(), you should call Gtk::Widget::show() or Gtk::Widget::realize() before calling Clutter::Actor::show() on the embedded Clutter::Stage actor. This is needed for Clutter to be able to paint on the Clutter::Gtk::Embed widget.

Constructor & Destructor Documentation

virtual Clutter::Gtk::Embed::~Embed ( ) [virtual]
Clutter::Gtk::Embed::Embed ( )

Member Function Documentation

Glib::RefPtr<Stage> Clutter::Gtk::Embed::get_stage ( )

Retrieves the Clutter::Stage from embed.

The returned stage can be used to add actors to the Clutter scene.

Returns:
The Clutter stage. You should never destroy or unref the returned actor.
Since clutter-gtkmm 0.6:
Glib::RefPtr<const Stage> Clutter::Gtk::Embed::get_stage ( ) const

Retrieves the Clutter::Stage from embed.

The returned stage can be used to add actors to the Clutter scene.

Returns:
The Clutter stage. You should never destroy or unref the returned actor.
Since clutter-gtkmm 0.6:
const GtkClutterEmbed* Clutter::Gtk::Embed::gobj ( ) const [inline]

Provides access to the underlying C GObject.

GtkClutterEmbed* Clutter::Gtk::Embed::gobj ( ) [inline]

Provides access to the underlying C GObject.

GtkClutterEmbed* Clutter::Gtk::Embed::gobj_copy ( )

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


Friends And Related Function Documentation

Glib::RefPtr< Clutter::Gtk::Embed > wrap ( GtkClutterEmbed *  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: