cluttermm: Clutter::Alpha Class Reference
Public Types | |
enum | { MAX_ALPHA = 0xFFFF } |
typedef sigc::slot< double, const Glib::RefPtr< Alpha >& > | SlotAlphaFunc |
For instance, double on_alpha(const Glib::RefPtr<Alpha>& alpha);. More... | |
Public Member Functions | |
virtual | ~Alpha () |
ClutterAlpha* | gobj () |
Provides access to the underlying C GObject. More... | |
const ClutterAlpha* | gobj () const |
Provides access to the underlying C GObject. More... | |
ClutterAlpha* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
void | set_timeline (const Glib::RefPtr< Timeline >& timeline) |
Binds alpha to timeline. More... | |
Glib::RefPtr< Timeline > | get_timeline () |
Gets the Clutter::Timeline bound to alpha. More... | |
Glib::RefPtr< const Timeline > | get_timeline () const |
Gets the Clutter::Timeline bound to alpha. More... | |
double | get_alpha () const |
Query the current alpha value. More... | |
void | set_func (const SlotAlphaFunc& slot) |
void | set_mode (gulong mode) |
Sets the progress function of alpha using the symbolic value of mode, as taken by the Clutter::AnimationMode enumeration or using the value returned by register_func(). More... | |
gulong | get_mode () const |
Retrieves the Clutter::AnimationMode used by alpha. More... | |
Glib::PropertyProxy_ReadOnly < double > | property_alpha () const |
Alpha value as computed by the alpha. More... | |
Glib::PropertyProxy < Glib::RefPtr< Timeline > > | property_timeline () |
Timeline used by the alpha. More... | |
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Timeline > > | property_timeline () const |
Timeline used by the alpha. More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static Glib::RefPtr< Alpha > | create () |
static Glib::RefPtr< Alpha > | create (const Glib::RefPtr< Timeline >& timeline, const SlotAlphaFunc& slot) |
static Glib::RefPtr< Alpha > | create (const Glib::RefPtr< Timeline >& timeline, gulong mode) |
Protected Member Functions | |
Alpha () | |
Alpha (const Glib::RefPtr< Timeline >& timeline, gulong mode) | |
Alpha (const Glib::RefPtr< Timeline >& timeline, const SlotAlphaFunc& slot) | |
Creates a new Alpha instance and sets the timeline and the alpha function. More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Clutter::Alpha > | wrap (ClutterAlpha* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Detailed Description
- Deprecated:
- Use the "progress-mode" property of Clutter::Timeline, or the Clutter::Timeline::set_progress_func() method instead.
Member Typedef Documentation
typedef sigc::slot<double, const Glib::RefPtr<Alpha>&> Clutter::Alpha::SlotAlphaFunc |
For instance, double on_alpha(const Glib::RefPtr<Alpha>& alpha);.
Member Enumeration Documentation
Constructor & Destructor Documentation
|
virtual |
|
protected |
|
explicitprotected |
|
protected |
Member Function Documentation
|
static |
|
static |
|
static |
double Clutter::Alpha::get_alpha | ( | ) | const |
Query the current alpha value.
Deprecated: 1.12
- Returns
- The current alpha value for the alpha.
gulong Clutter::Alpha::get_mode | ( | ) | const |
Glib::RefPtr<Timeline> Clutter::Alpha::get_timeline | ( | ) |
Glib::RefPtr<const Timeline> Clutter::Alpha::get_timeline | ( | ) | const |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
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.
Glib::PropertyProxy_ReadOnly< double > Clutter::Alpha::property_alpha | ( | ) | const |
Alpha value as computed by the alpha.
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.
Glib::PropertyProxy< Glib::RefPtr<Timeline> > Clutter::Alpha::property_timeline | ( | ) |
Timeline used by the alpha.
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< Glib::RefPtr<Timeline> > Clutter::Alpha::property_timeline | ( | ) | const |
Timeline used by the alpha.
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::Alpha::set_func | ( | const SlotAlphaFunc& | slot) |
void Clutter::Alpha::set_mode | ( | gulong | mode) |
Sets the progress function of alpha using the symbolic value of mode, as taken by the Clutter::AnimationMode enumeration or using the value returned by register_func().
Deprecated: 1.12
- Parameters
-
mode A Clutter::AnimationMode.
void Clutter::Alpha::set_timeline | ( | const Glib::RefPtr< Timeline >& | timeline) |
Friends And Related Function Documentation
|
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:
- cluttermm/alpha.h