cluttermm  1.17.3
New API in cluttermm 1.10
Member Clutter::Actor::add_child (const Glib::RefPtr< Actor >& child)
Parameters
childA Clutter::Actor.
Member Clutter::Actor::add_transition (const Glib::ustring& name, const Glib::RefPtr< Transition >& transition)
Parameters
nameThe name of the transition to add.
transitionThe Clutter::Transition to add.
Member Clutter::Actor::get_child_at_index (int index)
Parameters
indexThe position in the list of children.
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_child_at_index (int index) const
Parameters
indexThe position in the list of children.
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_children ()
Returns
A newly allocated List of Clutter::Actors. Use Glib::list_free() when done.
Member Clutter::Actor::get_children () const
Returns
A newly allocated List of Clutter::Actors. Use Glib::list_free() when done.
Member Clutter::Actor::get_content ()
Returns
A pointer to the Clutter::Content instance, or 0 if none was set.
Member Clutter::Actor::get_content () const
Returns
A pointer to the Clutter::Content instance, or 0 if none was set.
Member Clutter::Actor::get_content_gravity () const
Returns
The content gravity.
Member Clutter::Actor::get_content_scaling_filters (ScalingFilter& min_filter, ScalingFilter& mag_filter)
Parameters
min_filterReturn location for the minification filter, or 0.
mag_filterReturn location for the magnification filter, or 0.
Member Clutter::Actor::get_default_paint_volume () const
Returns
A pointer to the default Clutter::PaintVolume, relative to the Clutter::Actor, or 0 if the actor could not compute a valid paint volume. The returned value is not guaranteed to be stable across multiple frames, so if you want to retain it, you will need to copy it using clutter_paint_volume_copy().
Member Clutter::Actor::get_easing_delay () const
Returns
A delay, in milliseconds.
Member Clutter::Actor::get_easing_duration () const
Returns
The duration of the tweening, in milliseconds.
Member Clutter::Actor::get_easing_mode () const
Returns
An easing mode.
Member Clutter::Actor::get_first_child ()
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_first_child () const
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_last_child () const
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_last_child ()
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_layout_manager () const
Returns
A pointer to the Clutter::LayoutManager, or 0.
Member Clutter::Actor::get_layout_manager ()
Returns
A pointer to the Clutter::LayoutManager, or 0.
Member Clutter::Actor::get_margin_bottom () const
Returns
The bottom margin.
Member Clutter::Actor::get_margin_left () const
Returns
The left margin.
Member Clutter::Actor::get_margin_right () const
Returns
The right margin.
Member Clutter::Actor::get_margin_top () const
Returns
The top margin.
Member Clutter::Actor::get_n_children () const
Returns
The number of children of an actor.
Member Clutter::Actor::get_next_sibling ()
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_next_sibling () const
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_previous_sibling ()
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_previous_sibling () const
Returns
A pointer to a Clutter::Actor, or 0.
Member Clutter::Actor::get_transition (const Glib::ustring& name)
Parameters
nameThe name of the transition.
Returns
A Clutter::Transition, or 0 is none was found to match the passed name; the returned instance is owned by Clutter and it should not be freed.
Member Clutter::Actor::get_transition (const Glib::ustring& name) const
Parameters
nameThe name of the transition.
Returns
A Clutter::Transition, or 0 is none was found to match the passed name; the returned instance is owned by Clutter and it should not be freed.
Member Clutter::Actor::get_x_align () const
Returns
The horizontal alignment policy.
Member Clutter::Actor::get_y_align () const
Returns
The vertical alignment policy.
Member Clutter::Actor::has_actions () const
Returns
true if the actor has any actions, false otherwise.
Member Clutter::Actor::has_constraints () const
Returns
true if the actor has any constraints, false otherwise.
Member Clutter::Actor::has_effects () const
Returns
true if the actor has any effects, false otherwise.
Member Clutter::Actor::insert_child_above (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
Parameters
childA Clutter::Actor.
siblingA child of self, or 0.
Member Clutter::Actor::insert_child_at_index (const Glib::RefPtr< Actor >& child, int index)
Parameters
childA Clutter::Actor.
indexThe index.
Member Clutter::Actor::insert_child_below (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
Parameters
childA Clutter::Actor.
siblingA child of self, or 0.
Member Clutter::Actor::remove_all_children ()
Member Clutter::Actor::remove_all_transitions ()
Member Clutter::Actor::remove_child (const Glib::RefPtr< Actor >& child)
Parameters
childA Clutter::Actor.
Member Clutter::Actor::remove_transition (const Glib::ustring& name)
Parameters
nameThe name of the transition to remove.
Member Clutter::Actor::replace_child (const Glib::RefPtr< Actor >& old_child, const Glib::RefPtr< Actor >& new_child)
Parameters
old_childThe child of self to replace.
new_childThe Clutter::Actor to replace old_child.
Member Clutter::Actor::restore_easing_state ()
Member Clutter::Actor::save_easing_state ()
Member Clutter::Actor::set_allocation (const ActorBox& box, AllocationFlags flags)
Parameters
boxA Clutter::ActorBox.
flagsAllocation flags.
Member Clutter::Actor::set_background_color (const Color& color)
Parameters
colorA Clutter::Color, or 0 to unset a previously set color.
Member Clutter::Actor::set_child_above_sibling (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
Parameters
childA Clutter::Actor child of self.
siblingA Clutter::Actor child of self, or 0.
Member Clutter::Actor::set_child_at_index (const Glib::RefPtr< Actor >& child, int index)
Parameters
childA Clutter::Actor child of self.
indexThe new index for child.
Member Clutter::Actor::set_child_below_sibling (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling)
Parameters
childA Clutter::Actor child of self.
siblingA Clutter::Actor child of self, or 0.
Member Clutter::Actor::set_content (const Glib::RefPtr< Content >& content)
Parameters
contentA Clutter::Content, or 0.
Member Clutter::Actor::set_content_gravity (ContentGravity gravity)
Parameters
gravityThe Clutter::ContentGravity.
Member Clutter::Actor::set_content_scaling_filters (ScalingFilter min_filter, ScalingFilter mag_filter)
Parameters
min_filterThe minification filter for the content.
mag_filterThe magnification filter for the content.
Member Clutter::Actor::set_easing_delay (guint msecs)
Parameters
msecsThe delay before the start of the tweening, in milliseconds.
Member Clutter::Actor::set_easing_duration (guint msecs)
Parameters
msecsThe duration of the easing, or 0.
Member Clutter::Actor::set_easing_mode (AnimationMode mode)
Parameters
modeAn easing mode, excluding Clutter::CUSTOM_MODE.
Member Clutter::Actor::set_layout_manager (const Glib::RefPtr< LayoutManager >& manager)
Parameters
managerA Clutter::LayoutManager, or 0 to unset it.
Member Clutter::Actor::set_margin_bottom (float margin)
Parameters
marginThe bottom margin.
Member Clutter::Actor::set_margin_left (float margin)
Parameters
marginThe left margin.
Member Clutter::Actor::set_margin_right (float margin)
Parameters
marginThe right margin.
Member Clutter::Actor::set_margin_top (float margin)
Parameters
marginThe top margin.
Member Clutter::Actor::set_x_align (ActorAlign x_align)
Parameters
x_alignThe horizontal alignment policy.
Member Clutter::Actor::set_y_align (ActorAlign y_align)
Parameters
y_alignThe vertical alignment policy.
Member Clutter::Actor::signal_transitions_completed ()
Member Clutter::BrightnessContrastEffect::get_brightness (float& red, float& green, float& blue) const
Parameters
redReturn location for red component of the change in brightness.
greenReturn location for green component of the change in brightness.
blueReturn location for blue component of the change in brightness.
Member Clutter::BrightnessContrastEffect::get_contrast (float& red, float& green, float& blue) const
Parameters
redReturn location for red component of the change in contrast.
greenReturn location for green component of the change in contrast.
blueReturn location for blue component of the change in contrast.
Member Clutter::BrightnessContrastEffect::set_brightness (float brightness)
Parameters
brightnessThe brightness change for all three components (r, g, b).
Member Clutter::BrightnessContrastEffect::set_brightness (float red, float green, float blue)
Parameters
redRed component of the change in brightness.
greenGreen component of the change in brightness.
blueBlue component of the change in brightness.
Member Clutter::BrightnessContrastEffect::set_contrast (float red, float green, float blue)
Parameters
redRed component of the change in contrast.
greenGreen component of the change in contrast.
blueBlue component of the change in contrast.
Member Clutter::BrightnessContrastEffect::set_contrast (float contrast)
Parameters
contrastContrast change for all three channels.
Member Clutter::Canvas::set_size (int width, int height)
Parameters
widthThe width of the canvas, in pixels.
heightThe height of the canvas, in pixels.
Returns
This function returns true if the size change caused a content invalidation, and false otherwise.
Member Clutter::Canvas::signal_draw ()
Parameters
crThe Cairo context used to draw.
widthThe width of the canvas.
heightThe height of the canvas.
Returns
true if the signal emission should stop, and false otherwise.
Member Clutter::Content::get_preferred_size (float& width, float& height) const
Parameters
widthReturn location for the natural width of the content.
heightReturn location for the natural height of the content.
Returns
true if the content has a preferred size, and false otherwise.
Member Clutter::Content::invalidate ()
Member Clutter::Image::set (const guint8* data, CoglPixelFormat pixel_format, guint width, guint height, guint row_stride)
Parameters
dataThe image data, as an array of bytes.
pixel_formatThe Cogl pixel format of the image data.
widthThe width of the image data.
heightThe height of the image data.
row_strideThe length of each row inside data.
Returns
true if the image data was successfully loaded, and false otherwise.
Member Clutter::InputDevice::grab (const Glib::RefPtr< const Actor >& actor)
Parameters
actorA Clutter::Actor.
Member Clutter::InputDevice::keycode_to_evdev (guint hardware_keycode, guint& evdev_keycode) const
Parameters
hardware_keycodeThe hardware keycode from a Clutter::KeyEvent.
evdev_keycodeThe return location for the evdev keycode.
Returns
true if the conversion succeeded, false otherwise.
Member Clutter::InputDevice::ungrab ()
Member Clutter::OffscreenEffect::get_texture ()
Returns
A Cogl::Handle or Cogl::INVALID_HANDLE. The returned texture is owned by Clutter and it should not be modified or freed.
Member Clutter::PropertyTransition::get_property_name () const
Returns
The name of the property being animated, or 0 if none is set. The returned string is owned by the transition and it should not be freed.
Member Clutter::PropertyTransition::set_property_name (const Glib::ustring& property_name)
Parameters
property_nameA property name.
Member Clutter::Script::get_translation_domain () const
Returns
The translation domain, if any is set, or 0.
Member Clutter::Script::load_from_resource (const std::string& resource_path)
Parameters
resource_pathThe resource path of the file to parse.
Returns
On error, zero is returned and error is set accordingly. On success, the merge id for the UI definitions is returned. You can use the merge id with unmerge_objects().
Member Clutter::Script::set_translation_domain (const Glib::ustring& domain)
Parameters
domainThe translation domain, or 0.
Member Clutter::Text::coords_to_position (float x, float y)
Parameters
xThe X coordinate, relative to the actor.
yThe Y coordinate, relative to the actor.
Member Clutter::Text::get_buffer ()
Returns
A Gtk::EntryBuffer object.
Member Clutter::Text::get_buffer () const
Returns
A Gtk::EntryBuffer object.
Member Clutter::Text::set_buffer (const Glib::RefPtr< TextBuffer >& buffer)
Parameters
bufferA Clutter::TextBuffer.
Member Clutter::TextBuffer::delete_text (guint position, int n_chars)
Parameters
positionPosition at which to delete text.
n_charsNumber of characters to delete.
Returns
The number of characters deleted.
Member Clutter::TextBuffer::emit_deleted_text (guint position, guint n_chars)
Parameters
positionPosition at which text was deleted.
n_charsNumber of characters deleted.
Member Clutter::TextBuffer::emit_inserted_text (guint position, const Glib::ustring& chars, guint n_chars)
Parameters
positionPosition at which text was inserted.
charsText that was inserted.
n_charsNumber of characters inserted.
Member Clutter::TextBuffer::get_bytes () const
Returns
The byte length of the buffer.
Member Clutter::TextBuffer::get_length () const
Returns
The number of characters in the buffer.
Member Clutter::TextBuffer::get_max_length () const
Returns
The maximum allowed number of characters in Clutter::TextBuffer, or 0 if there is no maximum.
Member Clutter::TextBuffer::get_text () const
Returns
A pointer to the contents of the widget as a string. This string points to internally allocated storage in the buffer and must not be freed, modified or stored.
Member Clutter::TextBuffer::insert_text (guint position, const Glib::ustring& chars, int n_chars)
Parameters
positionThe position at which to insert text.
charsThe text to insert into the buffer.
n_charsThe length of the text in characters, or -1.
Returns
The number of characters actually inserted.
Member Clutter::TextBuffer::set_max_length (int max_length)
Parameters
max_lengthThe maximum length of the entry buffer, or 0 for no maximum. (other than the maximum length of entries.) The value passed in will be clamped to the range [ 0, Clutter::TEXT_BUFFER_MAX_SIZE ].
Member Clutter::TextBuffer::signal_deleted_text ()
Parameters
positionThe position the text was deleted at.
n_charsThe number of characters that were deleted.
Member Clutter::TextBuffer::signal_inserted_text ()
Parameters
positionThe position the text was inserted at.
charsThe text that was inserted.
n_charsThe number of characters that were inserted.
Member Clutter::TextBuffer::TextBuffer (const Glib::ustring& text)
Parameters
textInitial buffer text.
text_lenInitial buffer text length, or -1 for null-terminated.
Returns
A new ClutterTextBuffer object.
Member Clutter::Timeline::get_progress_mode () const
Returns
A Clutter::AnimationMode.
Member Clutter::Timeline::get_repeat_count () const
Returns
The number of repeats.
Member Clutter::Timeline::set_progress_mode (AnimationMode mode)
Parameters
modeThe progress mode, as a Clutter::AnimationMode.
Member Clutter::Timeline::set_repeat_count (int count)
Parameters
countThe number of times the timeline should repeat.
Member Clutter::Transition::get_animatable () const
Returns
A Clutter::Animatable, or 0; the returned animatable is owned by the Clutter::Transition, and it should not be freed directly.
Member Clutter::Transition::get_animatable ()
Returns
A Clutter::Animatable, or 0; the returned animatable is owned by the Clutter::Transition, and it should not be freed directly.
Member Clutter::Transition::get_interval ()
Returns
A Clutter::Interval, or 0; the returned interval is owned by the Clutter::Transition and it should not be freed directly.
Member Clutter::Transition::get_interval () const
Returns
A Clutter::Interval, or 0; the returned interval is owned by the Clutter::Transition and it should not be freed directly.
Member Clutter::Transition::get_remove_on_complete () const
Returns
true if the transition should be detached when complete, and false otherwise.
Member Clutter::Transition::set_animatable (const Glib::RefPtr< Animatable >& animatable)
Parameters
animatableA Clutter::Animatable, or 0.
Member Clutter::Transition::set_interval (const Glib::RefPtr< Interval >& interval)
Parameters
intervalA Clutter::Interval, or 0.
Member Clutter::Transition::set_remove_on_complete (bool remove_complete=true)
Parameters
remove_completeWhether to detach transition when complete.