* @}
*/
- /* layout */
+ /**
+ * @defgroup Layout Layout
+ *
+ * @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
+ *
+ * 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 controled 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
+ * controled 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
+ * controled 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
+ * just depends on the circunstances and requirements.
+ *
+ * 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_content_part_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
+ *
+ * @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
+ */
EAPI Evas_Object *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
+ /**
+ * 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
+ */
EAPI Eina_Bool elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
+ /**
+ * Set the edje group from the elementary theme that will be used as layout
+ *
+ * @param obj The layout object
+ * @param clas the clas of the group
+ * @param group the group
+ * @param style the style to used
+ *
+ * @return (1 = success, 0 = error)
+ *
+ * @ingroup Layout
+ */
EAPI Eina_Bool elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
+ /**
+ * 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
+ *
+ * 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_content_part_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_content_part_get()
+ * @see elm_object_content_part_unset()
+ * @see @ref secBox
+ *
+ * @ingroup Layout
+ */
EAPI void elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
+ /**
+ * 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
+ *
+ * @see elm_object_content_part_set()
+ *
+ * @ingroup Layout
+ */
EAPI Evas_Object *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ /**
+ * 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.
+ *
+ * @see elm_object_content_part_set()
+ *
+ * @ingroup Layout
+ */
EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
+ /**
+ * 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
+ *
+ * @ingroup Layout
+ * @deprecated use elm_object_text_* instead.
+ */
EINA_DEPRECATED EAPI void elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
+ /**
+ * 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
+ *
+ * @ingroup Layout
+ * @deprecated use elm_object_text_* instead.
+ */
EINA_DEPRECATED EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
+ /**
+ * 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.
+ *
+ * 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
+ */
EAPI void elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
+ /**
+ * 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.
+ *
+ * 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
+ */
EAPI void elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
+ /**
+ * 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.
+ *
+ * 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
+ */
EAPI void elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
+ /**
+ * 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.
+ *
+ * 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
+ */
EAPI void elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
+ /**
+ * 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_content_part_unset() for box.
+ *
+ * @see elm_layout_box_append()
+ * @see elm_layout_box_remove_all()
+ *
+ * @ingroup Layout
+ */
EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
+ /**
+ * Remove all child 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.
+ *
+ * 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
+ */
EAPI void elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+ /**
+ * 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)
+ *
+ * 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
+ */
EAPI void 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) EINA_ARG_NONNULL(1);
+ /**
+ * 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_content_part_unset() for table.
+ *
+ * @see elm_layout_table_pack()
+ * @see elm_layout_table_clear()
+ *
+ * @ingroup Layout
+ */
EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
+ /**
+ * Remove all child 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.
+ *
+ * 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
+ */
EAPI void elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
+ /**
+ * 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_content_part_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_text_part_set()
+ * @see elm_object_content_part_set()
+ * @see elm_layout_box_append()
+ * @see elm_layout_table_pack()
+ * @see elm_layout_data_get()
+ *
+ * @ingroup Layout
+ */
EAPI Evas_Object *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
+ /**
+ * 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
+ */
EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
+ /**
+ * 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
+ */
EAPI void elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
+
+ /**
+ * 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
+ */
EAPI Eina_Bool elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * 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
+ */
EAPI const char *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * 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().
+ *
+ * @ingroup Layout
+ */
EAPI void elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * 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
+ */
EAPI Eina_Bool elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * 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
+ */
EAPI const char *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * 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
+ * or should also search on widget's theme as well
+ *
+ * @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
+ */
EAPI Eina_Bool elm_layout_part_cursor_engine_only_set(Evas_Object *obj, const char *part_name, Eina_Bool engine_only) EINA_ARG_NONNULL(1, 2);
+
+ /**
+ * 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
+ */
EAPI Eina_Bool elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
+
/**
* @def elm_layout_icon_set
* Convienience macro to set the icon object in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
- * @deprecate use elm_object_text_* instead.
+ * @deprecated use elm_object_text_* instead.
*/
#define elm_layout_label_set(_ly, _txt) \
elm_layout_text_set((_ly), "elm.text", (_txt))
/**
* @def elm_layout_label_get
- * Convienience macro to get the label in a layout that follows the
+ * Convenience macro to get the label in a layout that follows the
* Elementary naming convention for its parts.
*
* @ingroup Layout
- * @deprecate use elm_object_text_* instead.
+ * @deprecated use elm_object_text_* instead.
*/
#define elm_layout_label_get(_ly) \
elm_layout_text_get((_ly), "elm.text")
/* smart callbacks called:
+ * "theme,changed" - when elm theme is changed.
*/
/* notify */
projects / framework / uifw / elementary.git / commitdiff