103 lines
4.7 KiB
C
103 lines
4.7 KiB
C
#ifndef ELM_WIDGET_LAYOUT_H
|
|
#define ELM_WIDGET_LAYOUT_H
|
|
|
|
#include "elm_widget_container.h"
|
|
|
|
/* DO NOT USE THIS HEADER UNLESS YOU ARE PREPARED FOR BREAKING OF YOUR
|
|
* CODE. THIS IS ELEMENTARY'S INTERNAL WIDGET API (for now) AND IS NOT
|
|
* FINAL. CALL elm_widget_api_check(ELM_INTERNAL_API_VERSION) TO CHECK
|
|
* IT AT RUNTIME.
|
|
*/
|
|
|
|
/**
|
|
* @addtogroup Widget
|
|
* @{
|
|
*
|
|
* @section elm-layout-class The Elementary Layout Class
|
|
*
|
|
* Elementary, besides having the @ref Layout widget, exposes its
|
|
* foundation -- the Elementary Layout Class -- in order to create
|
|
* other widgets which are, basically, a certain layout with some more
|
|
* logic on top.
|
|
*
|
|
* The idea is to make the creation of that widgets as easy as possible,
|
|
* factorizing code on this common base. For example, a button is a
|
|
* layout (that looks like push button) that happens to react on
|
|
* clicks and keyboard events in a special manner, calling its user
|
|
* back on those events. That's no surprise, then, that the @ref
|
|
* Button implementation relies on #Elm_Layout_Smart_Class, if you go
|
|
* to check it.
|
|
*
|
|
* The Layout class inherits from
|
|
* #Elm_Container_Smart_Class. Container parts, here, map directly to
|
|
* Edje parts from the layout's Edje group. Besides that, there's a whole
|
|
* infrastructure around Edje files:
|
|
* - interfacing by signals,
|
|
* - setting/retrieving text part values,
|
|
* - dealing with table and box parts directly,
|
|
* - etc.
|
|
*
|
|
* Take a look at #Elm_Layout_Smart_Class's 'virtual' functions to
|
|
* understand the whole interface. Finally, layout objects will do
|
|
* <b>part aliasing</b> for you, if you set it up properly. For that,
|
|
* take a look at #Elm_Layout_Part_Alias_Description, where it's
|
|
* explained in detail.
|
|
*/
|
|
|
|
/**
|
|
* @struct _Elm_Layout_Part_Alias_Description
|
|
*
|
|
* Elementary Layout-based widgets may declare part proxies, i.e., aliases
|
|
* for real theme part names to expose to the API calls:
|
|
* - elm_layout_text_set()
|
|
* - elm_layout_text_get()
|
|
* - elm_layout_content_set()
|
|
* - elm_layout_content_get()
|
|
* - elm_layout_content_unset()
|
|
* and their equivalents. This list must be set on the
|
|
* @c "_smart_set_user()" function of inheriting widgets, so that part
|
|
* aliasing is handled automatically for them.
|
|
*
|
|
* @ingroup Widget
|
|
*/
|
|
struct _Elm_Layout_Part_Alias_Description
|
|
{
|
|
const char *alias; /**< Alternate name for a given (real) part. Calls receiving this string as a part name will be translated to the string at _Elm_Layout_Part_Proxies_Description::real_part */
|
|
|
|
const char *real_part; /**< Target part name for the alias set on @ref _Elm_Layout_Part_Proxies_Description::real_part. An example of usage would be @c "default" on that field, with @c "elm.content.swallow" on this one */
|
|
};
|
|
|
|
/**
|
|
* Base widget smart data extended with layout instance data.
|
|
*/
|
|
typedef struct _Elm_Layout_Smart_Data
|
|
{
|
|
Evas_Object *obj; /**< The object itself */
|
|
Eina_List *subs; /**< List of Elm_Layout_Sub_Object_Data structs, to hold the actual sub objects such as text, content and the children of box and table. */
|
|
Eina_List *edje_signals; /**< The list of edje signal callbacks. */
|
|
Eina_List *parts_cursors; /**< The list of cursor names of layout parts. This is a list of Elm_Layout_Sub_Object_Cursor struct. */
|
|
const char *klass; /**< 1st identifier of an edje object group which is used in theme_set. klass and group are used together. */
|
|
const char *group; /**< 2nd identifier of an edje object group which is used in theme_set. klass and group are used together. */
|
|
int frozen; /**< Layout freeze counter */
|
|
|
|
Eina_Bool needs_size_calc : 1; /**< This flas is set true when the layout sizing eval is already requested. This defers sizing evaluation until smart calculation to avoid unnecessary calculation. */
|
|
Eina_Bool restricted_calc_w : 1; /**< This is a flag to support edje restricted_calc in w axis. */
|
|
Eina_Bool restricted_calc_h : 1; /**< This is a flag to support edje restricted_calc in y axis. */
|
|
Eina_Bool can_access : 1; /**< This is true when all text(including textblock) parts can be accessible by accessibility. */
|
|
Eina_Bool destructed_is : 1; /**< This flag indicates if Elm_Layout destructor was called. This is needed to avoid unnecessary calculation of subobject deletion during layout object's deletion. */
|
|
Eina_Bool file_set : 1; /**< This flag indicates if Elm_Layout source is set from a file*/
|
|
} Elm_Layout_Smart_Data;
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#define ELM_LAYOUT_DATA_GET(o, sd) \
|
|
Elm_Layout_Smart_Data * sd = eo_data_scope_get(o, ELM_LAYOUT_CLASS)
|
|
|
|
#define ELM_LAYOUT_CHECK(obj) \
|
|
if (EINA_UNLIKELY(!eo_isa(obj, ELM_LAYOUT_CLASS))) \
|
|
return
|
|
|
|
#endif
|