cluttermm: Clutter::Stage Class Reference

This is a top level 'window' on which child actors are placed and manipulated. More...

Inheritance diagram for Clutter::Stage:
Collaboration diagram for Clutter::Stage:

Public Member Functions

virtual ~Stage ()
 
ClutterStage* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterStage* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterStage* 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_color (const Color& color)
 Sets the stage color. More...

 
Color get_color () const
 Retrieves the stage color. More...

 
void set_perspective (const Perspective& prespective)
 Sets the stage perspective. More...

 
void get_perspective (Perspective& prespective)
 Retrieves the stage perspective. More...

 
void set_fullscreen (bool fullscreen=true)
 Asks to place the stage window in the fullscreen or unfullscreen states. More...

 
bool get_fullscreen () const
 Retrieves whether the stage is full screen or not. More...

 
void show_cursor ()
 Shows the cursor on the stage window. More...

 
void hide_cursor ()
 Makes the cursor invisible on the stage window. More...

 
Glib::ustring get_title () const
 Gets the stage title. More...

 
void set_title (const Glib::ustring& title)
 Sets the stage title. More...

 
void set_user_resizable (bool value=true)
 Sets if the stage is resizable by user interaction (e.g. via window manager controls) More...

 
bool get_user_resizable () const
 Retrieves the value set with set_user_resizable(). More...

 
void set_accept_focus (bool value=true)
 Sets whether the stage should accept the key focus when shown. More...

 
bool get_accept_focus () const
 Retrieves the value set with set_accept_focus(). More...

 
Glib::RefPtr< Actorget_actor_at_pos (PickMode pick_mode, int x, int y)
 Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates. More...

 
Glib::RefPtr< const Actorget_actor_at_pos (PickMode pick_mode, int x, int y) const
 Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates. More...

 
Glib::RefPtr< Actorget_key_focus ()
 Retrieves the actor that is currently under key focus. More...

 
Glib::RefPtr< const Actorget_key_focus () const
 Retrieves the actor that is currently under key focus. More...

 
void set_key_focus (const Glib::RefPtr< Actor >& actor)
 Sets the key focus on actor. More...

 
void set_key_focus ()
 
guchar* read_pixels (int x, int y, int width, int height) const
 Makes a screenshot of the stage in RGBA 8bit data, returns a linear buffer with width * 4 as rowstride. More...

 
bool get_use_fog () const
 Gets whether the depth cueing effect is enabled on stage. More...

 
void set_use_fog (bool fog=true)
 Sets whether the depth cueing effect on the stage should be enabled or not. More...

 
void set_fog (const Fog& fog)
 Sets the fog (also known as "depth cueing") settings for the stage. More...

 
void get_fog (Fog& fog) const
 Retrieves the current depth cueing settings from the stage. More...

 
void stage_event (Event*event)
 This function is used to emit an event on the main stage. More...

 
bool is_default () const
 Checks if stage is the default stage, or an instance created using new() but internally using the same implementation. More...

 
void ensure_current ()
 This function essentially makes sure the right GL context is current for the passed stage. More...

 
void ensure_viewport ()
 Ensures that the GL viewport is updated with the current stage window size. More...

 
void ensure_redraw ()
 Ensures that stage is redrawn. More...

 
void set_throttle_motion_events (bool throttle=true)
 Sets whether motion events received between redraws should be throttled or not. More...

 
bool get_throttle_motion_events () const
 Retrieves the value set with set_throttle_motion_events() More...

 
void set_use_alpha (bool use_alpha=true)
 Sets whether the stage should honour the Clutter::Actor::property_opacity() and the alpha channel of the Clutter::Stage::property_color() More...

 
bool get_use_alpha () const
 Retrieves the value set using set_use_alpha() More...

 
void set_minimum_size (guint width, guint height)
 Sets the minimum size for a stage window, if the default backend uses Clutter::Stage inside a window. More...

 
void get_minimum_size (guint& width, guint& height)
 Retrieves the minimum size for a stage window as set using set_minimum_size(). More...

 
Point get_minimum_size () const
 Returns the minimum size for the stage. More...

 
void set_no_clear_hint (bool no_clear=true)
 Sets whether the stage should clear itself at the beginning of each paint cycle or not. More...

 
bool get_no_clear_hint () const
 Retrieves the hint set with set_no_clear_hint() More...

 
void set_motion_events_enabled (bool enabled=true)
 Sets whether per-actor motion events (and relative crossing events) should be disabled or not. More...

 
bool get_motion_events_enabled () const
 Retrieves the value set using set_motion_events_enabled(). More...

 
Glib::SignalProxy0< void > signal_fullscreen ()
 
Glib::SignalProxy0< void > signal_unfullscreen ()
 
Glib::SignalProxy0< void > signal_activate ()
 
Glib::SignalProxy0< void > signal_deactivate ()
 
Glib::SignalProxy1< bool,

ClutterEvent* > 
signal_delete_event ()
 
Glib::PropertyProxy< bool > property_accept_focus ()
 Whether the stage should accept focus on show. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_accept_focus () const
 Whether the stage should accept focus on show. More...

 
Glib::PropertyProxy< Colorproperty_color ()
 The color of the stage. More...

 
Glib::PropertyProxy_ReadOnly

< Color
property_color () const
 The color of the stage. More...

 
Glib::PropertyProxy< bool > property_cursor_visible ()
 Whether the mouse pointer is visible on the main stage. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_cursor_visible () const
 Whether the mouse pointer is visible on the main stage. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_fullscreen_set () const
 Whether the main stage is fullscreen. More...

 
Glib::PropertyProxy< bool > property_no_clear_hint ()
 Whether the stage should clear its contents. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_no_clear_hint () const
 Whether the stage should clear its contents. More...

 
Glib::PropertyProxy< bool > property_offscreen ()
 Whether the main stage should be rendered offscreen. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_offscreen () const
 Whether the main stage should be rendered offscreen. More...

 
Glib::PropertyProxy< Perspectiveproperty_perspective ()
 Perspective projection parameters. More...

 
Glib::PropertyProxy_ReadOnly

< Perspective
property_perspective () const
 Perspective projection parameters. More...

 
Glib::PropertyProxy

< Glib::ustring
property_title ()
 Stage Title. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::ustring
property_title () const
 Stage Title. More...

 
Glib::PropertyProxy< bool > property_use_fog ()
 Whether to enable depth cueing. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_use_fog () const
 Whether to enable depth cueing. More...

 
Glib::PropertyProxy< bool > property_user_resizable ()
 Whether the stage is able to be resized via user interaction. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_user_resizable () const
 Whether the stage is able to be resized via user interaction. More...

 
Glib::PropertyProxy< Fogproperty_fog ()
 Settings for the depth cueing. More...

 
Glib::PropertyProxy_ReadOnly< Fogproperty_fog () const
 Settings for the depth cueing. More...

 
Glib::PropertyProxy< bool > property_use_alpha ()
 Whether to honour the alpha component of the stage color. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_use_alpha () const
 Whether to honour the alpha component of the stage color. More...

 
Glib::PropertyProxy

< Glib::RefPtr< Actor > > 
property_key_focus ()
 The currently key focused actor. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::RefPtr< Actor > > 
property_key_focus () const
 The currently key focused actor. More...

 
- Public Member Functions inherited from Clutter::Group
virtual ~Group ()
 
ClutterGroup* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterGroup* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterGroup* 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 remove_all ()
 Removes all children actors from the Clutter::Group. More...

 
int get_n_children () const
 Gets the number of actors held in the group. More...

 
Glib::RefPtr< Actorget_nth_child (int index)
 Gets a groups child held at index in stack. More...

 
Glib::RefPtr< const Actorget_nth_child (int index) const
 Gets a groups child held at index in stack. More...

 
- Public Member Functions inherited from Clutter::Actor
virtual ~Actor ()
 
ClutterActor* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterActor* gobj () const
 Provides access to the underlying C GObject. More...

 
ClutterActor* 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_flags (ActorFlags flags)
 Sets flags on self. More...

 
void unset_flags (ActorFlags flags)
 Unsets flags on self. More...

 
ActorFlags get_flags () const
 Retrieves the flags set on self. More...

 
bool is_mapped () const
 
bool is_realized () const
 
bool is_visible () const
 
bool is_reactive () const
 
void show ()
 Flags an actor to be displayed. More...

 
void show_all ()
 Calls show() on all children of an actor (if any). More...

 
void hide ()
 Flags an actor to be hidden. More...

 
void hide_all ()
 Calls hide() on all child actors (if any). More...

 
void realize ()
 Realization informs the actor that it is attached to a stage. More...

 
void unrealize ()
 Unrealization informs the actor that it may be being destroyed or moved to another stage. More...

 
void map ()
 Sets the Clutter::ACTOR_MAPPED flag on the actor and possibly maps and realizes its children if they are visible. More...

 
void unmap ()
 Unsets the Clutter::ACTOR_MAPPED flag on the actor and possibly unmaps its children if they were mapped. More...

 
void paint ()
 Renders the actor to display. More...

 
void continue_paint ()
 Run the next stage of the paint sequence. More...

 
void queue_redraw ()
 Queues up a redraw of an actor and any children. More...

 
void queue_relayout ()
 Indicates that the actor's size request or other layout-affecting properties may have changed. More...

 
bool has_overlaps ()
 Asks the actor's implementation whether it may contain overlapping primitives. More...

 
void set_content (const Glib::RefPtr< Content >& content)
 Sets the contents of a Clutter::Actor. More...

 
Glib::RefPtr< Contentget_content ()
 Retrieves the contents of self. More...

 
Glib::RefPtr< const Contentget_content () const
 Retrieves the contents of self. More...

 
void set_content_gravity (ContentGravity gravity)
 Sets the gravity of the Clutter::Content used by self. More...

 
ContentGravity get_content_gravity () const
 Retrieves the content gravity as set using set_content_gravity(). More...

 
void set_content_scaling_filters (ScalingFilter min_filter, ScalingFilter mag_filter)
 Sets the minification and magnification filter to be applied when scaling the Clutter::Actor::property_content() of a Clutter::Actor. More...

 
void get_content_scaling_filters (ScalingFilter& min_filter, ScalingFilter& mag_filter)
 Retrieves the values set using set_content_scaling_filters(). More...

 
void set_content_repeat (ContentRepeat repeat)
 Sets the policy for repeating the Clutter::Actor::property_content() of a Clutter::Actor. More...

 
ContentRepeat get_content_repeat () const
 Retrieves the repeat policy for a Clutter::Actor set by set_content_repeat(). More...

 
ActorBox get_content_box () const
 
void destroy ()
 Destroys an actor. More...

 
Glib::RefPtr< Pango::Context > get_pango_context ()
 Retrieves the Pango::Context for self. More...

 
Glib::RefPtr< const

Pango::Context > 
get_pango_context () const
 Retrieves the Pango::Context for self. More...

 
Glib::RefPtr< Pango::Context > create_pango_context ()
 Creates a Pango::Context for the given actor. More...

 
Glib::RefPtr< Pango::Layout > create_pango_layout (const Glib::ustring& text)
 Creates a new Pango::Layout from the same Pango::Context used by the Clutter::Actor. More...

 
Matrix get_transform () const
 Returns the transformation matrix being used by the actor. More...

 
void get_transformation_matrix (ClutterMatrix* matrix)
 Retrieves the transformations applied to self relative to its parent. More...

 
void set_transform (const Matrix&transform)
 Overrides the transformations of a Clutter::Actor with a custom matrix, which will be applied relative to the origin of the actor's allocation and to the actor's pivot point. More...

 
void set_child_transform (const Matrix&transform)
 Sets the transformation matrix to be applied to all the children of self prior to their own transformations. More...

 
bool is_in_clone_paint () const
 Checks whether self is being currently painted by a Clutter::Clone. More...

 
bool get_paint_box (ActorBox& box)
 Retrieves the paint volume of the passed Clutter::Actor, and transforms it into a 2D bounding box in stage coordinates. More...

 
bool has_pointer () const
 Checks whether an actor contains the pointer of a Clutter::InputDevice. More...

 
void set_text_direction (TextDirection text_dir)
 Sets the Clutter::TextDirection for an actor. More...

 
TextDirection get_text_direction () const
 Retrieves the value set using set_text_direction() More...

 
Glib::RefPtr< Actorget_stage ()
 Retrieves the Clutter::Stage where actor is contained. More...

 
Glib::RefPtr< const Actorget_stage () const
 Retrieves the Clutter::Stage where actor is contained. More...

 
void set_child_below_sibling (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
 Sets child to be below sibling in the list of children of self. More...

 
void set_child_above_sibling (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
 Sets child to be above sibling in the list of children of self. More...

 
void set_child_at_index (const Glib::RefPtr< Actor >& child, int index)
 Changes the index of child in the list of children of self. More...

 
void set_geometry (const Geometry& geometry)
 Sets the actor's fixed position and forces its minimum and natural size, in pixels. More...

 
Geometry get_geometry () const
 Gets the size and position of an actor relative to its parent actor. More...

 
void set_size (float width, float height)
 Sets the actor's size request in pixels. More...

 
void get_position (float& x, float& y)
 This function tries to "do what you mean" and tell you where the actor is, prior to any transformations. More...

 
void set_position (float x, float y)
 Sets the actor's fixed position in pixels relative to any parent actor. More...

 
float get_width () const
 Retrieves the width of a Clutter::Actor. More...

 
float get_height () const
 Retrieves the height of a Clutter::Actor. More...

 
void set_width (float width)
 Forces a width on an actor, causing the actor's preferred width and height (if any) to be ignored. More...

 
void set_height (float height)
 Forces a height on an actor, causing the actor's preferred width and height (if any) to be ignored. More...

 
void set_x (float x)
 Sets the actor's X coordinate, relative to its parent, in pixels. More...

 
float get_x () const
 Retrieves the X coordinate of a Clutter::Actor. More...

 
void set_y (float y)
 Sets the actor's Y coordinate, relative to its parent, in pixels. More...

 
float get_y () const
 Retrieves the Y coordinate of a Clutter::Actor. More...

 
void set_z_position (float z_position)
 Sets the actor's position on the Z axis. More...

 
float get_z_position () const
 Retrieves the actor's position on the Z axis. More...

 
void set_x_align (ActorAlign x_align)
 Sets the horizontal alignment policy of a Clutter::Actor, in case the actor received extra horizontal space. More...

 
ActorAlign get_x_align () const
 Retrieves the horizontal alignment policy set using set_x_align(). More...

 
void set_y_align (ActorAlign y_align)
 Sets the vertical alignment policy of a Clutter::Actor, in case the actor received extra vertical space. More...

 
ActorAlign get_y_align () const
 Retrieves the vertical alignment policy set using set_y_align(). More...

 
bool get_x_expand () const
 Retrieves the value set with set_x_expand(). More...

 
void set_x_expand (bool expand=true)
 Sets whether a Clutter::Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible. More...

 
bool get_y_expand () const
 Retrieves the value set with set_y_expand(). More...

 
void set_y_expand (bool expand=true)
 Sets whether a Clutter::Actor should expand horizontally; this means that layout manager should allocate extra space for the actor, if possible. More...

 
bool needs_expand (Orientation orientation) const
 Checks whether an actor, or any of its children, is set to expand horizontally or vertically. More...

 
void set_layout_manager (const Glib::RefPtr< LayoutManager >& manager)
 Sets the Clutter::LayoutManager delegate object that will be used to lay out the children of self. More...

 
void unset_layout_manager ()
 Unset the layout manager. More...

 
Glib::RefPtr< LayoutManagerget_layout_manager ()
 Retrieves the Clutter::LayoutManager used by self. More...

 
Glib::RefPtr< const LayoutManagerget_layout_manager () const
 Retrieves the Clutter::LayoutManager used by self. More...

 
void set_reactive (bool reactive=true)
 Sets actor as reactive. More...

 
bool get_reactive () const
 Checks whether actor is marked as reactive. More...

 
bool has_key_focus () const
 Checks whether self is the Clutter::Actor that has key focus. More...

 
void set_rotation (RotateAxis axis, double angle, float x, float y, float z)
 Sets the rotation angle of self around the given axis. More...

 
void set_z_rotation_from_gravity (double angle, Gravity gravity)
 Sets the rotation angle of self around the Z axis using the center point specified as a compass point. More...

 
double get_rotation (RotateAxis axis, float& x, float& y, float& z) const
 Retrieves the angle and center of rotation on the given axis, set using set_rotation(). More...

 
Gravity get_z_rotation_gravity () const
 Retrieves the center for the rotation around the Z axis as a compass direction. More...

 
void set_opacity (guint8 opacity)
 Sets the actor's opacity, with zero being completely transparent and 255 (0xff) being fully opaque. More...

 
guint8 get_opacity () const
 Retrieves the opacity value of an actor, as set by set_opacity(). More...

 
void set_offscreen_redirect (OffscreenRedirect redirect) const
 Defines the circumstances where the actor should be redirected into an offscreen image. More...

 
OffscreenRedirect get_offscreen_redirect ()
 Retrieves whether to redirect the actor to an offscreen buffer, as set by set_offscreen_redirect(). More...

 
void set_background_color (const Color& color)
 Sets the background color of a Clutter::Actor. More...

 
Color get_background_color () const
 Retrieves the color set using set_background_color(). More...

 
const PaintVolumeget_paint_volume () const
 Retrieves the paint volume of the passed Clutter::Actor, or 0 when a paint volume can't be determined. More...

 
const PaintVolumeget_transformed_paint_volume (const Glib::RefPtr< Actor >& relative_to_ancestor) const
 Retrieves the 3D paint volume of an actor like get_paint_volume() does (Please refer to the documentation of get_paint_volume() for more details.) and it additionally transforms the paint volume into the coordinate space of relative_to_ancestor. More...

 
const PaintVolumeget_transformed_paint_volume () const
 A get_transformed_paint_volume() convenience overload. More...

 
const PaintVolumeget_default_paint_volume () const
 Retrieves the default paint volume for self. More...

 
void set_name (const gchar* name)
 Sets the given name to self. More...

 
Glib::ustring get_name () const
 Retrieves the name of self. More...

 
guint32 get_gid () const
 Retrieves the unique id for self. More...

 
void set_clip (float xoff, float yoff, float width, float height)
 Sets clip area for self. More...

 
void get_clip (float& xoff, float& yoff, float& width, float& height)
 Gets the clip area for self, if any is set. More...

 
void set_clip_to_allocation (bool clip_set=true)
 Sets whether self should be clipped to the same size as its allocation. More...

 
bool get_clip_to_allocation () const
 Retrieves the value set using set_clip_to_allocation() More...

 
void remove_clip ()
 Removes clip area from self. More...

 
bool has_clip () const
 Determines whether the actor has a clip area set or not. More...

 
std::vector< Glib::RefPtr

< Actor > > 
get_children ()
 Retrieves the list of children of self. More...

 
std::vector< Glib::RefPtr

< const Actor > > 
get_children () const
 Retrieves the list of children of self. More...

 
int get_n_children () const
 Retrieves the number of children of self. More...

 
Glib::RefPtr< Actorget_child_at_index (int index)
 Retrieves the actor at the given index inside the list of children of self. More...

 
Glib::RefPtr< const Actorget_child_at_index (int index) const
 Retrieves the actor at the given index inside the list of children of self. More...

 
Glib::RefPtr< Actorget_previous_sibling ()
 Retrieves the sibling of self that comes before it in the list of children of self's parent. More...

 
Glib::RefPtr< const Actorget_previous_sibling () const
 Retrieves the sibling of self that comes before it in the list of children of self's parent. More...

 
Glib::RefPtr< Actorget_next_sibling ()
 Retrieves the sibling of self that comes after it in the list of children of self's parent. More...

 
Glib::RefPtr< const Actorget_next_sibling () const
 Retrieves the sibling of self that comes after it in the list of children of self's parent. More...

 
Glib::RefPtr< Actorget_first_child ()
 Retrieves the first child of self. More...

 
Glib::RefPtr< const Actorget_first_child () const
 Retrieves the first child of self. More...

 
Glib::RefPtr< Actorget_last_child ()
 Retrieves the last child of self. More...

 
Glib::RefPtr< const Actorget_last_child () const
 Retrieves the last child of self. More...

 
void set_parent (const Glib::RefPtr< Actor >& parent)
 Sets the parent of self to parent. More...

 
Glib::RefPtr< Actorget_parent ()
 Retrieves the parent of self. More...

 
Glib::RefPtr< const Actorget_parent () const
 Retrieves the parent of self. More...

 
void reparent (const Glib::RefPtr< Actor >& new_parent)
 Resets the parent actor of self. More...

 
void unparent ()
 Removes the parent of self. More...

 
bool contains (const Glib::RefPtr< const Actor >& descendant) const
 Determines if descendant is contained inside self (either as an immediate child, or as a deeper descendant). More...

 
void raise (const Glib::RefPtr< Actor >& below)
 Puts self above below. More...

 
void lower (const Glib::RefPtr< Actor >& above)
 Puts self below above. More...

 
void raise_top ()
 Raises self to the top. More...

 
void lower_bottom ()
 Lowers self to the bottom. More...

 
Glib::RefPtr< Shaderget_shader ()
 Queries the currently set Clutter::Shader on self. More...

 
Glib::RefPtr< const Shaderget_shader () const
 Queries the currently set Clutter::Shader on self. More...

 
void set_shader (const Glib::RefPtr< Shader >& shader)
 Sets the Clutter::Shader to be used when rendering self. More...

 
template<class ParamType >
void set_shader_param (const Glib::ustring& param, const ParamType& value)
 Sets the value for a named parameter of the shader applied to actor. More...

 
bool is_rotated () const
 Checks whether any rotation is applied to the actor. More...

 
bool is_scaled () const
 Checks whether the actor is scaled in either dimension. More...

 
void set_pivot_point (float x, float y)
 Sets the position of the Clutter::Actor::property_pivot_point() around which the scaling and rotation transformations occur. More...

 
void get_pivot_point (float& pivot_x, float& pivot_y) const
 Retrieves the coordinates of the Clutter::Actor::property_pivot_point(). More...

 
void set_pivot_point_z (float pivot_z)
 Sets the component on the Z axis of the Clutter::Actor::property_pivot_point() around which the scaling and rotation transformations occur. More...

 
float get_pivot_point_z () const
 Retrieves the Z component of the Clutter::Actor::property_pivot_point(). More...

 
void set_rotation_angle (RotateAxis axis, double angle)
 Sets the angle of rotation of a Clutter::Actor on the given axis. More...

 
double get_rotation_angle (RotateAxis axis) const
 Retrieves the angle of rotation set by set_rotation_angle(). More...

 
void set_translation (float translate_x, float translate_y, float translate_z)
 Sets an additional translation transformation on a Clutter::Actor, relative to the Clutter::Actor::property_pivot_point(). More...

 
void get_translation (float& translate_x, float& translate_y, float& translate_z) const
 Retrieves the translation set using set_translation(). More...

 
bool should_pick_paint () const
 Should be called inside the implementation of the Clutter::Actor::signal_pick() virtual function in order to check whether the actor should paint itself in pick mode or not. More...

 
void get_allocation_vertices (Vertex vertices[4]) const
 Calculates the transformed coordinates of the four corners of the actor in the plane of ancestor. More...

 
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. More...

 
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: More...

 
void allocate_align_fill (const ActorBox& box, gdouble x_align, double y_align, bool x_fill, bool y_fill, AllocationFlags flags)
 Allocates self by taking into consideration the available allocation area; an alignment factor on either axis; and whether the actor should fill the allocation on either axis. More...

 
void set_allocation (const ActorBox& box, AllocationFlags flags)
 Stores the allocation of self as defined by box. More...

 
ActorBox get_allocation_box () const
 Gets the layout box an actor has been assigned. More...

 
void allocate (const ActorBox& box, AllocationFlags absolute_origin_changed=ALLOCATION_NONE)
 Assigns the size of a Clutter::Actor from the given box. More...

 
void allocate_preferred_size (AllocationFlags absolute_origin_changed=ALLOCATION_NONE)
 Allocates the natural size of self. More...

 
void allocate_available_size (float x, float y, float available_width, float available_height, AllocationFlags flags=ALLOCATION_NONE)
 Allocates self taking into account the Clutter::Actor's preferred size, but limiting it to the maximum available width and height provided. More...

 
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) More...

 
void transform_stage_point (float x, float y, float& x_out, float& y_out) const
 This function translates screen coordinates ( x, y) to coordinates relative to the actor. More...

 
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). More...

 
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. More...

 
void get_transformed_position (float& x, float& y) const
 Gets the absolute position of an actor, in pixels relative to the stage. More...

 
Matrix get_child_transform () const
 
void get_transformed_size (float& width, float& height) const
 Gets the absolute size of an actor in pixels, taking into account the scaling factors. More...

 
void set_request_mode (RequestMode mode)
 Sets the geometry request mode of self. More...

 
RequestMode get_request_mode () const
 Retrieves the geometry request mode of self. More...

 
void get_preferred_size (float& min_width_p, float& min_height_p, float& natural_width_p, float& 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). More...

 
void get_preferred_width (float for_height, float& min_width_p, float& 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. More...

 
void get_preferred_height (float for_width, float& min_height_p, float& natural_height_p) const
 Computes the requested minimum and natural heights for an actor, or if they are already computed, returns the cached values. More...

 
guint8 get_paint_opacity () const
 Retrieves the absolute opacity of the actor, as it appears on the stage. More...

 
bool get_paint_visibility () const
 Retrieves the 'paint' visibility of an actor recursively checking for non visible parents. More...

 
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. More...

 
void move_anchor_point (float anchor_x, float 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. More...

 
void set_margin_top (float margin)
 Sets the margin from the top of a Clutter::Actor. More...

 
float get_margin_top () const
 Retrieves the top margin of a Clutter::Actor. More...

 
void set_margin_bottom (float margin)
 Sets the margin from the bottom of a Clutter::Actor. More...

 
float get_margin_bottom () const
 Retrieves the bottom margin of a Clutter::Actor. More...

 
void set_margin_left (float margin)
 Sets the margin from the left of a Clutter::Actor. More...

 
float get_margin_left () const
 Retrieves the left margin of a Clutter::Actor. More...

 
void set_margin_right (float margin)
 Sets the margin from the right of a Clutter::Actor. More...

 
float get_margin_right () const
 Retrieves the right margin of a Clutter::Actor. More...

 
void set_margins (float top, float left, float bottom, float right)
 Convenience method for setting all margins at once. More...

 
bool get_fixed_position_set () const
 Checks whether an actor has a fixed position set (and will thus be unaffected by any layout manager). More...

 
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). More...

 
Geometry get_allocation_geometry () const
 Gets the layout box an actor has been assigned. More...

 
void set_depth (float depth)
 Sets the Z coordinate of self to depth. More...

 
float get_depth () const
 Retrieves the depth of self. More...

 
void set_scale (double scale_x, double scale_y)
 Scales an actor with the given factors. More...

 
void set_scale_z (double scale_z)
 Scales an actor on the Z axis by the given scale_z factor. More...

 
void set_scale_full (double scale_x, double scale_y, float center_x, float center_y)
 Scales an actor with the given factors around the given center point. More...

 
void set_scale_with_gravity (double scale_x, double scale_y, Gravity gravity)
 Scales an actor with the given factors around the given center point. More...

 
void get_scale (double& scale_x, double& scale_y) const
 Retrieves an actors scale factors. More...

 
double get_scale_z () const
 Retrieves the scaling factor along the Z axis, as set using set_scale_z(). More...

 
void get_scale_center (float& center_x, float& center_y) const
 Retrieves the scale center coordinate in pixels relative to the top left corner of the actor. More...

 
Gravity get_scale_gravity () const
 Retrieves the scale center as a compass direction. More...

 
void get_size (float& width, float& height) const
 This function tries to "do what you mean" and return the size an actor will have. More...

 
void move_by (float dx, float dy)
 Moves an actor by the specified distance relative to its current position in pixels. More...

 
bool event (const ClutterEvent* event, bool capture)
 This function is used to emit an event on the main stage. More...

 
void set_anchor_point (float anchor_x, float anchor_y)
 Sets an anchor point for self. More...

 
void get_anchor_point (float& anchor_x, float& anchor_y) const
 Gets the current anchor point of the actor in pixels. More...

 
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()). More...

 
Gravity get_anchor_point_gravity ()
 Retrieves the anchor position expressed as a Clutter::Gravity. More...

 
void grab_key_focus ()
 Sets the key focus of the Clutter::Stage including self to this Clutter::Actor. More...

 
void add_child (const Glib::RefPtr< Actor >& child)
 Adds child to the children of self. More...

 
void insert_child_above (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
 Inserts child into the list of children of self, above another child of self or, if sibling is 0, above all the children of self. More...

 
void insert_child_at_index (const Glib::RefPtr< Actor >& child, int index)
 Inserts child into the list of children of self, using the given index. More...

 
void insert_child_at_index (const Glib::RefPtr< Actor >& child)
 A insert_child_at_index() convenience overload. More...

 
void insert_child_below (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
 Inserts child into the list of children of self, below another child of self or, if sibling is 0, below all the children of self. More...

 
void replace_child (const Glib::RefPtr< Actor >& old_child, const Glib::RefPtr< Actor >& new_child)
 Replaces old_child with new_child in the list of children of self. More...

 
void remove_child (const Glib::RefPtr< Actor >& child)
 Removes child from the children of self. More...

 
void remove_all_children ()
 Removes all children of self. More...

 
Glib::RefPtr< Animationget_animation ()
 Retrieves the Clutter::Animation used by actor, if animate() has been called on actor. More...

 
Glib::RefPtr< const Animationget_animation () const
 Retrieves the Clutter::Animation used by actor, if animate() has been called on actor. More...

 
void detach_animation ()
 Detaches the Clutter::Animation used by actor, if animate() has been called on actor. More...

 
void push_internal ()
 Should be used by actors implementing the Clutter::Container and with internal children added through set_parent(), for instance: More...

 
void pop_internal ()
 Disables the effects of push_internal(). More...

 
bool has_allocation () const
 Checks if the actor has an up-to-date allocation assigned to it. More...

 
Glib::RefPtr< Atk::Object > get_accessible ()
 Returns the accessible object that describes the actor to an assistive technology. More...

 
Glib::RefPtr< const Atk::Object > get_accessible () const
 Returns the accessible object that describes the actor to an assistive technology. More...

 
void add_action (const Glib::RefPtr< Action >& action)
 Adds action to the list of actions applied to self. More...

 
void add_action (const Glib::ustring& name, const Glib::RefPtr< Action >& action)
 A convenience function for setting the name of a Clutter::Action while adding it to the list of actions applied to self. More...

 
void remove_action (const Glib::RefPtr< Action >& action)
 Removes action from the list of actions applied to self. More...

 
void remove_action (const Glib::ustring& name)
 Removes the Clutter::Action with the given name from the list of actions applied to self. More...

 
Glib::RefPtr< Actionget_action (const Glib::ustring& name)
 Retrieves the Clutter::Action with the given name in the list of actions applied to self. More...

 
Glib::RefPtr< const Actionget_action (const Glib::ustring& name) const
 Retrieves the Clutter::Action with the given name in the list of actions applied to self. More...

 
void clear_actions ()
 Clears the list of actions applied to self. More...

 
std::vector< Glib::RefPtr

< Action > > 
get_actions ()
 Retrieves the list of actions applied to self. More...

 
std::vector< Glib::RefPtr

< const Action > > 
get_actions () const
 Retrieves the list of actions applied to self. More...

 
bool has_actions () const
 Returns whether the actor has any actions applied. More...

 
void add_effect (const Glib::RefPtr< Effect >& effect)
 Adds effect to the list of Clutter::Effects applied to self. More...

 
void add_effect_with_name (const Glib::ustring& name, const Glib::RefPtr< Effect >& effect)
 A convenience function for setting the name of a Clutter::Effect while adding it to the list of effectss applied to self. More...

 
void remove_effect (const Glib::RefPtr< Effect >& effect)
 Removes effect from the list of effects applied to self. More...

 
void remove_effect (const Glib::ustring& name)
 Removes the Clutter::Effect with the given name from the list of effects applied to self. More...

 
std::vector< Glib::RefPtr

< Effect > > 
get_effects ()
 Retrieves the Clutter::Effects applied on self, if any. More...

 
std::vector< Glib::RefPtr

< const Effect > > 
get_effects () const
 Retrieves the Clutter::Effects applied on self, if any. More...

 
Glib::RefPtr< Effectget_effect (const Glib::ustring& name)
 Retrieves the Clutter::Effect with the given name in the list of effects applied to self. More...

 
Glib::RefPtr< const Effectget_effect (const Glib::ustring& name) const
 Retrieves the Clutter::Effect with the given name in the list of effects applied to self. More...

 
void clear_effects ()
 Clears the list of effects applied to self. More...

 
bool has_effects () const
 Returns whether the actor has any effects applied. More...

 
void save_easing_state ()
 Saves the current easing state for animatable properties, and creates a new state with the default values for easing mode and duration. More...

 
void restore_easing_state ()
 Restores the easing state as it was prior to a call to save_easing_state(). More...

 
void set_easing_duration (guint msecs)
 Sets the duration of the tweening for animatable properties of self for the current easing state. More...

 
guint get_easing_duration () const
 Retrieves the duration of the tweening for animatable properties of self for the current easing state. More...

 
AnimationMode get_easing_mode () const
 Retrieves the easing mode for the tweening of animatable properties of self for the current easing state. More...

 
void set_easing_mode (AnimationMode mode)
 Sets the easing mode for the tweening of animatable properties of self. More...

 
guint get_easing_delay () const
 Retrieves the delay that should be applied when tweening animatable properties. More...

 
void set_easing_delay (guint msecs)
 Sets the delay that should be applied before tweening animatable properties. More...

 
Glib::RefPtr< Transitionget_transition (const Glib::ustring& name)
 Retrieves the Clutter::Transition of a Clutter::Actor by using the transition name. More...

 
Glib::RefPtr< const Transitionget_transition (const Glib::ustring& name) const
 Retrieves the Clutter::Transition of a Clutter::Actor by using the transition name. More...

 
void add_transition (const Glib::ustring& name, const Glib::RefPtr< Transition >& transition)
 Adds a transition to the Clutter::Actor's list of animations. More...

 
void remove_transition (const Glib::ustring& name)
 Removes the transition stored inside a Clutter::Actor using name identifier. More...

 
void remove_all_transitions ()
 Removes all transitions associated to self. More...

 
void add_constraint (const Glib::RefPtr< Constraint >& constraint)
 Adds constraint to the list of Clutter::Constraints applied to self. More...

 
void add_constraint (const Glib::ustring& name, const Glib::RefPtr< Constraint >& constraint)
 A convenience function for setting the name of a Clutter::Constraint while adding it to the list of constraints applied to self. More...

 
void remove_constraint (const Glib::RefPtr< Constraint >& constraint)
 Removes constraint from the list of constraints applied to self. More...

 
void remove_constraint (const Glib::ustring& name)
 Removes the Clutter::Constraint with the given name from the list of constraints applied to self. More...

 
bool has_constraints () const
 Returns whether the actor has any constraints applied. More...

 
std::vector< Glib::RefPtr

< Clutter::Constraint > > 
get_constraints ()
 Retrieves the list of constraints applied to self. More...

 
std::vector< Glib::RefPtr

< const Clutter::Constraint > > 
get_constraints () const
 Retrieves the list of constraints applied to self. More...

 
Glib::RefPtr< const Constraintget_constraint (const Glib::ustring& name) const
 Retrieves the Clutter::Constraint with the given name in the list of constraints applied to self. More...

 
Glib::RefPtr< Constraintget_constraint (const Glib::ustring& name)
 Retrieves the Clutter::Constraint with the given name in the list of constraints applied to self. More...

 
void clear_constraints ()
 Clears the list of constraints applied to self. More...

 
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_key_focus_out ()
 
Glib::SignalProxy0< void > signal_key_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::SignalProxy1< void,

const Glib::RefPtr< Actor >& > 
signal_queue_redaw ()
 
Glib::SignalProxy0< void > signal_queue_relayout ()
 
Glib::SignalProxy0< void > signal_realize ()
 
Glib::SignalProxy0< void > signal_unrealize ()
 
Glib::SignalProxy1< void,

const Color& > 
signal_pick ()
 
Glib::SignalProxy2< void,

const ActorBox

&, AllocationFlags
signal_allocation_changed ()
 
Glib::SignalProxy1< bool,

ClutterTouchEvent* > 
signal_touch_event ()
 
Glib::SignalProxy0< void > signal_transitions_completed ()
 
Glib::SignalProxy2< void,

const Glib::ustring&, bool > 
signal_transition_stopped ()
 
Glib::PropertyProxy_ReadOnly

< ActorBox
property_allocation () const
 The actor's allocation. More...

 
Glib::PropertyProxy< float > property_anchor_x ()
 X coordinate of the anchor point. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_anchor_x () const
 X coordinate of the anchor point. More...

 
Glib::PropertyProxy< float > property_anchor_y ()
 Y coordinate of the anchor point. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_anchor_y () const
 Y coordinate of the anchor point. More...

 
Glib::PropertyProxy< Gravityproperty_anchor_gravity ()
 The anchor point as a ClutterGravity. More...

 
Glib::PropertyProxy_ReadOnly

< Gravity
property_anchor_gravity () const
 The anchor point as a ClutterGravity. More...

 
Glib::PropertyProxy< Colorproperty_background_color ()
 The actor's background color. More...

 
Glib::PropertyProxy_ReadOnly

< Color
property_background_color () const
 The actor's background color. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_background_color_set () const
 Whether the background color is set. More...

 
Glib::PropertyProxy< Matrixproperty_child_transform ()
 Children transformation matrix. More...

 
Glib::PropertyProxy_ReadOnly

< Matrix
property_child_transform () const
 Children transformation matrix. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_child_transform_set () const
 Whether the child-transform property is set. More...

 
Glib::PropertyProxy< Geometryproperty_clip ()
 The clip region for the actor. More...

 
Glib::PropertyProxy_ReadOnly

< Geometry
property_clip () const
 The clip region for the actor. More...

 
Glib::PropertyProxy< Rectproperty_clip_rect ()
 The visible region of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< Rect
property_clip_rect () const
 The visible region of the actor. More...

 
Glib::PropertyProxy< bool > property_clip_to_allocation ()
 Sets the clip region to track the actor's allocation. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_clip_to_allocation () const
 Sets the clip region to track the actor's allocation. More...

 
Glib::PropertyProxy< Contentproperty_content ()
 Delegate object for painting the actor's content. More...

 
Glib::PropertyProxy_ReadOnly

< Content
property_content () const
 Delegate object for painting the actor's content. More...

 
Glib::PropertyProxy_ReadOnly

< ActorBox
property_content_box () const
 The bounding box of the actor's content. More...

 
Glib::PropertyProxy

< ContentGravity
property_content_gravity ()
 Alignment of the actor's content. More...

 
Glib::PropertyProxy_ReadOnly

< ContentGravity
property_content_gravity () const
 Alignment of the actor's content. More...

 
Glib::PropertyProxy

< ContentRepeat
property_content_repeat ()
 The repeat policy for the actor's content. More...

 
Glib::PropertyProxy_ReadOnly

< ContentRepeat
property_content_repeat () const
 The repeat policy for the actor's content. More...

 
Glib::PropertyProxy< float > property_depth ()
 Position on the Z axis. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_depth () const
 Position on the Z axis. More...

 
Glib::PropertyProxy_WriteOnly

< Glib::RefPtr< Effect > > 
property_effect ()
 Add an effect to be applied on the actor. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::RefPtr< Actor > > 
property_first_child () const
 The actor's first child. More...

 
Glib::PropertyProxy< bool > property_fixed_position_set ()
 Whether to use fixed positioning for the actor. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_fixed_position_set () const
 Whether to use fixed positioning for the actor. More...

 
Glib::PropertyProxy< float > property_fixed_x ()
 Forced X position of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_fixed_x () const
 Forced X position of the actor. More...

 
Glib::PropertyProxy< float > property_fixed_y ()
 Forced Y position of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_fixed_y () const
 Forced Y position of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_has_clip () const
 Whether the actor has a clip set. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_has_pointer () const
 Whether the actor contains the pointer of an input device. More...

 
Glib::PropertyProxy< float > property_height ()
 Height of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_height () const
 Height of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::RefPtr< Actor > > 
property_last_child () const
 The actor's last child. More...

 
Glib::PropertyProxy

< Glib::RefPtr< LayoutManager > > 
property_layout_manager ()
 The object controlling the layout of an actor's children. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::RefPtr< LayoutManager > > 
property_layout_manager () const
 The object controlling the layout of an actor's children. More...

 
Glib::PropertyProxy

< ScalingFilter
property_magnification_filter ()
 The filter used when increasing the size of the content. More...

 
Glib::PropertyProxy_ReadOnly

< ScalingFilter
property_magnification_filter () const
 The filter used when increasing the size of the content. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_mapped () const
 Whether the actor will be painted. More...

 
Glib::PropertyProxy< float > property_margin_bottom ()
 Extra space at the bottom. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_margin_bottom () const
 Extra space at the bottom. More...

 
Glib::PropertyProxy< float > property_margin_left ()
 Extra space at the left. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_margin_left () const
 Extra space at the left. More...

 
Glib::PropertyProxy< float > property_margin_right ()
 Extra space at the right. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_margin_right () const
 Extra space at the right. More...

 
Glib::PropertyProxy< float > property_margin_top ()
 Extra space at the top. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_margin_top () const
 Extra space at the top. More...

 
Glib::PropertyProxy

< ScalingFilter
property_minification_filter ()
 The filter used when reducing the size of the content. More...

 
Glib::PropertyProxy_ReadOnly

< ScalingFilter
property_minification_filter () const
 The filter used when reducing the size of the content. More...

 
Glib::PropertyProxy< float > property_min_height ()
 Forced minimum height request for the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_min_height () const
 Forced minimum height request for the actor. More...

 
Glib::PropertyProxy< bool > property_min_height_set ()
 Whether to use the min-height property. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_min_height_set () const
 Whether to use the min-height property. More...

 
Glib::PropertyProxy< float > property_min_width ()
 Forced minimum width request for the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_min_width () const
 Forced minimum width request for the actor. More...

 
Glib::PropertyProxy< bool > property_min_width_set ()
 Whether to use the min-width property. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_min_width_set () const
 Whether to use the min-width property. More...

 
Glib::PropertyProxy

< Glib::ustring
property_name ()
 Name of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< Glib::ustring
property_name () const
 Name of the actor. More...

 
Glib::PropertyProxy< float > property_natural_height ()
 Forced natural height request for the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_natural_height () const
 Forced natural height request for the actor. More...

 
Glib::PropertyProxy< bool > property_natural_height_set ()
 Whether to use the natural-height property. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_natural_height_set () const
 Whether to use the natural-height property. More...

 
Glib::PropertyProxy< float > property_natural_width ()
 Forced natural width request for the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_natural_width () const
 Forced natural width request for the actor. More...

 
Glib::PropertyProxy< bool > property_natural_width_set ()
 Whether to use the natural-width property. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_natural_width_set () const
 Whether to use the natural-width property. More...

 
Glib::PropertyProxy< guint8 > property_opacity ()
 Opacity of an actor. More...

 
Glib::PropertyProxy_ReadOnly

< guint8 > 
property_opacity () const
 Opacity of an actor. More...

 
Glib::PropertyProxy

< OffscreenRedirect
property_offscreen_redirect ()
 Flags controlling when to flatten the actor into a single image. More...

 
Glib::PropertyProxy_ReadOnly

< OffscreenRedirect
property_offscreen_redirect () const
 Flags controlling when to flatten the actor into a single image. More...

 
Glib::PropertyProxy< Pointproperty_pivot_point ()
 The point around which the scaling and rotation occur. More...

 
Glib::PropertyProxy_ReadOnly

< Point
property_pivot_point () const
 The point around which the scaling and rotation occur. More...

 
Glib::PropertyProxy< float > property_pivot_point_z ()
 Z component of the pivot point. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_pivot_point_z () const
 Z component of the pivot point. More...

 
Glib::PropertyProxy< Pointproperty_position ()
 The position of the origin of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< Point
property_position () const
 The position of the origin of the actor. More...

 
Glib::PropertyProxy< bool > property_reactive ()
 Whether the actor is reactive to events. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_reactive () const
 Whether the actor is reactive to events. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_realized () const
 Whether the actor has been realized. More...

 
Glib::PropertyProxy< RequestModeproperty_request_mode ()
 The actor's request mode. More...

 
Glib::PropertyProxy_ReadOnly

< RequestMode
property_request_mode () const
 The actor's request mode. More...

 
Glib::PropertyProxy< double > property_rotation_angle_x ()
 The rotation angle on the X axis. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_rotation_angle_x () const
 The rotation angle on the X axis. More...

 
Glib::PropertyProxy< double > property_rotation_angle_y ()
 The rotation angle on the Y axis. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_rotation_angle_y () const
 The rotation angle on the Y axis. More...

 
Glib::PropertyProxy< double > property_rotation_angle_z ()
 The rotation angle on the Z axis. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_rotation_angle_z () const
 The rotation angle on the Z axis. More...

 
Glib::PropertyProxy< Vertexproperty_rotation_center_x ()
 The rotation center on the X axis. More...

 
Glib::PropertyProxy_ReadOnly

< Vertex
property_rotation_center_x () const
 The rotation center on the X axis. More...

 
Glib::PropertyProxy< Vertexproperty_rotation_center_y ()
 The rotation center on the Y axis. More...

 
Glib::PropertyProxy_ReadOnly

< Vertex
property_rotation_center_y () const
 The rotation center on the Y axis. More...

 
Glib::PropertyProxy< Vertexproperty_rotation_center_z ()
 The rotation center on the Z axis. More...

 
Glib::PropertyProxy_ReadOnly

< Vertex
property_rotation_center_z () const
 The rotation center on the Z axis. More...

 
Glib::PropertyProxy< Gravityproperty_rotation_center_z_gravity ()
 Center point for rotation around the Z axis. More...

 
Glib::PropertyProxy_ReadOnly

< Gravity
property_rotation_center_z_gravity () const
 Center point for rotation around the Z axis. More...

 
Glib::PropertyProxy< double > property_scale_x ()
 Scale factor on the X axis. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_scale_x () const
 Scale factor on the X axis. More...

 
Glib::PropertyProxy< double > property_scale_y ()
 Scale factor on the Y axis. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_scale_y () const
 Scale factor on the Y axis. More...

 
Glib::PropertyProxy< double > property_scale_z ()
 Scale factor on the Z axis. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_scale_z () const
 Scale factor on the Z axis. More...

 
Glib::PropertyProxy< double > property_scale_center_x ()
 Horizontal scale center. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_scale_center_x () const
 Horizontal scale center. More...

 
Glib::PropertyProxy< double > property_scale_center_y ()
 Vertical scale center. More...

 
Glib::PropertyProxy_ReadOnly

< double > 
property_scale_center_y () const
 Vertical scale center. More...

 
Glib::PropertyProxy< Gravityproperty_scale_gravity ()
 The center of scaling. More...

 
Glib::PropertyProxy_ReadOnly

< Gravity
property_scale_gravity () const
 The center of scaling. More...

 
Glib::PropertyProxy< bool > property_show_on_set_parent ()
 Whether the actor is shown when parented. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_show_on_set_parent () const
 Whether the actor is shown when parented. More...

 
Glib::PropertyProxy

< TextDirection
property_text_direction ()
 Direction of the text. More...

 
Glib::PropertyProxy_ReadOnly

< TextDirection
property_text_direction () const
 Direction of the text. More...

 
Glib::PropertyProxy< float > property_translation_x ()
 Translation along the X axis. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_translation_x () const
 Translation along the X axis. More...

 
Glib::PropertyProxy< float > property_translation_y ()
 Translation along the Y axis. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_translation_y () const
 Translation along the Y axis. More...

 
Glib::PropertyProxy< float > property_translation_z ()
 Translation along the Z axis. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_translation_z () const
 Translation along the Z axis. More...

 
Glib::PropertyProxy< Matrixproperty_transform ()
 Transformation matrix. More...

 
Glib::PropertyProxy_ReadOnly

< Matrix
property_transform () const
 Transformation matrix. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_transform_set () const
 Whether the transform property is set. More...

 
Glib::PropertyProxy< bool > property_visible ()
 Whether the actor is visible or not. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_visible () const
 Whether the actor is visible or not. More...

 
Glib::PropertyProxy< float > property_width ()
 Width of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_width () const
 Width of the actor. More...

 
Glib::PropertyProxy< float > property_x ()
 X coordinate of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_x () const
 X coordinate of the actor. More...

 
Glib::PropertyProxy< ActorAlignproperty_x_align ()
 The alignment of the actor on the X axis within its allocation. More...

 
Glib::PropertyProxy_ReadOnly

< ActorAlign
property_x_align () const
 The alignment of the actor on the X axis within its allocation. More...

 
Glib::PropertyProxy< bool > property_x_expand ()
 Whether extra horizontal space should be assigned to the actor. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_x_expand () const
 Whether extra horizontal space should be assigned to the actor. More...

 
Glib::PropertyProxy< float > property_y ()
 Y coordinate of the actor. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_y () const
 Y coordinate of the actor. More...

 
Glib::PropertyProxy< ActorAlignproperty_y_align ()
 The alignment of the actor on the Y axis within its allocation. More...

 
Glib::PropertyProxy_ReadOnly

< ActorAlign
property_y_align () const
 The alignment of the actor on the Y axis within its allocation. More...

 
Glib::PropertyProxy< bool > property_y_expand ()
 Whether extra vertical space should be assigned to the actor. More...

 
Glib::PropertyProxy_ReadOnly

< bool > 
property_y_expand () const
 Whether extra vertical space should be assigned to the actor. More...

 
Glib::PropertyProxy< float > property_z_position ()
 The actor's position on the Z axis. More...

 
Glib::PropertyProxy_ReadOnly

< float > 
property_z_position () const
 The actor's position on the Z axis. More...

 
- Public Member Functions inherited from Clutter::Scriptable
virtual ~Scriptable ()
 
ClutterScriptable* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterScriptable* gobj () const
 Provides access to the underlying C GObject. More...

 
void set_id (const std::string& id)
 Sets id as the unique Clutter script it for this instance of Clutter::ScriptableIface. More...

 
std::string get_id () const
 Retrieves the id of scriptable set using set_id(). More...

 
bool parse_custom_node (const Glib::RefPtr< Script >& script, Glib::ValueBase& value, const Glib::ustring& name, JsonNode* node)
 Parses the passed JSON node. More...

 
void set_custom_property (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value)
 Overrides the common properties setting. More...

 
- Public Member Functions inherited from Clutter::Animatable
virtual ~Animatable ()
 
ClutterAnimatable* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterAnimatable* gobj () const
 Provides access to the underlying C GObject. More...

 
GParamSpec* find_property (const Glib::ustring& property_name)
 Finds the ParamSpec for property_name. More...

 
void get_initial_state_value (const Glib::ustring& property_name, Glib::ValueBase& value) const
 Retrieves the current state of property_name and sets value with it. More...

 
void set_final_state_value (const Glib::ustring& property_name, const Glib::ValueBase& value)
 Sets the current state of property_name to value. More...

 
void interpolate_value_value (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, Glib::ValueBase& value)
 Asks a Clutter::Animatable implementation to interpolate a a named property between the initial and final values of a Clutter::Interval, using progress as the interpolation value, and store the result inside value. More...

 
template<class ValueType >
void get_initial_state (const Glib::ustring& property_name, ValueType& value) const
 Gets the initial state of an animation. More...

 
template<class ValueType >
void set_final_state (const Glib::ustring& property_name, const ValueType& value)
 Sets the final state for an animation. More...

 
template<class ValueType >
bool interpolate (const Glib::ustring& property_name, const Glib::RefPtr< const Interval >& interval, double progress, ValueType& value)
 
- Public Member Functions inherited from Clutter::Container
virtual ~Container ()
 
ClutterContainer* gobj ()
 Provides access to the underlying C GObject. More...

 
const ClutterContainer* gobj () const
 Provides access to the underlying C GObject. More...

 
void add_actor (const Glib::RefPtr< Actor >& actor)
 Adds a Clutter::Actor to container. More...

 
void remove_actor (const Glib::RefPtr< Actor >& actor)
 Removes actor from container. More...

 
std::vector< Glib::RefPtr

< Actor > > 
get_children ()
 
std::vector< Glib::RefPtr

< const Actor > > 
get_children () const
 
void lower_child (const Glib::RefPtr< Actor >& actor, const Glib::RefPtr< Actor >& sibling)
 Lowers actor to sibling level, in the depth ordering. More...

 
void lower_child (const Glib::RefPtr< Actor >& actor)
 
void raise_child (const Glib::RefPtr< Actor >& actor, const Glib::RefPtr< Actor >& sibling)
 Raises actor to sibling level, in the depth ordering. More...

 
void raise_child (const Glib::RefPtr< Actor >& actor)
 
Glib::RefPtr< Actorfind_child (const Glib::ustring& child_name)
 Finds a child actor of a container by its name. More...

 
Glib::RefPtr< const Actorfind_child (const Glib::ustring& child_name) const
 Finds a child actor of a container by its name. More...

 
void foreach (const SlotForEach& slot)
 
template<class PropertyType >
void set_child_property (const Glib::RefPtr< Actor >& child, const Glib::ustring& property_name, const PropertyType& value)
 
void set_child_property_value (const Glib::RefPtr< Actor >& child, const Glib::ustring& property_name, const Glib::ValueBase& value)
 Sets a container-specific property on a child of container. More...

 
template<class PropertyType >
void get_child_property (const Glib::RefPtr< const Actor >& child, const Glib::ustring& property_name, PropertyType& value) const
 
void get_child_property_value (const Glib::RefPtr< const Actor >& child, const Glib::ustring& property_name, Glib::ValueBase& value) const
 
Glib::RefPtr< ChildMetaget_child_meta (const Glib::RefPtr< const Actor >& actor)
 Retrieves the Clutter::ChildMeta which contains the data about the container specific state for actor. More...

 
Glib::RefPtr< const ChildMetaget_child_meta (const Glib::RefPtr< const Actor >& actor) const
 Retrieves the Clutter::ChildMeta which contains the data about the container specific state for actor. More...

 
Glib::SignalProxy1< void,

const Glib::RefPtr< Actor >& > 
signal_actor_added ()
 
Glib::SignalProxy1< void,

const Glib::RefPtr< Actor >& > 
signal_actor_removed ()
 
Glib::SignalProxy2< void,

const Glib::RefPtr< Actor >

&, GParamSpec* > 
signal_child_notify ()
 

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< Stagecreate ()
 
static Glib::RefPtr< Stageget_default ()
 Retrieves a Clutter::Stage singleton. More...

 
- Static Public Member Functions inherited from Clutter::Group
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr< Groupcreate ()
 
- Static Public Member Functions inherited from Clutter::Actor
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr< Actorcreate ()
 
static Glib::RefPtr< Actorget_actor_by_gid (guint32 id)
 Retrieves the Clutter::Actor with id. More...

 
- Static Public Member Functions inherited from Clutter::Scriptable
static void add_interface (GType gtype_implementer)
 
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::Animatable
static void add_interface (GType gtype_implementer)
 
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::Container
static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 

Protected Member Functions

 Stage ()
 Creates a new stage. More...

 
virtual void on_fullscreen ()
 This is a default handler for the signal signal_fullscreen(). More...

 
virtual void on_unfullscreen ()
 This is a default handler for the signal signal_unfullscreen(). More...

 
virtual void on_activate ()
 This is a default handler for the signal signal_activate(). More...

 
virtual void on_deactivate ()
 This is a default handler for the signal signal_deactivate(). More...

 
virtual bool on_delete_event (ClutterEvent*event)
 This is a default handler for the signal signal_delete_event(). More...

 
- Protected Member Functions inherited from Clutter::Group
 Group ()
 
- Protected Member Functions inherited from Clutter::Actor
 Actor ()
 
void set_shader_param_value (const Glib::ustring& param, const Glib::ValueBase& value)
 Sets the value for a named parameter of the shader applied to actor. More...

 
virtual void show_all_vfunc ()
 
virtual void hide_all_vfunc ()
 
virtual void map_vfunc ()
 
virtual void unmap_vfunc ()
 
virtual void paint_vfunc ()
 
virtual void get_preferred_width_vfunc (float for_height, float& min_width_p, float& natural_width_p) const
 
virtual void get_preferred_height_vfunc (float for_width, float& min_height_p, float& natural_height_p) const
 
virtual void allocate_vfunc (const ActorBox& box, AllocationFlags absolute_origin_changed)
 
virtual void pick_vfunc (const Color& color)
 
virtual bool get_paint_volume_vfunc (ClutterPaintVolume* volume)
 
virtual bool has_overlaps_vfunc () const
 
virtual void paint_node_vfunc (ClutterPaintNode* root)
 
virtual bool on_button_press_event (ButtonEvent*event)
 This is a default handler for the signal signal_button_press_event(). More...

 
virtual bool on_button_release_event (ButtonEvent*event)
 This is a default handler for the signal signal_button_release_event(). More...

 
virtual bool on_motion_event (MotionEvent*event)
 This is a default handler for the signal signal_motion_event(). More...

 
virtual bool on_leave_event (CrossingEvent*event)
 This is a default handler for the signal signal_leave_event(). More...

 
virtual void on_show ()
 This is a default handler for the signal signal_show(). More...

 
virtual void on_hide ()
 This is a default handler for the signal signal_hide(). More...

 
virtual void on_destroy ()
 This is a default handler for the signal signal_destroy(). More...

 
virtual bool on_key_release_event (KeyEvent*event)
 This is a default handler for the signal signal_key_release_event(). More...

 
virtual bool on_enter_event (CrossingEvent*event)
 This is a default handler for the signal signal_enter_event(). More...

 
virtual bool on_event (Event*event)
 This is a default handler for the signal signal_event(). More...

 
virtual void on_key_focus_out ()
 This is a default handler for the signal signal_key_focus_out(). More...

 
virtual void on_key_focus_in ()
 This is a default handler for the signal signal_key_focus_in(). More...

 
virtual void on_parent_set (const Glib::RefPtr< Actor >& old_parent)
 This is a default handler for the signal signal_parent_set(). More...

 
virtual bool on_scroll_event (ScrollEvent*event)
 This is a default handler for the signal signal_scroll_event(). More...

 
virtual bool on_key_press_event (KeyEvent*event)
 This is a default handler for the signal signal_key_press_event(). More...

 
virtual bool on_captured_event (Event*event)
 This is a default handler for the signal signal_captured_event(). More...

 
virtual void on_paint ()
 This is a default handler for the signal signal_paint(). More...

 
virtual void on_queue_redaw (const Glib::RefPtr< Actor >& origin)
 This is a default handler for the signal signal_queue_redaw(). More...

 
virtual void on_queue_relayout ()
 This is a default handler for the signal signal_queue_relayout(). More...

 
virtual void on_realize ()
 This is a default handler for the signal signal_realize(). More...

 
virtual void on_unrealize ()
 This is a default handler for the signal signal_unrealize(). More...

 
virtual void on_pick (const Color& color)
 This is a default handler for the signal signal_pick(). More...

 
virtual bool on_touch_event (ClutterTouchEvent*event)
 This is a default handler for the signal signal_touch_event(). More...

 
- Protected Member Functions inherited from Clutter::Scriptable
 Scriptable ()
 You should derive from this class to use it. More...

 
virtual void set_id_vfunc (const std::string& id)
 
virtual const char* get_id_vfunc () const
 
virtual void set_custom_property_vfunc (const Glib::RefPtr< Script >& script, const Glib::ustring& name, const Glib::ValueBase& value)
 
- Protected Member Functions inherited from Clutter::Animatable
 Animatable ()
 You should derive from this class to use it. More...

 
virtual GParamSpec* find_property_vfunc (const Glib::ustring& property_name)
 
virtual void get_initial_state_vfunc (const Glib::ustring& property_name, Glib::ValueBase& value)
 
virtual void set_final_state_vfunc (const Glib::ustring& property_name, const Glib::ValueBase& value)
 
- Protected Member Functions inherited from Clutter::Container
 Container ()
 You should derive from this class to use it. More...

 
void sort_depth_order ()
 Sorts a container's children using their depth. More...

 
virtual void add_vfunc (const Glib::RefPtr< Actor >& actor)
 
virtual void remove_vfunc (const Glib::RefPtr< Actor >& actor)
 
virtual void raise_vfunc (const Glib::RefPtr< Actor >& actor, const Glib::RefPtr< Actor >& sibling)
 
virtual void lower_vfunc (const Glib::RefPtr< Actor >& actor, const Glib::RefPtr< Actor >& sibling)
 
virtual void sort_depth_order_vfunc ()
 
virtual void foreach_vfunc (ClutterCallback callback, gpointer user_data)
 
void actor_added (const Glib::RefPtr< Actor >& actor)
 Emit signal_actor_added(). More...

 
void actor_removed (const Glib::RefPtr< Actor >& actor)
 Emit signal_actor_removed(). More...

 
virtual void create_child_meta_vfunc (const Glib::RefPtr< Actor >& actor)
 
virtual void destroy_child_meta_vfunc (const Glib::RefPtr< Actor >& actor)
 
virtual Glib::RefPtr< ChildMetaget_child_meta_vfunc (const Glib::RefPtr< Actor >& actor)
 
virtual void on_actor_added (const Glib::RefPtr< Actor >& actor)
 This is a default handler for the signal signal_actor_added(). More...

 
virtual void on_actor_removed (const Glib::RefPtr< Actor >& actor)
 This is a default handler for the signal signal_actor_removed(). More...

 
virtual void on_child_notify (const Glib::RefPtr< Actor >& actor, GParamSpec* pspec)
 This is a default handler for the signal signal_child_notify(). More...

 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Clutter::Stagewrap (ClutterStage* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Public Types inherited from Clutter::Container
typedef sigc::slot< void,

const Glib::RefPtr< Actor >& > 
SlotForEach
 For instance, void on_foreach(const Glib::RefPtr<Actor>& actor) More...

 

Detailed Description

This is a top level 'window' on which child actors are placed and manipulated.

Clutter creates a default stage upon initialization, which can be retrieved using Stage::get_default(). Clutter always provides the default stage, unless the backend is unable to create one. The stage returned by Stage::get_default() is guaranteed to always be the same.

Backends might provide support for multiple stages. The support for this feature can be checked at run-time using the clutter_feature_available() function and the CLUTTER_FEATURE_STAGE_MULTIPLE flag. If the backend used supports multiple stages, new Clutter::Stage instances can be created.

Clutter::Stage is a proxy actor, wrapping the backend-specific implementation of the windowing system. It is possible to subclass ClutterStage, as long as every overridden virtual function calls the implementation in the base class.

Constructor & Destructor Documentation

virtual Clutter::Stage::~Stage ( )
virtual
Clutter::Stage::Stage ( )
protected

Creates a new stage.

Every Clutter::Actor must be placed on a stage, and the stage first created automatically occupies the window generated when Clutter::maiAdded new properties and functions to wrap clutter 1.7.6n() is run.

Clutter can support more than one stage at once; however the ability to support multiple stages depends on the current backend. Use feature_available() and CLUTTER::FEATURE_STAGE_MULTIPLE to check at runtime whether a backend supports multiple stages.

Returns
a new stage.

{0.8}

Member Function Documentation

static Glib::RefPtr<Stage> Clutter::Stage::create ( )
static
void Clutter::Stage::ensure_current ( )

This function essentially makes sure the right GL context is current for the passed stage.

It is not intended to be used by applications.

Since cluttermm 0.8:
void Clutter::Stage::ensure_redraw ( )

Ensures that stage is redrawn.

This function should not be called by applications: it is used when embedding a Clutter::Stage into a toolkit with another windowing system, like GTK+.

Since cluttermm 1.0:
void Clutter::Stage::ensure_viewport ( )

Ensures that the GL viewport is updated with the current stage window size.

This function will queue a redraw of stage.

This function should not be called by applications; it is used when embedding a Clutter::Stage into a toolkit with another windowing system, like GTK+.

Since cluttermm 1.0:
bool Clutter::Stage::get_accept_focus ( ) const

Retrieves the value set with set_accept_focus().

Since cluttermm 1.6:
Returns
true if the Clutter::Stage should accept focus, and false otherwise.
Glib::RefPtr<Actor> Clutter::Stage::get_actor_at_pos ( PickMode  pick_mode,
int  x,
int  y 
)

Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates.

By using pick_mode it is possible to control which actors will be painted and thus available.

Parameters
pick_modeHow the scene graph should be painted.
xX coordinate to check.
yY coordinate to check.
Returns
The actor at the specified coordinates, if any.
Glib::RefPtr<const Actor> Clutter::Stage::get_actor_at_pos ( PickMode  pick_mode,
int  x,
int  y 
) const

Checks the scene at the coordinates x and y and returns a pointer to the Clutter::Actor at those coordinates.

By using pick_mode it is possible to control which actors will be painted and thus available.

Parameters
pick_modeHow the scene graph should be painted.
xX coordinate to check.
yY coordinate to check.
Returns
The actor at the specified coordinates, if any.
Color Clutter::Stage::get_color ( ) const

Retrieves the stage color.

Deprecated: 1.10: Use Clutter::Actor::get_background_color() instead.

Parameters
colorReturn location for a Clutter::Color.
static Glib::RefPtr<Stage> Clutter::Stage::get_default ( )
static

Retrieves a Clutter::Stage singleton.

This function is not as useful as it sounds, and will most likely by deprecated in the future. Application code should only create a Clutter::Stage instance using new(), and manage the lifetime of the stage manually.

The default stage singleton has a platform-specific behaviour: on platforms without the Clutter::FEATURE_STAGE_MULTIPLE feature flag set, the first Clutter::Stage instance will also be set to be the default stage instance, and this function will always return a pointer to it.

On platforms with the Clutter::FEATURE_STAGE_MULTIPLE feature flag set, the default stage will be created by the first call to this function, and every following call will return the same pointer to it.

Deprecated: 1.10: Use new() instead.

Deprecated:
Use Stage::create() instead
Returns
The main Clutter::Stage. You should never destroy or unref the returned actor.
void Clutter::Stage::get_fog ( Fog fog) const

Retrieves the current depth cueing settings from the stage.

Since cluttermm 0.6:

Deprecated: 1.10: This function will always return the default values of Clutter::Fog

Deprecated:
This function will always return default values.
Parameters
fogReturn location for a Clutter::Fog structure.
bool Clutter::Stage::get_fullscreen ( ) const

Retrieves whether the stage is full screen or not.

Since cluttermm 1.0:
Returns
true if the stage is full screen.
Glib::RefPtr<Actor> Clutter::Stage::get_key_focus ( )

Retrieves the actor that is currently under key focus.

Since cluttermm 0.6:
Returns
The actor with key focus, or the stage.
Glib::RefPtr<const Actor> Clutter::Stage::get_key_focus ( ) const

Retrieves the actor that is currently under key focus.

Since cluttermm 0.6:
Returns
The actor with key focus, or the stage.
void Clutter::Stage::get_minimum_size ( guint &  width,
guint &  height 
)

Retrieves the minimum size for a stage window as set using set_minimum_size().

The returned size may not correspond to the actual minimum size and it is specific to the Clutter::Stage implementation inside the Clutter backend

Since cluttermm 1.2:
Parameters
widthReturn location for the minimum width, in pixels, or 0.
heightReturn location for the minimum height, in pixels, or 0.
Point Clutter::Stage::get_minimum_size ( ) const

Returns the minimum size for the stage.

The Point contains the x_minimum and y minimum.

Returns
a point with the minimum sizes set as its parameters.
bool Clutter::Stage::get_motion_events_enabled ( ) const

Retrieves the value set using set_motion_events_enabled().

Since cluttermm 1.8:
Returns
true if the per-actor motion event delivery is enabled and false otherwise.
bool Clutter::Stage::get_no_clear_hint ( ) const

Retrieves the hint set with set_no_clear_hint()

Since cluttermm 1.4:
Returns
true if the stage should not clear itself on every paint cycle, and false otherwise.
void Clutter::Stage::get_perspective ( Perspective prespective)

Retrieves the stage perspective.

Parameters
perspectiveReturn location for a Clutter::Perspective.
bool Clutter::Stage::get_throttle_motion_events ( ) const

Retrieves the value set with set_throttle_motion_events()

Since cluttermm 1.0:
Returns
true if the motion events are being throttled, and false otherwise.
Glib::ustring Clutter::Stage::get_title ( ) const

Gets the stage title.

Since cluttermm 0.4:
Returns
Pointer to the title string for the stage. The returned string is owned by the actor and should not be modified or freed.
static GType Clutter::Stage::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

bool Clutter::Stage::get_use_alpha ( ) const

Retrieves the value set using set_use_alpha()

Since cluttermm 1.2:
Returns
true if the stage should honour the opacity and the alpha channel of the stage color.
bool Clutter::Stage::get_use_fog ( ) const

Gets whether the depth cueing effect is enabled on stage.

Since cluttermm 0.6:

Deprecated: 1.10: This function will always return false

Deprecated:
This method will always return false.
Returns
true if the depth cueing effect is enabled.
bool Clutter::Stage::get_user_resizable ( ) const

Retrieves the value set with set_user_resizable().

Since cluttermm 0.4:
Returns
true if the stage is resizable by the user.
ClutterStage* Clutter::Stage::gobj ( )
inline

Provides access to the underlying C GObject.

const ClutterStage* Clutter::Stage::gobj ( ) const
inline

Provides access to the underlying C GObject.

ClutterStage* Clutter::Stage::gobj_copy ( )

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

void Clutter::Stage::hide_cursor ( )

Makes the cursor invisible on the stage window.

Since cluttermm 0.4:
bool Clutter::Stage::is_default ( ) const

Checks if stage is the default stage, or an instance created using new() but internally using the same implementation.

Since cluttermm 0.8:

Deprecated: 1.10: Track the stage pointer inside your application code, or use Clutter::Actor::get_stage() to retrieve the stage for a given actor.

Deprecated:
Track the stage pointer inside your application code
Returns
true if the passed stage is the default one.
virtual void Clutter::Stage::on_activate ( )
protectedvirtual

This is a default handler for the signal signal_activate().

virtual void Clutter::Stage::on_deactivate ( )
protectedvirtual

This is a default handler for the signal signal_deactivate().

virtual bool Clutter::Stage::on_delete_event ( ClutterEvent *  event)
protectedvirtual

This is a default handler for the signal signal_delete_event().

virtual void Clutter::Stage::on_fullscreen ( )
protectedvirtual

This is a default handler for the signal signal_fullscreen().

virtual void Clutter::Stage::on_unfullscreen ( )
protectedvirtual

This is a default handler for the signal signal_unfullscreen().

Glib::PropertyProxy< bool > Clutter::Stage::property_accept_focus ( )

Whether the stage should accept focus on show.

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< bool > Clutter::Stage::property_accept_focus ( ) const

Whether the stage should accept focus on show.

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< Color > Clutter::Stage::property_color ( )

The color of the stage.

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< Color > Clutter::Stage::property_color ( ) const

The color of the stage.

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< bool > Clutter::Stage::property_cursor_visible ( )

Whether the mouse pointer is visible on the main stage.

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< bool > Clutter::Stage::property_cursor_visible ( ) const

Whether the mouse pointer is visible on the main stage.

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< Fog > Clutter::Stage::property_fog ( )

Settings for the depth cueing.

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< Fog > Clutter::Stage::property_fog ( ) const

Settings for the depth cueing.

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_ReadOnly< bool > Clutter::Stage::property_fullscreen_set ( ) const

Whether the main stage is fullscreen.

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::Stage::property_key_focus ( )

The currently key focused actor.

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::Stage::property_key_focus ( ) const

The currently key focused actor.

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< bool > Clutter::Stage::property_no_clear_hint ( )

Whether the stage should clear its contents.

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< bool > Clutter::Stage::property_no_clear_hint ( ) const

Whether the stage should clear its contents.

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< bool > Clutter::Stage::property_offscreen ( )

Whether the main stage should be rendered offscreen.

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< bool > Clutter::Stage::property_offscreen ( ) const

Whether the main stage should be rendered offscreen.

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< Perspective > Clutter::Stage::property_perspective ( )

Perspective projection parameters.

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< Perspective > Clutter::Stage::property_perspective ( ) const

Perspective projection parameters.

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::ustring > Clutter::Stage::property_title ( )

Stage Title.

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::ustring > Clutter::Stage::property_title ( ) const

Stage Title.

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< bool > Clutter::Stage::property_use_alpha ( )

Whether to honour the alpha component of the stage color.

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< bool > Clutter::Stage::property_use_alpha ( ) const

Whether to honour the alpha component of the stage color.

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< bool > Clutter::Stage::property_use_fog ( )

Whether to enable depth cueing.

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< bool > Clutter::Stage::property_use_fog ( ) const

Whether to enable depth cueing.

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< bool > Clutter::Stage::property_user_resizable ( )

Whether the stage is able to be resized via user interaction.

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< bool > Clutter::Stage::property_user_resizable ( ) const

Whether the stage is able to be resized via user interaction.

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.
guchar* Clutter::Stage::read_pixels ( int  x,
int  y,
int  width,
int  height 
) const

Makes a screenshot of the stage in RGBA 8bit data, returns a linear buffer with width * 4 as rowstride.

The alpha data contained in the returned buffer is driver-dependent, and not guaranteed to hold any sensible value.

Parameters
xX coordinate of the first pixel that is read from stage.
yY coordinate of the first pixel that is read from stage.
widthWidth dimention of pixels to be read, or -1 for the entire stage width.
heightHeight dimention of pixels to be read, or -1 for the entire stage height.
Returns
A pointer to newly allocated memory with the buffer or 0 if the read failed. Use Glib::free() on the returned data to release the resources it has allocated.
void Clutter::Stage::set_accept_focus ( bool  value = true)

Sets whether the stage should accept the key focus when shown.

This function should be called before showing stage using Clutter::Actor::show().

Since cluttermm 1.6:
Parameters
accept_focustrue to accept focus on show.
void Clutter::Stage::set_color ( const Color color)

Sets the stage color.

Deprecated: 1.10: Use Clutter::Actor::set_background_color() instead.

Deprecated:
Use Actor::set_background_color() instead.
Parameters
colorA Clutter::Color.
void Clutter::Stage::set_fog ( const Fog fog)

Sets the fog (also known as "depth cueing") settings for the stage.

A Clutter::Stage will only use a linear fog progression, which depends solely on the distance from the viewer. The cogl_set_fog() function in COGL exposes more of the underlying implementation, and allows changing the for progression function. It can be directly used by disabling the Clutter::Stage::property_use_fog() property and connecting a signal handler to the Clutter::Actor::signal_paint() signal on the stage, like:

[C example ellipted]

The paint signal handler will call cogl_set_fog() with the desired settings:

[C example ellipted]

<note>The fogging functions only work correctly when the visible actors use unmultiplied alpha colors. By default Cogl will premultiply textures and cogl_set_source_color() will premultiply colors, so unless you explicitly load your textures requesting an unmultiplied internal format and use cogl_material_set_color() you can only use fogging with fully opaque actors. Support for premultiplied colors will improve in the future when we can depend on fragment shaders.</note>

Since cluttermm 0.6:

Deprecated: 1.10: Fog settings are ignored.

Deprecated:
Fog settings are ignored.
Parameters
fogA Clutter::Fog structure.
void Clutter::Stage::set_fullscreen ( bool  fullscreen = true)

Asks to place the stage window in the fullscreen or unfullscreen states.

( Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows.

If you want to receive notification of the fullscreen state you should either use the Clutter::Stage::signal_fullscreen() and Clutter::Stage::signal_unfullscreen() signals, or use the notify signal for the Clutter::Stage::property_fullscreen_set() property

Since cluttermm 1.0:
Parameters
fullscreentrue to to set the stage fullscreen.
void Clutter::Stage::set_key_focus ( const Glib::RefPtr< Actor >&  actor)

Sets the key focus on actor.

An actor with key focus will receive all the key events. If actor is 0, the stage will receive focus.

Since cluttermm 0.6:
Parameters
actorThe actor to set key focus to, or 0.
void Clutter::Stage::set_key_focus ( )
void Clutter::Stage::set_minimum_size ( guint  width,
guint  height 
)

Sets the minimum size for a stage window, if the default backend uses Clutter::Stage inside a window.

This is a convenience function, and it is equivalent to setting the Clutter::Actor::property_min_width() and Clutter::Actor::property_min_height() on stage

If the current size of stage is smaller than the minimum size, the stage will be resized to the new width and height

This function has no effect if stage is fullscreen

Since cluttermm 1.2:
Parameters
widthWidth, in pixels.
heightHeight, in pixels.
void Clutter::Stage::set_motion_events_enabled ( bool  enabled = true)

Sets whether per-actor motion events (and relative crossing events) should be disabled or not.

The default is true.

If enable is false the following events will not be delivered to the actors children of stage.

The events will still be delivered to the Clutter::Stage.

The main side effect of this function is that disabling the motion events will disable picking to detect the Clutter::Actor underneath the pointer for each motion event. This is useful, for instance, when dragging a Clutter::Actor across the stage: the actor underneath the pointer is not going to change, so it's meaningless to perform a pick.

Since cluttermm 1.8:
Parameters
enabledtrue to enable the motion events delivery, and false otherwise.
void Clutter::Stage::set_no_clear_hint ( bool  no_clear = true)

Sets whether the stage should clear itself at the beginning of each paint cycle or not.

Clearing the Clutter::Stage can be a costly operation, especially if the stage is always covered - for instance, in a full-screen video player or in a game with a background texture.

<note>This setting is a hint; Clutter might discard this hint depending on its internal state.</note>

<warning>If parts of the stage are visible and you disable clearing you might end up with visual artifacts while painting the contents of the stage.</warning>

Since cluttermm 1.4:
Parameters
no_cleartrue if the stage should not clear itself on every repaint cycle.
void Clutter::Stage::set_perspective ( const Perspective prespective)

Sets the stage perspective.

Using this function is not recommended because it will disable Clutter's attempts to generate an appropriate perspective based on the size of the stage.

Parameters
perspectiveA Clutter::Perspective.
void Clutter::Stage::set_throttle_motion_events ( bool  throttle = true)

Sets whether motion events received between redraws should be throttled or not.

If motion events are throttled, those events received by the windowing system between redraws will be compressed so that only the last event will be propagated to the stage and its actors.

This function should only be used if you want to have all the motion events delivered to your application code.

Since cluttermm 1.0:
Parameters
throttletrue to throttle motion events.
void Clutter::Stage::set_title ( const Glib::ustring title)

Sets the stage title.

Since cluttermm 0.4:
Parameters
titleA utf8 string for the stage windows title.
void Clutter::Stage::set_use_alpha ( bool  use_alpha = true)

Sets whether the stage should honour the Clutter::Actor::property_opacity() and the alpha channel of the Clutter::Stage::property_color()

Since cluttermm 1.2:
Parameters
use_alphaWhether the stage should honour the opacity or the alpha channel of the stage color.
void Clutter::Stage::set_use_fog ( bool  fog = true)

Sets whether the depth cueing effect on the stage should be enabled or not.

Depth cueing is a 3D effect that makes actors farther away from the viewing point less opaque, by fading them with the stage color.

The parameters of the GL fog used can be changed using the set_fog() function.

Since cluttermm 0.6:

Deprecated: 1.10: Calling this function produces no visible effect

Deprecated:
This method has no visible effect.
Parameters
fogtrue for enabling the depth cueing effect.
void Clutter::Stage::set_user_resizable ( bool  value = true)

Sets if the stage is resizable by user interaction (e.g. via window manager controls)

Since cluttermm 0.4:
Parameters
resizableWhether the stage should be user resizable.
void Clutter::Stage::show_cursor ( )

Shows the cursor on the stage window.

Glib::SignalProxy0< void > Clutter::Stage::signal_activate ( )
Slot Prototype:
void on_my_activate()

The signal_activate() signal is emitted when the stage receives key focus from the underlying window system.

Since cluttermm 0.6:
Glib::SignalProxy0< void > Clutter::Stage::signal_deactivate ( )
Slot Prototype:
void on_my_deactivate()

The signal_activate() signal is emitted when the stage loses key focus from the underlying window system.

Since cluttermm 0.6:
Glib::SignalProxy1< bool,ClutterEvent * > Clutter::Stage::signal_delete_event ( )
Slot Prototype:
bool on_my_delete_event(ClutterEvent * event)

The signal_delete_event() signal is emitted when the user closes a Clutter::Stage window using the window controls.

Clutter by default will call clutter_main_quit() if stage is the default stage, and Clutter::Actor::destroy() for any other stage.

It is possible to override the default behaviour by connecting a new handler and returning true there.

<note>This signal is emitted only on Clutter backends that embed Clutter::Stage in native windows. It is not emitted for backends that use a static frame buffer.</note>

Since cluttermm 1.2:
Parameters
eventA Clutter::Event of type Clutter::DELETE.
Glib::SignalProxy0< void > Clutter::Stage::signal_fullscreen ( )
Slot Prototype:
void on_my_fullscreen()

The signal_fullscreen() signal is emitted when the stage is made fullscreen.

Since cluttermm 0.6:
Glib::SignalProxy0< void > Clutter::Stage::signal_unfullscreen ( )
Slot Prototype:
void on_my_unfullscreen()

The signal_unfullscreen() signal is emitted when the stage leaves a fullscreen state.

Since cluttermm 0.6:
void Clutter::Stage::stage_event ( Event event)

This function is used to emit an event on the main stage.

You should rarely need to use this function, except for synthetised events.

Since cluttermm 0.4:
Parameters
eventA Clutter::Event.
Returns
The return value from the signal emission.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::Stage > wrap ( ClutterStage *  object,
bool  take_copy = false 
)
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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/stage.h