#include <actor.h>
Public Member Functions | |
virtual | ~Actor () |
ClutterActor * | gobj () |
Provides access to the underlying C GObject. | |
const ClutterActor * | gobj () const |
Provides access to the underlying C GObject. | |
ClutterActor * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | show () |
Flags an actor to be displayed. | |
void | show_all () |
Calls show() on all children of an actor (if any). | |
void | hide () |
Flags an actor to be hidden. | |
void | hide_all () |
Calls hide() on all child actors (if any). | |
void | realize () |
Creates any underlying graphics resources needed by the actor to be displayed. | |
void | unrealize () |
Frees up any underlying graphics resources needed by the actor to be displayed. | |
void | paint () |
Renders the actor to display. | |
void | queue_redraw () |
Queues up a redraw of an actor and any children. | |
void | queue_relayout () |
Indicates that the actor's size request or other layout-affecting properties may have changed. | |
Glib::RefPtr< Actor > | get_stage () |
Retrieves the Clutter::Stage where actor is contained. | |
Glib::RefPtr< const Actor > | get_stage () const |
Retrieves the Clutter::Stage where actor is contained. | |
void | set_geometry (const Geometry &geometry) |
Sets the actor's fixed position and forces its minimum and natural size, in pixels. | |
Geometry | get_geometry () const |
Gets the size and position of an actor relative to its parent actor. | |
void | set_size (int width, int height) |
Sets the actor's size request in pixels. | |
void | set_sizeu (Unit width, Unit height) |
Overrides the actor's size request in Clutter::Unit<!-- -->s. | |
void | get_position (int &x, int &y) |
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations. | |
void | get_positionu (Unit &x, Unit &y) |
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations. | |
void | set_position (int x, int y) |
Sets the actor's fixed position in pixels relative to any parent actor. | |
void | set_positionu (Unit x, Unit y) |
Sets the actor's position in Clutter::Unit<!-- -->s relative to any parent actor. | |
guint | get_width () const |
Retrieves the width of a Clutter::Actor. | |
Unit | get_widthu () const |
Retrieves the width of a Clutter::Actor, in Clutter::Unit<!-- -->s. | |
guint | get_height () const |
Retrieves the height of a Clutter::Actor. | |
Unit | get_heightu () const |
Retrieves the height of a Clutter::Actor, in Clutter::Unit<!-- -->s. | |
void | set_width (guint width) |
Forces a width request on an actor, causing the actor's normal width and height (if any) to be ignored. | |
void | set_widthu (Unit width) |
Forces a width request on an actor, causing the actor's normal width and height (if any) to be ignored. | |
void | set_height (guint height) |
Forces a height request on an actor, causing the actor's normal width and height (if any) to be ignored. | |
void | set_heightu (Unit height) |
Forces a height request on an actor, causing the actor's normal width and height (if any) to be ignored. | |
void | set_x (int x) |
Sets the actor's X coordinate, relative to its parent, in pixels. | |
void | set_xu (Unit x) |
Sets the actor's X coordinate, relative to its parent. | |
int | get_x () const |
Retrieves the X coordinate of a Clutter::Actor. | |
Unit | get_xu () const |
Retrieves the X coordinate of a Clutter::Actor, in Clutter::Unit<!-- -->s. | |
void | set_y (int y) |
Sets the actor's Y coordinate, relative to its parent, in pixels. | |
void | set_yu (Unit y) |
Sets the actor's Y coordinate, relative to its parent. | |
int | get_y () const |
Retrieves the Y coordinate of a Clutter::Actor. | |
Unit | get_yu () const |
Retrieves the Y coordinate of a Clutter::Actor, in Clutter::Unit<!-- -->s. | |
void | set_reactive (bool reactive=true) |
Sets actor as reactive. | |
bool | get_reactive () const |
Checks whether actor is marked as reactive. | |
void | set_rotation (RotateAxis axis, double angle, int x, int y, int z) |
Sets the rotation angle of self around the given axis. | |
void | set_rotationx (RotateAxis axis, Fixed angle, int x, int y, int z) |
Sets the rotation angle of self around the given axis. | |
void | set_rotationu (RotateAxis axis, double angle, Unit x, Unit y, Unit z) |
Sets the rotation angle of self around the given axis. | |
double | get_rotation (RotateAxis axis, int &x, int &y, int &z) const |
Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_angle(). | |
Fixed | get_rotationx (RotateAxis axis, int &x, int &y, int &z) const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation(). | |
double | get_rotationu (RotateAxis axis, Unit &x, Unit &y, Unit &z) const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation(). | |
void | set_opacity (guint8 opacity) |
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque. | |
guint8 | get_opacity () const |
Retrieves the opacity value of an actor, as set by set_opacity(). | |
void | set_name (const gchar *name) |
Sets the given name to self. | |
Glib::ustring | get_name () const |
Retrieves the name of self. | |
guint32 | get_gid () const |
Retrieves the unique id for self. | |
void | set_clip (int xoff, int yoff, int width, int height) |
Sets clip area in pixels for self. | |
void | get_clip (int &xoff, int &yoff, int &width, int &height) |
Gets the clip area for self, in pixels. | |
void | set_clipu (Unit xoff, Unit yoff, Unit width, Unit height) |
Unit-based variant of set_clip(). | |
void | get_clipu (Unit &xoff, Unit &yoff, Unit &width, Unit &height) |
Unit-based variant of get_clip(). | |
void | remove_clip () |
Removes clip area from self. | |
bool | has_clip () const |
Determines whether the actor has a clip area set or not. | |
void | set_parent (const Glib::RefPtr< Actor > &parent) |
Sets the parent of self to parent. | |
Glib::RefPtr< Actor > | get_parent () |
Retrieves the parent of self. | |
Glib::RefPtr< const Actor > | get_parent () const |
Retrieves the parent of self. | |
void | reparent (const Glib::RefPtr< Actor > &new_parent) |
This function resets the parent actor of self. | |
void | unparent () |
This function should not be used in applications. | |
void | raise (const Glib::RefPtr< Actor > &below) |
Puts self above below. | |
void | lower (const Glib::RefPtr< Actor > &above) |
Puts self below above. | |
void | raise_top () |
Raises self to the top. | |
void | lower_bottom () |
Lowers self to the bottom. | |
Glib::RefPtr< Shader > | get_shader () |
Queries the currently set Clutter::Shader on self. | |
Glib::RefPtr< const Shader > | get_shader () const |
Queries the currently set Clutter::Shader on self. | |
void | set_shader (const Glib::RefPtr< Shader > &shader) |
Sets the Clutter::Shader to be used when rendering self. | |
void | set_shader_param (const Glib::ustring ¶m, float value) |
Sets the value for a named parameter of the shader applied to actor. | |
bool | is_rotated () const |
Checks whether any rotation is applied to the actor. | |
bool | is_scaled () const |
Checks whether the actor is scaled in either dimension. | |
void | get_allocation_vertices (Vertex vertices[4]) const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. | |
void | get_allocation_vertices (const Glib::RefPtr< Actor > &ancestor, Vertex vertices[4]) const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. | |
void | get_abs_allocation_vertices (Vertex vertices[4]) const |
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the Clutter::ActorBox coordinates as follows: <itemizedlist> <listitem>v[0] contains (x1, y1)</listitem> <listitem>v[1] contains (x2, y1)</listitem> <listitem>v[2] contains (x1, y2)</listitem> <listitem>v[3] contains (x2, y2)</listitem> </itemizedlist>. | |
ActorBox | get_allocation_box () const |
Gets the layout box an actor has been assigned. | |
void | allocate (const ActorBox &box, bool absolute_origin_changed) |
Called by the parent of an actor to assign the actor its size. | |
void | apply_relative_transform_to_point (const Glib::RefPtr< Actor > &ancestor, const Vertex &point, Vertex &vertex) const |
Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc). | |
void | apply_relative_transform_to_point (const Vertex &point, Vertex &vertex) const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. | |
void | get_preferred_size (Unit &min_width_p, Unit &min_height_p, Unit &natural_width_p, Unit &natural_height_p) const |
Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height). | |
void | get_preferred_width (Unit for_height, Unit &min_width_p, Unit &natural_width_p) const |
Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values. | |
void | get_preferred_height (Unit for_width, Unit &min_height_p, Unit &natural_height_p) const |
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values. | |
guint8 | get_paint_opacity () const |
Retrieves the absolute opacity of the actor, as it appears on the stage. | |
void | move_anchor_point_from_gravity (Gravity gravity) |
Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged. | |
void | move_anchor_point (int anchor_x, int anchor_y) |
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same. | |
void | move_anchor_pointu (Unit anchor_x, Unit anchor_y) |
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same. | |
bool | get_fixed_position_set () const |
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager). | |
void | set_fixed_position_set (bool is_set) |
Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager). | |
void | get_transformed_position (int &x, int &y) const |
Gets the absolute position of an actor, in pixels, relative to the stage. | |
void | get_transformed_positionu (Unit &x, Unit &y) const |
Gets the absolute position of an actor, in Clutter::Unit<!-- -->s, relative to the stage. | |
void | get_transformed_size (guint &width, guint &height) const |
Gets the absolute size of an actor taking into account any scaling factors. | |
void | get_transformed_sizeu (Unit &width, Unit &height) const |
Gets the absolute size of an actor in Clutter::Units<!-- -->s, taking into account the scaling factors. | |
void | get_allocation_coords (int &x1, int &y1, int &x2, int &y2) const |
Gets the layout box an actor has been assigned. | |
Geometry | get_allocation_geometry () const |
Gets the layout box an actor has been assigned. | |
void | set_depth (int depth) |
Sets the Z co-ordinate of self to depth. | |
void | set_depthu (Unit depth) |
Sets the Z co-ordinate of self to depth in Clutter::Unit<!-- -->s, the units of which are dependant on the perspective setup. | |
int | get_depth () const |
Retrieves the depth of self. | |
Unit | get_depthu () const |
Retrieves the depth of self. | |
void | set_scalex (Fixed scale_x, Fixed scale_y) |
Fixed point version of set_scale(). | |
void | set_scale (double scale_x, double scale_y) |
Scales an actor with the given factors. | |
void | get_scalex (Fixed &scale_x, Fixed &scale_y) const |
Fixed point version of get_scale(). | |
void | get_scale (double &scale_x, double &scale_y) const |
Retrieves an actors scale in floating point. | |
void | get_size (guint &width, guint &height) const |
This function tries to "do what you mean" and return the size an actor will have. | |
void | get_sizeu (Unit &width, Unit &height) const |
This function tries to "do what you mean" and return the size an actor will have. | |
void | move_by (int dx, int dy) |
Moves an actor by the specified distance relative to its current position in pixels. | |
void | move_byu (Unit dx, Unit dy) |
Moves an actor by the specified distance relative to its current position. | |
void | apply_transform_to_point (const Vertex &point, Vertex &vertex) const |
Transforms point in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e. scale, rotation, etc). | |
void | transform_stage_point (Unit x, Unit y, Unit &x_out, Unit &y_out) const |
This function translates screen coordinates ( x, y) to coordinates relative to the actor. | |
bool | event (ClutterEvent *event, bool capture) |
This function is used to emit an event on the main stage. | |
void | set_anchor_point (int anchor_x, int anchor_y) |
Sets an anchor point for the actor. | |
void | get_anchor_point (int &anchor_x, int &anchor_y) const |
Gets the current anchor point of the actor in pixels. | |
void | set_anchor_pointu (Unit anchor_x, Unit anchor_y) |
Sets an anchor point for self. | |
void | get_anchor_pointu (Unit &anchor_x, Unit &anchor_y) |
Gets the current anchor point of the actor in Clutter::Unit<!-- -->s. | |
void | set_anchor_point_from_gravity (ClutterGravity gravity) |
Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping set_anchor_point()). | |
Glib::SignalProxy1< bool, ButtonEvent * > | signal_button_press_event () |
| |
Glib::SignalProxy1< bool, ButtonEvent * > | signal_button_release_event () |
| |
Glib::SignalProxy1< bool, MotionEvent * > | signal_motion_event () |
| |
Glib::SignalProxy1< bool, CrossingEvent * > | signal_leave_event () |
| |
Glib::SignalProxy0< void > | signal_show () |
| |
Glib::SignalProxy0< void > | signal_hide () |
| |
Glib::SignalProxy0< void > | signal_destroy () |
| |
Glib::SignalProxy1< bool, KeyEvent * > | signal_key_release_event () |
| |
Glib::SignalProxy1< bool, CrossingEvent * > | signal_enter_event () |
| |
Glib::SignalProxy1< bool, Event * > | signal_event () |
| |
Glib::SignalProxy0< void > | signal_focus_out () |
| |
Glib::SignalProxy0< void > | signal_focus_in () |
| |
Glib::SignalProxy1< void, const Glib::RefPtr< Actor > & > | signal_parent_set () |
| |
Glib::SignalProxy1< bool, ScrollEvent * > | signal_scroll_event () |
| |
Glib::SignalProxy1< bool, KeyEvent * > | signal_key_press_event () |
| |
Glib::SignalProxy1< bool, Event * > | signal_captured_event () |
| |
Glib::SignalProxy0< void > | signal_paint () |
| |
Glib::SignalProxy0< void > | signal_realize () |
| |
Glib::SignalProxy0< void > | signal_unrealize () |
| |
Glib::PropertyProxy_ReadOnly < ActorBox > | property_allocation () const |
The actor's allocation. | |
Glib::PropertyProxy< int > | property_anchor_x () |
X coordinate of the anchor point. | |
Glib::PropertyProxy_ReadOnly< int > | property_anchor_x () const |
X coordinate of the anchor point. | |
Glib::PropertyProxy< int > | property_anchor_y () |
Y coordinate of the anchor point. | |
Glib::PropertyProxy_ReadOnly< int > | property_anchor_y () const |
Y coordinate of the anchor point. | |
Glib::PropertyProxy< Geometry > | property_clip () |
The clip region for the actor. | |
Glib::PropertyProxy_ReadOnly < Geometry > | property_clip () const |
The clip region for the actor. | |
Glib::PropertyProxy< int > | property_depth () |
Depth of actor. | |
Glib::PropertyProxy_ReadOnly< int > | property_depth () const |
Depth of actor. | |
Glib::PropertyProxy< bool > | property_fixed_position_set () |
Whether to use fixed positioning for the actor. | |
Glib::PropertyProxy_ReadOnly < bool > | property_fixed_position_set () const |
Whether to use fixed positioning for the actor. | |
Glib::PropertyProxy< Unit > | property_fixed_x () |
Forced X position of the actor. | |
Glib::PropertyProxy_ReadOnly < Unit > | property_fixed_x () const |
Forced X position of the actor. | |
Glib::PropertyProxy< Unit > | property_fixed_y () |
Forced Y position of the actor. | |
Glib::PropertyProxy_ReadOnly < Unit > | property_fixed_y () const |
Forced Y position of the actor. | |
Glib::PropertyProxy_ReadOnly < bool > | property_has_clip () const |
Whether the actor has a clip set or not. | |
Glib::PropertyProxy< int > | property_height () |
Height of the actor. | |
Glib::PropertyProxy_ReadOnly< int > | property_height () const |
Height of the actor. | |
Glib::PropertyProxy< Unit > | property_min_height () |
Forced minimum height request for the actor. | |
Glib::PropertyProxy_ReadOnly < Unit > | property_min_height () const |
Forced minimum height request for the actor. | |
Glib::PropertyProxy< bool > | property_min_height_set () |
Whether to use the min-height property. | |
Glib::PropertyProxy_ReadOnly < bool > | property_min_height_set () const |
Whether to use the min-height property. | |
Glib::PropertyProxy< Unit > | property_min_width () |
Forced minimum width request for the actor. | |
Glib::PropertyProxy_ReadOnly < Unit > | property_min_width () const |
Forced minimum width request for the actor. | |
Glib::PropertyProxy< bool > | property_min_width_set () |
Whether to use the min-width property. | |
Glib::PropertyProxy_ReadOnly < bool > | property_min_width_set () const |
Whether to use the min-width property. | |
Glib::PropertyProxy< guint8 > | property_opacity () |
Opacity of actor. | |
Glib::PropertyProxy_ReadOnly < guint8 > | property_opacity () const |
Opacity of actor. | |
Glib::PropertyProxy< bool > | property_reactive () |
Whether the actor is reactive to events or not. | |
Glib::PropertyProxy_ReadOnly < bool > | property_reactive () const |
Whether the actor is reactive to events or not. | |
Glib::PropertyProxy< RequestMode > | property_request_mode () |
The actor's request mode. | |
Glib::PropertyProxy_ReadOnly < RequestMode > | property_request_mode () const |
The actor's request mode. | |
Glib::PropertyProxy< double > | property_rotation_angle_x () |
The rotation angle on the X axis. | |
Glib::PropertyProxy_ReadOnly < double > | property_rotation_angle_x () const |
The rotation angle on the X axis. | |
Glib::PropertyProxy< double > | property_rotation_angle_y () |
The rotation angle on the Y axis. | |
Glib::PropertyProxy_ReadOnly < double > | property_rotation_angle_y () const |
The rotation angle on the Y axis. | |
Glib::PropertyProxy< double > | property_rotation_angle_z () |
The rotation angle on the Z axis. | |
Glib::PropertyProxy_ReadOnly < double > | property_rotation_angle_z () const |
The rotation angle on the Z axis. | |
Glib::PropertyProxy< Vertex > | property_rotation_center_x () |
The rotation center on the X axis. | |
Glib::PropertyProxy_ReadOnly < Vertex > | property_rotation_center_x () const |
The rotation center on the X axis. | |
Glib::PropertyProxy< Vertex > | property_rotation_center_y () |
The rotation center on the Y axis. | |
Glib::PropertyProxy_ReadOnly < Vertex > | property_rotation_center_y () const |
The rotation center on the Y axis. | |
Glib::PropertyProxy< Vertex > | property_rotation_center_z () |
The rotation center on the Z axis. | |
Glib::PropertyProxy_ReadOnly < Vertex > | property_rotation_center_z () const |
The rotation center on the Z axis. | |
Glib::PropertyProxy< double > | property_scale_x () |
Scale factor on the X axis. | |
Glib::PropertyProxy_ReadOnly < double > | property_scale_x () const |
Scale factor on the X axis. | |
Glib::PropertyProxy< double > | property_scale_y () |
Scale factor on the Y axis. | |
Glib::PropertyProxy_ReadOnly < double > | property_scale_y () const |
Scale factor on the Y axis. | |
Glib::PropertyProxy< bool > | property_show_on_set_parent () |
Whether the actor is shown when parented. | |
Glib::PropertyProxy_ReadOnly < bool > | property_show_on_set_parent () const |
Whether the actor is shown when parented. | |
Glib::PropertyProxy< bool > | property_visible () |
Whether the actor is visible or not. | |
Glib::PropertyProxy_ReadOnly < bool > | property_visible () const |
Whether the actor is visible or not. | |
Glib::PropertyProxy< int > | property_width () |
Width of the actor. | |
Glib::PropertyProxy_ReadOnly< int > | property_width () const |
Width of the actor. | |
Glib::PropertyProxy< int > | property_x () |
X coordinate of the actor. | |
Glib::PropertyProxy_ReadOnly< int > | property_x () const |
X coordinate of the actor. | |
Glib::PropertyProxy< int > | property_y () |
Y coordinate of the actor. | |
Glib::PropertyProxy_ReadOnly< int > | property_y () const |
Y coordinate of the actor. | |
Static Public Member Functions | |
static Glib::RefPtr< Actor > | get_actor_by_gid (guint32 id) |
Retrieves the Clutter::Actor with id. | |
Protected Member Functions | |
Actor () | |
void | pick (const Color &color) |
Renders a silhouette of the actor using the supplied color. | |
bool | should_pick_paint () const |
Utility call for subclasses overiding the pick method. | |
virtual void | show_all_vfunc () |
virtual void | hide_all_vfunc () |
virtual void | pick_vfunc (const Color &color) |
virtual void | get_preferred_width_vfunc (Unit for_height, Unit &min_width_p, Unit &natural_width_p) const |
virtual void | get_preferred_height_vfunc (Unit for_width, Unit &min_height_p, Unit &natural_height_p) const |
virtual void | allocate_vfunc (const ActorBox &box, bool absolute_origin_changed) |
virtual bool | on_button_press_event (ButtonEvent *event) |
virtual bool | on_button_release_event (ButtonEvent *event) |
virtual bool | on_motion_event (MotionEvent *event) |
virtual bool | on_leave_event (CrossingEvent *event) |
virtual void | on_show () |
virtual void | on_hide () |
virtual void | on_destroy () |
virtual bool | on_key_release_event (KeyEvent *event) |
virtual bool | on_enter_event (CrossingEvent *event) |
virtual bool | on_event (Event *event) |
virtual void | on_focus_out () |
virtual void | on_focus_in () |
virtual void | on_parent_set (const Glib::RefPtr< Actor > &old_parent) |
virtual bool | on_scroll_event (ScrollEvent *event) |
virtual bool | on_key_press_event (KeyEvent *event) |
virtual bool | on_captured_event (Event *event) |
virtual void | on_paint () |
virtual void | on_realize () |
virtual void | on_unrealize () |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Clutter::Actor > | wrap (ClutterActor *object, bool take_copy=false) |
A Glib::wrap() method for this object. |
virtual Clutter::Actor::~Actor | ( | ) | [virtual] |
Clutter::Actor::Actor | ( | ) | [protected] |
ClutterActor* Clutter::Actor::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
Reimplemented from Clutter::Scriptable.
Reimplemented in Clutter::CloneTexture, Clutter::Entry, Clutter::Group, Clutter::Label, Clutter::Rectangle, Clutter::Stage, and Clutter::Texture.
const ClutterActor* Clutter::Actor::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
Reimplemented from Clutter::Scriptable.
Reimplemented in Clutter::CloneTexture, Clutter::Entry, Clutter::Group, Clutter::Label, Clutter::Rectangle, Clutter::Stage, and Clutter::Texture.
ClutterActor* Clutter::Actor::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Reimplemented in Clutter::CloneTexture, Clutter::Entry, Clutter::Group, Clutter::Label, Clutter::Rectangle, Clutter::Stage, and Clutter::Texture.
void Clutter::Actor::show | ( | ) |
Flags an actor to be displayed.
An actor that isn't shown will not be rendered on the stage.
Actors are visible by default.
If this function is called on an actor without a parent, the Clutter::Actor:show-on-set-parent will be set to true
as a side effect.
void Clutter::Actor::show_all | ( | ) |
Calls show() on all children of an actor (if any).
Since: 0.2
void Clutter::Actor::hide | ( | ) |
Flags an actor to be hidden.
A hidden actor will not be rendered on the stage.
Actors are visible by default.
If this function is called on an actor without a parent, the Clutter::Actor:show-on-set-parent property will be set to false
as a side-effect.
void Clutter::Actor::hide_all | ( | ) |
Calls hide() on all child actors (if any).
Since: 0.2
void Clutter::Actor::realize | ( | ) |
Creates any underlying graphics resources needed by the actor to be displayed.
void Clutter::Actor::unrealize | ( | ) |
Frees up any underlying graphics resources needed by the actor to be displayed.
void Clutter::Actor::paint | ( | ) |
Renders the actor to display.
This function should not be called directly by applications. Call queue_redraw() to queue paints, instead.
void Clutter::Actor::queue_redraw | ( | ) |
Queues up a redraw of an actor and any children.
The redraw occurs once the main loop becomes idle (after the current batch of events has been processed, roughly).
Applications rarely need to call this, as redraws are handled automatically by modification functions.
void Clutter::Actor::queue_relayout | ( | ) |
Indicates that the actor's size request or other layout-affecting properties may have changed.
This function is used inside Clutter::Actor subclass implementations, not by applications directly.
Queueing a new layout automatically queues a redraw as well.
Since: 0.8
Glib::RefPtr<Actor> Clutter::Actor::get_stage | ( | ) |
Retrieves the Clutter::Stage where actor is contained.
0
Glib::RefPtr<const Actor> Clutter::Actor::get_stage | ( | ) | const |
Retrieves the Clutter::Stage where actor is contained.
0
void Clutter::Actor::set_geometry | ( | const Geometry & | geometry | ) |
Sets the actor's fixed position and forces its minimum and natural size, in pixels.
This means the untransformed actor will have the given geometry. This is the same as calling set_position() and set_size().
geometry | A Clutter::Geometry. |
Geometry Clutter::Actor::get_geometry | ( | ) | const |
Gets the size and position of an actor relative to its parent actor.
This is the same as calling get_position() and get_size(). It tries to "do what you mean" and get the requested size and position if the actor's allocation is invalid.
geometry | A location to store actors Clutter::Geometry. |
void Clutter::Actor::set_size | ( | int | width, | |
int | height | |||
) |
Sets the actor's size request in pixels.
This overrides any "normal" size request the actor would have. For example a text actor might normally request the size of the text; this function would force a specific size instead.
If width and/or height are -1 the actor will use its "normal" size request instead of overriding it, i.e. you can "unset" the size with -1.
This function sets or unsets both the minimum and natural size.
width | New width of actor in pixels, or -1. | |
height | New height of actor in pixels, or -1. |
Overrides the actor's size request in Clutter::Unit<!-- -->s.
If width and/or height are -1 the actor will use its normal size request (the override is removed).
This function sets or unsets both the minimum and natural size.
Since: 0.6
width | New width of actor in Clutter::Unit<!-- -->s, or -1. | |
height | New height of actor in Clutter::Unit<!-- -->s, or -1. |
void Clutter::Actor::get_position | ( | int & | x, | |
int & | y | |||
) |
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations.
Retrieves the fixed position of an actor in pixels, if one has been set; otherwise, if the allocation is valid, returns the actor's allocated position; otherwise, returns 0,0.
The returned position is in pixels.
Since: 0.6
x | Return location for the X coordinate, or 0 . | |
y | Return location for the Y coordinate, or 0 . |
This function tries to "do what you mean" and tell you where the actor is, prior to any transformations.
Retrieves the fixed position of an actor in pixels, if one has been set; otherwise, if the allocation is valid, returns the actor's allocated position; otherwise, returns 0,0.
The returned position is in Clutter::Unit<!-- -->s.
Since: 0.6
x | Return location for the X coordinate, or 0 . | |
y | Return location for the Y coordinate, or 0 . |
void Clutter::Actor::set_position | ( | int | x, | |
int | y | |||
) |
Sets the actor's fixed position in pixels relative to any parent actor.
If a layout manager is in use, this position will override the layout manager and force a fixed position.
x | New left position of actor in pixels. | |
y | New top position of actor in pixels. |
Sets the actor's position in Clutter::Unit<!-- -->s relative to any parent actor.
If a layout manager is in use, this position will override the layout manager and force a fixed position.
Since: 0.6
x | New left position of actor in Clutter::Unit<!-- -->s. | |
y | New top position of actor in Clutter::Unit<!-- -->s. |
guint Clutter::Actor::get_width | ( | ) | const |
Retrieves the width of a Clutter::Actor.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the width of the allocation box.
If the actor does not have a valid allocation, this function will return the actor's natural width request.
If you care whether you get the width request or the allocation, you should probably call a different function like get_allocation_coords() to retrieve the allocation or get_preferred_width() to retrieve the preferred width.
Unit Clutter::Actor::get_widthu | ( | ) | const |
Retrieves the width of a Clutter::Actor, in Clutter::Unit<!-- -->s.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the width of the allocation box.
If the actor does not have a valid allocation, this function will return the actor's natural width request.
If you care whether you get the width request or the allocation, you should probably call a different function like get_allocation_coords() to retrieve the allocation or get_preferred_width() to retrieve the preferred width.
guint Clutter::Actor::get_height | ( | ) | const |
Retrieves the height of a Clutter::Actor.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the height of the allocation box.
If the actor does not have a valid allocation, this function will return the actor's natural height request.
If you care whether you get the height request or the allocation, you should probably call a different function like get_allocation_coords() to retrieve the allocation or get_preferred_height() to retrieve the preferred height.
Unit Clutter::Actor::get_heightu | ( | ) | const |
Retrieves the height of a Clutter::Actor, in Clutter::Unit<!-- -->s.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the height of the allocation box.
If the actor does not have a valid allocation, this function will return the actor's natural height request.
If you care whether you get the height request or the allocation, you should probably call a different function like get_allocation_coords() to retrieve the allocation or get_preferred_height() to retrieve the preferred height.
void Clutter::Actor::set_width | ( | guint | width | ) |
Forces a width request on an actor, causing the actor's normal width and height (if any) to be ignored.
This function sets both the minimum and natural size request of the actor.
since: 0.2
width | Requested new width for the actor, in pixels. |
void Clutter::Actor::set_widthu | ( | Unit | width | ) |
Forces a width request on an actor, causing the actor's normal width and height (if any) to be ignored.
This function sets both the minimum and natural size request of the actor.
since: 0.6
width | Requested new width for the actor, in Clutter::Unit<!-- -->s. |
void Clutter::Actor::set_height | ( | guint | height | ) |
Forces a height request on an actor, causing the actor's normal width and height (if any) to be ignored.
This function sets both the minimum and natural size request of the actor.
since: 0.2
height | Requested new height for the actor, in pixels. |
void Clutter::Actor::set_heightu | ( | Unit | height | ) |
Forces a height request on an actor, causing the actor's normal width and height (if any) to be ignored.
This function sets both the minimum and natural size request of the actor.
since: 0.6
height | Requested new height for the actor, in Clutter::Unit<!-- -->s. |
void Clutter::Actor::set_x | ( | int | x | ) |
Sets the actor's X coordinate, relative to its parent, in pixels.
Overrides any layout manager and forces a fixed position for the actor.
Since: 0.6
x | The actor's position on the X axis. |
void Clutter::Actor::set_xu | ( | Unit | x | ) |
Sets the actor's X coordinate, relative to its parent.
Overrides any layout manager and forces a fixed position for the actor.
Since: 0.6
x | The actor's position on the X axis, in Clutter::Unit<!-- -->s. |
int Clutter::Actor::get_x | ( | ) | const |
Retrieves the X coordinate of a Clutter::Actor.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the X coordinate of the origin of the allocation box.
If the actor has any fixed coordinate set using set_x(), set_position() or set_geometry(), this function will return that coordinate.
If both the allocation and a fixed position are missing, this function will return 0.
Unit Clutter::Actor::get_xu | ( | ) | const |
Retrieves the X coordinate of a Clutter::Actor, in Clutter::Unit<!-- -->s.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the X coordinate of the origin of the allocation box.
If the actor has any fixed coordinate set using set_x(), set_position() or set_geometry(), this function will return that coordinate.
If both the allocation and a fixed position are missing, this function will return 0.
void Clutter::Actor::set_y | ( | int | y | ) |
Sets the actor's Y coordinate, relative to its parent, in pixels.
Overrides any layout manager and forces a fixed position for the actor.
Since: 0.6
y | The actor's position on the Y axis. |
void Clutter::Actor::set_yu | ( | Unit | y | ) |
Sets the actor's Y coordinate, relative to its parent.
Overrides any layout manager and forces a fixed position for the actor.
Since: 0.6
y | The actor's position on the Y axis, in Clutter::Unit<!-- -->s. |
int Clutter::Actor::get_y | ( | ) | const |
Retrieves the Y coordinate of a Clutter::Actor.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the Y coordinate of the origin of the allocation box.
If the actor has any fixed coordinate set using set_y(), set_position() or set_geometry(), this function will return that coordinate.
If both the allocation and a fixed position are missing, this function will return 0.
Unit Clutter::Actor::get_yu | ( | ) | const |
Retrieves the Y coordinate of a Clutter::Actor, in Clutter::Unit<!-- -->s.
This function tries to "do what you mean", by returning the correct value depending on the actor's state.
If the actor has a valid allocation, this function will return the Y coordinate of the origin of the allocation box.
If the actor has any fixed coordinate set using set_y(), set_position() or set_geometry(), this function will return that coordinate.
If both the allocation and a fixed position are missing, this function will return 0.
void Clutter::Actor::set_reactive | ( | bool | reactive = true |
) |
Sets actor as reactive.
Reactive actors will receive events.
Since: 0.6
reactive | Whether the actor should be reactive to events. |
bool Clutter::Actor::get_reactive | ( | ) | const |
Checks whether actor is marked as reactive.
true
if the actor is reactivevoid Clutter::Actor::set_rotation | ( | RotateAxis | axis, | |
double | angle, | |||
int | x, | |||
int | y, | |||
int | z | |||
) |
Sets the rotation angle of self around the given axis.
The rotation center coordinates used depend on the value of axis: <itemizedlist> <listitem>Clutter::X_AXIS requires y and z</listitem> <listitem>Clutter::Y_AXIS requires x and z</listitem> <listitem>Clutter::Z_AXIS requires x and y</listitem> </itemizedlist>
The rotation coordinates are relative to the anchor point of the actor, set using set_anchor_point(). If no anchor point is set, the upper left corner is assumed as the origin.
Since: 0.6
axis | The axis of rotation. | |
angle | The angle of rotation. | |
x | X coordinate of the rotation center. | |
y | Y coordinate of the rotation center. | |
z | Z coordinate of the rotation center. |
void Clutter::Actor::set_rotationx | ( | RotateAxis | axis, | |
Fixed | angle, | |||
int | x, | |||
int | y, | |||
int | z | |||
) |
Sets the rotation angle of self around the given axis.
This function is the fixed point variant of set_rotation().
Since: 0.6
axis | The axis of rotation. | |
angle | The angle of rotation. | |
x | X coordinate of the rotation center. | |
y | Y coordinate of the rotation center. | |
z | Z coordinate of the rotation center. |
void Clutter::Actor::set_rotationu | ( | RotateAxis | axis, | |
double | angle, | |||
Unit | x, | |||
Unit | y, | |||
Unit | z | |||
) |
Sets the rotation angle of self around the given axis.
This function is the units based variant of set_rotation().
Since: 0.8
axis | The axis of rotation. | |
angle | The angle of rotation. | |
x | X coordinate of the rotation center, in Clutter::Unit<!-- -->s. | |
y | Y coordinate of the rotation center, in Clutter::Unit<!-- -->s. | |
z | Z coordinate of the rotation center, in Clutter::Unit<!-- -->s. |
double Clutter::Actor::get_rotation | ( | RotateAxis | axis, | |
int & | x, | |||
int & | y, | |||
int & | z | |||
) | const |
Retrieves the angle and center of rotation on the given axis, set using clutter_actor_set_angle().
The coordinates of the center returned by this function depend on the axis passed.
axis | The axis of rotation. | |
x | Return value for the X coordinate of the center of rotation. | |
y | Return value for the Y coordinate of the center of rotation. | |
z | Return value for the Z coordinate of the center of rotation. |
Fixed Clutter::Actor::get_rotationx | ( | RotateAxis | axis, | |
int & | x, | |||
int & | y, | |||
int & | z | |||
) | const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation().
This function is the fixed point variant of get_rotation().
axis | The axis of rotation. | |
x | Return value for the X coordinate of the center of rotation. | |
y | Return value for the Y coordinate of the center of rotation. | |
z | Return value for the Z coordinate of the center of rotation. |
double Clutter::Actor::get_rotationu | ( | RotateAxis | axis, | |
Unit & | x, | |||
Unit & | y, | |||
Unit & | z | |||
) | const |
Retrieves the angle and center of rotation on the given axis, set using set_rotation().
This function is the units based variant of get_rotation().
axis | The axis of rotation. | |
x | Return value for the X coordinate of the center of rotation, in Clutter::Unit<!-- -->s. | |
y | Return value for the Y coordinate of the center of rotation, in Clutter::Unit<!-- -->s. | |
z | Return value for the Z coordinate of the center of rotation, in Clutter::Unit<!-- -->s. |
void Clutter::Actor::set_opacity | ( | guint8 | opacity | ) |
Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque.
opacity | New opacity value for the actor. |
guint8 Clutter::Actor::get_opacity | ( | ) | const |
Retrieves the opacity value of an actor, as set by set_opacity().
For retrieving the absolute opacity of the actor inside a paint virtual function, see get_paint_opacity().
void Clutter::Actor::set_name | ( | const gchar * | name | ) |
Sets the given name to self.
The name can be used to identify a Clutter::Actor.
name | Textual tag to apply to actor. |
Glib::ustring Clutter::Actor::get_name | ( | ) | const |
Retrieves the name of self.
0
. The returned string is owned by the actor and should not be modified or freed. guint32 Clutter::Actor::get_gid | ( | ) | const |
Retrieves the unique id for self.
void Clutter::Actor::set_clip | ( | int | xoff, | |
int | yoff, | |||
int | width, | |||
int | height | |||
) |
Sets clip area in pixels for self.
The clip area is always computed from the upper left corner of the actor, even if the anchor point is set otherwise.
xoff | X offset of the clip rectangle, in pixels. | |
yoff | Y offset of the clip rectangle, in pixels. | |
width | Width of the clip rectangle, in pixels. | |
height | Height of the clip rectangle, in pixels. |
void Clutter::Actor::get_clip | ( | int & | xoff, | |
int & | yoff, | |||
int & | width, | |||
int & | height | |||
) |
Gets the clip area for self, in pixels.
Since: 0.6
xoff | Return location for the X offset of the clip rectangle, or 0 . | |
yoff | Return location for the Y offset of the clip rectangle, or 0 . | |
width | Return location for the width of the clip rectangle, or 0 . | |
height | Return location for the height of the clip rectangle, or 0 . |
Unit-based variant of set_clip().
Sets clip area for self. The clip area is always computed from the upper left corner of the actor, even if the anchor point is set otherwise.
Since: 0.6
xoff | X offset of the clip rectangle, in Clutter::Unit<!-- -->s. | |
yoff | Y offset of the clip rectangle, in Clutter::Unit<!-- -->s. | |
width | Width of the clip rectangle, in Clutter::Unit<!-- -->s. | |
height | Height of the clip rectangle, in Clutter::Unit<!-- -->s. |
Unit-based variant of get_clip().
Gets the clip area for self, in Clutter::Unit<!-- -->s.
Since: 0.6
xoff | Return location for the X offset of the clip rectangle, or 0 . | |
yoff | Return location for the Y offset of the clip rectangle, or 0 . | |
width | Return location for the width of the clip rectangle, or 0 . | |
height | Return location for the height of the clip rectangle, or 0 . |
void Clutter::Actor::remove_clip | ( | ) |
Removes clip area from self.
bool Clutter::Actor::has_clip | ( | ) | const |
Determines whether the actor has a clip area set or not.
true
if the actor has a clip area set.void Clutter::Actor::set_parent | ( | const Glib::RefPtr< Actor > & | parent | ) |
Sets the parent of self to parent.
The opposite function is unparent().
This function should not be used by applications, but by custom 'composite' actor subclasses.
parent | A new Clutter::Actor parent. |
Glib::RefPtr<Actor> Clutter::Actor::get_parent | ( | ) |
Glib::RefPtr<const Actor> Clutter::Actor::get_parent | ( | ) | const |
void Clutter::Actor::reparent | ( | const Glib::RefPtr< Actor > & | new_parent | ) |
This function resets the parent actor of self.
It is logically equivalent to calling unparent() and set_parent().
Since: 0.2
new_parent | The new Clutter::Actor parent. |
void Clutter::Actor::unparent | ( | ) |
This function should not be used in applications.
It should be called by implementations of container actors, to dissociate a child from the container.
Since: 0.1.1
void Clutter::Actor::raise | ( | const Glib::RefPtr< Actor > & | below | ) |
Puts self above below.
Both actors must have the same parent.
below | A Clutter::Actor to raise above. |
void Clutter::Actor::lower | ( | const Glib::RefPtr< Actor > & | above | ) |
Puts self below above.
Both actors must have the same parent.
above | A Clutter::Actor to lower below. |
void Clutter::Actor::raise_top | ( | ) |
Raises self to the top.
void Clutter::Actor::lower_bottom | ( | ) |
Lowers self to the bottom.
Glib::RefPtr<Shader> Clutter::Actor::get_shader | ( | ) |
Queries the currently set Clutter::Shader on self.
0
if no shader is set.Glib::RefPtr<const Shader> Clutter::Actor::get_shader | ( | ) | const |
Queries the currently set Clutter::Shader on self.
0
if no shader is set.void Clutter::Actor::set_shader | ( | const Glib::RefPtr< Shader > & | shader | ) |
Sets the Clutter::Shader to be used when rendering self.
If shader is 0
it will unset any currently set shader for the actor.
shader | A Clutter::Shader or 0 to unset the shader. |
true
if the shader was successfully appliedvoid Clutter::Actor::set_shader_param | ( | const Glib::ustring & | param, | |
float | value | |||
) |
Sets the value for a named parameter of the shader applied to actor.
Since: 0.6
param | The name of the parameter. | |
value | The value of the parameter. |
bool Clutter::Actor::is_rotated | ( | ) | const |
Checks whether any rotation is applied to the actor.
true
if the actor is rotated.bool Clutter::Actor::is_scaled | ( | ) | const |
Checks whether the actor is scaled in either dimension.
true
if the actor is scaled.void Clutter::Actor::get_allocation_vertices | ( | Vertex | vertices[4] | ) | const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor.
The returned vertices relate to the Clutter::ActorBox coordinates as follows: <itemizedlist> <listitem>v[0] contains (x1, y1)</listitem> <listitem>v[1] contains (x2, y1)</listitem> <listitem>v[2] contains (x1, y2)</listitem> <listitem>v[3] contains (x2, y2)</listitem> </itemizedlist>
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of get_abs_allocation_vertices().
Since: 0.6
ancestor | A Clutter::Actor to calculate the vertices against, or 0 to use the default Clutter::Stage. | |
verts | Return location for an array of 4 Clutter::Vertex in which to store the result. |
void Clutter::Actor::get_allocation_vertices | ( | const Glib::RefPtr< Actor > & | ancestor, | |
Vertex | vertices[4] | |||
) | const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor.
The returned vertices relate to the Clutter::ActorBox coordinates as follows: <itemizedlist> <listitem>v[0] contains (x1, y1)</listitem> <listitem>v[1] contains (x2, y1)</listitem> <listitem>v[2] contains (x1, y2)</listitem> <listitem>v[3] contains (x2, y2)</listitem> </itemizedlist>
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of get_abs_allocation_vertices().
Since: 0.6
ancestor | A Clutter::Actor to calculate the vertices against, or 0 to use the default Clutter::Stage. | |
verts | Return location for an array of 4 Clutter::Vertex in which to store the result. |
void Clutter::Actor::get_abs_allocation_vertices | ( | Vertex | vertices[4] | ) | const |
Calculates the transformed screen coordinates of the four corners of the actor; the returned vertices relate to the Clutter::ActorBox coordinates as follows: <itemizedlist> <listitem>v[0] contains (x1, y1)</listitem> <listitem>v[1] contains (x2, y1)</listitem> <listitem>v[2] contains (x1, y2)</listitem> <listitem>v[3] contains (x2, y2)</listitem> </itemizedlist>.
Since: 0.4
verts | Pointer to a location of an array of 4 Clutter::Vertex where to store the result. |
ActorBox Clutter::Actor::get_allocation_box | ( | ) | const |
Gets the layout box an actor has been assigned.
The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date.
An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
<note>Do not call any of the clutter_actor_get_allocation_*() family of functions inside the implementation of the get_preferred_width() or get_preferred_height() virtual functions.</note>
Since: 0.8
box | The function fills this in with the actor's allocation. |
void Clutter::Actor::allocate | ( | const ActorBox & | box, | |
bool | absolute_origin_changed | |||
) |
Called by the parent of an actor to assign the actor its size.
Should never be called by applications (except when implementing a container or layout manager).
Actors can know from their allocation box whether they have moved with respect to their parent actor. The absolute_origin_changed parameter additionally indicates whether the parent has moved with respect to the stage, for example because a grandparent's origin has moved.
Since: 0.8
box | New allocation of the actor, in parent-relative coordinates. | |
absolute_origin_changed | Whether the position of the parent has changed in stage coordinates. |
void Clutter::Actor::apply_relative_transform_to_point | ( | const Glib::RefPtr< Actor > & | ancestor, | |
const Vertex & | point, | |||
Vertex & | vertex | |||
) | const |
Transforms point in coordinates relative to the actor into ancestor-relative coordinates using the relevant transform stack (i.e. scale, rotation, etc).
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of apply_transform_to_point().
Since: 0.6
ancestor | A Clutter::Actor ancestor, or 0 to use the default Clutter::Stage. | |
point | A point as Clutter::Vertex. | |
vertex | The translated Clutter::Vertex. |
void Clutter::Actor::apply_relative_transform_to_point | ( | const Vertex & | point, | |
Vertex & | vertex | |||
) | const |
Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor.
The returned vertices relate to the Clutter::ActorBox coordinates as follows: <itemizedlist> <listitem>v[0] contains (x1, y1)</listitem> <listitem>v[1] contains (x2, y1)</listitem> <listitem>v[2] contains (x1, y2)</listitem> <listitem>v[3] contains (x2, y2)</listitem> </itemizedlist>
If ancestor is 0
the ancestor will be the Clutter::Stage. In this case, the coordinates returned will be the coordinates on the stage before the projection is applied. This is different from the behaviour of get_abs_allocation_vertices().
Since: 0.6
ancestor | A Clutter::Actor to calculate the vertices against, or 0 to use the default Clutter::Stage. | |
verts | Return location for an array of 4 Clutter::Vertex in which to store the result. |
void Clutter::Actor::get_preferred_size | ( | Unit & | min_width_p, | |
Unit & | min_height_p, | |||
Unit & | natural_width_p, | |||
Unit & | natural_height_p | |||
) | const |
Computes the preferred minimum and natural size of an actor, taking into account the actor's geometry management (either height-for-width or width-for-height).
The width and height used to compute the preferred height and preferred width are the actor's natural ones.
If you need to control the height for the preferred width, or the width for the preferred height, you should use get_preferred_width() and get_preferred_height(), and check the actor's preferred geometry management using the Clutter::Actor:request-mode property.
Since: 0.8
min_width_p | Return location for the minimum width, or 0 . | |
min_height_p | Return location for the minimum height, or 0 . | |
natural_width_p | Return location for the natural width, or 0 . | |
natural_height_p | Return location for the natural height, or 0 . |
void Clutter::Actor::get_preferred_width | ( | Unit | for_height, | |
Unit & | min_width_p, | |||
Unit & | natural_width_p | |||
) | const |
Computes the requested minimum and natural widths for an actor, optionally depending on the specified height, or if they are already computed, returns the cached values.
An actor may not get its request - depending on the layout manager that's in effect.
A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
Since: 0.8
for_height | Available height when computing the preferred width, or a negative value to indicate that no height is defined. | |
min_width_p | Return location for min width, or 0 . | |
natural_width_p | Return location for min width, or 0 . |
void Clutter::Actor::get_preferred_height | ( | Unit | for_width, | |
Unit & | min_height_p, | |||
Unit & | natural_height_p | |||
) | const |
Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values.
An actor may not get its request - depending on the layout manager that's in effect.
A request should not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
Since: 0.8
for_width | Available width to assume in computing desired height, or a negative value to indicate that no width is defined. | |
min_height_p | Return location for min height, or 0 . | |
natural_height_p | Return location for natural height, or 0 . |
guint8 Clutter::Actor::get_paint_opacity | ( | ) | const |
Retrieves the absolute opacity of the actor, as it appears on the stage.
This function traverses the hierarchy chain and composites the opacity of the actor with that of its parents.
This function is intended for subclasses to use in the paint virtual function, to paint themselves with the correct opacity.
void Clutter::Actor::move_anchor_point_from_gravity | ( | Gravity | gravity | ) |
Sets an anchor point on the actor based on the given gravity, adjusting the actor postion so that its relative position within its parent remains unchanged.
Since: 0.6
gravity | Clutter::Gravity. |
void Clutter::Actor::move_anchor_point | ( | int | anchor_x, | |
int | anchor_y | |||
) |
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.
Since: 0.6
anchor_x | X coordinate of the anchor point. | |
anchor_y | Y coordinate of the anchor point. |
Sets an anchor point for the actor, and adjusts the actor postion so that the relative position of the actor toward its parent remains the same.
Since: 0.6
anchor_x | X coordinate of the anchor point. | |
anchor_y | Y coordinate of the anchor point. |
bool Clutter::Actor::get_fixed_position_set | ( | ) | const |
Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
true
if the fixed position is set on the actorvoid Clutter::Actor::set_fixed_position_set | ( | bool | is_set | ) |
Sets whether an actor has a fixed position set (and will thus be unaffected by any layout manager).
Since: 0.8
is_set | Whether to use fixed position. |
void Clutter::Actor::get_transformed_position | ( | int & | x, | |
int & | y | |||
) | const |
Gets the absolute position of an actor, in pixels, relative to the stage.
Since: 0.8
x | Return location for the X coordinate, or 0 . | |
y | Return location for the Y coordinate, or 0 . |
Gets the absolute position of an actor, in Clutter::Unit<!-- -->s, relative to the stage.
Since: 0.8
x | Return location for the X coordinate, or 0 . | |
y | Return location for the Y coordinate, or 0 . |
void Clutter::Actor::get_transformed_size | ( | guint & | width, | |
guint & | height | |||
) | const |
Gets the absolute size of an actor taking into account any scaling factors.
Since: 0.8
width | Return location for the width, or 0 . | |
height | Return location for the height, or 0 . |
Gets the absolute size of an actor in Clutter::Units<!-- -->s, taking into account the scaling factors.
<note>When the actor (or one of its ancestors) is rotated around the X or Y axis, it no longer appears as on the stage as a rectangle, but as a generic quadrangle; in that case this function returns the size of the smallest rectangle that encapsulates the entire quad. Please note that in this case no assumptions can be made about the relative position of this envelope to the absolute position of the actor, as returned by get_transformed_position(); if you need this information, you need to use get_abs_allocation_vertices() to get the coords of the actual quadrangle.</note>
Since: 0.8
width | Return location for the width, or 0 . | |
height | Return location for the height, or 0 . |
void Clutter::Actor::get_allocation_coords | ( | int & | x1, | |
int & | y1, | |||
int & | x2, | |||
int & | y2 | |||
) | const |
Gets the layout box an actor has been assigned.
The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date.
An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
The returned coordinates are in pixels.
Since: 0.8
x1 | X1 coord. | |
y1 | Y1 coord. | |
x2 | X2 coord. | |
y2 | Y2 coord. |
Geometry Clutter::Actor::get_allocation_geometry | ( | ) | const |
Gets the layout box an actor has been assigned.
The allocation can only be assumed valid inside a paint() method; anywhere else, it may be out-of-date.
An allocation does not incorporate the actor's scale or anchor point; those transformations do not affect layout, only rendering.
The returned rectangle is in pixels.
Since: 0.8
geom | Allocation geometry in pixels. |
void Clutter::Actor::set_depth | ( | int | depth | ) |
Sets the Z co-ordinate of self to depth.
The Units of which are dependant on the perspective setup.
depth | Z co-ord. |
void Clutter::Actor::set_depthu | ( | Unit | depth | ) |
Sets the Z co-ordinate of self to depth in Clutter::Unit<!-- -->s, the units of which are dependant on the perspective setup.
depth | Z co-ordinate, in Clutter::Unit<!-- -->s. |
int Clutter::Actor::get_depth | ( | ) | const |
Retrieves the depth of self.
Unit Clutter::Actor::get_depthu | ( | ) | const |
Fixed point version of set_scale().
Scales an actor with the given factors. The scaling is always relative to the anchor point.
scale_x | Clutter::Fixed factor to scale actor by horizontally. | |
scale_y | Clutter::Fixed factor to scale actor by vertically. |
void Clutter::Actor::set_scale | ( | double | scale_x, | |
double | scale_y | |||
) |
Scales an actor with the given factors.
The scaling is always relative to the anchor point.
Since: 0.2
scale_x | Double factor to scale actor by horizontally. | |
scale_y | Double factor to scale actor by vertically. |
Fixed point version of get_scale().
Retrieves the scale factors of an actor.
Since: 0.2
scale_x | Location to store horizonal scale factor, or 0 . | |
scale_y | Location to store vertical scale factor, or 0 . |
void Clutter::Actor::get_scale | ( | double & | scale_x, | |
double & | scale_y | |||
) | const |
Retrieves an actors scale in floating point.
Since: 0.2
scale_x | Location to store horizonal float scale factor, or 0 . | |
scale_y | Location to store vertical float scale factor, or 0 . |
void Clutter::Actor::get_size | ( | guint & | width, | |
guint & | height | |||
) | const |
This function tries to "do what you mean" and return the size an actor will have.
If the actor has a valid allocation, the allocation will be returned; otherwise, the actors natural size request will be returned.
If you care whether you get the request vs. the allocation, you should probably call a different function like get_allocation_coords() or get_preferred_width().
Since: 0.2
width | Return location for the width, or 0 . | |
height | Return location for the height, or 0 . |
This function tries to "do what you mean" and return the size an actor will have.
If the actor has a valid allocation, the allocation will be returned; otherwise, the actors natural size request will be returned.
If you care whether you get the request vs. the allocation, you should probably call a different function like get_allocation_coords() or get_preferred_width().
Since: 0.6
width | Return location for the width, or 0 . | |
height | Return location for the height, or 0 . |
void Clutter::Actor::move_by | ( | int | dx, | |
int | dy | |||
) |
Moves an actor by the specified distance relative to its current position in pixels.
This function modifies the fixed position of an actor and thus removes it from any layout management. Another way to move an actor is with an anchor point, see set_anchor_point().
Since: 0.2
Moves an actor by the specified distance relative to its current position.
The move is accomplished by setting a fixed position, overriding any layout manager, see set_positionu().
Since: 0.6
dx | Distance to move Actor on X axis, in Clutter::Unit<!-- -->s. | |
dy | Distance to move Actor on Y axis, in Clutter::Unit<!-- -->s. |
Transforms point in coordinates relative to the actor into screen-relative coordinates with the current actor transformation (i.e. scale, rotation, etc).
Since: 0.4
point | A point as Clutter::Vertex. | |
vertex | The translated Clutter::Vertex. |
This function translates screen coordinates ( x, y) to coordinates relative to the actor.
For example, it can be used to translate screen events from global screen coordinates into actor-local coordinates.
The conversion can fail, notably if the transform stack results in the actor being projected on the screen as a mere line.
The conversion should not be expected to be pixel-perfect due to the nature of the operation. In general the error grows when the skewing of the actor rectangle on screen increases.
This function only works when the allocation is up-to-date, i.e. inside of paint()
x | X screen coordinate of the point to unproject, in Clutter::Unit<!-- -->s. | |
y | Y screen coordinate of the point to unproject, in Clutter::Unit<!-- -->s. | |
x_out | Return location for the unprojected x coordinance, in Clutter::Unit<!-- -->s. | |
y_out | Return location for the unprojected y coordinance, in Clutter::Unit<!-- -->s. |
true
if conversion was successful.bool Clutter::Actor::event | ( | ClutterEvent * | event, | |
bool | capture | |||
) |
This function is used to emit an event on the main stage.
You should rarely need to use this function, except for synthetising events.
event | A Clutter::Event. | |
capture | true if event in in capture phase, false otherwise. |
true
if the actor handled the event, or false
if the event was not handledstatic Glib::RefPtr<Actor> Clutter::Actor::get_actor_by_gid | ( | guint32 | id | ) | [static] |
Retrieves the Clutter::Actor with id.
id | A Clutter::Actor ID. |
0
. The returned actor does not have its reference count increased.void Clutter::Actor::set_anchor_point | ( | int | anchor_x, | |
int | anchor_y | |||
) |
Sets an anchor point for the actor.
The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.
Since: 0.6
anchor_x | X coordinate of the anchor point. | |
anchor_y | Y coordinate of the anchor point. |
void Clutter::Actor::get_anchor_point | ( | int & | anchor_x, | |
int & | anchor_y | |||
) | const |
Gets the current anchor point of the actor in pixels.
Since: 0.6
anchor_x | Return location for the X coordinate of the anchor point. | |
anchor_y | Return location for the y coordinate of the anchor point. |
Sets an anchor point for self.
The anchor point is a point in the coordinate space of an actor to which the actor position within its parent is relative; the default is (0, 0), i.e. the top-left corner of the actor.
Since: 0.6
anchor_x | X coordinate of the anchor point, in Clutter::Unit<!-- -->s. | |
anchor_y | Y coordinate of the anchor point, in Clutter::Unit<!-- -->s. |
Gets the current anchor point of the actor in Clutter::Unit<!-- -->s.
Since: 0.6
anchor_x | Return location for the X coordinace of the anchor point. | |
anchor_y | Return location for the X coordinace of the anchor point. |
void Clutter::Actor::set_anchor_point_from_gravity | ( | ClutterGravity | gravity | ) |
Sets an anchor point on the actor, based on the given gravity (this is a convenience function wrapping set_anchor_point()).
Since: 0.6
gravity | Clutter::Gravity. |
Glib::SignalProxy1< bool,ButtonEvent* > Clutter::Actor::signal_button_press_event | ( | ) |
bool on_my_button_press_event(ButtonEvent* event)
Glib::SignalProxy1< bool,ButtonEvent* > Clutter::Actor::signal_button_release_event | ( | ) |
bool on_my_button_release_event(ButtonEvent* event)
Glib::SignalProxy1< bool,MotionEvent* > Clutter::Actor::signal_motion_event | ( | ) |
bool on_my_motion_event(MotionEvent* event)
Glib::SignalProxy1< bool,CrossingEvent* > Clutter::Actor::signal_leave_event | ( | ) |
bool on_my_leave_event(CrossingEvent* event)
Glib::SignalProxy0< void > Clutter::Actor::signal_show | ( | ) |
void on_my_show()
Glib::SignalProxy0< void > Clutter::Actor::signal_hide | ( | ) |
void on_my_hide()
Glib::SignalProxy0< void > Clutter::Actor::signal_destroy | ( | ) |
void on_my_destroy()
Glib::SignalProxy1< bool,KeyEvent* > Clutter::Actor::signal_key_release_event | ( | ) |
bool on_my_key_release_event(KeyEvent* event)
Glib::SignalProxy1< bool,CrossingEvent* > Clutter::Actor::signal_enter_event | ( | ) |
bool on_my_enter_event(CrossingEvent* event)
Glib::SignalProxy1< bool,Event* > Clutter::Actor::signal_event | ( | ) |
bool on_my_event(Event* event)
Glib::SignalProxy0< void > Clutter::Actor::signal_focus_out | ( | ) |
void on_my_focus_out()
Glib::SignalProxy0< void > Clutter::Actor::signal_focus_in | ( | ) |
void on_my_focus_in()
Glib::SignalProxy1< void,const Glib::RefPtr<Actor>& > Clutter::Actor::signal_parent_set | ( | ) |
void on_my_parent_set(const Glib::RefPtr<Actor>& old_parent)
Glib::SignalProxy1< bool,ScrollEvent* > Clutter::Actor::signal_scroll_event | ( | ) |
bool on_my_scroll_event(ScrollEvent* event)
Glib::SignalProxy1< bool,KeyEvent* > Clutter::Actor::signal_key_press_event | ( | ) |
bool on_my_key_press_event(KeyEvent* event)
Glib::SignalProxy1< bool,Event* > Clutter::Actor::signal_captured_event | ( | ) |
bool on_my_captured_event(Event* event)
Glib::SignalProxy0< void > Clutter::Actor::signal_paint | ( | ) |
void on_my_paint()
Glib::SignalProxy0< void > Clutter::Actor::signal_realize | ( | ) |
void on_my_realize()
Glib::SignalProxy0< void > Clutter::Actor::signal_unrealize | ( | ) |
void on_my_unrealize()
Glib::PropertyProxy_ReadOnly<ActorBox> Clutter::Actor::property_allocation | ( | ) | const |
The actor's allocation.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<int> Clutter::Actor::property_anchor_x | ( | ) |
X coordinate of the anchor point.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<int> Clutter::Actor::property_anchor_x | ( | ) | const |
X coordinate of the anchor point.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<int> Clutter::Actor::property_anchor_y | ( | ) |
Y coordinate of the anchor point.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<int> Clutter::Actor::property_anchor_y | ( | ) | const |
Y coordinate of the anchor point.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Geometry> Clutter::Actor::property_clip | ( | ) |
The clip region for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Geometry> Clutter::Actor::property_clip | ( | ) | const |
The clip region for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<int> Clutter::Actor::property_depth | ( | ) |
Depth of actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<int> Clutter::Actor::property_depth | ( | ) | const |
Depth of actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Clutter::Actor::property_fixed_position_set | ( | ) |
Whether to use fixed positioning for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Actor::property_fixed_position_set | ( | ) | const |
Whether to use fixed positioning for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Unit> Clutter::Actor::property_fixed_x | ( | ) |
Forced X position of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Unit> Clutter::Actor::property_fixed_x | ( | ) | const |
Forced X position of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Unit> Clutter::Actor::property_fixed_y | ( | ) |
Forced Y position of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Unit> Clutter::Actor::property_fixed_y | ( | ) | const |
Forced Y position of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Actor::property_has_clip | ( | ) | const |
Whether the actor has a clip set or not.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<int> Clutter::Actor::property_height | ( | ) |
Height of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<int> Clutter::Actor::property_height | ( | ) | const |
Height of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Unit> Clutter::Actor::property_min_height | ( | ) |
Forced minimum height request for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Unit> Clutter::Actor::property_min_height | ( | ) | const |
Forced minimum height request for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Clutter::Actor::property_min_height_set | ( | ) |
Whether to use the min-height property.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Actor::property_min_height_set | ( | ) | const |
Whether to use the min-height property.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Unit> Clutter::Actor::property_min_width | ( | ) |
Forced minimum width request for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Unit> Clutter::Actor::property_min_width | ( | ) | const |
Forced minimum width request for the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Clutter::Actor::property_min_width_set | ( | ) |
Whether to use the min-width property.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Actor::property_min_width_set | ( | ) | const |
Whether to use the min-width property.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<guint8> Clutter::Actor::property_opacity | ( | ) |
Opacity of actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<guint8> Clutter::Actor::property_opacity | ( | ) | const |
Opacity of actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Clutter::Actor::property_reactive | ( | ) |
Whether the actor is reactive to events or not.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Actor::property_reactive | ( | ) | const |
Whether the actor is reactive to events or not.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<RequestMode> Clutter::Actor::property_request_mode | ( | ) |
The actor's request mode.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<RequestMode> Clutter::Actor::property_request_mode | ( | ) | const |
The actor's request mode.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<double> Clutter::Actor::property_rotation_angle_x | ( | ) |
The rotation angle on the X axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<double> Clutter::Actor::property_rotation_angle_x | ( | ) | const |
The rotation angle on the X axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<double> Clutter::Actor::property_rotation_angle_y | ( | ) |
The rotation angle on the Y axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<double> Clutter::Actor::property_rotation_angle_y | ( | ) | const |
The rotation angle on the Y axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<double> Clutter::Actor::property_rotation_angle_z | ( | ) |
The rotation angle on the Z axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<double> Clutter::Actor::property_rotation_angle_z | ( | ) | const |
The rotation angle on the Z axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Vertex> Clutter::Actor::property_rotation_center_x | ( | ) |
The rotation center on the X axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Vertex> Clutter::Actor::property_rotation_center_x | ( | ) | const |
The rotation center on the X axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Vertex> Clutter::Actor::property_rotation_center_y | ( | ) |
The rotation center on the Y axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Vertex> Clutter::Actor::property_rotation_center_y | ( | ) | const |
The rotation center on the Y axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<Vertex> Clutter::Actor::property_rotation_center_z | ( | ) |
The rotation center on the Z axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<Vertex> Clutter::Actor::property_rotation_center_z | ( | ) | const |
The rotation center on the Z axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<double> Clutter::Actor::property_scale_x | ( | ) |
Scale factor on the X axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<double> Clutter::Actor::property_scale_x | ( | ) | const |
Scale factor on the X axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<double> Clutter::Actor::property_scale_y | ( | ) |
Scale factor on the Y axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<double> Clutter::Actor::property_scale_y | ( | ) | const |
Scale factor on the Y axis.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Clutter::Actor::property_show_on_set_parent | ( | ) |
Whether the actor is shown when parented.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Actor::property_show_on_set_parent | ( | ) | const |
Whether the actor is shown when parented.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<bool> Clutter::Actor::property_visible | ( | ) |
Whether the actor is visible or not.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<bool> Clutter::Actor::property_visible | ( | ) | const |
Whether the actor is visible or not.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<int> Clutter::Actor::property_width | ( | ) |
Width of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<int> Clutter::Actor::property_width | ( | ) | const |
Width of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<int> Clutter::Actor::property_x | ( | ) |
X coordinate of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<int> Clutter::Actor::property_x | ( | ) | const |
X coordinate of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy<int> Clutter::Actor::property_y | ( | ) |
Y coordinate of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly<int> Clutter::Actor::property_y | ( | ) | const |
Y coordinate of the actor.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
void Clutter::Actor::pick | ( | const Color & | color | ) | [protected] |
Renders a silhouette of the actor using the supplied color.
Used internally for mapping pointer events to actors.
This function should never be called directly by applications.
Subclasses overiding the ClutterActor::pick() method should call should_pick_paint() to decide whether to render their silhouette. Containers should always recursively call pick for each child.
Since 0.4
color | A Clutter::Color. |
bool Clutter::Actor::should_pick_paint | ( | ) | const [protected] |
Utility call for subclasses overiding the pick method.
This function should never be called directly by applications.
true
if the actor should paint its silhouette, false
otherwise. virtual void Clutter::Actor::show_all_vfunc | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::hide_all_vfunc | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::pick_vfunc | ( | const Color & | color | ) | [protected, virtual] |
virtual void Clutter::Actor::get_preferred_width_vfunc | ( | Unit | for_height, | |
Unit & | min_width_p, | |||
Unit & | natural_width_p | |||
) | const [protected, virtual] |
virtual void Clutter::Actor::get_preferred_height_vfunc | ( | Unit | for_width, | |
Unit & | min_height_p, | |||
Unit & | natural_height_p | |||
) | const [protected, virtual] |
virtual void Clutter::Actor::allocate_vfunc | ( | const ActorBox & | box, | |
bool | absolute_origin_changed | |||
) | [protected, virtual] |
virtual bool Clutter::Actor::on_button_press_event | ( | ButtonEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_button_release_event | ( | ButtonEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_motion_event | ( | MotionEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_leave_event | ( | CrossingEvent * | event | ) | [protected, virtual] |
virtual void Clutter::Actor::on_show | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_hide | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_destroy | ( | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_key_release_event | ( | KeyEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_enter_event | ( | CrossingEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_event | ( | Event * | event | ) | [protected, virtual] |
virtual void Clutter::Actor::on_focus_out | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_focus_in | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_parent_set | ( | const Glib::RefPtr< Actor > & | old_parent | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_scroll_event | ( | ScrollEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_key_press_event | ( | KeyEvent * | event | ) | [protected, virtual] |
virtual bool Clutter::Actor::on_captured_event | ( | Event * | event | ) | [protected, virtual] |
virtual void Clutter::Actor::on_paint | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_realize | ( | ) | [protected, virtual] |
virtual void Clutter::Actor::on_unrealize | ( | ) | [protected, virtual] |
Glib::RefPtr< Clutter::Actor > wrap | ( | ClutterActor * | object, | |
bool | take_copy = false | |||
) | [related] |
A Glib::wrap() method for this object.
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. |