Class: Clutter::Box

Inherits:
Actor
  • Object
show all
Defined in:
(unknown)

Overview

The Clutter::BoxClass structure 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=, #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, #position, #position=, #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(manager) ⇒ Clutter::Actor

Creates a new Clutter::Box. The children of the box will be layed out by the passed manager

Parameters:

Instance Method Details

#color ⇒ Clutter::Color

The color to be used to paint the background of the Clutter::Box. Setting this property will set the Clutter::Box:color-set property as a side effect

This property sets the Clutter::Actor:background-color property internally.

Returns:

#color=(color) ⇒ Clutter::Color

The color to be used to paint the background of the Clutter::Box. Setting this property will set the Clutter::Box:color-set property as a side effect

This property sets the Clutter::Actor:background-color property internally.

Parameters:

Returns:

#color_set=(color_set) ⇒ Boolean

Whether the Clutter::Box:color property has been set.

This property reads the Clutter::Actor:background-color-set property internally.

Parameters:

  • color_set (Boolean)

Returns:

  • (Boolean) —

    color-set

  • (Boolean) —

    color-set

#color_set? ⇒ Boolean

Whether the Clutter::Box:color property has been set.

This property reads the Clutter::Actor:background-color-set property internally.

Returns:

  • (Boolean) —

    color-set

#get_color(color) ⇒ nil

Retrieves the background color of box

If the Clutter::Box:color-set property is set to false the returned Clutter::Color is undefined

Parameters:

Returns:

  • (nil)

#layout_manager ⇒ Clutter::LayoutManager

Retrieves the Clutter::LayoutManager instance used by box

Returns:

  • (Clutter::LayoutManager) —

    a Clutter::LayoutManager. The returned Clutter::LayoutManager is owned by the #ClutterBox and it should not be unreferenced

#layout_manager=(manager) ⇒ nil

Sets the Clutter::LayoutManager for box

A Clutter::LayoutManager is a delegate object that controls the layout of the children of box

Parameters:

Returns:

  • (nil)

#pack(actor, first_property, array) ⇒ nil

Adds actor to box and sets layout properties at the same time, if the Clutter::LayoutManager used by box has them

This function is a wrapper around clutter_container_add_actor() and clutter_layout_manager_child_set()

Language bindings should use the vector-based clutter_box_packv() variant instead

Parameters:

  • actor (Clutter::Actor) —

    a Clutter::Actor

  • first_property (String) —

    the name of the first property to set, or nil

  • array (Array) —

    a list of property name and value pairs, terminated by nil

Returns:

  • (nil)

#pack_after(actor, sibling, first_property, array) ⇒ nil

Adds actor to box, placing it after sibling, and sets layout properties at the same time, if the Clutter::LayoutManager used by box supports them

If sibling is nil then actor is placed at the end of the list of children, to be allocated and painted after every other child

This function is a wrapper around clutter_container_add_actor(), clutter_container_raise_child() and clutter_layout_manager_child_set()

Parameters:

  • actor (Clutter::Actor) —

    a Clutter::Actor

  • sibling (Clutter::Actor) —

    a Clutter::Actor or nil

  • first_property (String) —

    the name of the first property to set, or nil

  • array (Array) —

    a list of property name and value pairs, terminated by nil

Returns:

  • (nil)

#pack_at(actor, position, first_property, array) ⇒ nil

Adds actor to box, placing it at position, and sets layout properties at the same time, if the Clutter::LayoutManager used by box supports them

If position is a negative number, or is larger than the number of children of box, the new child is added at the end of the list of children

Parameters:

  • actor (Clutter::Actor) —

    a Clutter::Actor

  • position (Integer) —

    the position to insert the actor at

  • first_property (String) —

    the name of the first property to set, or nil

  • array (Array) —

    a list of property name and value pairs, terminated by nil

Returns:

  • (nil)

#pack_before(actor, sibling, first_property, array) ⇒ nil

Adds actor to box, placing it before sibling, and sets layout properties at the same time, if the Clutter::LayoutManager used by box supports them

If sibling is nil then actor is placed at the beginning of the list of children, to be allocated and painted below every other child

This function is a wrapper around clutter_container_add_actor(), clutter_container_lower_child() and clutter_layout_manager_child_set()

Parameters:

  • actor (Clutter::Actor) —

    a Clutter::Actor

  • sibling (Clutter::Actor) —

    a Clutter::Actor or nil

  • first_property (String) —

    the name of the first property to set, or nil

  • array (Array) —

    a list of property name and value pairs, terminated by nil

Returns:

  • (nil)

#packv(actor, n_properties, properties, values) ⇒ nil

Vector-based variant of clutter_box_pack(), intended for language bindings to use

Parameters:

  • actor (Clutter::Actor) —

    a Clutter::Actor

  • n_properties (Integer) —

    the number of properties to set

  • properties (Array<String>) —

    a vector containing the property names to set

  • values (Array<GObject::Value>) —

    a vector containing the property values to set

Returns:

  • (nil)