cluttermm: Clutter::SnapConstraint Class Reference
SnapConstraint is a constraint the snaps the edges of two actors together, expanding the actor's allocation if necessary. More...
Inheritance diagram for Clutter::SnapConstraint:
Collaboration diagram for Clutter::SnapConstraint:
Public Member Functions | |
| virtual | ~SnapConstraint () |
| ClutterSnapConstraint* | gobj () |
| Provides access to the underlying C GObject. More... | |
| const ClutterSnapConstraint* | gobj () const |
| Provides access to the underlying C GObject. More... | |
| ClutterSnapConstraint* | 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 Clutter::Actor for the constraint. More... | |
| Glib::RefPtr< Actor > | get_source () |
| Retrieves the Clutter::Actor set using set_source() More... | |
| Glib::RefPtr< const Actor > | get_source () const |
| Retrieves the Clutter::Actor set using set_source() More... | |
| void | set_edges (SnapEdge from_edge, SnapEdge to_edge) |
| Sets the edges to be used by the constraint. More... | |
| void | set_offset (float offset) |
| Sets the offset to be applied to the constraint. More... | |
| float | get_offset () const |
| Retrieves the offset set using set_offset() More... | |
| Glib::PropertyProxy< SnapEdge > | property_from_edge () |
| The edge of the actor that should be snapped. More... | |
| Glib::PropertyProxy_ReadOnly < SnapEdge > | property_from_edge () const |
| The edge of the actor that should be snapped. More... | |
| Glib::PropertyProxy< float > | property_offset () |
| The offset in pixels to apply to the constraint. More... | |
| Glib::PropertyProxy_ReadOnly < float > | property_offset () const |
| The offset in pixels to apply to the constraint. More... | |
| Glib::PropertyProxy < Glib::RefPtr< Actor > > | property_source () |
| The source of the constraint. More... | |
| Glib::PropertyProxy_ReadOnly < Glib::RefPtr< Actor > > | property_source () const |
| The source of the constraint. More... | |
| Glib::PropertyProxy< SnapEdge > | property_to_edge () |
| The edge of the source that should be snapped. More... | |
| Glib::PropertyProxy_ReadOnly < SnapEdge > | property_to_edge () const |
| The edge of the source that should be snapped. 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 < SnapConstraint > | create (const Glib::RefPtr< Actor >& source, SnapEdge from_edge, SnapEdge to_edge, float offset) |
| 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 | |
| SnapConstraint (const Glib::RefPtr< Actor >& source, SnapEdge from_edge, SnapEdge to_edge, float offset) | |
| 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::SnapConstraint > | wrap (ClutterSnapConstraint* 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
SnapConstraint is a constraint the snaps the edges of two actors together, expanding the actor's allocation if necessary.
An offset can be applied to the constraint, to provide spacing.
Constructor & Destructor Documentation
|
virtual |
|
explicitprotected |
Member Function Documentation
|
static |
| float Clutter::SnapConstraint::get_offset | ( | ) | const |
| Glib::RefPtr<Actor> Clutter::SnapConstraint::get_source | ( | ) |
Retrieves the Clutter::Actor set using set_source()
- Returns
- A pointer to the source actor.
| Glib::RefPtr<const Actor> Clutter::SnapConstraint::get_source | ( | ) | const |
Retrieves the Clutter::Actor set using set_source()
- Returns
- A pointer to the source actor.
|
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.
| ClutterSnapConstraint* Clutter::SnapConstraint::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< SnapEdge > Clutter::SnapConstraint::property_from_edge | ( | ) |
The edge of the actor that should be snapped.
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< SnapEdge > Clutter::SnapConstraint::property_from_edge | ( | ) | const |
The edge of the actor that should be snapped.
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::SnapConstraint::property_offset | ( | ) |
The offset in pixels to apply to the constraint.
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::SnapConstraint::property_offset | ( | ) | const |
The offset in pixels to apply to the constraint.
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<Actor> > Clutter::SnapConstraint::property_source | ( | ) |
The source of the constraint.
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<Actor> > Clutter::SnapConstraint::property_source | ( | ) | const |
The source of the constraint.
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< SnapEdge > Clutter::SnapConstraint::property_to_edge | ( | ) |
The edge of the source that should be snapped.
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< SnapEdge > Clutter::SnapConstraint::property_to_edge | ( | ) | const |
The edge of the source that should be snapped.
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.
Sets the edges to be used by the constraint.
The from_edge is the edge on the Clutter::Actor to which constraint has been added. The to_edge is the edge of the Clutter::Actor inside the Clutter::SnapConstraint::property_source() property.
- Parameters
-
from_edge The edge on the actor. to_edge The edge on the source.
| void Clutter::SnapConstraint::set_offset | ( | float | offset) |
Sets the offset to be applied to the constraint.
- Parameters
-
offset The offset to apply, in pixels.
| void Clutter::SnapConstraint::set_source | ( | const Glib::RefPtr< Actor >& | source) |
Sets the source Clutter::Actor for the 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/snap-constraint.h