cluttermm: Clutter::AlignConstraint Class Reference
AlignConstraint is a Constraint that aligns the position of the Actor to which it is applied to the size of another Actor using an alignment factor. More...
Public Member Functions | |
| virtual | ~AlignConstraint () |
| ClutterAlignConstraint* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterAlignConstraint* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterAlignConstraint* | 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_source (const Glib::RefPtr< Actor >& source) |
| Sets the source of the alignment constraint. More... | |
| Glib::RefPtr< Actor > | get_source () |
| Retrieves the source of the alignment. More... | |
| Glib::RefPtr< const Actor > | get_source () const |
| Retrieves the source of the alignment. More... | |
| void | set_align_axis (AlignAxis axis) |
| Sets the axis to which the alignment refers to. More... | |
| AlignAxis | get_align_axis () const |
| Retrieves the value set using set_align_axis() More... | |
| void | set_factor (float factor) |
| Sets the alignment factor of the constraint. More... | |
| float | get_factor () const |
| Retrieves the factor set using set_factor() More... | |
| Glib::PropertyProxy< AlignAxis > | property_align_axis () |
| The axis to align the position to. More... | |
| Glib::PropertyProxy_ReadOnly < AlignAxis > | property_align_axis () const |
| The axis to align the position to. More... | |
| Glib::PropertyProxy< float > | property_factor () |
| The alignment factor, between 0.0 and 1.0. More... | |
| Glib::PropertyProxy_ReadOnly < float > | property_factor () const |
| The alignment factor, between 0.0 and 1.0. More... | |
| Glib::PropertyProxy< Actor > | property_source () |
| The source of the alignment. More... | |
| Glib::PropertyProxy_ReadOnly < Actor > | property_source () const |
| The source of the alignment. More... | |
 Public Member Functions inherited from Clutter::Constraint | |
| virtual | ~Constraint () |
| ClutterConstraint* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterConstraint* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterConstraint* | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
| Public Member Functions inherited from Clutter::ActorMeta | |
| virtual | ~ActorMeta () |
| ClutterActorMeta* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterActorMeta* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterActorMeta* | 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_name (const Glib::ustring& name) |
| Sets the name of meta. More... | |
| Glib::ustring | get_name () const |
| Retrieves the name set using set_name() More... | |
| void | set_enabled (bool is_enabled=true) |
| Sets whether meta should be enabled or not. More... | |
| bool | get_enabled () const |
| Retrieves whether meta is enabled. More... | |
| Glib::RefPtr< Actor > | get_actor () |
| Retrieves a pointer to the Clutter::Actor that owns meta. More... | |
| Glib::RefPtr< const Actor > | get_actor () const |
| Retrieves a pointer to the Clutter::Actor that owns meta. 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 < AlignConstraint > | create (const Glib::RefPtr< Actor >& source, AlignAxis axis, float factor) |
| Static Public Member Functions inherited from Clutter::Constraint | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
| Static Public Member Functions inherited from Clutter::ActorMeta | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. More... | |
Protected Member Functions | |
| AlignConstraint (const Glib::RefPtr< Actor >& source, Clutter::AlignAxis align_axis, float factor) | |
| Protected Member Functions inherited from Clutter::Constraint | |
| Constraint () | |
| Protected Member Functions inherited from Clutter::ActorMeta | |
| ActorMeta () | |
| virtual void | set_actor_vfunc (const Glib::RefPtr< const Actor >& actor) |
| Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > > | property_actor () const |
| The actor attached to the meta. More... | |
| Glib::PropertyProxy< bool > | property_enabled () |
| Whether the meta is enabled. More... | |
| Glib::PropertyProxy_ReadOnly < bool > | property_enabled () const |
| Whether the meta is enabled. More... | |
| Glib::PropertyProxy < Glib::ustring > | property_name () |
| The name of the meta. More... | |
| Glib::PropertyProxy_ReadOnly < Glib::ustring > | property_name () const |
| The name of the meta. More... | |
Related Functions | |
(Note that these are not member functions.) | |
| Glib::RefPtr < Clutter::AlignConstraint > | wrap (ClutterAlignConstraint* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
| Related Functions inherited from Clutter::Constraint | |
| Glib::RefPtr< Clutter::Constraint > | wrap (ClutterConstraint* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
| Related Functions inherited from Clutter::ActorMeta | |
| Glib::RefPtr< Clutter::ActorMeta > | wrap (ClutterActorMeta* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Detailed Description
AlignConstraint is a Constraint that aligns the position of the Actor to which it is applied to the size of another Actor using an alignment factor.
Constructor & Destructor Documentation
|
virtual |
|
explicitprotected |
Member Function Documentation
|
static |
| AlignAxis Clutter::AlignConstraint::get_align_axis | ( | ) | const |
| float Clutter::AlignConstraint::get_factor | ( | ) | const |
| Glib::RefPtr<Actor> Clutter::AlignConstraint::get_source | ( | ) |
Retrieves the source of the alignment.
- Returns
- The Clutter::Actor used as the source of the alignment.
| Glib::RefPtr<const Actor> Clutter::AlignConstraint::get_source | ( | ) | const |
Retrieves the source of the alignment.
- Returns
- The Clutter::Actor used as the source of the alignment.
|
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.
| ClutterAlignConstraint* Clutter::AlignConstraint::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< AlignAxis > Clutter::AlignConstraint::property_align_axis | ( | ) |
The axis to align the position to.
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< AlignAxis > Clutter::AlignConstraint::property_align_axis | ( | ) | const |
The axis to align the position to.
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< float > Clutter::AlignConstraint::property_factor | ( | ) |
The alignment factor, between 0.0 and 1.0.
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< float > Clutter::AlignConstraint::property_factor | ( | ) | const |
The alignment factor, between 0.0 and 1.0.
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< Actor > Clutter::AlignConstraint::property_source | ( | ) |
The source of the alignment.
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< Actor > Clutter::AlignConstraint::property_source | ( | ) | const |
The source of the alignment.
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::AlignConstraint::set_align_axis | ( | AlignAxis | axis) |
Sets the axis to which the alignment refers to.
- Parameters
-
axis The axis to which the alignment refers to.
| void Clutter::AlignConstraint::set_factor | ( | float | factor) |
Sets the alignment factor of the constraint.
The factor depends on the Clutter::AlignConstraint::property_align_axis() property and it is a value between 0.0 (meaning left, when Clutter::AlignConstraint::property_align_axis() is set to Clutter::ALIGN_X_AXIS; or meaning top, when Clutter::AlignConstraint::property_align_axis() is set to Clutter::ALIGN_Y_AXIS) and 1.0 (meaning right, when Clutter::AlignConstraint::property_align_axis() is set to Clutter::ALIGN_X_AXIS; or meaning bottom, when Clutter::AlignConstraint::property_align_axis() is set to Clutter::ALIGN_Y_AXIS). A value of 0.5 aligns in the middle in either cases
- Parameters
-
factor The alignment factor, between 0.0 and 1.0.
| void Clutter::AlignConstraint::set_source | ( | const Glib::RefPtr< Actor >& | source) |
Sets the source of the alignment constraint.
- Parameters
-
source A Clutter::Actor, or 0to unset the source.
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/align-constraint.h