clutter-gtkmm: 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...

Inherits Container.

Public Member Functions

virtual ~Embed ()
 
GtkClutterEmbed* gobj ()
 Provides access to the underlying C GtkObject. More...

 
const GtkClutterEmbed* gobj () const
 Provides access to the underlying C GtkObject. More...

 
 Embed ()
 
Glib::RefPtr< Stage > get_stage ()
 Retrieves the Clutter::Stage from embed. More...

 
Glib::RefPtr< const Stage > get_stage () const
 Retrieves the Clutter::Stage from embed. More...

 
void set_use_layout_size (bool use_layout_size=true)
 
Glib::PropertyProxy< bool > property_use_layout_size ()
 Whether to use the reported size of the LayoutManager on the stage as the widget size. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_use_layout_size () const
 Whether to use the reported size of the LayoutManager on the stage as the widget size. More...

 

Static Public Member Functions

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

 

Related Functions

(Note that these are not member functions.)

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

 

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:
static GType Clutter::Gtk::Embed::get_type ( )
static

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

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

Provides access to the underlying C GtkObject.

const GtkClutterEmbed* Clutter::Gtk::Embed::gobj ( ) const
inline

Provides access to the underlying C GtkObject.

Glib::PropertyProxy< bool > Clutter::Gtk::Embed::property_use_layout_size ( )

Whether to use the reported size of the LayoutManager on the stage as the widget size.

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::Gtk::Embed::property_use_layout_size ( ) const

Whether to use the reported size of the LayoutManager on the stage as the widget size.

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.
void Clutter::Gtk::Embed::set_use_layout_size ( bool  use_layout_size = true)

Friends And Related Function Documentation

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:
  • clutter-gtkmm/embed.h