Inheritance diagram for Clutter::GridLayout:

Collaboration diagram for Clutter::GridLayout:

Public Member Functions
virtual	~GridLayout ()
ClutterGridLayout*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterGridLayout*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterGridLayout*	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	attach (const Glib::RefPtr< Actor >& child, int left, int top, int width, int height)
	Adds a widget to the grid. More...
void	attach_next_to (const Glib::RefPtr< Actor >& child, const Glib::RefPtr< Actor >& sibling, GridPosition side, int width, int height)
	Adds a actor to the grid. More...
Glib::RefPtr< Actor >	get_child_at (int left, int top)
	Gets the child of layout whose area covers the grid cell whose upper left corner is at left, top. More...
Glib::RefPtr< const Actor >	get_child_at (int left, int top) const
	Gets the child of layout whose area covers the grid cell whose upper left corner is at left, top. More...
void	insert_column (int position)
	Inserts a column at the specified position. More...
void	insert_row (int position)
	Inserts a row at the specified position. More...
void	insert_next_to (const Glib::RefPtr< Actor >& sibling, GridPosition side)
	Inserts a row or column at the specified position. More...
void	set_orientation (Orientation orientation)
	Sets the orientation of the layout. More...
Orientation	get_orientation () const
	Retrieves the orientation of the layout. More...
void	set_column_homogeneous (bool homogeneous=true)
	Sets whether all columns of layout will have the same width. More...
bool	get_column_homogeneous () const
	Returns whether all columns of layout have the same width. More...
void	set_row_homogeneous (bool homogeneous=true)
	Sets whether all rows of layout will have the same height. More...
bool	get_row_homogeneous () const
	Returns whether all rows of layout have the same height. More...
void	set_column_spacing (guint spacing)
	Sets the spacing between columns of layout. More...
guint	get_column_spacing () const
	Retrieves the spacing set using set_column_spacing() More...
void	set_row_spacing (guint spacing)
	Sets the spacing between rows of layout. More...
guint	get_row_spacing () const
	Retrieves the spacing set using set_row_spacing() More...
Glib::PropertyProxy< bool >	property_column_homogeneous ()
	If TRUE, the columns are all the same width. More...
Glib::PropertyProxy_ReadOnly < bool >	property_column_homogeneous () const
	If TRUE, the columns are all the same width. More...
Glib::PropertyProxy< guint >	property_column_spacing ()
	The amount of space between two consecutive columns. More...
Glib::PropertyProxy_ReadOnly < guint >	property_column_spacing () const
	The amount of space between two consecutive columns. More...
Glib::PropertyProxy< bool >	property_row_homogeneous ()
	If TRUE, the rows are all the same height. More...
Glib::PropertyProxy_ReadOnly < bool >	property_row_homogeneous () const
	If TRUE, the rows are all the same height. More...
Glib::PropertyProxy< guint >	property_row_spacing ()
	The amount of space between two consecutive rows. More...
Glib::PropertyProxy_ReadOnly < guint >	property_row_spacing () const
	The amount of space between two consecutive rows. More...
Glib::PropertyProxy< Orientation >	property_orientation ()
	The orientation of the layout. More...
Glib::PropertyProxy_ReadOnly < Orientation >	property_orientation () const
	The orientation of the layout. More...
Public Member Functions inherited from Clutter::LayoutManager
virtual	~LayoutManager ()
ClutterLayoutManager*	gobj ()
	Provides access to the underlying C GObject. More...
const ClutterLayoutManager*	gobj () const
	Provides access to the underlying C GObject. More...
ClutterLayoutManager*	gobj_copy ()
	Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
template<class PropertyType >
void	set_child_property (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& child, const Glib::ustring& property_name, const PropertyType& value)
void	set_child_property_value (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& child, const Glib::ustring& property_name, const Glib::ValueBase& value)
	Sets a property on the Clutter::LayoutMeta created by manager and attached to a child of container. More...
template<class PropertyType >
void	get_child_property (const Glib::RefPtr< Container >& container, const Glib::RefPtr< const Actor >& actor, const Glib::ustring& property_name, PropertyType& value) const
void	get_child_property_value (const Glib::RefPtr< Container >& container, const Glib::RefPtr< const Actor >& actor, const Glib::ustring& property_name, Glib::ValueBase& value) const
void	get_preferred_width (const Glib::RefPtr< Container >& container, float for_height, float& min_width_p, float& natural_width_p) const
	Computes the minimum and natural widths of the container according to manager. More...
void	get_preferred_height (const Glib::RefPtr< Container >& container, float for_width, float& min_height_p, float& natural_height_p) const
	Computes the minimum and natural heights of the container according to manager. More...
void	allocate (const Glib::RefPtr< Container >& container, const ActorBox& box, AllocationFlags absolute_origin_changed)
	Allocates the children of container given an area. More...
void	set_container (const Glib::RefPtr< Container >& container)
	If the Clutter::LayoutManager sub-class allows it, allow adding a weak reference of the container using manager from within the layout manager. More...
void	layout_changed ()
	Emits the Clutter::LayoutManager::signal_layout_changed() signal on manager. More...
Glib::RefPtr< LayoutMeta >	get_child_meta (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& actor)
	Retrieves the Clutter::LayoutMeta that the layout manager associated to the actor child of container, eventually by creating one if the Clutter::LayoutManager supports layout properties. More...
Glib::RefPtr< const LayoutMeta >	get_child_meta (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& actor) const
	Retrieves the Clutter::LayoutMeta that the layout manager associated to the actor child of container, eventually by creating one if the Clutter::LayoutManager supports layout properties. More...
Glib::RefPtr< Alpha >	begin_animation (guint duration, gulong mode)
	Begins an animation of duration milliseconds, using the provided easing mode. More...
Glib::RefPtr< const Alpha >	begin_animation (guint duration, gulong mode) const
	Begins an animation of duration milliseconds, using the provided easing mode. More...
double	get_animation_progress ()
	Retrieves the progress of the animation, if one has been started by begin_animation() More...
void	end_animation ()
	Ends an animation started by begin_animation() More...
virtual void	get_preferred_width_vfunc (const Glib::RefPtr< Container >& container, float for_height, float& min_width_p, float& natural_width_p) const
virtual void	get_preferred_height_vfunc (const Glib::RefPtr< Container >& container, float for_width, float& min_height_p, float& natural_height_p) const
virtual void	allocate_vfunc (const Glib::RefPtr< Container >& container, const ActorBox& box, AllocationFlags absolute_origin_changed)
virtual void	set_container_vfunc (const Glib::RefPtr< Container >& container)
virtual GType	get_child_meta_type_vfunc () const
virtual Glib::RefPtr< LayoutMeta >	create_child_meta_vfunc (const Glib::RefPtr< Container >& container, const Glib::RefPtr< Actor >& actor)
virtual Glib::RefPtr< Alpha >	begin_animation_vfunc (guint duration, gulong mode)
virtual double	get_animation_progress_vfunc ()
virtual void	end_animation_vfunc ()
Glib::SignalProxy0< void >	signal_layout_changed ()

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< GridLayout >	create ()
Static Public Member Functions inherited from Clutter::LayoutManager
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system. More...

Protected Member Functions
	GridLayout ()
Protected Member Functions inherited from Clutter::LayoutManager
	LayoutManager ()
virtual void	on_layout_changed ()
	This is a default handler for the signal signal_layout_changed(). More...

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Clutter::GridLayout >	wrap (ClutterGridLayout* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...
Related Functions inherited from Clutter::LayoutManager
Glib::RefPtr < Clutter::LayoutManager >	wrap (ClutterLayoutManager* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Constructor & Destructor Documentation

virtual Clutter::GridLayout::~GridLayout ( )

virtual

Clutter::GridLayout::GridLayout ( )

explicitprotected

Member Function Documentation

void Clutter::GridLayout::attach	(	const Glib::RefPtr< Actor >&	child,
		int	left,
		int	top,
		int	width,
		int	height
	)

Adds a widget to the grid.

The position of child is determined by left and top. The number of 'cells' that child will occupy is determined by width and height.

Since cluttermm 1.12:

Parameters

child	The Clutter::Actor to add.
left	The column number to attach the left side of child to.
top	The row number to attach the top side of child to.
width	The number of columns that child will span.
height	The number of rows that child will span.

void Clutter::GridLayout::attach_next_to	(	const Glib::RefPtr< Actor >&	child,
		const Glib::RefPtr< Actor >&	sibling,
		GridPosition	side,
		int	width,
		int	height
	)

Adds a actor to the grid.

The actor is placed next to sibling, on the side determined by side. When sibling is 0, the actor is placed in row (for left or right placement) or column 0 (for top or bottom placement), at the end indicated by side.

Attaching widgets labeled [1], [2], [3] with sibling == 0 and side == Clutter::GRID_POSITION_LEFT yields a layout of [3][2][1].

Since cluttermm 1.12:

Parameters

child	The actor to add.
sibling	The child of layout that child will be placed next to, or 0 to place child at the beginning or end.
side	The side of sibling that child is positioned next to.
width	The number of columns that child will span.
height	The number of rows that child will span.

static Glib::RefPtr<GridLayout> Clutter::GridLayout::create ( )

static

Glib::RefPtr<Actor> Clutter::GridLayout::get_child_at	(	int	left,
		int	top
	)

Gets the child of layout whose area covers the grid cell whose upper left corner is at left, top.

Since cluttermm 1.12:

Parameters

left	The left edge of the cell.
top	The top edge of the cell.

Returns

The child at the given position, or 0.

Glib::RefPtr<const Actor> Clutter::GridLayout::get_child_at	(	int	left,
		int	top
	)		const

Gets the child of layout whose area covers the grid cell whose upper left corner is at left, top.

Since cluttermm 1.12:

Parameters

left	The left edge of the cell.
top	The top edge of the cell.

Returns

The child at the given position, or 0.

bool Clutter::GridLayout::get_column_homogeneous

(

)

const

Returns whether all columns of layout have the same width.

Returns

Whether all columns of layout have the same width.

guint Clutter::GridLayout::get_column_spacing

(

)

const

Retrieves the spacing set using set_column_spacing()

Since cluttermm 1.12:

Returns

The spacing between coluns of layout.

Orientation Clutter::GridLayout::get_orientation

(

)

const

Retrieves the orientation of the layout.

Since cluttermm 1.12:

Returns

The orientation of the layout.

bool Clutter::GridLayout::get_row_homogeneous

(

)

const

Returns whether all rows of layout have the same height.

Since cluttermm 1.12:

Returns

Whether all rows of layout have the same height.

guint Clutter::GridLayout::get_row_spacing

(

)

const

Retrieves the spacing set using set_row_spacing()

Since cluttermm 1.12:

Returns

The spacing between rows of layout.

static GType Clutter::GridLayout::get_type ( )

static

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

ClutterGridLayout* Clutter::GridLayout::gobj ( )

inline

Provides access to the underlying C GObject.

const ClutterGridLayout* Clutter::GridLayout::gobj ( ) const

inline

Provides access to the underlying C GObject.

ClutterGridLayout* Clutter::GridLayout::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::GridLayout::insert_column

(

int

position)

Inserts a column at the specified position.

Children which are attached at or to the right of this position are moved one column to the right. Children which span across this position are grown to span the new column.

Since cluttermm 1.12:

Parameters

position

The position to insert the column at.

void Clutter::GridLayout::insert_next_to	(	const Glib::RefPtr< Actor >&	sibling,
		GridPosition	side
	)

Inserts a row or column at the specified position.

The new row or column is placed next to sibling, on the side determined by side. If side is Clutter::GRID_POSITION_LEFT or Clutter::GRID_POSITION_BOTTOM, a row is inserted. If side is Clutter::GRID_POSITION_LEFT of Clutter::GRID_POSITION_RIGHT, a column is inserted.

Since cluttermm 1.12:

Parameters

sibling	The child of layout that the new row or column will be placed next to.
side	The side of sibling that child is positioned next to.

void Clutter::GridLayout::insert_row

(

int

position)

Inserts a row at the specified position.

Children which are attached at or below this position are moved one row down. Children which span across this position are grown to span the new row.

Since cluttermm 1.12:

Parameters

position

The position to insert the row at.

Glib::PropertyProxy< bool > Clutter::GridLayout::property_column_homogeneous

(

)

If TRUE, the columns are all the same width.

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::GridLayout::property_column_homogeneous

(

)

const

If TRUE, the columns are all the same width.

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::GridLayout::property_column_spacing

(

)

The amount of space between two consecutive columns.

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::GridLayout::property_column_spacing

(

)

const

The amount of space between two consecutive columns.

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< Orientation > Clutter::GridLayout::property_orientation

(

)

The orientation of the layout.

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< Orientation > Clutter::GridLayout::property_orientation

(

)

const

The orientation of the layout.

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::GridLayout::property_row_homogeneous

(

)

If TRUE, the rows are all the same height.

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::GridLayout::property_row_homogeneous

(

)

const

If TRUE, the rows are all the same height.

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::GridLayout::property_row_spacing

(

)

The amount of space between two consecutive rows.

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::GridLayout::property_row_spacing

(

)

const

The amount of space between two consecutive rows.

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::GridLayout::set_column_homogeneous

(

bool

homogeneous = true)

Sets whether all columns of layout will have the same width.

Since cluttermm 1.12:

Parameters

homogeneous

true to make columns homogeneous.

void Clutter::GridLayout::set_column_spacing

(

guint

spacing)

Sets the spacing between columns of layout.

Since cluttermm 1.12:

Parameters

spacing

The spacing between columns of the layout, in pixels.

void Clutter::GridLayout::set_orientation

(

Orientation

orientation)

Sets the orientation of the layout.

Since cluttermm 1.12:

Parameters

orientation

The orientation of the Clutter::GridLayout.

void Clutter::GridLayout::set_row_homogeneous

(

bool

homogeneous = true)

Sets whether all rows of layout will have the same height.

Since cluttermm 1.12:

Parameters

homogeneous

true to make rows homogeneous.

void Clutter::GridLayout::set_row_spacing

(

guint

spacing)

Sets the spacing between rows of layout.

Since cluttermm 1.12:

Parameters

spacing

The spacing between rows of the layout, in pixels.

Friends And Related Function Documentation

Glib::RefPtr< Clutter::GridLayout > wrap ( ClutterGridLayout *  object, bool  take_copy = false  )

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/grid-layout.h