forked from enlightenment/efl
391 lines
12 KiB
C
391 lines
12 KiB
C
/**
|
|
* 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 Elm_Layout
|
|
*/
|
|
EAPI Evas_Object *elm_layout_add(Evas_Object *parent);
|
|
|
|
/**
|
|
* Get the list of swallow parts of a given container widget
|
|
*
|
|
* @param obj The layout object
|
|
*
|
|
* @return list of swallow parts which should be freed by the user program with elm_list_free()
|
|
*
|
|
* @since 1.9
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_List *elm_layout_content_swallow_list_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* 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_layout_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_layout_content_get()
|
|
* @see elm_layout_content_unset()
|
|
*
|
|
* @see @ref secBox
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
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
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
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.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Evas_Object *elm_layout_content_unset(Evas_Object *obj, const char *swallow);
|
|
|
|
/**
|
|
* Set the file that will be used as layout
|
|
*
|
|
* @return (1 = success, 0 = error)
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*
|
|
* @param[in] file The path to file (edj) that will be used as layout
|
|
* @param[in] group The group that the layout belongs in edje file
|
|
*/
|
|
EAPI Eina_Bool elm_layout_file_set(Eo *obj, const char *file, const char *group);
|
|
|
|
/**
|
|
* Get the loaded file
|
|
*
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*
|
|
* @param file The path to file (edj) used as layout
|
|
* @param group The group that the layout belongs in edje file
|
|
*
|
|
* @since 1.14
|
|
*/
|
|
EAPI void elm_layout_file_get(Eo *obj, const char **file, const char **group);
|
|
|
|
/**
|
|
* Set the mmap file that will be used as layout
|
|
*
|
|
* @return (1 = success, 0 = error)
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*
|
|
* @param[in] file Eina_File (edj) that will be used as layout
|
|
* @param[in] group The group that the layout belongs in edje file
|
|
*
|
|
* @since 1.19
|
|
*/
|
|
EAPI Eina_Bool elm_layout_mmap_set(Eo *obj, const Eina_File *file, const char *group);
|
|
|
|
/**
|
|
* Get the loaded mmap file
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*
|
|
* @param file Eina_File (edj) used as layout
|
|
* @param group The group that the layout belongs in edje file
|
|
*
|
|
* @since 1.19
|
|
*/
|
|
EAPI void elm_layout_mmap_get(Eo *obj, const Eina_File **file, const char **group);
|
|
|
|
/**
|
|
* @brief Set the text of the given part.
|
|
*
|
|
* @param[in] part The TEXT part where to set the text.
|
|
* @param[in] text The text to set.
|
|
*
|
|
* @return @c true on success, @c false otherwise
|
|
*/
|
|
EAPI Eina_Bool elm_layout_text_set(Evas_Object *obj, const char * part, const char *text);
|
|
|
|
/**
|
|
* @brief Get the text set in the given part.
|
|
*
|
|
* @param[in] part The TEXT part where to set the text.
|
|
*
|
|
* @return The text to set.
|
|
*/
|
|
EAPI const char *elm_layout_text_get(const Evas_Object *obj, const char * part);
|
|
|
|
/**
|
|
* @brief Append child to layout box part.
|
|
*
|
|
* 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 @ref elm_layout_box_remove to
|
|
* make this layout forget about the object.
|
|
*
|
|
* @param[in] child The child object to append to box.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_Bool elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child);
|
|
|
|
/**
|
|
* @brief Prepend child to layout box part.
|
|
*
|
|
* 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 @ref elm_layout_box_remove to
|
|
* make this layout forget about the object.
|
|
*
|
|
* @param[in] child The child object to prepend to box.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_Bool elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child);
|
|
|
|
/**
|
|
* @brief Insert child to layout box part before a reference object.
|
|
*
|
|
* 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 @ref elm_layout_box_remove to
|
|
* make this layout forget about the object.
|
|
*
|
|
* @param[in] child The child object to insert into box.
|
|
* @param[in] reference Another reference object to insert before in box.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_Bool elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference);
|
|
|
|
/**
|
|
* @brief Insert child to layout box part at a given position.
|
|
*
|
|
* 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 @ref elm_layout_box_remove to
|
|
* make this layout forget about the object.
|
|
*
|
|
* @param[in] child The child object to insert into box.
|
|
* @param[in] pos The numeric position >=0 to insert the child.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_Bool elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos);
|
|
|
|
/**
|
|
* @brief Remove a child of the given part box.
|
|
*
|
|
* The object will be removed from the box part and its lifetime will not be
|
|
* handled by the layout anymore. This is equivalent to @ref
|
|
* elm_layout_content_unset for box.
|
|
*
|
|
* @param[in] child The object to remove from box.
|
|
*
|
|
* @return The object that was being used, or @c null if not found.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Evas_Object *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child);
|
|
|
|
/**
|
|
* @brief Remove all children of the given part box.
|
|
*
|
|
* The objects will be removed from the box part and their lifetime will not be
|
|
* handled by the layout anymore. This is equivalent to
|
|
* @ref elm_layout_box_remove for all box children.
|
|
*
|
|
* @param[in] clear If true, then all objects will be deleted as well,
|
|
* otherwise they will just be removed and will be dangling on the canvas.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_Bool elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear);
|
|
|
|
/**
|
|
* @brief Insert child to layout table part.
|
|
*
|
|
* 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 @ref elm_layout_table_unpack to make
|
|
* this layout forget about the object.
|
|
*
|
|
* If @c colspan or @c rowspan are bigger than 1, that object will occupy more
|
|
* space than a single cell.
|
|
*
|
|
* See also @ref elm_layout_table_unpack, @ref elm_layout_table_clear.
|
|
*
|
|
* @param[in] child The child object to pack into table.
|
|
* @param[in] col The column to which the child should be added. (>= 0)
|
|
* @param[in] row The row to which the child should be added. (>= 0)
|
|
* @param[in] colspan How many columns should be used to store this object. (>=
|
|
* 1)
|
|
* @param[in] rowspan How many rows should be used to store this object. (>= 1)
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_Bool elm_layout_table_pack(Evas_Object *obj, const char *part, Evas_Object *child, unsigned short col, unsigned short row, unsigned short colspan, unsigned short rowspan);
|
|
|
|
/**
|
|
* @brief Unpack (remove) a child of the given part table.
|
|
*
|
|
* The object will be unpacked from the table part and its lifetime will not be
|
|
* handled by the layout anymore. This is equivalent to @ref
|
|
* elm_layout_content_unset for table.
|
|
*
|
|
* @param[in] child The object to remove from table.
|
|
*
|
|
* @return The object that was being used, or @c null if not found.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Evas_Object *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child);
|
|
|
|
/**
|
|
* @brief Remove all the child objects of the given part table.
|
|
*
|
|
* The objects will be removed from the table part and their lifetime will not
|
|
* be handled by the layout anymore. This is equivalent to
|
|
* @ref elm_layout_table_unpack for all table children.
|
|
*
|
|
* @param[in] clear If true, then all objects will be deleted as well,
|
|
* otherwise they will just be removed and will be dangling on the canvas.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI Eina_Bool elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear);
|
|
|
|
/**
|
|
* @brief Get the edje data from the given layout.
|
|
*
|
|
* 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 @c obj was
|
|
* loaded from.
|
|
*
|
|
* @param[in] key The data key.
|
|
*
|
|
* @return The edje data string.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI const char *elm_layout_data_get(const Evas_Object *obj, const char *key);
|
|
|
|
/**
|
|
* @brief Send a (Edje) signal to a given layout widget's underlying Edje
|
|
* object.
|
|
*
|
|
* This function sends a signal to the underlying Edje object of @c obj. An
|
|
* Edje program on that Edje object's definition can respond to a signal by
|
|
* specifying matching 'signal' and 'source' fields.
|
|
*
|
|
* @param[in] emission The signal's name string.
|
|
* @param[in] source The signal's source string.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI void elm_layout_signal_emit(Evas_Object *obj, const char *emission, const char *source);
|
|
|
|
/**
|
|
* @brief Add a callback for a (Edje) signal emitted by a layout widget's
|
|
* underlying Edje object.
|
|
*
|
|
* This function connects a callback function to a signal emitted by the
|
|
* underlying Edje object of @c obj. Globs are accepted in either the emission
|
|
* or source strings.
|
|
*
|
|
* @param[in] emission The signal's name string.
|
|
* @param[in] source The signal's source string.
|
|
* @param[in] func The callback function to be executed when the signal is
|
|
* emitted.
|
|
* @param[in] data A pointer to data to pass in to the callback function.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI void elm_layout_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data);
|
|
|
|
/**
|
|
* @brief Remove a signal-triggered callback from a given layout widget.
|
|
*
|
|
* This function removes the last callback attached to a signal emitted by the
|
|
* undelying Edje object of @c obj, with parameters @c emission, @c source and
|
|
* @c func matching exactly those passed to a previous call to
|
|
* @ref elm_layout_signal_callback_add. The data pointer that was passed to
|
|
* this call will be returned.
|
|
*
|
|
* @param[in] emission The signal's name string.
|
|
* @param[in] source The signal's source string.
|
|
* @param[in] func The callback function being executed when the signal was
|
|
* emitted.
|
|
*
|
|
* @return The data pointer of the signal callback (passed on
|
|
* @ref elm_layout_signal_callback_add) or @c null on errors.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI void *elm_layout_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func);
|
|
|
|
/**
|
|
* @brief Freezes the Elementary layout object.
|
|
*
|
|
* This function puts all changes on hold. Successive freezes will nest,
|
|
* requiring an equal number of thaws.
|
|
*
|
|
* See also @ref elm_layout_thaw.
|
|
*
|
|
* @return The frozen state or 0 on error.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI int elm_layout_freeze(Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Thaws the Elementary object.
|
|
*
|
|
* This function thaws the given Edje object and the Elementary sizing calc.
|
|
*
|
|
* @note If sucessives freezes were done, an equal number of thaws will be
|
|
* required.
|
|
*
|
|
* See also @ref elm_layout_freeze.
|
|
*
|
|
* @return The frozen state or 0 if the object is not frozen or on error.
|
|
*
|
|
* @ingroup Elm_Layout
|
|
*/
|
|
EAPI int elm_layout_thaw(Evas_Object *obj);
|
|
|
|
#include "elm_layout.eo.legacy.h"
|