cluttermm: Clutter::Text Class Reference
Public Member Functions | |
virtual | ~Text () |
ClutterText* | gobj () |
Provides access to the underlying C GObject. More... | |
const ClutterText* | gobj () const |
Provides access to the underlying C GObject. More... | |
ClutterText* | 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_buffer (const Glib::RefPtr< TextBuffer >& buffer) |
Set the Clutter::TextBuffer object which holds the text for this widget. More... | |
Glib::RefPtr< TextBuffer > | get_buffer () |
Get the Clutter::TextBuffer object which holds the text for this widget. More... | |
Glib::RefPtr< const TextBuffer > | get_buffer () const |
Get the Clutter::TextBuffer object which holds the text for this widget. More... | |
void | set_text (const Glib::ustring& text) |
Sets the contents of a Clutter::Text actor. More... | |
void | set_markup (const Glib::ustring& markup) |
Sets markup as the contents of a Clutter::Text. More... | |
Glib::ustring | get_text () const |
Retrieves a pointer to the current contents of a Clutter::Text actor. More... | |
void | set_activatable (bool activatable=true) |
Sets whether a Clutter::Text actor should be activatable. More... | |
bool | get_activatable () const |
Retrieves whether a Clutter::Text is activatable or not. More... | |
void | set_attributes (Pango::AttrList& attrs) |
Sets the attributes list that are going to be applied to the Clutter::Text contents. More... | |
Pango::AttrList | get_attributes () const |
Gets the attribute list that was set on the Clutter::Text actor set_attributes(), if any. More... | |
void | set_color (const Color& color) |
Sets the color of the contents of a Clutter::Text actor. More... | |
Color | get_color () const |
Retrieves the text color as set by set_color(). More... | |
void | set_ellipsize (Pango::EllipsizeMode mode) |
Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire contents of a Clutter::Text actor. More... | |
Pango::EllipsizeMode | get_ellipsize () const |
Returns the ellipsizing position of a Clutter::Text actor, as set by set_ellipsize(). More... | |
void | set_font_name (const Glib::ustring& font_name) |
Sets the font used by a Clutter::Text. More... | |
Glib::ustring | get_font_name () const |
Retrieves the font name as set by set_font_name(). More... | |
void | set_font_description (const Pango::FontDescription& font_desc) |
Sets font_desc as the font description for a Clutter::Text. More... | |
Pango::FontDescription | get_font_description () const |
Retrieves the Pango::FontDescription used by self. More... | |
void | set_password_char (gunichar wc) |
Sets the character to use in place of the actual text in a password text actor. More... | |
gunichar | get_password_char () const |
Retrieves the character to use in place of the actual text as set by set_password_char(). More... | |
void | set_justify (bool justify=true) |
Sets whether the text of the Clutter::Text actor should be justified on both margins. More... | |
bool | get_justify () const |
Retrieves whether the Clutter::Text actor should justify its contents on both margins. More... | |
Glib::RefPtr< Pango::Layout > | get_layout () |
Retrieves the current Pango::Layout used by a Clutter::Text actor. More... | |
Glib::RefPtr< const Pango::Layout > | get_layout () const |
Retrieves the current Pango::Layout used by a Clutter::Text actor. More... | |
void | set_line_alignment (Pango::Alignment alignment) |
Sets the way that the lines of a wrapped label are aligned with respect to each other. More... | |
Pango::Alignment | get_line_alignment () const |
Retrieves the alignment of a Clutter::Text, as set by set_line_alignment(). More... | |
void | set_line_wrap (bool line_wrap=true) |
Sets whether the contents of a Clutter::Text actor should wrap, if they don't fit the size assigned to the actor. More... | |
bool | get_line_wrap () const |
Retrieves the value set using set_line_wrap(). More... | |
Pango::WrapMode | get_line_wrap_mode () const |
Retrieves the line wrap mode used by the Clutter::Text actor. More... | |
void | set_line_wrap_mode (Pango::WrapMode wrap_mode) |
If line wrapping is enabled (see set_line_wrap()) this function controls how the line wrapping is performed. More... | |
int | get_max_length () const |
Gets the maximum length of text that can be set into a text actor. More... | |
void | set_max_length (int max_length) |
Sets the maximum allowed length of the contents of the actor. More... | |
void | set_selectable (bool selectable=true) |
Sets whether a Clutter::Text actor should be selectable. More... | |
bool | get_selectable () const |
Retrieves whether a Clutter::Text is selectable or not. More... | |
void | set_selection (gssize start_pos, gssize end_pos) |
Selects the region of text between start_pos and end_pos. More... | |
Glib::ustring | get_selection () const |
Retrieves the currently selected text. More... | |
void | set_selection_bound (int selection_bound) |
Sets the other end of the selection, starting from the current cursor position. More... | |
int | get_selection_bound () const |
Retrieves the other end of the selection of a Clutter::Text actor, in characters from the current cursor position. More... | |
void | set_selection_color (const Color& color) |
Sets the color of the selection of a Clutter::Text actor. More... | |
Color | get_selection_color () const |
Retrieves the color of the selection of a Clutter::Text actor. More... | |
void | set_single_line_mode (bool single_line=true) |
Sets whether a Clutter::Text actor should be in single line mode or not. More... | |
bool | get_single_line_mode () const |
Retrieves whether the Clutter::Text actor is in single line mode. More... | |
Color | get_selected_text_color () const |
Retrieves the color of selected text of a Clutter::Text actor. More... | |
void | set_use_markup (bool setting=true) |
Sets whether the contents of the Clutter::Text actor contains markup in Pango's text markup language. More... | |
bool | get_use_markup () const |
Retrieves whether the contents of the Clutter::Text actor should be parsed for the Pango text markup. More... | |
void | set_editable (bool editable=true) |
Sets whether the Clutter::Text actor should be editable. More... | |
bool | get_editable () const |
Retrieves whether a Clutter::Text is editable or not. More... | |
void | insert (gunichar wc) |
Inserts wc at the current cursor position of a Clutter::Text actor. More... | |
void | insert (const Glib::ustring& text, gssize position) |
Inserts text into a Clutter::Actor at the given position. More... | |
void | delete_chars (guint len) |
Deletes n_chars inside a Clutter::Text actor, starting from the current cursor position. More... | |
void | delete_text (gssize start_pos, gssize end_pos) |
Deletes the text inside a Clutter::Text actor between start_pos and end_pos. More... | |
bool | delete_selection () |
Deletes the currently selected text. More... | |
Glib::ustring | get_chars (gssize start_pos, gssize end_pos) const |
Retrieves the contents of the Clutter::Text actor between start_pos and end_pos, but not including end_pos. More... | |
void | set_cursor_color (const Color& color) |
Sets the color of the cursor of a Clutter::Text actor. More... | |
Color | get_cursor_color () const |
Retrieves the color. More... | |
void | set_cursor_position (int position) |
Sets the cursor of a Clutter::Text actor at position. More... | |
int | get_cursor_position () const |
Retrieves the cursor position. More... | |
void | set_cursor_visible (bool visible) |
Sets whether the cursor of a Clutter::Text actor should be visible or not. More... | |
bool | get_cursor_visible () const |
Retrieves whether the cursor of a Clutter::Text actor is visible. More... | |
void | set_cursor_size (int size) |
Sets the size of the cursor of a Clutter::Text. More... | |
guint | get_cursor_size () const |
Retrieves the size of the cursor of a Clutter::Text actor. More... | |
Rect | get_cursor_rect () const |
bool | activate () |
Emits the Clutter::Text::signal_activate() signal, if self has been set as activatable using set_activatable(). More... | |
int | coords_to_position (float x, float y) |
Retrieves the position of the character at the given coordinates. More... | |
bool | position_to_coords (int position, float& x, float& y, float& line_height) |
Retrieves the coordinates of the given position. More... | |
void | set_preedit_string (const Glib::ustring& preedit_str, const Pango::AttrList& preedit_attrs, guint ursor_pos) |
Sets, or unsets, the pre-edit string. More... | |
void | get_layout_offsets (int& x, int& y) |
Obtains the coordinates where the Clutter::Text will draw the Pango::Layout representing the text. More... | |
Glib::SignalProxy0< void > | signal_activate () |
Glib::SignalProxy0< void > | signal_text_changed () |
Glib::SignalProxy0< void > | signal_cursor_changed () |
Glib::PropertyProxy< bool > | property_activatable () |
Whether pressing return causes the activate signal to be emitted. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_activatable () const |
Whether pressing return causes the activate signal to be emitted. More... | |
Glib::PropertyProxy < Pango::AttrList > | property_attributes () |
A list of style attributes to apply to the contents of the actor. More... | |
Glib::PropertyProxy_ReadOnly < Pango::AttrList > | property_attributes () const |
A list of style attributes to apply to the contents of the actor. More... | |
Glib::PropertyProxy < Glib::RefPtr< TextBuffer > > | property_buffer () |
The buffer for the text. More... | |
Glib::PropertyProxy_ReadOnly < Glib::RefPtr< TextBuffer > > | property_buffer () const |
The buffer for the text. More... | |
Glib::PropertyProxy< Color > | property_color () |
Color of the font used by the text. More... | |
Glib::PropertyProxy_ReadOnly < Color > | property_color () const |
Color of the font used by the text. More... | |
Glib::PropertyProxy< Color > | property_cursor_color () |
Cursor Color. More... | |
Glib::PropertyProxy_ReadOnly < Color > | property_cursor_color () const |
Cursor Color. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_cursor_color_set () const |
Whether the cursor color has been set. More... | |
Glib::PropertyProxy< guint > | property_cursor_position () |
The cursor position. More... | |
Glib::PropertyProxy_ReadOnly < guint > | property_cursor_position () const |
The cursor position. More... | |
Glib::PropertyProxy< int > | property_cursor_size () |
The width of the cursor, in pixels. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_cursor_size () const |
The width of the cursor, in pixels. More... | |
Glib::PropertyProxy< bool > | property_cursor_visible () |
Whether the input cursor is visible. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_cursor_visible () const |
Whether the input cursor is visible. More... | |
Glib::PropertyProxy< bool > | property_editable () |
Whether the text is editable. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_editable () const |
Whether the text is editable. More... | |
Glib::PropertyProxy < Pango::EllipsizeMode > | property_ellipsize () |
The preferred place to ellipsize the string. More... | |
Glib::PropertyProxy_ReadOnly < Pango::EllipsizeMode > | property_ellipsize () const |
The preferred place to ellipsize the string. More... | |
Glib::PropertyProxy < Pango::FontDescription > | property_font_description () |
The font description to be used. More... | |
Glib::PropertyProxy_ReadOnly < Pango::FontDescription > | property_font_description () const |
The font description to be used. More... | |
Glib::PropertyProxy < Glib::ustring > | property_font_name () |
The font to be used by the text. More... | |
Glib::PropertyProxy_ReadOnly < Glib::ustring > | property_font_name () const |
The font to be used by the text. More... | |
Glib::PropertyProxy< bool > | property_justify () |
Whether the text should be justified. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_justify () const |
Whether the text should be justified. More... | |
Glib::PropertyProxy < Pango::Alignment > | property_line_alignment () |
The preferred alignment for the string, for multi-line text. More... | |
Glib::PropertyProxy_ReadOnly < Pango::Alignment > | property_line_alignment () const |
The preferred alignment for the string, for multi-line text. More... | |
Glib::PropertyProxy < Pango::WrapMode > | property_line_wrap_mode () |
Control how line-wrapping is done. More... | |
Glib::PropertyProxy_ReadOnly < Pango::WrapMode > | property_line_wrap_mode () const |
Control how line-wrapping is done. More... | |
Glib::PropertyProxy< bool > | property_line_wrap () |
If set, wrap the lines if the text becomes too wide. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_line_wrap () const |
If set, wrap the lines if the text becomes too wide. More... | |
Glib::PropertyProxy< int > | property_max_length () |
Maximum length of the text inside the actor. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_max_length () const |
Maximum length of the text inside the actor. More... | |
Glib::PropertyProxy< gunichar > | property_password_char () |
If non-zero, use this character to display the actor's contents. More... | |
Glib::PropertyProxy_ReadOnly < gunichar > | property_password_char () const |
If non-zero, use this character to display the actor's contents. More... | |
Glib::PropertyProxy< int > | property_position () |
The cursor position. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_position () const |
The cursor position. More... | |
Glib::PropertyProxy< bool > | property_selectable () |
Whether the text is selectable. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_selectable () const |
Whether the text is selectable. More... | |
Glib::PropertyProxy< Color > | property_selected_text_color () |
Selected Text Color. More... | |
Glib::PropertyProxy_ReadOnly < Color > | property_selected_text_color () const |
Selected Text Color. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_selected_text_color_set () const |
Whether the selected text color has been set. More... | |
Glib::PropertyProxy< int > | property_selection_bound () |
The cursor position of the other end of the selection. More... | |
Glib::PropertyProxy_ReadOnly< int > | property_selection_bound () const |
The cursor position of the other end of the selection. More... | |
Glib::PropertyProxy< Color > | property_selection_color () |
Selection Color. More... | |
Glib::PropertyProxy_ReadOnly < Color > | property_selection_color () const |
Selection Color. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_selection_color_set () const |
Whether the selection color has been set. More... | |
Glib::PropertyProxy< bool > | property_single_line_mode () |
Whether the text should be a single line. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_single_line_mode () const |
Whether the text should be a single line. More... | |
Glib::PropertyProxy < Glib::ustring > | property_text () |
The text to render. More... | |
Glib::PropertyProxy_ReadOnly < Glib::ustring > | property_text () const |
The text to render. More... | |
Glib::PropertyProxy< bool > | property_use_markup () |
Whether or not the text includes Pango markup. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_use_markup () const |
Whether or not the text includes Pango markup. 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< Content > | get_content () |
Retrieves the contents of self. More... | |
Glib::RefPtr< const Content > | get_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< Actor > | get_stage () |
Retrieves the Clutter::Stage where actor is contained. More... | |
Glib::RefPtr< const Actor > | get_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< LayoutManager > | get_layout_manager () |
Retrieves the Clutter::LayoutManager used by self. More... | |
Glib::RefPtr< const LayoutManager > | get_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 PaintVolume* | get_paint_volume () const |
Retrieves the paint volume of the passed Clutter::Actor, or 0 when a paint volume can't be determined. More... | |
const PaintVolume* | get_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 PaintVolume* | get_transformed_paint_volume () const |
A get_transformed_paint_volume() convenience overload. More... | |
const PaintVolume* | get_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< Actor > | get_child_at_index (int index) |
Retrieves the actor at the given index inside the list of children of self. More... | |
Glib::RefPtr< const Actor > | get_child_at_index (int index) const |
Retrieves the actor at the given index inside the list of children of self. More... | |
Glib::RefPtr< Actor > | get_previous_sibling () |
Retrieves the sibling of self that comes before it in the list of children of self's parent. More... | |
Glib::RefPtr< const Actor > | get_previous_sibling () const |
Retrieves the sibling of self that comes before it in the list of children of self's parent. More... | |
Glib::RefPtr< Actor > | get_next_sibling () |
Retrieves the sibling of self that comes after it in the list of children of self's parent. More... | |
Glib::RefPtr< const Actor > | get_next_sibling () const |
Retrieves the sibling of self that comes after it in the list of children of self's parent. More... | |
Glib::RefPtr< Actor > | get_first_child () |
Retrieves the first child of self. More... | |
Glib::RefPtr< const Actor > | get_first_child () const |
Retrieves the first child of self. More... | |
Glib::RefPtr< Actor > | get_last_child () |
Retrieves the last child of self. More... | |
Glib::RefPtr< const Actor > | get_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< Actor > | get_parent () |
Retrieves the parent of self. More... | |
Glib::RefPtr< const Actor > | get_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< Shader > | get_shader () |
Queries the currently set Clutter::Shader on self. More... | |
Glib::RefPtr< const Shader > | get_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< Animation > | get_animation () |
Retrieves the Clutter::Animation used by actor, if animate() has been called on actor. More... | |
Glib::RefPtr< const Animation > | get_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< Action > | get_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 Action > | get_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< Effect > | get_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 Effect > | get_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< Transition > | get_transition (const Glib::ustring& name) |
Retrieves the Clutter::Transition of a Clutter::Actor by using the transition name. More... | |
Glib::RefPtr< const Transition > | get_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 Constraint > | get_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< Constraint > | get_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< Gravity > | property_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< Color > | property_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< Matrix > | property_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< Geometry > | property_clip () |
The clip region for the actor. More... | |
Glib::PropertyProxy_ReadOnly < Geometry > | property_clip () const |
The clip region for the actor. More... | |
Glib::PropertyProxy< Rect > | property_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< Content > | property_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< Point > | property_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< Point > | property_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< RequestMode > | property_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< Vertex > | property_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< Vertex > | property_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< Vertex > | property_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< Gravity > | property_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< Gravity > | property_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< Matrix > | property_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< ActorAlign > | property_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< ActorAlign > | property_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) |
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< Text > | create () |
static Glib::RefPtr< Text > | create (const Glib::ustring& font_name, const Glib::ustring& text) |
static Glib::RefPtr< Text > | create (const Glib::ustring& font_name, const Glib::ustring& text, const Color& color) |
static Glib::RefPtr< Text > | create (const Glib::RefPtr< TextBuffer >& buffer) |
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< Actor > | create () |
static Glib::RefPtr< Actor > | get_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... | |
Protected Member Functions | |
Text () | |
Text (const Glib::ustring& font_name, const Glib::ustring& text) | |
Text (const Glib::ustring& font_name, const Glib::ustring& text, const Color& color) | |
Text (const Glib::RefPtr< TextBuffer >& buffer) | |
virtual void | on_activate () |
This is a default handler for the signal signal_activate(). More... | |
virtual void | on_text_changed () |
This is a default handler for the signal signal_text_changed(). More... | |
virtual void | on_cursor_changed () |
This is a default handler for the signal signal_cursor_changed(). More... | |
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) |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Clutter::Text > | wrap (ClutterText* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Clutter::Actor | |
Glib::RefPtr< Clutter::Actor > | wrap (ClutterActor* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Clutter::Scriptable | |
Glib::RefPtr< Clutter::Scriptable > | wrap (ClutterScriptable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Clutter::Animatable | |
Glib::RefPtr< Clutter::Animatable > | wrap (ClutterAnimatable* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Constructor & Destructor Documentation
|
virtual |
|
protected |
|
explicitprotected |
|
explicitprotected |
|
explicitprotected |
Member Function Documentation
bool Clutter::Text::activate | ( | ) |
Emits the Clutter::Text::signal_activate() signal, if self has been set as activatable using set_activatable().
This function can be used to emit the signal_activate() signal inside a Clutter::Actor::signal_captured_event() or Clutter::Actor::signal_key_press_event() signal handlers before the default signal handler for the Clutter::Text is invoked.
- Returns
true
if the signal_activate() signal has been emitted, andfalse
otherwise.
int Clutter::Text::coords_to_position | ( | float | x, |
float | y | ||
) |
Retrieves the position of the character at the given coordinates.
Return: the position of the character
- Parameters
-
x The X coordinate, relative to the actor. y The Y coordinate, relative to the actor.
|
static |
|
static |
|
static |
|
static |
void Clutter::Text::delete_chars | ( | guint | len) |
Deletes n_chars inside a Clutter::Text actor, starting from the current cursor position.
Somewhat awkwardly, the cursor position is decremented by the same number of characters you've deleted.
- Parameters
-
n_chars The number of characters to delete.
bool Clutter::Text::delete_selection | ( | ) |
Deletes the currently selected text.
This function is only useful in subclasses of Clutter::Text
- Returns
true
if text was deleted or if the text actor is empty, andfalse
otherwise.
void Clutter::Text::delete_text | ( | gssize | start_pos, |
gssize | end_pos | ||
) |
Deletes the text inside a Clutter::Text actor between start_pos and end_pos.
The starting and ending positions are expressed in characters, not in bytes.
- Parameters
-
start_pos Starting position. end_pos Ending position.
bool Clutter::Text::get_activatable | ( | ) | const |
Retrieves whether a Clutter::Text is activatable or not.
- Returns
true
if the actor is activatable.
Pango::AttrList Clutter::Text::get_attributes | ( | ) | const |
Gets the attribute list that was set on the Clutter::Text actor set_attributes(), if any.
- Returns
- The attribute list, or
0
if none was set. The returned value is owned by the Clutter::Text and should not be unreferenced.
Glib::RefPtr<TextBuffer> Clutter::Text::get_buffer | ( | ) |
Get the Clutter::TextBuffer object which holds the text for this widget.
- Returns
- A Gtk::EntryBuffer object.
Glib::RefPtr<const TextBuffer> Clutter::Text::get_buffer | ( | ) | const |
Get the Clutter::TextBuffer object which holds the text for this widget.
- Returns
- A Gtk::EntryBuffer object.
Glib::ustring Clutter::Text::get_chars | ( | gssize | start_pos, |
gssize | end_pos | ||
) | const |
Retrieves the contents of the Clutter::Text actor between start_pos and end_pos, but not including end_pos.
The positions are specified in characters, not in bytes.
- Parameters
-
start_pos Start of text, in characters. end_pos End of text, in characters.
- Returns
- A newly allocated string with the contents of the text actor between the specified positions. Use Glib::free() to free the resources when done.
Color Clutter::Text::get_color | ( | ) | const |
Retrieves the text color as set by set_color().
- Parameters
-
color Return location for a Clutter::Color.
Color Clutter::Text::get_cursor_color | ( | ) | const |
Retrieves the color.
int Clutter::Text::get_cursor_position | ( | ) | const |
Rect Clutter::Text::get_cursor_rect | ( | ) | const |
guint Clutter::Text::get_cursor_size | ( | ) | const |
Retrieves the size of the cursor of a Clutter::Text actor.
- Returns
- The size of the cursor, in pixels.
bool Clutter::Text::get_cursor_visible | ( | ) | const |
Retrieves whether the cursor of a Clutter::Text actor is visible.
- Returns
true
if the cursor is visible.
bool Clutter::Text::get_editable | ( | ) | const |
Retrieves whether a Clutter::Text is editable or not.
- Returns
true
if the actor is editable.
Pango::EllipsizeMode Clutter::Text::get_ellipsize | ( | ) | const |
Returns the ellipsizing position of a Clutter::Text actor, as set by set_ellipsize().
- Returns
- Pango::EllipsizeMode.
Pango::FontDescription Clutter::Text::get_font_description | ( | ) | const |
Retrieves the Pango::FontDescription used by self.
- Returns
- A Pango::FontDescription. The returned value is owned by the Clutter::Text actor and it should not be modified or freed.
Glib::ustring Clutter::Text::get_font_name | ( | ) | const |
Retrieves the font name as set by set_font_name().
- Returns
- A string containing the font name. The returned string is owned by the Clutter::Text actor and should not be modified or freed.
bool Clutter::Text::get_justify | ( | ) | const |
Retrieves whether the Clutter::Text actor should justify its contents on both margins.
- Returns
true
if the text should be justified.
Glib::RefPtr<Pango::Layout> Clutter::Text::get_layout | ( | ) |
Retrieves the current Pango::Layout used by a Clutter::Text actor.
- Returns
- A Pango::Layout. The returned object is owned by the Clutter::Text actor and should not be modified or freed.
Glib::RefPtr<const Pango::Layout> Clutter::Text::get_layout | ( | ) | const |
Retrieves the current Pango::Layout used by a Clutter::Text actor.
- Returns
- A Pango::Layout. The returned object is owned by the Clutter::Text actor and should not be modified or freed.
void Clutter::Text::get_layout_offsets | ( | int & | x, |
int & | y | ||
) |
Obtains the coordinates where the Clutter::Text will draw the Pango::Layout representing the text.
- Parameters
-
x Location to store X offset of layout, or 0
.y Location to store Y offset of layout, or 0
.
Pango::Alignment Clutter::Text::get_line_alignment | ( | ) | const |
Retrieves the alignment of a Clutter::Text, as set by set_line_alignment().
- Returns
- A Pango::Alignment.
bool Clutter::Text::get_line_wrap | ( | ) | const |
Retrieves the value set using set_line_wrap().
- Returns
true
if the Clutter::Text actor should wrap its contents.
Pango::WrapMode Clutter::Text::get_line_wrap_mode | ( | ) | const |
Retrieves the line wrap mode used by the Clutter::Text actor.
See set_line_wrap_mode().
- Returns
- The wrap mode used by the Clutter::Text.
int Clutter::Text::get_max_length | ( | ) | const |
Gets the maximum length of text that can be set into a text actor.
See set_max_length().
- Returns
- The maximum number of characters.
gunichar Clutter::Text::get_password_char | ( | ) | const |
Retrieves the character to use in place of the actual text as set by set_password_char().
- Returns
- A Unicode character or 0 if the password character is not set.
bool Clutter::Text::get_selectable | ( | ) | const |
Retrieves whether a Clutter::Text is selectable or not.
- Returns
true
if the actor is selectable.
Color Clutter::Text::get_selected_text_color | ( | ) | const |
Retrieves the color of selected text of a Clutter::Text actor.
- Parameters
-
color Return location for a Clutter::Color.
Glib::ustring Clutter::Text::get_selection | ( | ) | const |
Retrieves the currently selected text.
- Returns
- A newly allocated string containing the currently selected text, or
0
. Use Glib::free() to free the returned string.
int Clutter::Text::get_selection_bound | ( | ) | const |
Retrieves the other end of the selection of a Clutter::Text actor, in characters from the current cursor position.
- Returns
- The position of the other end of the selection.
Color Clutter::Text::get_selection_color | ( | ) | const |
Retrieves the color of the selection of a Clutter::Text actor.
- Parameters
-
color Return location for a Clutter::Color.
bool Clutter::Text::get_single_line_mode | ( | ) | const |
Retrieves whether the Clutter::Text actor is in single line mode.
- Returns
true
if the Clutter::Text actor is in single line mode.
Glib::ustring Clutter::Text::get_text | ( | ) | const |
Retrieves a pointer to the current contents of a Clutter::Text actor.
If you need a copy of the contents for manipulating, either use Glib::strdup() on the returned string, or use:
[C example ellipted]
Which will return a newly allocated string.
If the Clutter::Text actor is empty, this function will return an empty string, and not 0
.
- Returns
- The contents of the actor. The returned string is owned by the Clutter::Text actor and should never be modified or freed.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
bool Clutter::Text::get_use_markup | ( | ) | const |
Retrieves whether the contents of the Clutter::Text actor should be parsed for the Pango text markup.
- Returns
true
if the contents will be parsed for markup.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
ClutterText* Clutter::Text::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::Text::insert | ( | gunichar | wc) |
Inserts wc at the current cursor position of a Clutter::Text actor.
- Parameters
-
wc A Unicode character.
void Clutter::Text::insert | ( | const Glib::ustring & | text, |
gssize | position | ||
) |
Inserts text into a Clutter::Actor at the given position.
If position is a negative number, the text will be appended at the end of the current contents of the Clutter::Text.
The position is expressed in characters, not in bytes.
- Parameters
-
text The text to be inserted. position The position of the insertion, or -1.
|
protectedvirtual |
This is a default handler for the signal signal_activate().
|
protectedvirtual |
This is a default handler for the signal signal_cursor_changed().
|
protectedvirtual |
This is a default handler for the signal signal_text_changed().
bool Clutter::Text::position_to_coords | ( | int | position, |
float & | x, | ||
float & | y, | ||
float & | line_height | ||
) |
Retrieves the coordinates of the given position.
- Parameters
-
position Position in characters. x Return location for the X coordinate, or 0
.y Return location for the Y coordinate, or 0
.line_height Return location for the line height, or 0
.
- Returns
true
if the conversion was successful.
Glib::PropertyProxy< bool > Clutter::Text::property_activatable | ( | ) |
Whether pressing return causes the activate signal to be emitted.
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::Text::property_activatable | ( | ) | const |
Whether pressing return causes the activate signal to be emitted.
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< Pango::AttrList > Clutter::Text::property_attributes | ( | ) |
A list of style attributes to apply to the contents of the 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< Pango::AttrList > Clutter::Text::property_attributes | ( | ) | const |
A list of style attributes to apply to the contents of the 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< Glib::RefPtr<TextBuffer> > Clutter::Text::property_buffer | ( | ) |
The buffer for the text.
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<TextBuffer> > Clutter::Text::property_buffer | ( | ) | const |
The buffer for the text.
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::Text::property_color | ( | ) |
Color of the font used by the text.
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::Text::property_color | ( | ) | const |
Color of the font used by the text.
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::Text::property_cursor_color | ( | ) |
Cursor 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< Color > Clutter::Text::property_cursor_color | ( | ) | const |
Cursor 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_ReadOnly< bool > Clutter::Text::property_cursor_color_set | ( | ) | const |
Whether the cursor color has been set.
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< guint > Clutter::Text::property_cursor_position | ( | ) |
The cursor position.
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< guint > Clutter::Text::property_cursor_position | ( | ) | const |
The cursor position.
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< int > Clutter::Text::property_cursor_size | ( | ) |
The width of the cursor, in pixels.
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< int > Clutter::Text::property_cursor_size | ( | ) | const |
The width of the cursor, in pixels.
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::Text::property_cursor_visible | ( | ) |
Whether the input cursor is visible.
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::Text::property_cursor_visible | ( | ) | const |
Whether the input cursor is visible.
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::Text::property_editable | ( | ) |
Whether the text is editable.
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::Text::property_editable | ( | ) | const |
Whether the text is editable.
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< Pango::EllipsizeMode > Clutter::Text::property_ellipsize | ( | ) |
The preferred place to ellipsize the string.
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< Pango::EllipsizeMode > Clutter::Text::property_ellipsize | ( | ) | const |
The preferred place to ellipsize the string.
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< Pango::FontDescription > Clutter::Text::property_font_description | ( | ) |
The font description to be used.
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< Pango::FontDescription > Clutter::Text::property_font_description | ( | ) | const |
The font description to be used.
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::Text::property_font_name | ( | ) |
The font to be used by the text.
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::Text::property_font_name | ( | ) | const |
The font to be used by the text.
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::Text::property_justify | ( | ) |
Whether the text should be justified.
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::Text::property_justify | ( | ) | const |
Whether the text should be justified.
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< Pango::Alignment > Clutter::Text::property_line_alignment | ( | ) |
The preferred alignment for the string, for multi-line text.
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< Pango::Alignment > Clutter::Text::property_line_alignment | ( | ) | const |
The preferred alignment for the string, for multi-line text.
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::Text::property_line_wrap | ( | ) |
If set, wrap the lines if the text becomes too wide.
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::Text::property_line_wrap | ( | ) | const |
If set, wrap the lines if the text becomes too wide.
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< Pango::WrapMode > Clutter::Text::property_line_wrap_mode | ( | ) |
Control how line-wrapping is done.
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< Pango::WrapMode > Clutter::Text::property_line_wrap_mode | ( | ) | const |
Control how line-wrapping is done.
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< int > Clutter::Text::property_max_length | ( | ) |
Maximum length of the text inside the 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< int > Clutter::Text::property_max_length | ( | ) | const |
Maximum length of the text inside the 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< gunichar > Clutter::Text::property_password_char | ( | ) |
If non-zero, use this character to display the actor's 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< gunichar > Clutter::Text::property_password_char | ( | ) | const |
If non-zero, use this character to display the actor's 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< int > Clutter::Text::property_position | ( | ) |
The cursor position.
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< int > Clutter::Text::property_position | ( | ) | const |
The cursor position.
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::Text::property_selectable | ( | ) |
Whether the text is selectable.
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::Text::property_selectable | ( | ) | const |
Whether the text is selectable.
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::Text::property_selected_text_color | ( | ) |
Glib::PropertyProxy_ReadOnly< Color > Clutter::Text::property_selected_text_color | ( | ) | const |
Glib::PropertyProxy_ReadOnly< bool > Clutter::Text::property_selected_text_color_set | ( | ) | const |
Whether the selected text color has been set.
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< int > Clutter::Text::property_selection_bound | ( | ) |
The cursor position of the other end of the selection.
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< int > Clutter::Text::property_selection_bound | ( | ) | const |
The cursor position of the other end of the selection.
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::Text::property_selection_color | ( | ) |
Selection 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< Color > Clutter::Text::property_selection_color | ( | ) | const |
Selection 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_ReadOnly< bool > Clutter::Text::property_selection_color_set | ( | ) | const |
Whether the selection color has been set.
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::Text::property_single_line_mode | ( | ) |
Whether the text should be a single line.
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::Text::property_single_line_mode | ( | ) | const |
Whether the text should be a single line.
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::Text::property_text | ( | ) |
The text to render.
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::Text::property_text | ( | ) | const |
The text to render.
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::Text::property_use_markup | ( | ) |
Whether or not the text includes Pango markup.
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::Text::property_use_markup | ( | ) | const |
Whether or not the text includes Pango markup.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
- Returns
- A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Clutter::Text::set_activatable | ( | bool | activatable = true ) |
Sets whether a Clutter::Text actor should be activatable.
An activatable Clutter::Text actor will emit the Clutter::Text::signal_activate() signal whenever the 'Enter' (or 'Return') key is pressed; if it is not activatable, a new line will be appended to the current content.
An activatable Clutter::Text must also be set as editable using set_editable().
- Parameters
-
activatable Whether the Clutter::Text actor should be activatable.
void Clutter::Text::set_attributes | ( | Pango::AttrList & | attrs) |
Sets the attributes list that are going to be applied to the Clutter::Text contents.
The Clutter::Text actor will take a reference on the Pango::AttrList passed to this function.
- Parameters
-
attrs A Pango::AttrList or 0
to unset the attributes.
void Clutter::Text::set_buffer | ( | const Glib::RefPtr< TextBuffer >& | buffer) |
Set the Clutter::TextBuffer object which holds the text for this widget.
- Parameters
-
buffer A Clutter::TextBuffer.
void Clutter::Text::set_color | ( | const Color& | color) |
Sets the color of the contents of a Clutter::Text actor.
The overall opacity of the Clutter::Text actor will be the result of the alpha value of color and the composited opacity of the actor itself on the scenegraph, as returned by Clutter::Actor::get_paint_opacity().
- Parameters
-
color A Clutter::Color.
void Clutter::Text::set_cursor_color | ( | const Color& | color) |
Sets the color of the cursor of a Clutter::Text actor.
If color is 0
, the cursor color will be the same as the text color.
- Parameters
-
color The color of the cursor, or 0
to unset it.
void Clutter::Text::set_cursor_position | ( | int | position) |
Sets the cursor of a Clutter::Text actor at position.
The position is expressed in characters, not in bytes.
- Parameters
-
position The new cursor position, in characters.
void Clutter::Text::set_cursor_size | ( | int | size) |
Sets the size of the cursor of a Clutter::Text.
The cursor will only be visible if the Clutter::Text::property_cursor_visible() property is set to true
.
- Parameters
-
size The size of the cursor, in pixels, or -1 to use the default value.
void Clutter::Text::set_cursor_visible | ( | bool | visible) |
Sets whether the cursor of a Clutter::Text actor should be visible or not.
The color of the cursor will be the same as the text color unless set_cursor_color() has been called.
The size of the cursor can be set using set_cursor_size().
The position of the cursor can be changed programmatically using set_cursor_position().
- Parameters
-
cursor_visible Whether the cursor should be visible.
void Clutter::Text::set_editable | ( | bool | editable = true ) |
Sets whether the Clutter::Text actor should be editable.
An editable Clutter::Text with key focus set using Clutter::Actor::grab_key_focus() or Clutter::Stage::set_key_focus() will receive key events and will update its contents accordingly.
- Parameters
-
editable Whether the Clutter::Text should be editable.
void Clutter::Text::set_ellipsize | ( | Pango::EllipsizeMode | mode) |
Sets the mode used to ellipsize (add an ellipsis: "...") to the text if there is not enough space to render the entire contents of a Clutter::Text actor.
- Parameters
-
mode A Pango::EllipsizeMode.
void Clutter::Text::set_font_description | ( | const Pango::FontDescription & | font_desc) |
Sets font_desc as the font description for a Clutter::Text.
The Pango::FontDescription is copied by the Clutter::Text actor so you can safely call pango_font_description_free() on it after calling this function.
- Parameters
-
font_desc A Pango::FontDescription.
void Clutter::Text::set_font_name | ( | const Glib::ustring & | font_name) |
Sets the font used by a Clutter::Text.
The font_name string must either be 0
, which means that the font name from the default Clutter::Backend will be used; or be something that can be parsed by the pango_font_description_from_string() function, like:
[C example ellipted]
- Parameters
-
font_name A font name, or 0
to set the default font name.
void Clutter::Text::set_justify | ( | bool | justify = true ) |
Sets whether the text of the Clutter::Text actor should be justified on both margins.
This setting is ignored if Clutter is compiled against Pango < 1.18.
- Parameters
-
justify Whether the text should be justified.
void Clutter::Text::set_line_alignment | ( | Pango::Alignment | alignment) |
Sets the way that the lines of a wrapped label are aligned with respect to each other.
This does not affect the overall alignment of the label within its allocated or specified width.
To align a Clutter::Text actor you should add it to a container that supports alignment, or use the anchor point.
- Parameters
-
alignment A Pango::Alignment.
void Clutter::Text::set_line_wrap | ( | bool | line_wrap = true ) |
Sets whether the contents of a Clutter::Text actor should wrap, if they don't fit the size assigned to the actor.
- Parameters
-
line_wrap Whether the contents should wrap.
void Clutter::Text::set_line_wrap_mode | ( | Pango::WrapMode | wrap_mode) |
If line wrapping is enabled (see set_line_wrap()) this function controls how the line wrapping is performed.
The default is Pango::WRAP_WORD which means wrap on word boundaries.
- Parameters
-
wrap_mode The line wrapping mode.
void Clutter::Text::set_markup | ( | const Glib::ustring & | markup) |
Sets markup as the contents of a Clutter::Text.
This is a convenience function for setting a string containing Pango markup, and it is logically equivalent to:
[C example ellipted]
- Parameters
-
markup A string containing Pango markup. Passing 0
is the same as passing "" (the empty string).
void Clutter::Text::set_max_length | ( | int | max_length) |
Sets the maximum allowed length of the contents of the actor.
If the current contents are longer than the given length, then they will be truncated to fit.
- Parameters
-
max The maximum number of characters allowed in the text actor; 0 to disable or -1 to set the length of the current string.
void Clutter::Text::set_password_char | ( | gunichar | wc) |
Sets the character to use in place of the actual text in a password text actor.
If wc is 0 the text will be displayed as it is entered in the Clutter::Text actor.
- Parameters
-
wc A Unicode character, or 0 to unset the password character.
void Clutter::Text::set_preedit_string | ( | const Glib::ustring & | preedit_str, |
const Pango::AttrList & | preedit_attrs, | ||
guint | ursor_pos | ||
) |
Sets, or unsets, the pre-edit string.
This function is useful for input methods to display a string (with eventual specific Pango attributes) before it is entered inside the Clutter::Text buffer.
The preedit string and attributes are ignored if the Clutter::Text actor is not editable.
This function should not be used by applications
- Parameters
-
preedit_str The pre-edit string, or 0
to unset it.preedit_attrs The pre-edit string attributes. cursor_pos The cursor position for the pre-edit string.
void Clutter::Text::set_selectable | ( | bool | selectable = true ) |
Sets whether a Clutter::Text actor should be selectable.
A selectable Clutter::Text will allow selecting its contents using the pointer or the keyboard.
- Parameters
-
selectable Whether the Clutter::Text actor should be selectable.
void Clutter::Text::set_selection | ( | gssize | start_pos, |
gssize | end_pos | ||
) |
Selects the region of text between start_pos and end_pos.
This function changes the position of the cursor to match start_pos and the selection bound to match end_pos.
- Parameters
-
start_pos Start of the selection, in characters. end_pos End of the selection, in characters.
void Clutter::Text::set_selection_bound | ( | int | selection_bound) |
Sets the other end of the selection, starting from the current cursor position.
If selection_bound is -1, the selection unset.
- Parameters
-
selection_bound The position of the end of the selection, in characters.
void Clutter::Text::set_selection_color | ( | const Color& | color) |
Sets the color of the selection of a Clutter::Text actor.
If color is 0
, the selection color will be the same as the cursor color, or if no cursor color is set either then it will be the same as the text color.
- Parameters
-
color The color of the selection, or 0
to unset it.
void Clutter::Text::set_single_line_mode | ( | bool | single_line = true ) |
Sets whether a Clutter::Text actor should be in single line mode or not.
Only editable Clutter::Texts can be in single line mode.
A text actor in single line mode will not wrap text and will clip the visible area to the predefined size. The contents of the text actor will scroll to display the end of the text if its length is bigger than the allocated width.
When setting the single line mode the Clutter::Text::property_activatable() property is also set as a side effect. Instead of entering a new line character, the text actor will emit the Clutter::Text::signal_activate() signal.
- Parameters
-
single_line Whether to enable single line mode.
void Clutter::Text::set_text | ( | const Glib::ustring & | text) |
Sets the contents of a Clutter::Text actor.
If the Clutter::Text::property_use_markup() property was set to true
it will be reset to false
as a side effect. If you want to maintain the Clutter::Text::property_use_markup() you should use the set_markup() function instead
- Parameters
-
text The text to set. Passing 0
is the same as passing "" (the empty string).
void Clutter::Text::set_use_markup | ( | bool | setting = true ) |
Sets whether the contents of the Clutter::Text actor contains markup in Pango's text markup language.
Setting Clutter::Text::property_use_markup() on an editable Clutter::Text will not have any effect except hiding the markup.
See also Clutter::Text::property_use_markup().
- Parameters
-
setting true
if the text should be parsed for markup.
Glib::SignalProxy0< void > Clutter::Text::signal_activate | ( | ) |
- Slot Prototype:
void on_my_activate()
The signal_activate() signal is emitted each time the actor is 'activated' by the user, normally by pressing the 'Enter' key. The signal is emitted only if Clutter::Text::property_activatable() is set to true
.
Glib::SignalProxy0< void > Clutter::Text::signal_cursor_changed | ( | ) |
- Slot Prototype:
void on_my_cursor_changed()
The signal_cursor_changed() signal is emitted whenever the cursor position or size changes.
Glib::SignalProxy0< void > Clutter::Text::signal_text_changed | ( | ) |
- Slot Prototype:
void on_my_text_changed()
The signal_text_changed() signal is emitted after actor's text changes
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
object The C instance. take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
- Returns
- A C++ instance that wraps this C instance.
The documentation for this class was generated from the following file:
- cluttermm/text.h