efl/legacy/elementary/src/lib/elm_layout_legacy.h

105 lines
2.9 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 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 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 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 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 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 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 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);
#include "elm_layout.eo.legacy.h"