Clutter::Alpha Class Reference

#include <alpha.h>

Inheritance diagram for Clutter::Alpha:

Inheritance graph
[legend]

List of all members.

Public Types

typedef sigc::slot< guint32,
const Glib::RefPtr< Alpha > & > 
SlotAlphaFunc
 For instance, guint32 on_alpha(const Glib::RefPtr<Alpha>& alpha);.

Public Member Functions

virtual ~Alpha ()
ClutterAlpha * gobj ()
 Provides access to the underlying C GObject.
const ClutterAlpha * gobj () const
 Provides access to the underlying C GObject.
ClutterAlpha * gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
void set_timeline (const Glib::RefPtr< Timeline > &timeline)
 Binds alpha to timeline.
Glib::RefPtr< Timelineget_timeline () const
 Gets the Clutter::Timeline bound to alpha.
guint32 get_alpha () const
 Query the current alpha value.
void set_func (const SlotAlphaFunc &slot)
Glib::PropertyProxy_ReadOnly
< guint > 
property_alpha () const
 Alpha value.
Glib::PropertyProxy
< Glib::RefPtr< Timeline > > 
property_timeline ()
 Timeline.
Glib::PropertyProxy_ReadOnly
< Glib::RefPtr< Timeline > > 
property_timeline () const
 Timeline.

Static Public Member Functions

static Glib::RefPtr< Alphacreate ()
static Glib::RefPtr< Alphacreate (const Glib::RefPtr< Timeline > &timeline, const SlotAlphaFunc &slot)
static Glib::RefPtr< Alphacreate (const Glib::RefPtr< Timeline > &timeline, ClutterAlphaFunc callback)

Protected Member Functions

 Alpha ()
 Alpha (const Glib::RefPtr< Timeline > &timeline, const SlotAlphaFunc &slot)
 Creates a new Alpha instance and sets the timeline and the alpha function.
 Alpha (const Glib::RefPtr< Timeline > &timeline, ClutterAlphaFunc callback)
 Creates a new Alpha instance and sets the timeline and the alpha function.

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Clutter::Alphawrap (ClutterAlpha *object, bool take_copy=false)
 A Glib::wrap() method for this object.
Pre-defined Alpha functions
Alpha::SlotAlphaFunc ALPHA_RAMP_INC
Alpha::SlotAlphaFunc ALPHA_RAMP_DEC
Alpha::SlotAlphaFunc ALPHA_RAMP
Alpha::SlotAlphaFunc ALPHA_SINE
Alpha::SlotAlphaFunc ALPHA_SINE_INC
Alpha::SlotAlphaFunc ALPHA_SINE_DEC
Alpha::SlotAlphaFunc ALPHA_SINE_HALF
Alpha::SlotAlphaFunc ALPHA_SQUARE
Alpha::SlotAlphaFunc ALPHA_SMOOTHSTEP_INC
Alpha::SlotAlphaFunc ALPHA_SMOOTHSTEP_DEC
Alpha::SlotAlphaFunc ALPHA_EXP_INC
Alpha::SlotAlphaFunc ALPHA_EXP_DEC


Member Typedef Documentation

typedef sigc::slot<guint32, const Glib::RefPtr<Alpha>& > Clutter::Alpha::SlotAlphaFunc

For instance, guint32 on_alpha(const Glib::RefPtr<Alpha>& alpha);.


Constructor & Destructor Documentation

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

Clutter::Alpha::Alpha (  )  [protected]

Clutter::Alpha::Alpha ( const Glib::RefPtr< Timeline > &  timeline,
const SlotAlphaFunc slot 
) [protected]

Creates a new Alpha instance and sets the timeline and the alpha function.

Parameters:
timeline Timeline.
slot Alpha function.

Clutter::Alpha::Alpha ( const Glib::RefPtr< Timeline > &  timeline,
ClutterAlphaFunc  callback 
) [protected]

Creates a new Alpha instance and sets the timeline and the alpha function.

Parameters:
timeline Timeline.
slot Alpha function.


Member Function Documentation

ClutterAlpha* Clutter::Alpha::gobj (  )  [inline]

Provides access to the underlying C GObject.

const ClutterAlpha* Clutter::Alpha::gobj (  )  const [inline]

Provides access to the underlying C GObject.

ClutterAlpha* Clutter::Alpha::gobj_copy (  ) 

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

static Glib::RefPtr<Alpha> Clutter::Alpha::create (  )  [static]

static Glib::RefPtr<Alpha> Clutter::Alpha::create ( const Glib::RefPtr< Timeline > &  timeline,
const SlotAlphaFunc slot 
) [static]

static Glib::RefPtr<Alpha> Clutter::Alpha::create ( const Glib::RefPtr< Timeline > &  timeline,
ClutterAlphaFunc  callback 
) [static]

void Clutter::Alpha::set_timeline ( const Glib::RefPtr< Timeline > &  timeline  ) 

Binds alpha to timeline.

Since: 0.2

Parameters:
timeline A Clutter::Timeline.

Glib::RefPtr<Timeline> Clutter::Alpha::get_timeline (  )  const

Gets the Clutter::Timeline bound to alpha.

Returns:
A Clutter::Timeline instance
Since: 0.2.

guint32 Clutter::Alpha::get_alpha (  )  const

Query the current alpha value.

Returns:
The current alpha value for the alpha
Since: 0.2.

void Clutter::Alpha::set_func ( const SlotAlphaFunc slot  ) 

Glib::PropertyProxy_ReadOnly<guint> Clutter::Alpha::property_alpha (  )  const

Alpha value.

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< Glib::RefPtr<Timeline> > Clutter::Alpha::property_timeline (  ) 

Timeline.

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<Timeline> > Clutter::Alpha::property_timeline (  )  const

Timeline.

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.


Friends And Related Function Documentation

Glib::RefPtr< Clutter::Alpha > wrap ( ClutterAlpha *  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 Mon Sep 15 05:39:58 2008 for cluttermm by  doxygen 1.5.6