efl/src/lib/elementary/elm_widget_layout.h

105 lines
5.0 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 Elm_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.
*/
/**
* Base widget smart data extended with layout instance data.
*/
typedef struct _Efl_Ui_Layout_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. */
Eina_Inarray *deferred_signals; /**< signals which were generated during construction */
struct {
Eina_Hash *properties; /**< The list of properties connected to layout parts. */
Eina_Hash *signals; /**< The list of signals connected. */
Eina_Hash *factories; /**< The hash with parts connected to factories. */
Eina_Bool updating : 1;
} connect;
unsigned int finger_size_multiplier_x, finger_size_multiplier_y; /**< multipliers for finger_size during group_calc */
unsigned int version; /**< version number specified in the widget's theme */
Eina_Bool frozen; /**< Layout freeze state */
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 Efl.Ui.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 Efl.Ui.Layout source is set from a file*/
Eina_Bool automatic_orientation_apply : 1;
Eina_Bool model_bound : 1; /**< Set to true once we are watching over a model*/
Eina_Bool model_watch : 1; /**< Set to true once we do watch for model change*/
Eina_Bool calc_subobjs : 1; /**< Set to true if group_calc should also handle subobjs during manual calc */
Eina_Bool cb_theme_changed : 1; /**< if theme,changed event subscriber has been added */
Eina_Bool needs_theme_apply : 1; /**< if theme has not been manually set during construction */
Eina_Bool frozen_changed : 1; /**< only set if object was changed while frozen */
} Efl_Ui_Layout_Data;
typedef struct _Elm_Layout_Data
{
Eina_Bool needs_size_calc : 1; /**< This flag 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 in_calc : 1; /**< object is currently in group_calc */
Eina_Bool user_min_sz : 1; /**< min size was set by user (legacy only has restricted min) */
} Elm_Layout_Data;
/**
* @}
*/
#define EFL_UI_LAYOUT_DATA_GET(o, sd) \
Efl_Ui_Layout_Data * sd = efl_data_scope_get(o, EFL_UI_LAYOUT_BASE_CLASS)
#define EFL_UI_LAYOUT_CHECK(obj) \
if (EINA_UNLIKELY(!efl_isa(obj, EFL_UI_LAYOUT_BASE_CLASS))) \
return
void _efl_ui_layout_subobjs_calc_set(Eo *obj, Eina_Bool set);
#endif