Class: Clutter::Text

Inherits:
Actor
  • Object
show all
Defined in:
lib/clutter/text.rb

Overview

The Clutter::TextClass struct contains only private data.

Instance Method Summary collapse

Methods inherited from Actor

#accessible, #actions, #actions=, #add_action, #add_action_with_name, #add_child, #add_constraint, #add_constraint_with_name, #add_effect, #add_effect_with_name, #add_transition, #allocate, #allocate_align_fill, #allocate_available_size, #allocate_preferred_size, #allocation, #allocation=, #anchor_gravity, #anchor_gravity=, #anchor_point_from_gravity=, #anchor_point_gravity, #anchor_x, #anchor_x=, #anchor_y, #anchor_y=, #animate, #animate_with_alpha, #animate_with_alphav, #animate_with_timeline, #animate_with_timelinev, #animatev, #animation, #apply_relative_transform_to_point, #apply_transform_to_point, #background_color, #background_color=, #background_color_set=, #background_color_set?, #bind_model, #bind_model_with_properties, #child_transform, #child_transform=, #child_transform_set=, #child_transform_set?, #children, #clear_actions, #clear_constraints, #clear_effects, #clip, #clip=, #clip_rect, #clip_rect=, #clip_to_allocation, #clip_to_allocation=, #clip_to_allocation?, #constraints, #constraints=, #contains, #content, #content=, #content_box, #content_box=, #content_gravity, #content_gravity=, #content_repeat, #content_repeat=, #continue_paint, #create_pango_context, #create_pango_layout, #default_paint_volume, #depth, #depth=, #destroy, #destroy_all_children, #detach_animation, #easing_delay, #easing_delay=, #easing_duration, #easing_duration=, #easing_mode, #easing_mode=, #effect=, #effects, #event, #first_child, #first_child=, #fixed_position_set, #fixed_position_set=, #fixed_position_set?, #fixed_x, #fixed_x=, #fixed_y, #fixed_y=, #flags, #flags=, #geometry=, #get_abs_allocation_vertices, #get_action, #get_allocation_box, #get_allocation_geometry, #get_allocation_vertices, #get_anchor_point, #get_background_color, #get_child_at_index, #get_child_transform, #get_clip, #get_constraint, #get_content_box, #get_content_scaling_filters, #get_effect, #get_geometry, #get_margin, #get_paint_box, #get_pivot_point, #get_position, #get_preferred_height, #get_preferred_size, #get_preferred_width, #get_rotation, #get_rotation_angle, #get_scale, #get_scale_center, #get_size, #get_transform, #get_transformation_matrix, #get_transformed_paint_volume, #get_transformed_position, #get_transformed_size, #get_transition, #get_translation, #gid, #grab_key_focus, #has_actions, #has_allocation, #has_clip, #has_clip=, #has_clip?, #has_constraints, #has_effects, #has_key_focus, #has_overlaps, #has_pointer, #has_pointer=, #has_pointer?, #height, #height=, #hide, #hide_all, #insert_child_above, #insert_child_at_index, #insert_child_below, #is_in_clone_paint, #is_mapped, #is_realized, #is_rotated, #is_scaled, #is_visible, #last_child, #last_child=, #layout_manager, #layout_manager=, #lower, #lower_bottom, #magnification_filter, #magnification_filter=, #map, #mapped=, #mapped?, #margin=, #margin_bottom, #margin_bottom=, #margin_left, #margin_left=, #margin_right, #margin_right=, #margin_top, #margin_top=, #min_height, #min_height=, #min_height_set=, #min_height_set?, #min_width, #min_width=, #min_width_set=, #min_width_set?, #minification_filter, #minification_filter=, #move_anchor_point, #move_anchor_point_from_gravity, #move_by, #n_children, #name, #name=, #natural_height, #natural_height=, #natural_height_set=, #natural_height_set?, #natural_width, #natural_width=, #natural_width_set=, #natural_width_set?, #needs_expand, #next_sibling, #offscreen_redirect, #offscreen_redirect=, #opacity, #opacity=, #paint, #paint_opacity, #paint_visibility, #paint_volume, #pango_context, #parent, #parent=, #pivot_point, #pivot_point=, #pivot_point_z, #pivot_point_z=, #pop_internal, #previous_sibling, #push_internal, #queue_redraw, #queue_redraw_with_clip, #queue_relayout, #raise, #raise_top, #reactive, #reactive=, #reactive?, #realize, #realized=, #realized?, #remove_action, #remove_action_by_name, #remove_all_children, #remove_all_transitions, #remove_child, #remove_clip, #remove_constraint, #remove_constraint_by_name, #remove_effect, #remove_effect_by_name, #remove_transition, #reparent, #replace_child, #request_mode, #request_mode=, #restore_easing_state, #rotation_angle_x, #rotation_angle_x=, #rotation_angle_y, #rotation_angle_y=, #rotation_angle_z, #rotation_angle_z=, #rotation_center_x, #rotation_center_x=, #rotation_center_y, #rotation_center_y=, #rotation_center_z, #rotation_center_z=, #rotation_center_z_gravity, #rotation_center_z_gravity=, #save_easing_state, #save_easing_state_without_block, #scale_center_x, #scale_center_x=, #scale_center_y, #scale_center_y=, #scale_gravity, #scale_gravity=, #scale_x, #scale_x=, #scale_y, #scale_y=, #scale_z, #scale_z=, #set_allocation, #set_anchor_point, #set_child_above_sibling, #set_child_at_index, #set_child_below_sibling, #set_clip, #set_content_scaling_filters, #set_pivot_point, #set_position, #set_rotation, #set_rotation_angle, #set_scale, #set_scale_full, #set_scale_with_gravity, #set_shader_param, #set_shader_param_float, #set_shader_param_int, #set_size, #set_translation, #set_z_rotation_from_gravity, #shader, #shader=, #should_pick_paint, #show, #show_all, #show_on_set_parent=, #show_on_set_parent?, #size, #size=, #stage, #text_direction, #text_direction=, #transform, #transform=, #transform_set=, #transform_set?, #transform_stage_point, #translation_x, #translation_x=, #translation_y, #translation_y=, #translation_z, #translation_z=, #unmap, #unparent, #unrealize, #unset_flags, #visible=, #visible?, #width, #width=, #x, #x=, #x_align, #x_align=, #x_expand, #x_expand=, #x_expand?, #y, #y=, #y_align, #y_align=, #y_expand, #y_expand=, #y_expand?, #z_position, #z_position=, #z_rotation_gravity

Constructor Details

#initialize(font_name, text) ⇒ Clutter::Actor

Creates a new Clutter::Text actor, using font_name as the font description; text will be used to set the contents of the actor.

This function is equivalent to calling clutter_text_new(), clutter_text_set_font_name(), and clutter_text_set_text().

Parameters:

  • font_name (String) —

    a string with a font description

  • text (String) —

    the contents of the actor

Instance Method Details

#activatable ⇒ Boolean

Retrieves whether a Clutter::Text is activatable or not.

Returns:

  • (Boolean) —

    true if the actor is activatable

#activatable=(activatable) ⇒ Boolean

Toggles whether return invokes the activate signal or not.

Parameters:

  • activatable (Boolean)

Returns:

  • (Boolean) —

    activatable

  • (Boolean) —

    activatable

#activatable? ⇒ Boolean

Toggles whether return invokes the activate signal or not.

Returns:

  • (Boolean) —

    activatable

#activate ⇒ Boolean

Emits the Clutter::Text::activate signal, if self has been set as activatable using clutter_text_set_activatable().

This function can be used to emit the ::activate signal inside a Clutter::Actor::captured-event or #ClutterActor::key-press-event signal handlers before the default signal handler for the Clutter::Text is invoked.

Returns:

  • (Boolean) —

    true if the ::activate signal has been emitted, and false otherwise

#attributes ⇒ Pango::AttrList

A list of Pango::StyleAttributes to be applied to the contents of the Clutter::Text actor.

Returns:

  • (Pango::AttrList) —

    attributes

#attributes=(attributes) ⇒ Pango::AttrList

A list of Pango::StyleAttributes to be applied to the contents of the Clutter::Text actor.

Parameters:

  • attributes (Pango::AttrList)

Returns:

  • (Pango::AttrList) —

    attributes

  • (Pango::AttrList) —

    attributes

#buffer ⇒ Clutter::TextBuffer

The buffer which stores the text for this Clutter::Text.

If set to nil, a default buffer will be created.

Returns:

#buffer=(buffer) ⇒ Clutter::TextBuffer

The buffer which stores the text for this Clutter::Text.

If set to nil, a default buffer will be created.

Parameters:

Returns:

#color ⇒ Clutter::Color

The color used to render the text.

Returns:

#color=(color) ⇒ Clutter::Color

The color used to render the text.

Parameters:

Returns:

#coords_to_position(x, y) ⇒ Integer

Retrieves the position of the character at the given coordinates.

Parameters:

  • x (Clutter::gfloat) —

    the X coordinate, relative to the actor

  • y (Clutter::gfloat) —

    the Y coordinate, relative to the actor

Returns:

  • (Integer) —

    the position of the character

#cursor_color ⇒ Clutter::Color

The color of the cursor.

Returns:

#cursor_color=(cursor_color) ⇒ Clutter::Color

The color of the cursor.

Parameters:

Returns:

#cursor_color_set=(cursor_color_set) ⇒ Boolean

Will be set to true if Clutter::Text:cursor-color has been set.

Parameters:

  • cursor_color_set (Boolean)

Returns:

  • (Boolean) —

    cursor-color-set

  • (Boolean) —

    cursor-color-set

#cursor_color_set? ⇒ Boolean

Will be set to true if Clutter::Text:cursor-color has been set.

Returns:

  • (Boolean) —

    cursor-color-set

#cursor_position ⇒ Integer

The current input cursor position. -1 is taken to be the end of the text

Returns:

  • (Integer) —

    cursor-position

#cursor_position=(cursor_position) ⇒ Integer

The current input cursor position. -1 is taken to be the end of the text

Parameters:

  • cursor_position (Integer)

Returns:

  • (Integer) —

    cursor-position

  • (Integer) —

    cursor-position

#cursor_size ⇒ Integer

The size of the cursor, in pixels. If set to -1 the size used will be the default cursor size of 2 pixels.

Returns:

  • (Integer) —

    cursor-size

#cursor_size=(cursor_size) ⇒ Integer

The size of the cursor, in pixels. If set to -1 the size used will be the default cursor size of 2 pixels.

Parameters:

  • cursor_size (Integer)

Returns:

  • (Integer) —

    cursor-size

  • (Integer) —

    cursor-size

#cursor_visible ⇒ Boolean

Retrieves whether the cursor of a Clutter::Text actor is visible.

Returns:

  • (Boolean) —

    true if the cursor is visible

#cursor_visible=(cursor_visible) ⇒ Boolean

Whether the input cursor is visible or not.

The cursor will only be visible if this property and either the Clutter::Text:editable or the #ClutterText:selectable properties are set to true.

Parameters:

  • cursor_visible (Boolean)

Returns:

  • (Boolean) —

    cursor-visible

  • (Boolean) —

    cursor-visible

#cursor_visible? ⇒ Boolean

Whether the input cursor is visible or not.

The cursor will only be visible if this property and either the Clutter::Text:editable or the #ClutterText:selectable properties are set to true.

Returns:

  • (Boolean) —

    cursor-visible

#delete_chars(n_chars) ⇒ nil

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 (Integer) —

    the number of characters to delete

Returns:

  • (nil)

#delete_selection ⇒ Boolean

Deletes the currently selected text

This function is only useful in subclasses of Clutter::Text

Returns:

  • (Boolean) —

    true if text was deleted or if the text actor is empty, and false otherwise

#delete_text(start_pos, end_pos) ⇒ nil

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 (Clutter::gssize) —

    starting position

  • end_pos (Clutter::gssize) —

    ending position

Returns:

  • (nil)

#editable ⇒ Boolean

Retrieves whether a Clutter::Text is editable or not.

Returns:

  • (Boolean) —

    true if the actor is editable

#editable=(editable) ⇒ Boolean

Whether key events delivered to the actor causes editing.

Parameters:

  • editable (Boolean)

Returns:

  • (Boolean) —

    editable

  • (Boolean) —

    editable

#editable? ⇒ Boolean

Whether key events delivered to the actor causes editing.

Returns:

  • (Boolean) —

    editable

#ellipsize ⇒ Pango::EllipsizeMode

The preferred place to ellipsize the contents of the Clutter::Text actor

Returns:

  • (Pango::EllipsizeMode) —

    ellipsize

#ellipsize=(ellipsize) ⇒ Pango::EllipsizeMode

The preferred place to ellipsize the contents of the Clutter::Text actor

Parameters:

  • ellipsize (Pango::EllipsizeMode)

Returns:

  • (Pango::EllipsizeMode) —

    ellipsize

  • (Pango::EllipsizeMode) —

    ellipsize

#font_description ⇒ Pango::FontDescription

The Pango::FontDescription that should be used by the #ClutterText

If you have a string describing the font then you should look at Clutter::Text:font-name instead

Returns:

  • (Pango::FontDescription) —

    font-description

#font_description=(font_description) ⇒ Pango::FontDescription

The Pango::FontDescription that should be used by the #ClutterText

If you have a string describing the font then you should look at Clutter::Text:font-name instead

Parameters:

  • font_description (Pango::FontDescription)

Returns:

  • (Pango::FontDescription) —

    font-description

  • (Pango::FontDescription) —

    font-description

#font_name ⇒ String

The font to be used by the Clutter::Text, as a string that can be parsed by pango_font_description_from_string().

If set to nil, the default system font will be used instead.

Returns:

  • (String) —

    font-name

#font_name=(font_name) ⇒ String

The font to be used by the Clutter::Text, as a string that can be parsed by pango_font_description_from_string().

If set to nil, the default system font will be used instead.

Parameters:

  • font_name (String)

Returns:

  • (String) —

    font-name

  • (String) —

    font-name

#get_chars(start_pos, end_pos) ⇒ String

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 (Clutter::gssize) —

    start of text, in characters

  • end_pos (Clutter::gssize) —

    end of text, in characters

Returns:

  • (String) —

    a newly allocated string with the contents of the text actor between the specified positions. Use g_free() to free the resources when done

#get_color(color) ⇒ nil

Retrieves the text color as set by clutter_text_set_color().

Parameters:

Returns:

  • (nil)

#get_cursor_color(color) ⇒ nil

Retrieves the color of the cursor of a Clutter::Text actor.

Parameters:

Returns:

  • (nil)

#get_cursor_rect(rect) ⇒ nil

Retrieves the rectangle that contains the cursor.

The coordinates of the rectangle's origin are in actor-relative coordinates.

Parameters:

  • rect (Clutter::Rect) —

    return location of a Clutter::Rect

Returns:

  • (nil)

#get_layout_offsets(x, y) ⇒ nil

Obtains the coordinates where the Clutter::Text will draw the #PangoLayout representing the text.

Parameters:

  • x (Integer) —

    location to store X offset of layout, or nil

  • y (Integer) —

    location to store Y offset of layout, or nil

Returns:

  • (nil)

#get_selected_text_color(color) ⇒ nil

Retrieves the color of selected text of a Clutter::Text actor.

Parameters:

Returns:

  • (nil)

#get_selection_color(color) ⇒ nil

Retrieves the color of the selection of a Clutter::Text actor.

Parameters:

Returns:

  • (nil)

#insert_text(text, position) ⇒ nil

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 (String) —

    the text to be inserted

  • position (Clutter::gssize) —

    the position of the insertion, or -1

Returns:

  • (nil)

#insert_unichar(wc) ⇒ nil

Inserts wc at the current cursor position of a Clutter::Text actor.

Parameters:

  • wc (String) —

    a Unicode character

Returns:

  • (nil)

#justify ⇒ Boolean

Retrieves whether the Clutter::Text actor should justify its contents on both margins.

Returns:

  • (Boolean) —

    true if the text should be justified

#justify=(justify) ⇒ Boolean

Whether the contents of the Clutter::Text should be justified on both margins.

Parameters:

  • justify (Boolean)

Returns:

  • (Boolean) —

    justify

  • (Boolean) —

    justify

#justify? ⇒ Boolean

Whether the contents of the Clutter::Text should be justified on both margins.

Returns:

  • (Boolean) —

    justify

#layout ⇒ Pango::Layout

Retrieves the current Pango::Layout used by a #ClutterText actor.

Returns:

  • (Pango::Layout) —

    a Pango::Layout. The returned object is owned by the Clutter::Text actor and should not be modified or freed

#line_alignment ⇒ Pango::Alignment

The preferred alignment for the text. This property controls the alignment of multi-line paragraphs.

Returns:

  • (Pango::Alignment) —

    line-alignment

#line_alignment=(line_alignment) ⇒ Pango::Alignment

The preferred alignment for the text. This property controls the alignment of multi-line paragraphs.

Parameters:

  • line_alignment (Pango::Alignment)

Returns:

  • (Pango::Alignment) —

    line-alignment

  • (Pango::Alignment) —

    line-alignment

#line_wrap ⇒ Boolean

Retrieves the value set using clutter_text_set_line_wrap().

Returns:

  • (Boolean) —

    true if the Clutter::Text actor should wrap its contents

#line_wrap=(line_wrap) ⇒ Boolean

Whether to wrap the lines of Clutter::Text:text if the contents exceed the available allocation. The wrapping strategy is controlled by the Clutter::Text:line-wrap-mode property.

Parameters:

  • line_wrap (Boolean)

Returns:

  • (Boolean) —

    line-wrap

  • (Boolean) —

    line-wrap

#line_wrap? ⇒ Boolean

Whether to wrap the lines of Clutter::Text:text if the contents exceed the available allocation. The wrapping strategy is controlled by the Clutter::Text:line-wrap-mode property.

Returns:

  • (Boolean) —

    line-wrap

#line_wrap_mode ⇒ Pango::WrapMode

If Clutter::Text:line-wrap is set to true, this property will control how the text is wrapped.

Returns:

  • (Pango::WrapMode) —

    line-wrap-mode

#line_wrap_mode=(line_wrap_mode) ⇒ Pango::WrapMode

If Clutter::Text:line-wrap is set to true, this property will control how the text is wrapped.

Parameters:

  • line_wrap_mode (Pango::WrapMode)

Returns:

  • (Pango::WrapMode) —

    line-wrap-mode

  • (Pango::WrapMode) —

    line-wrap-mode

#markup=(markup) ⇒ nil

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:

|[ /* the order is important */ clutter_text_set_text (CLUTTER_TEXT (actor), markup); clutter_text_set_use_markup (CLUTTER_TEXT (actor), TRUE); ]|

Parameters:

  • markup (String) —

    a string containing Pango markup. Passing nil is the same as passing "" (the empty string)

Returns:

  • (nil)

#max_length ⇒ Integer

The maximum length of the contents of the Clutter::Text actor.

Returns:

  • (Integer) —

    max-length

#max_length=(max_length) ⇒ Integer

The maximum length of the contents of the Clutter::Text actor.

Parameters:

  • max_length (Integer)

Returns:

  • (Integer) —

    max-length

  • (Integer) —

    max-length

#password_char ⇒ Integer

If non-zero, the character that should be used in place of the actual text in a password text actor.

Returns:

  • (Integer) —

    password-char

#password_char=(password_char) ⇒ Integer

If non-zero, the character that should be used in place of the actual text in a password text actor.

Parameters:

  • password_char (Integer)

Returns:

  • (Integer) —

    password-char

  • (Integer) —

    password-char

#position ⇒ Integer

The current input cursor position. -1 is taken to be the end of the text

Returns:

  • (Integer) —

    position

#position=(position) ⇒ Integer

The current input cursor position. -1 is taken to be the end of the text

Parameters:

  • position (Integer)

Returns:

  • (Integer) —

    position

  • (Integer) —

    position

#position_to_coords(position, x, y, line_height) ⇒ Boolean

Retrieves the coordinates of the given position.

Parameters:

  • position (Integer) —

    position in characters

  • x (Clutter::gfloat) —

    return location for the X coordinate, or nil

  • y (Clutter::gfloat) —

    return location for the Y coordinate, or nil

  • line_height (Clutter::gfloat) —

    return location for the line height, or nil

Returns:

  • (Boolean) —

    true if the conversion was successful

#selectable ⇒ Boolean

Retrieves whether a Clutter::Text is selectable or not.

Returns:

  • (Boolean) —

    true if the actor is selectable

#selectable=(selectable) ⇒ Boolean

Whether it is possible to select text, either using the pointer or the keyboard.

This property depends on the Clutter::Actor:reactive property being set to true.

Parameters:

  • selectable (Boolean)

Returns:

  • (Boolean) —

    selectable

  • (Boolean) —

    selectable

#selectable? ⇒ Boolean

Whether it is possible to select text, either using the pointer or the keyboard.

This property depends on the Clutter::Actor:reactive property being set to true.

Returns:

  • (Boolean) —

    selectable

#selected_text_color ⇒ Clutter::Color

The color of selected text.

Returns:

#selected_text_color=(selected_text_color) ⇒ Clutter::Color

The color of selected text.

Parameters:

Returns:

#selected_text_color_set=(selected_text_color_set) ⇒ Boolean

Will be set to true if Clutter::Text:selected-text-color has been set.

Parameters:

  • selected_text_color_set (Boolean)

Returns:

  • (Boolean) —

    selected-text-color-set

  • (Boolean) —

    selected-text-color-set

#selected_text_color_set? ⇒ Boolean

Will be set to true if Clutter::Text:selected-text-color has been set.

Returns:

  • (Boolean) —

    selected-text-color-set

#selection ⇒ String

Retrieves the currently selected text.

Returns:

  • (String) —

    a newly allocated string containing the currently selected text, or nil. Use g_free() to free the returned string.

#selection_bound ⇒ Integer

The current input cursor position. -1 is taken to be the end of the text

Returns:

  • (Integer) —

    selection-bound

#selection_bound=(selection_bound) ⇒ Integer

The current input cursor position. -1 is taken to be the end of the text

Parameters:

  • selection_bound (Integer)

Returns:

  • (Integer) —

    selection-bound

  • (Integer) —

    selection-bound

#selection_color ⇒ Clutter::Color

The color of the selection.

Returns:

#selection_color=(selection_color) ⇒ Clutter::Color

The color of the selection.

Parameters:

Returns:

#selection_color_set=(selection_color_set) ⇒ Boolean

Will be set to true if Clutter::Text:selection-color has been set.

Parameters:

  • selection_color_set (Boolean)

Returns:

  • (Boolean) —

    selection-color-set

  • (Boolean) —

    selection-color-set

#selection_color_set? ⇒ Boolean

Will be set to true if Clutter::Text:selection-color has been set.

Returns:

  • (Boolean) —

    selection-color-set

#set_preedit_string(preedit_str, preedit_attrs, cursor_pos) ⇒ nil

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 (String) —

    the pre-edit string, or nil to unset it

  • preedit_attrs (Pango::AttrList) —

    the pre-edit string attributes

  • cursor_pos (Integer) —

    the cursor position for the pre-edit string

Returns:

  • (nil)

#set_selection(start_pos, end_pos) ⇒ nil

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 (Clutter::gssize) —

    start of the selection, in characters

  • end_pos (Clutter::gssize) —

    end of the selection, in characters

Returns:

  • (nil)

#single_line_mode ⇒ Boolean

Retrieves whether the Clutter::Text actor is in single line mode.

Returns:

  • (Boolean) —

    true if the Clutter::Text actor is in single line mode

#single_line_mode=(single_line_mode) ⇒ Boolean

Whether the Clutter::Text actor should be in single line mode or not. A single line Clutter::Text actor will only contain a single line of text, scrolling it in case its length is bigger than the allocated size.

Setting this property will also set the Clutter::Text:activatable property as a side-effect.

The Clutter::Text:single-line-mode property is used only if the Clutter::Text:editable property is set to true.

Parameters:

  • single_line_mode (Boolean)

Returns:

  • (Boolean) —

    single-line-mode

  • (Boolean) —

    single-line-mode

#single_line_mode? ⇒ Boolean

Whether the Clutter::Text actor should be in single line mode or not. A single line Clutter::Text actor will only contain a single line of text, scrolling it in case its length is bigger than the allocated size.

Setting this property will also set the Clutter::Text:activatable property as a side-effect.

The Clutter::Text:single-line-mode property is used only if the Clutter::Text:editable property is set to true.

Returns:

  • (Boolean) —

    single-line-mode

#text ⇒ String

The text to render inside the actor.

Returns:

  • (String) —

    text

#text=(text) ⇒ String

The text to render inside the actor.

Parameters:

  • text (String)

Returns:

  • (String) —

    text

  • (String) —

    text

#use_markup ⇒ Boolean

Retrieves whether the contents of the Clutter::Text actor should be parsed for the Pango text markup.

Returns:

  • (Boolean) —

    true if the contents will be parsed for markup

#use_markup=(use_markup) ⇒ Boolean

Whether the text includes Pango markup.

For more informations about the Pango markup format, see pango_layout_set_markup() in the Pango documentation.

It is not possible to round-trip this property between true and false. Once a string with markup has been set on a Clutter::Text actor with :use-markup set to true, the markup is stripped from the string.

Parameters:

  • use_markup (Boolean)

Returns:

  • (Boolean) —

    use-markup

  • (Boolean) —

    use-markup

#use_markup? ⇒ Boolean

Whether the text includes Pango markup.

For more informations about the Pango markup format, see pango_layout_set_markup() in the Pango documentation.

It is not possible to round-trip this property between true and false. Once a string with markup has been set on a Clutter::Text actor with :use-markup set to true, the markup is stripped from the string.

Returns:

  • (Boolean) —

    use-markup