cluttermm: Clutter::FlowLayout Class Reference
Public Member Functions | |
virtual | ~FlowLayout () |
ClutterFlowLayout* | gobj () |
Provides access to the underlying C GObject. More... | |
const ClutterFlowLayout* | gobj () const |
Provides access to the underlying C GObject. More... | |
ClutterFlowLayout* | 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_homogeneous (bool homogeneous) |
Sets whether the layout should allocate the same space for each child. More... | |
bool | get_homogeneous () const |
Retrieves whether the layout is homogeneous. More... | |
void | set_orientation (FlowOrientation orientation) |
Sets the orientation of the flow layout. More... | |
FlowOrientation | get_orientation () const |
Retrieves the orientation of the layout. More... | |
void | set_snap_to_grid (bool snap_to_grid) |
Whether the layout should place its children on a grid. More... | |
bool | get_snap_to_grid () const |
Retrieves the value of Clutter::FlowLayout::property_snap_to_grid() property. More... | |
void | set_column_spacing (float spacing) |
Sets the space between columns, in pixels. More... | |
float | get_column_spacing () const |
Retrieves the spacing between columns. More... | |
void | set_row_spacing (float spacing) |
Sets the spacing between rows, in pixels. More... | |
float | get_row_spacing () const |
Retrieves the spacing between rows. More... | |
void | set_column_width (float min_width, float max_width) |
Sets the minimum and maximum widths that a column can have. More... | |
void | get_column_width (float& min_width, float& max_width) const |
Retrieves the minimum and maximum column widths. More... | |
void | set_row_height (float min_height, float max_height) |
Sets the minimum and maximum heights that a row can have. More... | |
void | get_row_height (float& min_height, float& max_height) const |
Retrieves the minimum and maximum row heights. More... | |
Glib::PropertyProxy< bool > | property_homogeneous () |
Whether each item should receive the same allocation. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_homogeneous () const |
Whether each item should receive the same allocation. More... | |
Glib::PropertyProxy < FlowOrientation > | property_orientation () |
The orientation of the layout. More... | |
Glib::PropertyProxy_ReadOnly < FlowOrientation > | property_orientation () const |
The orientation of the layout. More... | |
Glib::PropertyProxy< float > | property_column_spacing () |
The spacing between columns. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_column_spacing () const |
The spacing between columns. More... | |
Glib::PropertyProxy< float > | property_row_spacing () |
The spacing between rows. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_row_spacing () const |
The spacing between rows. More... | |
Glib::PropertyProxy< float > | property_min_column_width () |
Minimum width for each column. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_min_column_width () const |
Minimum width for each column. More... | |
Glib::PropertyProxy< float > | property_max_column_width () |
Maximum width for each column. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_max_column_width () const |
Maximum width for each column. More... | |
Glib::PropertyProxy< float > | property_min_row_height () |
Minimum height for each row. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_min_row_height () const |
Minimum height for each row. More... | |
Glib::PropertyProxy< float > | property_max_row_height () |
Maximum height for each row. More... | |
Glib::PropertyProxy_ReadOnly < float > | property_max_row_height () const |
Maximum height for each row. More... | |
Glib::PropertyProxy< bool > | property_snap_to_grid () |
Snap to grid. More... | |
Glib::PropertyProxy_ReadOnly < bool > | property_snap_to_grid () const |
Snap to grid. 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< FlowLayout > | create (FlowOrientation orientation) |
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 | |
FlowLayout (FlowOrientation orientation) | |
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::FlowLayout > | wrap (ClutterFlowLayout* 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 |
|
explicitprotected |
Member Function Documentation
|
static |
float Clutter::FlowLayout::get_column_spacing | ( | ) | const |
Retrieves the spacing between columns.
- Returns
- The spacing between columns of the Clutter::FlowLayout, in pixels.
void Clutter::FlowLayout::get_column_width | ( | float & | min_width, |
float & | max_width | ||
) | const |
Retrieves the minimum and maximum column widths.
- Parameters
-
min_width Return location for the minimum column width, or 0
.max_width Return location for the maximum column width, or 0
.
bool Clutter::FlowLayout::get_homogeneous | ( | ) | const |
Retrieves whether the layout is homogeneous.
- Returns
true
if the Clutter::FlowLayout is homogeneous.
FlowOrientation Clutter::FlowLayout::get_orientation | ( | ) | const |
Retrieves the orientation of the layout.
- Returns
- The orientation of the Clutter::FlowLayout.
void Clutter::FlowLayout::get_row_height | ( | float & | min_height, |
float & | max_height | ||
) | const |
Retrieves the minimum and maximum row heights.
- Parameters
-
min_height Return location for the minimum row height, or 0
.max_height Return location for the maximum row height, or 0
.
float Clutter::FlowLayout::get_row_spacing | ( | ) | const |
Retrieves the spacing between rows.
- Returns
- The spacing between rows of the Clutter::FlowLayout, in pixels.
bool Clutter::FlowLayout::get_snap_to_grid | ( | ) | const |
Retrieves the value of Clutter::FlowLayout::property_snap_to_grid() property.
- Returns
true
if the layout is placing its children on a grid.
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
ClutterFlowLayout* Clutter::FlowLayout::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::PropertyProxy< float > Clutter::FlowLayout::property_column_spacing | ( | ) |
The spacing between 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< float > Clutter::FlowLayout::property_column_spacing | ( | ) | const |
The spacing between 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< bool > Clutter::FlowLayout::property_homogeneous | ( | ) |
Whether each item should receive the same allocation.
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::FlowLayout::property_homogeneous | ( | ) | const |
Whether each item should receive the same allocation.
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< float > Clutter::FlowLayout::property_max_column_width | ( | ) |
Maximum width for each column.
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< float > Clutter::FlowLayout::property_max_column_width | ( | ) | const |
Maximum width for each column.
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< float > Clutter::FlowLayout::property_max_row_height | ( | ) |
Maximum height for each row.
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< float > Clutter::FlowLayout::property_max_row_height | ( | ) | const |
Maximum height for each row.
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< float > Clutter::FlowLayout::property_min_column_width | ( | ) |
Minimum width for each column.
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< float > Clutter::FlowLayout::property_min_column_width | ( | ) | const |
Minimum width for each column.
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< float > Clutter::FlowLayout::property_min_row_height | ( | ) |
Minimum height for each row.
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< float > Clutter::FlowLayout::property_min_row_height | ( | ) | const |
Minimum height for each row.
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< FlowOrientation > Clutter::FlowLayout::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< FlowOrientation > Clutter::FlowLayout::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< float > Clutter::FlowLayout::property_row_spacing | ( | ) |
The spacing between 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< float > Clutter::FlowLayout::property_row_spacing | ( | ) | const |
The spacing between 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.
Glib::PropertyProxy< bool > Clutter::FlowLayout::property_snap_to_grid | ( | ) |
Snap to grid.
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::FlowLayout::property_snap_to_grid | ( | ) | const |
Snap to grid.
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::FlowLayout::set_column_spacing | ( | float | spacing) |
Sets the space between columns, in pixels.
- Parameters
-
spacing The space between columns.
void Clutter::FlowLayout::set_column_width | ( | float | min_width, |
float | max_width | ||
) |
Sets the minimum and maximum widths that a column can have.
- Parameters
-
min_width Minimum width of a column. max_width Maximum width of a column.
void Clutter::FlowLayout::set_homogeneous | ( | bool | homogeneous) |
Sets whether the layout should allocate the same space for each child.
- Parameters
-
homogeneous Whether the layout should be homogeneous or not.
void Clutter::FlowLayout::set_orientation | ( | FlowOrientation | orientation) |
Sets the orientation of the flow layout.
The orientation controls the direction used to allocate the children: either horizontally or vertically. The orientation also controls the direction of the overflowing
- Parameters
-
orientation The orientation of the layout.
void Clutter::FlowLayout::set_row_height | ( | float | min_height, |
float | max_height | ||
) |
Sets the minimum and maximum heights that a row can have.
- Parameters
-
min_height The minimum height of a row. max_height The maximum height of a row.
void Clutter::FlowLayout::set_row_spacing | ( | float | spacing) |
Sets the spacing between rows, in pixels.
- Parameters
-
spacing The space between rows.
void Clutter::FlowLayout::set_snap_to_grid | ( | bool | snap_to_grid) |
Whether the layout should place its children on a grid.
- Parameters
-
snap_to_grid true
if layout should place its children on a grid.
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/flow-layout.h