cluttermm 1.3.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Clutter::Box Class Reference
Inheritance diagram for Clutter::Box:
Inheritance graph
[legend]
Collaboration diagram for Clutter::Box:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual ~Box ()
ClutterBox* gobj ()
 Provides access to the underlying C GObject.
const ClutterBox* gobj () const
 Provides access to the underlying C GObject.
ClutterBox* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::RefPtr< LayoutManagerget_layout_manager ()
 Retrieves the Clutter::LayoutManager instance used by box.
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the Clutter::LayoutManager instance used by box.
void set_color (const Color& color)
 Sets (or unsets) the background color for box.
Color get_color () const
 Retrieves the background color of box.
Glib::PropertyProxy< Colorproperty_color ()
 The color to be used to paint the background of the ClutterBox.
Glib::PropertyProxy_ReadOnly
< Color
property_color () const
 The color to be used to paint the background of the ClutterBox.
Glib::PropertyProxy< bool > property_color_set ()
 Whether the 'color' property has been set.
Glib::PropertyProxy_ReadOnly
< bool > 
property_color_set () const
 Whether the 'color' property has been set.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< LayoutManager > > 
property_layout_manager () const
 The ClutterLayoutManager used by the ClutterBox.

Static Public Member Functions

static Glib::RefPtr< Boxcreate ()
static Glib::RefPtr< Boxcreate (const Glib::RefPtr< LayoutManager >& layoutManager)

Protected Member Functions

 Box ()
 Box (const Glib::RefPtr< LayoutManager >& layoutManager)

Related Functions

(Note that these are not member functions.)

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

Constructor & Destructor Documentation

virtual Clutter::Box::~Box ( ) [virtual]
Clutter::Box::Box ( ) [protected]
Clutter::Box::Box ( const Glib::RefPtr< LayoutManager >&  layoutManager) [explicit, protected]

Member Function Documentation

static Glib::RefPtr<Box> Clutter::Box::create ( ) [static]
static Glib::RefPtr<Box> Clutter::Box::create ( const Glib::RefPtr< LayoutManager >&  layoutManager) [static]
Color Clutter::Box::get_color ( ) const

Retrieves the background color of box.

If the Clutter::Box:color-set property is set to false the returned Clutter::Color is undefined

Since cluttermm 1.2:
Parameters:
colorReturn location for a Clutter::Color.
Glib::RefPtr<LayoutManager> Clutter::Box::get_layout_manager ( )

Retrieves the Clutter::LayoutManager instance used by box.

Since cluttermm 1.2:
Returns:
A Clutter::LayoutManager.
Glib::RefPtr<const LayoutManager> Clutter::Box::get_layout_manager ( ) const

Retrieves the Clutter::LayoutManager instance used by box.

Since cluttermm 1.2:
Returns:
A Clutter::LayoutManager.
const ClutterBox* Clutter::Box::gobj ( ) const [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Actor.

ClutterBox* Clutter::Box::gobj ( ) [inline]

Provides access to the underlying C GObject.

Reimplemented from Clutter::Actor.

ClutterBox* Clutter::Box::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 Clutter::Actor.

Glib::PropertyProxy<Color> Clutter::Box::property_color ( )

The color to be used to paint the background of the ClutterBox.

Setting this property will set the 'color-set' property as a side effect.

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.
Glib::PropertyProxy_ReadOnly<Color> Clutter::Box::property_color ( ) const

The color to be used to paint the background of the ClutterBox.

Setting this property will set the 'color-set' property as a side effect.

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.
Glib::PropertyProxy<bool> Clutter::Box::property_color_set ( )

Whether the 'color' property has been set.

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.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Box::property_color_set ( ) const

Whether the 'color' property has been set.

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.
Glib::PropertyProxy_ReadOnly< Glib::RefPtr<LayoutManager> > Clutter::Box::property_layout_manager ( ) const

The ClutterLayoutManager used by the ClutterBox.

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.
void Clutter::Box::set_color ( const Color color)

Sets (or unsets) the background color for box.

Since cluttermm 1.2:
Parameters:
colorThe background color, or 0 to unset.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Box > wrap ( ClutterBox *  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: