2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @defgroup Layout Layout
|
2012-04-16 18:35:46 -07:00
|
|
|
* @ingroup Elementary
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
2012-06-05 15:41:21 -07:00
|
|
|
* @image html layout_inheritance_tree.png
|
|
|
|
* @image latex layout_inheritance_tree.eps
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @image html img/widget/layout/preview-00.png
|
|
|
|
* @image latex img/widget/layout/preview-00.eps width=\textwidth
|
|
|
|
*
|
|
|
|
* @image html img/layout-predefined.png
|
|
|
|
* @image latex img/layout-predefined.eps width=\textwidth
|
|
|
|
*
|
2012-05-25 12:53:51 -07:00
|
|
|
* A Layout is a direct realization of @ref elm-layout-class.
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* This is a container widget that takes a standard Edje design file and
|
|
|
|
* wraps it very thinly in a widget.
|
|
|
|
*
|
|
|
|
* An Edje design (theme) file has a very wide range of possibilities to
|
|
|
|
* describe the behavior of elements added to the Layout. Check out the Edje
|
|
|
|
* documentation and the EDC reference to get more information about what can
|
|
|
|
* be done with Edje.
|
|
|
|
*
|
|
|
|
* Just like @ref List, @ref Box, and other container widgets, any
|
|
|
|
* object added to the Layout will become its child, meaning that it will be
|
|
|
|
* deleted if the Layout is deleted, move if the Layout is moved, and so on.
|
|
|
|
*
|
|
|
|
* The Layout widget can contain as many Contents, Boxes or Tables as
|
|
|
|
* described in its theme file. For instance, objects can be added to
|
|
|
|
* different Tables by specifying the respective Table part names. The same
|
|
|
|
* is valid for Content and Box.
|
|
|
|
*
|
|
|
|
* The objects added as child of the Layout will behave as described in the
|
|
|
|
* part description where they were added. There are 3 possible types of
|
|
|
|
* parts where a child can be added:
|
|
|
|
*
|
|
|
|
* @section secContent Content (SWALLOW part)
|
|
|
|
*
|
|
|
|
* Only one object can be added to the @c SWALLOW part (but you still can
|
|
|
|
* have many @c SWALLOW parts and one object on each of them). Use the @c
|
|
|
|
* elm_object_content_set/get/unset functions to set, retrieve and unset
|
|
|
|
* objects as content of the @c SWALLOW. After being set to this part, the
|
|
|
|
* object size, position, visibility, clipping and other description
|
|
|
|
* properties will be totally controlled by the description of the given part
|
|
|
|
* (inside the Edje theme file).
|
|
|
|
*
|
|
|
|
* One can use @c evas_object_size_hint_* functions on the child to have some
|
|
|
|
* kind of control over its behavior, but the resulting behavior will still
|
|
|
|
* depend heavily on the @c SWALLOW part description.
|
|
|
|
*
|
|
|
|
* The Edje theme also can change the part description, based on signals or
|
|
|
|
* scripts running inside the theme. This change can also be animated. All of
|
|
|
|
* this will affect the child object set as content accordingly. The object
|
|
|
|
* size will be changed if the part size is changed, it will animate move if
|
|
|
|
* the part is moving, and so on.
|
|
|
|
*
|
|
|
|
* The following picture demonstrates a Layout widget with a child object
|
|
|
|
* added to its @c SWALLOW:
|
|
|
|
*
|
|
|
|
* @image html layout_swallow.png
|
|
|
|
* @image latex layout_swallow.eps width=\textwidth
|
|
|
|
*
|
|
|
|
* @section secBox Box (BOX part)
|
|
|
|
*
|
|
|
|
* An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
|
|
|
|
* allows one to add objects to the box and have them distributed along its
|
|
|
|
* area, accordingly to the specified @a layout property (now by @a layout we
|
|
|
|
* mean the chosen layouting design of the Box, not the Layout widget
|
|
|
|
* itself).
|
|
|
|
*
|
|
|
|
* A similar effect for having a box with its position, size and other things
|
|
|
|
* controlled by the Layout theme would be to create an Elementary @ref Box
|
|
|
|
* widget and add it as a Content in the @c SWALLOW part.
|
|
|
|
*
|
|
|
|
* The main difference of using the Layout Box is that its behavior, the box
|
|
|
|
* properties like layouting format, padding, align, etc. will be all
|
|
|
|
* controlled by the theme. This means, for example, that a signal could be
|
|
|
|
* sent to the Layout theme (with elm_object_signal_emit()) and the theme
|
|
|
|
* handled the signal by changing the box padding, or align, or both. Using
|
|
|
|
* the Elementary @ref Box widget is not necessarily harder or easier, it
|
2012-02-14 00:50:40 -08:00
|
|
|
* just depends on the circumstances and requirements.
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* The Layout Box can be used through the @c elm_layout_box_* set of
|
|
|
|
* functions.
|
|
|
|
*
|
|
|
|
* The following picture demonstrates a Layout widget with many child objects
|
|
|
|
* added to its @c BOX part:
|
|
|
|
*
|
|
|
|
* @image html layout_box.png
|
|
|
|
* @image latex layout_box.eps width=\textwidth
|
|
|
|
*
|
|
|
|
* @section secTable Table (TABLE part)
|
|
|
|
*
|
|
|
|
* Just like the @ref secBox, the Layout Table is very similar to the
|
|
|
|
* Elementary @ref Table widget. It allows one to add objects to the Table
|
|
|
|
* specifying the row and column where the object should be added, and any
|
|
|
|
* column or row span if necessary.
|
|
|
|
*
|
|
|
|
* Again, we could have this design by adding a @ref Table widget to the @c
|
|
|
|
* SWALLOW part using elm_object_part_content_set(). The same difference happens
|
|
|
|
* here when choosing to use the Layout Table (a @c TABLE part) instead of
|
|
|
|
* the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
|
|
|
|
*
|
|
|
|
* The Layout Table can be used through the @c elm_layout_table_* set of
|
|
|
|
* functions.
|
|
|
|
*
|
|
|
|
* The following picture demonstrates a Layout widget with many child objects
|
|
|
|
* added to its @c TABLE part:
|
|
|
|
*
|
|
|
|
* @image html layout_table.png
|
|
|
|
* @image latex layout_table.eps width=\textwidth
|
|
|
|
*
|
|
|
|
* @section secPredef Predefined Layouts
|
|
|
|
*
|
|
|
|
* Another interesting thing about the Layout widget is that it offers some
|
|
|
|
* predefined themes that come with the default Elementary theme. These
|
|
|
|
* themes can be set by the call elm_layout_theme_set(), and provide some
|
|
|
|
* basic functionality depending on the theme used.
|
|
|
|
*
|
|
|
|
* Most of them already send some signals, some already provide a toolbar or
|
|
|
|
* back and next buttons.
|
|
|
|
*
|
|
|
|
* These are available predefined theme layouts. All of them have class = @c
|
|
|
|
* layout, group = @c application, and style = one of the following options:
|
|
|
|
*
|
|
|
|
* @li @c toolbar-content - application with toolbar and main content area
|
|
|
|
* @li @c toolbar-content-back - application with toolbar and main content
|
|
|
|
* area with a back button and title area
|
|
|
|
* @li @c toolbar-content-back-next - application with toolbar and main
|
|
|
|
* content area with a back and next buttons and title area
|
|
|
|
* @li @c content-back - application with a main content area with a back
|
|
|
|
* button and title area
|
|
|
|
* @li @c content-back-next - application with a main content area with a
|
|
|
|
* back and next buttons and title area
|
|
|
|
* @li @c toolbar-vbox - application with toolbar and main content area as a
|
|
|
|
* vertical box
|
|
|
|
* @li @c toolbar-table - application with toolbar and main content area as a
|
|
|
|
* table
|
|
|
|
*
|
2012-01-08 22:55:51 -08:00
|
|
|
* Supported elm_object common APIs.
|
2012-04-17 13:33:59 -07:00
|
|
|
* @li @ref elm_object_signal_emit
|
|
|
|
* @li @ref elm_object_signal_callback_add
|
|
|
|
* @li @ref elm_object_signal_callback_del
|
|
|
|
* @li @ref elm_object_part_text_set
|
|
|
|
* @li @ref elm_object_part_text_get
|
|
|
|
* @li @ref elm_object_part_content_set
|
|
|
|
* @li @ref elm_object_part_content_get
|
|
|
|
* @li @ref elm_object_part_content_unset
|
2012-01-08 22:55:51 -08:00
|
|
|
*
|
2012-05-16 04:04:11 -07:00
|
|
|
* @section layout-signals Emitted signals
|
|
|
|
*
|
|
|
|
* This widget emits the following signals:
|
|
|
|
*
|
|
|
|
* @li "theme,changed": The theme was changed.
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @section secExamples Examples
|
|
|
|
*
|
|
|
|
* Some examples of the Layout widget can be found here:
|
|
|
|
* @li @ref layout_example_01
|
|
|
|
* @li @ref layout_example_02
|
|
|
|
* @li @ref layout_example_03
|
|
|
|
* @li @ref layout_example_edc
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a new layout to the parent
|
|
|
|
*
|
|
|
|
* @param parent The parent object
|
|
|
|
* @return The new object or NULL if it cannot be created
|
|
|
|
*
|
|
|
|
* @see elm_layout_file_set()
|
|
|
|
* @see elm_layout_theme_set()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Evas_Object *elm_layout_add(Evas_Object *parent);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the file that will be used as layout
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param file The path to file (edj) that will be used as layout
|
|
|
|
* @param group The group that the layout belongs in edje file
|
|
|
|
*
|
|
|
|
* @return (1 = success, 0 = error)
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the edje group from the elementary theme that will be used as layout
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
2012-02-14 00:50:40 -08:00
|
|
|
* @param clas the class of the group
|
2011-12-29 23:20:48 -08:00
|
|
|
* @param group the group
|
|
|
|
* @param style the style to used
|
|
|
|
*
|
|
|
|
* @return (1 = success, 0 = error)
|
|
|
|
*
|
2012-05-03 15:41:26 -07:00
|
|
|
* Note that @a style will be the new style of @a obj too, as in an
|
|
|
|
* elm_object_style_set() call.
|
|
|
|
*
|
2011-12-29 23:20:48 -08:00
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
2012-05-03 15:41:26 -07:00
|
|
|
/**
|
|
|
|
* Send a (Edje) signal to a given layout widget's underlying Edje
|
|
|
|
* object.
|
|
|
|
*
|
|
|
|
* @param obj The layout object handle
|
|
|
|
* @param emission The signal's name string
|
|
|
|
* @param source The signal's source string
|
|
|
|
*
|
|
|
|
* This function sends a signal to the underlying Edje object of @a
|
|
|
|
* obj. An Edje program on that Edje object's definition can respond
|
|
|
|
* to a signal by specifying matching 'signal' and 'source' fields.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
|
|
|
EAPI void elm_layout_signal_emit(Evas_Object *obj, const char *emission, const char *source);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Add a callback for a (Edje) signal emitted by a layout widget's
|
|
|
|
* underlying Edje object.
|
|
|
|
*
|
|
|
|
* @param obj The layout object handle
|
|
|
|
* @param emission The signal's name string
|
|
|
|
* @param source The signal's source string
|
|
|
|
* @param func The callback function to be executed when the signal is
|
|
|
|
* emitted.
|
|
|
|
* @param data A pointer to data to pass in to the callback function.
|
|
|
|
*
|
|
|
|
* This function connects a callback function to a signal emitted by
|
|
|
|
* the underlying Edje object of @a obj. Globs are accepted in either
|
|
|
|
* the emission or source strings (see @c
|
|
|
|
* edje_object_signal_callback_add()).
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
|
|
|
EAPI void elm_layout_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove a signal-triggered callback from a given layout widget.
|
|
|
|
*
|
|
|
|
* @param obj The layout object handle
|
|
|
|
* @param emission The signal's name string
|
|
|
|
* @param source The signal's source string
|
|
|
|
* @param func The callback function being executed when the signal
|
|
|
|
* was emitted.
|
|
|
|
* @return The data pointer of the signal callback (passed on
|
|
|
|
* elm_layout_signal_callback_add()) or @c NULL, on errors.
|
|
|
|
*
|
|
|
|
* This function removes the @b last callback attached to a signal
|
|
|
|
* emitted by the undelying Edje object of @a obj, with parameters @a
|
|
|
|
* emission, @a source and @c func matching exactly those passed to a
|
|
|
|
* previous call to elm_object_signal_callback_add(). The data pointer
|
|
|
|
* that was passed to this call will be returned.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
|
|
|
EAPI void *elm_layout_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func);
|
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Append child to layout box part.
|
|
|
|
*
|
|
|
|
* @param obj the layout object
|
|
|
|
* @param part the box part to which the object will be appended.
|
|
|
|
* @param child the child object to append to box.
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Once the object is appended, it will become child of the layout. Its
|
|
|
|
* lifetime will be bound to the layout, whenever the layout dies the child
|
|
|
|
* will be deleted automatically. One should use elm_layout_box_remove() to
|
|
|
|
* make this layout forget about the object.
|
|
|
|
*
|
|
|
|
* @see elm_layout_box_prepend()
|
|
|
|
* @see elm_layout_box_insert_before()
|
|
|
|
* @see elm_layout_box_insert_at()
|
|
|
|
* @see elm_layout_box_remove()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Prepend child to layout box part.
|
|
|
|
*
|
|
|
|
* @param obj the layout object
|
|
|
|
* @param part the box part to prepend.
|
|
|
|
* @param child the child object to prepend to box.
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Once the object is prepended, it will become child of the layout. Its
|
|
|
|
* lifetime will be bound to the layout, whenever the layout dies the child
|
|
|
|
* will be deleted automatically. One should use elm_layout_box_remove() to
|
|
|
|
* make this layout forget about the object.
|
|
|
|
*
|
|
|
|
* @see elm_layout_box_append()
|
|
|
|
* @see elm_layout_box_insert_before()
|
|
|
|
* @see elm_layout_box_insert_at()
|
|
|
|
* @see elm_layout_box_remove()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Insert child to layout box part before a reference object.
|
|
|
|
*
|
|
|
|
* @param obj the layout object
|
|
|
|
* @param part the box part to insert.
|
|
|
|
* @param child the child object to insert into box.
|
|
|
|
* @param reference another reference object to insert before in box.
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Once the object is inserted, it will become child of the layout. Its
|
|
|
|
* lifetime will be bound to the layout, whenever the layout dies the child
|
|
|
|
* will be deleted automatically. One should use elm_layout_box_remove() to
|
|
|
|
* make this layout forget about the object.
|
|
|
|
*
|
|
|
|
* @see elm_layout_box_append()
|
|
|
|
* @see elm_layout_box_prepend()
|
|
|
|
* @see elm_layout_box_insert_before()
|
|
|
|
* @see elm_layout_box_remove()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Insert child to layout box part at a given position.
|
|
|
|
*
|
|
|
|
* @param obj the layout object
|
|
|
|
* @param part the box part to insert.
|
|
|
|
* @param child the child object to insert into box.
|
|
|
|
* @param pos the numeric position >=0 to insert the child.
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Once the object is inserted, it will become child of the layout. Its
|
|
|
|
* lifetime will be bound to the layout, whenever the layout dies the child
|
|
|
|
* will be deleted automatically. One should use elm_layout_box_remove() to
|
|
|
|
* make this layout forget about the object.
|
|
|
|
*
|
|
|
|
* @see elm_layout_box_append()
|
|
|
|
* @see elm_layout_box_prepend()
|
|
|
|
* @see elm_layout_box_insert_before()
|
|
|
|
* @see elm_layout_box_remove()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove a child of the given part box.
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param part The box part name to remove child.
|
|
|
|
* @param child The object to remove from box.
|
|
|
|
* @return The object that was being used, or NULL if not found.
|
|
|
|
*
|
|
|
|
* The object will be removed from the box part and its lifetime will
|
|
|
|
* not be handled by the layout anymore. This is equivalent to
|
|
|
|
* elm_object_part_content_unset() for box.
|
|
|
|
*
|
|
|
|
* @see elm_layout_box_append()
|
|
|
|
* @see elm_layout_box_remove_all()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove all children of the given part box.
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param part The box part name to remove child.
|
|
|
|
* @param clear If EINA_TRUE, then all objects will be deleted as
|
|
|
|
* well, otherwise they will just be removed and will be
|
|
|
|
* dangling on the canvas.
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* The objects will be removed from the box part and their lifetime will
|
|
|
|
* not be handled by the layout anymore. This is equivalent to
|
|
|
|
* elm_layout_box_remove() for all box children.
|
|
|
|
*
|
|
|
|
* @see elm_layout_box_append()
|
|
|
|
* @see elm_layout_box_remove()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Insert child to layout table part.
|
|
|
|
*
|
|
|
|
* @param obj the layout object
|
|
|
|
* @param part the box part to pack child.
|
|
|
|
* @param child_obj the child object to pack into table.
|
|
|
|
* @param col the column to which the child should be added. (>= 0)
|
|
|
|
* @param row the row to which the child should be added. (>= 0)
|
|
|
|
* @param colspan how many columns should be used to store this object. (>=
|
|
|
|
* 1)
|
|
|
|
* @param rowspan how many rows should be used to store this object. (>= 1)
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* Once the object is inserted, it will become child of the table. Its
|
|
|
|
* lifetime will be bound to the layout, and whenever the layout dies the
|
|
|
|
* child will be deleted automatically. One should use
|
|
|
|
* elm_layout_table_remove() to make this layout forget about the object.
|
|
|
|
*
|
|
|
|
* If @p colspan or @p rowspan are bigger than 1, that object will occupy
|
|
|
|
* more space than a single cell. For instance, the following code:
|
|
|
|
* @code
|
|
|
|
* elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
|
|
|
|
* @endcode
|
|
|
|
*
|
|
|
|
* Would result in an object being added like the following picture:
|
|
|
|
*
|
|
|
|
* @image html layout_colspan.png
|
|
|
|
* @image latex layout_colspan.eps width=\textwidth
|
|
|
|
*
|
|
|
|
* @see elm_layout_table_unpack()
|
|
|
|
* @see elm_layout_table_clear()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_table_pack(Evas_Object *obj, const char *part, Evas_Object *child_obj, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Unpack (remove) a child of the given part table.
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param part The table part name to remove child.
|
|
|
|
* @param child_obj The object to remove from table.
|
|
|
|
* @return The object that was being used, or NULL if not found.
|
|
|
|
*
|
|
|
|
* The object will be unpacked from the table part and its lifetime
|
|
|
|
* will not be handled by the layout anymore. This is equivalent to
|
|
|
|
* elm_object_part_content_unset() for table.
|
|
|
|
*
|
|
|
|
* @see elm_layout_table_pack()
|
|
|
|
* @see elm_layout_table_clear()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Remove all the child objects of the given part table.
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param part The table part name to remove child.
|
|
|
|
* @param clear If EINA_TRUE, then all objects will be deleted as
|
|
|
|
* well, otherwise they will just be removed and will be
|
|
|
|
* dangling on the canvas.
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* The objects will be removed from the table part and their lifetime will
|
|
|
|
* not be handled by the layout anymore. This is equivalent to
|
|
|
|
* elm_layout_table_unpack() for all table children.
|
|
|
|
*
|
|
|
|
* @see elm_layout_table_pack()
|
|
|
|
* @see elm_layout_table_unpack()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the edje layout
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
*
|
|
|
|
* @return A Evas_Object with the edje layout settings loaded
|
|
|
|
* with function elm_layout_file_set
|
|
|
|
*
|
|
|
|
* This returns the edje object. It is not expected to be used to then
|
|
|
|
* swallow objects via edje_object_part_swallow() for example. Use
|
|
|
|
* elm_object_part_content_set() instead so child object handling and sizing is
|
|
|
|
* done properly.
|
|
|
|
*
|
|
|
|
* @note This function should only be used if you really need to call some
|
|
|
|
* low level Edje function on this edje object. All the common stuff (setting
|
|
|
|
* text, emitting signals, hooking callbacks to signals, etc.) can be done
|
|
|
|
* with proper elementary functions.
|
|
|
|
*
|
|
|
|
* @see elm_object_signal_callback_add()
|
|
|
|
* @see elm_object_signal_emit()
|
|
|
|
* @see elm_object_part_text_set()
|
|
|
|
* @see elm_object_part_content_set()
|
|
|
|
* @see elm_layout_box_append()
|
|
|
|
* @see elm_layout_table_pack()
|
|
|
|
* @see elm_layout_data_get()
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the edje data from the given layout
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param key The data key
|
|
|
|
*
|
|
|
|
* @return The edje data string
|
|
|
|
*
|
|
|
|
* This function fetches data specified inside the edje theme of this layout.
|
|
|
|
* This function return NULL if data is not found.
|
|
|
|
*
|
|
|
|
* In EDC this comes from a data block within the group block that @p
|
|
|
|
* obj was loaded from. E.g.
|
|
|
|
*
|
|
|
|
* @code
|
|
|
|
* collections {
|
|
|
|
* group {
|
|
|
|
* name: "a_group";
|
|
|
|
* data {
|
|
|
|
* item: "key1" "value1";
|
|
|
|
* item: "key2" "value2";
|
|
|
|
* }
|
|
|
|
* }
|
|
|
|
* }
|
|
|
|
* @endcode
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Eval sizing
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
*
|
|
|
|
* Manually forces a sizing re-evaluation. This is useful when the minimum
|
|
|
|
* size required by the edje theme of this layout has changed. The change on
|
|
|
|
* the minimum size required by the edje theme is not immediately reported to
|
|
|
|
* the elementary layout, so one needs to call this function in order to tell
|
|
|
|
* the widget (layout) that it needs to reevaluate its own size.
|
|
|
|
*
|
|
|
|
* The minimum size of the theme is calculated based on minimum size of
|
|
|
|
* parts, the size of elements inside containers like box and table, etc. All
|
|
|
|
* of this can change due to state changes, and that's when this function
|
|
|
|
* should be called.
|
|
|
|
*
|
|
|
|
* Also note that a standard signal of "size,eval" "elm" emitted from the
|
|
|
|
* edje object will cause this to happen too.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI void elm_layout_sizing_eval(Evas_Object *obj);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets a specific cursor for an edje part.
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param part_name a part from loaded edje group.
|
|
|
|
* @param cursor cursor name to use, see Elementary_Cursor.h
|
|
|
|
*
|
|
|
|
* @return EINA_TRUE on success or EINA_FALSE on failure, that may be
|
|
|
|
* part not exists or it has "mouse_events: 0".
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the cursor to be shown when mouse is over an edje part
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param part_name a part from loaded edje group.
|
|
|
|
* @return the cursor name.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Unsets a cursor previously set with elm_layout_part_cursor_set().
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param part_name a part from loaded edje group, that had a cursor set
|
|
|
|
* with elm_layout_part_cursor_set().
|
2012-03-06 12:25:29 -08:00
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
2011-12-29 23:20:48 -08:00
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-03-06 12:25:29 -08:00
|
|
|
EAPI Eina_Bool elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets a specific cursor style for an edje part.
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param part_name a part from loaded edje group.
|
|
|
|
* @param style the theme style to use (default, transparent, ...)
|
|
|
|
*
|
|
|
|
* @return EINA_TRUE on success or EINA_FALSE on failure, that may be
|
|
|
|
* part not exists or it did not had a cursor set.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Gets a specific cursor style for an edje part.
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param part_name a part from loaded edje group.
|
|
|
|
*
|
|
|
|
* @return the theme style in use, defaults to "default". If the
|
|
|
|
* object does not have a cursor set, then NULL is returned.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Sets if the cursor set should be searched on the theme or should use
|
|
|
|
* the provided by the engine, only.
|
|
|
|
*
|
|
|
|
* @note before you set if should look on theme you should define a
|
|
|
|
* cursor with elm_layout_part_cursor_set(). By default it will only
|
|
|
|
* look for cursors provided by the engine.
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param part_name a part from loaded edje group.
|
|
|
|
* @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
|
|
|
|
* or should also search on widget's theme as well (EINA_FALSE)
|
|
|
|
*
|
|
|
|
* @return EINA_TRUE on success or EINA_FALSE on failure, that may be
|
|
|
|
* part not exists or it did not had a cursor set.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Eina_Bool elm_layout_part_cursor_engine_only_set(Evas_Object *obj, const char *part_name, Eina_Bool engine_only);
|
2011-12-29 23:20:48 -08:00
|
|
|
|
2012-07-05 21:03:21 -07:00
|
|
|
/*
|
|
|
|
* Set accessibility to all texblock(text) parts in the layout object
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param can_access makes all textblock(text) parts in the layout @p obj possible
|
|
|
|
* to have accessibility. @c EINA_TRUE means textblock(text) parts can be accessible
|
|
|
|
*
|
|
|
|
* @return @c EINA_TRUE on success or @c EINA_FALSE on failure. If @p obj is not
|
|
|
|
* a proper layout object, @c EINA_FALSE is returned.
|
|
|
|
*
|
2012-07-09 03:20:21 -07:00
|
|
|
* @since 1.7
|
2012-07-05 21:03:21 -07:00
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-07-06 20:50:59 -07:00
|
|
|
EAPI Eina_Bool elm_layout_edje_object_can_access_set(Evas_Object *obj, Eina_Bool can_access);
|
2012-07-05 21:03:21 -07:00
|
|
|
|
|
|
|
/*
|
|
|
|
* Get accessibility state of texblock(text) parts in the layout object
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
*
|
|
|
|
* @return @c EINA_TRUE, if all textblock(text) parts in the layout can be accessible
|
|
|
|
* @c EINA_FALSET if those cannot be accessible. If @p obj is not a proper layout
|
|
|
|
* object, @c EINA_FALSE is returned.
|
|
|
|
*
|
|
|
|
* @see elm_layout_edje_object_access_set()
|
|
|
|
*
|
2012-07-09 03:20:21 -07:00
|
|
|
* @since 1.7
|
2012-07-05 21:03:21 -07:00
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2012-07-06 20:50:59 -07:00
|
|
|
EAPI Eina_Bool elm_layout_edje_object_can_access_get(Evas_Object *obj);
|
2012-07-05 21:03:21 -07:00
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* Gets a specific cursor engine_only for an edje part.
|
|
|
|
*
|
|
|
|
* @param obj The layout object.
|
|
|
|
* @param part_name a part from loaded edje group.
|
|
|
|
*
|
|
|
|
* @return whenever the cursor is just provided by engine or also from theme.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-30 01:48:46 -08:00
|
|
|
EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name);
|
2011-12-29 22:49:28 -08:00
|
|
|
|
2012-05-03 15:41:26 -07:00
|
|
|
/**
|
|
|
|
* Set the layout content.
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param swallow The swallow part name in the edje file
|
|
|
|
* @param content The child that will be added in this layout object
|
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
|
|
|
*
|
|
|
|
* Once the content object is set, a previously set one will be deleted.
|
|
|
|
* If you want to keep that old content object, use the
|
|
|
|
* elm_object_part_content_unset() function.
|
|
|
|
*
|
|
|
|
* @note In an Edje theme, the part used as a content container is called @c
|
|
|
|
* SWALLOW. This is why the parameter name is called @p swallow, but it is
|
|
|
|
* expected to be a part name just like the second parameter of
|
|
|
|
* elm_layout_box_append().
|
|
|
|
*
|
|
|
|
* @see elm_layout_box_append()
|
|
|
|
* @see elm_object_part_content_get()
|
|
|
|
* @see elm_object_part_content_unset()
|
|
|
|
* @see @ref secBox
|
|
|
|
*/
|
|
|
|
EAPI Eina_Bool elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the child object in the given content part.
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param swallow The SWALLOW part to get its content
|
|
|
|
*
|
|
|
|
* @return The swallowed object or NULL if none or an error occurred
|
|
|
|
*/
|
|
|
|
EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Unset the layout content.
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param swallow The swallow part name in the edje file
|
|
|
|
* @return The content that was being used
|
|
|
|
*
|
|
|
|
* Unparent and return the content object which was set for this part.
|
|
|
|
*/
|
|
|
|
EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Set the text of the given part
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param part The TEXT part where to set the text
|
|
|
|
* @param text The text to set
|
|
|
|
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
|
|
|
|
*/
|
|
|
|
EAPI Eina_Bool elm_layout_text_set(Evas_Object *obj, const char *part, const char *text);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the text set in the given part
|
|
|
|
*
|
|
|
|
* @param obj The layout object
|
|
|
|
* @param part The TEXT part to retrieve the text off
|
|
|
|
*
|
|
|
|
* @return The text set in @p part
|
|
|
|
*/
|
|
|
|
EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part);
|
|
|
|
|
2011-12-29 22:49:28 -08:00
|
|
|
/**
|
|
|
|
* @def elm_layout_icon_set
|
|
|
|
* Convenience macro to set the icon object in a layout that follows the
|
|
|
|
* Elementary naming convention for its parts.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-29 23:20:48 -08:00
|
|
|
#define elm_layout_icon_set(_ly, _obj) \
|
|
|
|
do { \
|
|
|
|
const char *sig; \
|
|
|
|
elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
|
|
|
|
if ((_obj)) sig = "elm,state,icon,visible"; \
|
|
|
|
else sig = "elm,state,icon,hidden"; \
|
|
|
|
elm_object_signal_emit((_ly), sig, "elm"); \
|
|
|
|
} while (0)
|
2011-12-29 22:49:28 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @def elm_layout_icon_get
|
2012-02-14 00:50:40 -08:00
|
|
|
* Convenience macro to get the icon object from a layout that follows the
|
2011-12-29 22:49:28 -08:00
|
|
|
* Elementary naming convention for its parts.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
|
|
|
#define elm_layout_icon_get(_ly) \
|
|
|
|
elm_object_part_content_get((_ly), "elm.swallow.icon")
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @def elm_layout_end_set
|
2012-02-14 00:50:40 -08:00
|
|
|
* Convenience macro to set the end object in a layout that follows the
|
2011-12-29 22:49:28 -08:00
|
|
|
* Elementary naming convention for its parts.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
2011-12-29 23:20:48 -08:00
|
|
|
#define elm_layout_end_set(_ly, _obj) \
|
|
|
|
do { \
|
|
|
|
const char *sig; \
|
|
|
|
elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
|
|
|
|
if ((_obj)) sig = "elm,state,end,visible"; \
|
|
|
|
else sig = "elm,state,end,hidden"; \
|
|
|
|
elm_object_signal_emit((_ly), sig, "elm"); \
|
|
|
|
} while (0)
|
2011-12-29 22:49:28 -08:00
|
|
|
|
|
|
|
/**
|
|
|
|
* @def elm_layout_end_get
|
2012-02-14 00:50:40 -08:00
|
|
|
* Convenience macro to get the end object in a layout that follows the
|
2011-12-29 22:49:28 -08:00
|
|
|
* Elementary naming convention for its parts.
|
|
|
|
*
|
|
|
|
* @ingroup Layout
|
|
|
|
*/
|
|
|
|
#define elm_layout_end_get(_ly) \
|
|
|
|
elm_object_part_content_get((_ly), "elm.swallow.end")
|
|
|
|
|
2011-12-29 23:20:48 -08:00
|
|
|
/**
|
|
|
|
* @}
|
|
|
|
*/
|