Legato widget definitions. More...

#include "gfx/legato/common/legato_common.h"
#include "gfx/legato/common/legato_rect.h"
#include "gfx/legato/core/legato_event.h"
#include "gfx/legato/core/legato_scheme.h"
#include "gfx/legato/datastructure/legato_array.h"

Include dependency graph for legato_widget.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	leWidget_MoveEvent
	Used to define widget move event. More...

struct	leWidget_ResizeEvent
	Used to define widget resize event. More...

struct	leWidgetEvent
	Used to define widget event. More...

struct	leWidgetEvent_TouchDown
	Used to define widget touch down event. More...

struct	leWidgetEvent_TouchUp
	Used to define widget touch up event. More...

struct	leWidgetEvent_TouchMove
	Used to define widget touch move event. More...

struct	leWidgetEventFilter
	Used to define widget touch event filter. More...

struct	leWidget
	Used to define a widget. More...

Typedefs
typedef enum leWidgetType	leWidgetType
	Used to define widget types. More...

typedef enum leBackgroundType	leBackgroundType
	Used to define widget background types. More...

typedef enum leBorderType	leBorderType
	Used to define widget border types. More...

typedef enum leWidgetDirtyState	leWidgetDirtyState
	Used to define widget dirty state. More...

typedef enum leWidgetDrawState	leWidgetDrawState
	Used to define widget dirty state. More...

typedef struct leWidget_MoveEvent	leWidget_MoveEvent
	Used to define widget move event. More...

typedef struct leWidget_ResizeEvent	leWidget_ResizeEvent
	Used to define widget resize event. More...

typedef struct leWidget	leWidget
	Used to define a widget. More...

typedef struct leWidgetEvent	leWidgetEvent
	Used to define widget event.

typedef struct leWidgetEvent_TouchDown	leWidgetEvent_TouchDown
	Used to define widget touch down event. More...

typedef struct leWidgetEvent_TouchUp	leWidgetEvent_TouchUp
	Used to define widget touch up event. More...

typedef struct leWidgetEvent_TouchMove	leWidgetEvent_TouchMove
	Used to define widget touch move event. More...

Enumerations
enum	leWidgetType { LE_WIDGET_WIDGET, LE_WIDGET_ARC }
	Used to define widget types. More...

enum	leBackgroundType { LE_WIDGET_BACKGROUND_NONE, LE_WIDGET_BACKGROUND_FILL, LE_WIDGET_BACKGROUND_LAST = LE_WIDGET_BACKGROUND_FILL }
	Used to define widget background types. More...

enum	leBorderType { LE_WIDGET_BORDER_NONE, LE_WIDGET_BORDER_LINE, LE_WIDGET_BORDER_BEVEL, LE_WIDGET_BORDER_LAST = LE_WIDGET_BORDER_BEVEL }
	Used to define widget border types. More...

enum	leWidgetDirtyState { LE_WIDGET_DIRTY_STATE_CLEAN, LE_WIDGET_DIRTY_STATE_CHILD, LE_WIDGET_DIRTY_STATE_DIRTY }
	Used to define widget dirty state. More...

enum	leWidgetDrawState { LE_WIDGET_DRAW_STATE_READY, LE_WIDGET_DRAW_STATE_DONE }
	Used to define widget dirty state. More...

Functions
void	leWidgetEvent_Accept (leWidgetEvent evt, leWidget owner)

LIB_EXPORT leWidget *	leWidget_New ()
	Create widget. More...

LIB_EXPORT void	leWidget_Constructor (leWidget *wgt)
	Initialize widget. More...

LIB_EXPORT void	leWidget_Delete (leWidget *wgt)
	Delete widget. More...

leWidgetType	_leWidget_GetType (const leWidget *_this)
	Get widget type. More...

int32_t	_leWidget_GetX (const leWidget *_this)
	Get widget x position. More...

leResult	_leWidget_SetX (leWidget *_this, int32_t x)
	Set widget x position. More...

int32_t	_leWidget_GetY (const leWidget *_this)
	Get widget y position. More...

leResult	_leWidget_SetY (leWidget *_this, int32_t y)
	Set widget y position. More...

leResult	_leWidget_SetPosition (leWidget *_this, int32_t x, int32_t y)
	Set widget x and y position. More...

leResult	_leWidget_Translate (leWidget *_this, int32_t x, int32_t y)
	Translate widget x and y position. More...

uint32_t	_leWidget_GetWidth (const leWidget *_this)
	Get widget width. More...

leResult	_leWidget_SetWidth (leWidget *_this, uint32_t width)
	Set the widget width. More...

uint32_t	_leWidget_GetHeight (const leWidget *_this)
	Get widget height. More...

leResult	_leWidget_SetHeight (leWidget *_this, uint32_t height)
	Set widget height. More...

leResult	_leWidget_SetSize (leWidget *_this, uint32_t width, uint32_t height)
	Set widget height. More...

leResult	_leWidget_Resize (leWidget *_this, int32_t width, int32_t height)
	Resize widget. More...

leBool	_leWidget_GetAlphaEnabled (const leWidget *_this)
	Get alpha enable status. More...

leBool	_leWidget_GetCumulativeAlphaEnabled (const leWidget *_this)
	Get cumulative alpha enable status. More...

leResult	_leWidget_SetAlphaEnabled (leWidget *_this, leBool enable)
	Set cumulative alpha enable status. More...

uint32_t	_leWidget_GetAlphaAmount (const leWidget *_this)
	Get alpha amount. More...

uint32_t	_leWidget_GetCumulativeAlphaAmount (const leWidget *_this)
	Get cumulative alpha amount. More...

leResult	_leWidget_SetAlphaAmount (leWidget *_this, uint32_t alpha)
	Set alpha amount. More...

leBool	_leWidget_IsOpaque (const leWidget *_this)
	Determine is widget is opaque. More...

leBool	_leWidget_GetEnabled (const leWidget *_this)
	Get widget enabled flag. More...

leResult	_leWidget_SetEnabled (leWidget *_this, leBool enable)
	Set widget enabled flag. More...

leBool	_leWidget_GetVisible (const leWidget *_this)
	Get widget visible status. More...

leResult	_leWidget_SetVisible (leWidget *_this, leBool visible)
	Set widget visible status. More...

leRect	_leWidget_LocalRect (const leWidget *_this)
	Get widget rectangle. More...

leRect	_leWidget_RectToParentSpace (const leWidget *_this)
	Get widget rectangle. More...

leRect	_leWidget_RectToScreenSpace (const leWidget *_this)
	Get widget rectangle. More...

leResult	_leWidget_AddChild (leWidget _this, leWidget child)
	Add child to widget. More...

leResult	_leWidget_InsertChild (leWidget _this, leWidget child, uint32_t idx)
	Adds child to widget at index. More...

leResult	_leWidget_RemoveChild (leWidget _this, leWidget child)
	Remove child from widget. More...

leResult	_leWidget_RemoveChildAt (leWidget *_this, uint32_t idx)
	Remove child from widget at index. More...

void	_leWidget_RemoveAllChildren (leWidget *_this)
	Remove all children from widget. More...

leWidget *	_leWidget_GetRootWidget (const leWidget *_this)
	Get root widget. More...

leResult	_leWidget_SetParent (leWidget _this, leWidget parent)
	Set parent widget. More...

uint32_t	_leWidget_GetChildCount (const leWidget *_this)
	Get child count. More...

leWidget *	_leWidget_GetChildAtIndex (const leWidget *_this, uint32_t idx)
	Get child at index. More...

uint32_t	_leWidget_GetIndexOfChild (const leWidget _this, const leWidget child)
	Get index of child. More...

leBool	_leWidget_ContainsDescendant (const leWidget _this, const leWidget wgt)
	Determine widget exists. More...

leScheme *	_leWidget_GetScheme (const leWidget *_this)
	Get widget scheme. More...

leResult	_leWidget_SetScheme (leWidget _this, const leScheme scheme)
	Set widget scheme. More...

leBorderType	_leWidget_GetBorderType (const leWidget *_this)
	Get widget bordertype. More...

leResult	_leWidget_SetBorderType (leWidget *_this, leBorderType type)
	Set widget scheme. More...

leBackgroundType	_leWidget_GetBackgroundType (const leWidget *_this)
	Get widget background type. More...

leResult	_leWidget_SetBackgroundType (leWidget *_this, leBackgroundType type)
	Set widget scheme. More...

leHAlignment	_leWidget_GetHAlignment (const leWidget *_this)
	Get widget horizontal alignment. More...

leResult	_leWidget_SetHAlignment (leWidget *_this, leHAlignment align)
	Set widget scheme. More...

leVAlignment	_leWidget_GetVAlignment (const leWidget *_this)
	Get widget vertical alignment. More...

leResult	_leWidget_SetVAlignment (leWidget *_this, leVAlignment align)
	Set widget vertical alignment. More...

leMargin	_leWidget_GetMargins (const leWidget *_this)
	Get widget margins. More...

leResult	_leWidget_SetMargins (leWidget *_this, uint32_t l, uint32_t t, uint32_t r, uint32_t b)
	Set widget margins. More...

uint32_t	_leWidget_GetCornerRadius (const leWidget *_this)
	Get widget corner radius. More...

leResult	_leWidget_SetCornerRadius (leWidget *_this, uint32_t radius)
	Set widget scheme. More...

leBool	_leWidget_HasFocus (const leWidget *_this)
	Determines the focus status. More...

leResult	_leWidget_SetFocus (leWidget *_this)
	Set widget scheme. More...

void	_leWidget_Invalidate (const leWidget *_this)
	Invalidate widget. More...

void	_leWidget_InvalidateContents (const leWidget *_this)
	Invalidate widget contents. More...

leResult	_leWidget_InstallEventFilter (leWidget *_this, leWidgetEventFilter fltr)
	Install event filter. More...

leResult	_leWidget_RemoveEventFilter (leWidget *_this, leWidgetEventFilter fltr)
	Remove event filter. More...

void	_leWidget_Update (leWidget *_this, uint32_t dt)
	Update widget. More...

void	_leWidget_HandleEvent (leWidget , leEvent )

void	_leWidget_ValidateChildren (leWidget *)

void	_leWidget_IncreaseDirtyState (leWidget *, uint32_t)

void	_leWidget_SetDirtyState (leWidget *, uint32_t)

void	_leWidget_ClearDirtyState (leWidget *)

void	_leWidget_InvalidateBorderAreas (const leWidget *)

void	_leWidget_DamageArea (const leWidget , leRect )

void	_leWidget_TouchDownEvent (leWidget , leWidgetEvent_TouchDown )

void	_leWidget_TouchUpEvent (leWidget , leWidgetEvent_TouchUp )

void	_leWidget_TouchMoveEvent (leWidget , leWidgetEvent_TouchMove )

void	_leWidget_MoveEvent (leWidget , leWidget_MoveEvent )

void	_leWidget_ResizeEvent (leWidget , leWidget_ResizeEvent )

void	_leWidget_FocusLostEvent (leWidget *)

void	_leWidget_FocusGainedEvent (leWidget *)

void	_leWidget_LanguageChangeEvent (leWidget *)

Detailed Description

Legato widget definitions.

Defines the widget that are used in the UI library. Widgets are created and stored for later processing during a library context's update loop.

Typedef Documentation

◆ leBackgroundType

typedef enum leBackgroundType leBackgroundType

Used to define widget background types.

Specifies the different background types used for the widgets in the library. None - No background fill. Widget must defer to its parent to erase dirty pixels. This may cause additional overhead as clean pixels may be repainted as well. Fill - a scheme color is used to fill the widget rectangle. Cache - a local framebuffer cache is maintained by the widget and used to clean up dirty pixels. Will not cause a parent repaint event but will use additional memory to contain the cache.

◆ leBorderType

typedef enum leBorderType leBorderType

Used to define widget border types.

Specifies the different background types used for the widgets in the library.

◆ leWidget

typedef struct leWidget leWidget

Used to define a widget.

◆ leWidget_MoveEvent

typedef struct leWidget_MoveEvent leWidget_MoveEvent

Used to define widget move event.

Specifies the old a new position of a widget..

◆ leWidget_ResizeEvent

typedef struct leWidget_ResizeEvent leWidget_ResizeEvent

Used to define widget resize event.

Specifies the old a new size of a widget.

◆ leWidgetDirtyState

typedef enum leWidgetDirtyState leWidgetDirtyState

Used to define widget dirty state.

Specifies the different dirty states the widget can be assigned. This decides whether the particular widget would be re-drawn or not. Dirty widget are re-drawn and clean are not painted over.

◆ leWidgetDrawState

typedef enum leWidgetDrawState leWidgetDrawState

Used to define widget dirty state.

Specifies the different dirty states the widget can be assigned. This decides whether the particular widget would be re-drawn or not. Dirty widget are re-drawn and clean are not painted over.

◆ leWidgetEvent_TouchDown

typedef struct leWidgetEvent_TouchDown leWidgetEvent_TouchDown

Used to define widget touch down event.

Specifies event, id and location.

◆ leWidgetEvent_TouchMove

typedef struct leWidgetEvent_TouchMove leWidgetEvent_TouchMove

Used to define widget touch move event.

Specifies event, id and location.

◆ leWidgetEvent_TouchUp

typedef struct leWidgetEvent_TouchUp leWidgetEvent_TouchUp

Used to define widget touch up event.

Specifies event, id and location.

◆ leWidgetType

typedef enum leWidgetType leWidgetType

Used to define widget types.

Enumeration Type Documentation

◆ leBackgroundType

enum leBackgroundType

Used to define widget background types.

Specifies the different background types used for the widgets in the library. None - No background fill. Widget must defer to its parent to erase dirty pixels. This may cause additional overhead as clean pixels may be repainted as well. Fill - a scheme color is used to fill the widget rectangle. Cache - a local framebuffer cache is maintained by the widget and used to clean up dirty pixels. Will not cause a parent repaint event but will use additional memory to contain the cache.

Enumerator
LE_WIDGET_BACKGROUND_NONE	No background fill.
LE_WIDGET_BACKGROUND_FILL	Uses scheme color.
LE_WIDGET_BACKGROUND_LAST	Uses Cache.

◆ leBorderType

enum leBorderType

Used to define widget border types.

Specifies the different background types used for the widgets in the library.

◆ leWidgetDirtyState

enum leWidgetDirtyState

Used to define widget dirty state.

Specifies the different dirty states the widget can be assigned. This decides whether the particular widget would be re-drawn or not. Dirty widget are re-drawn and clean are not painted over.

◆ leWidgetDrawState

enum leWidgetDrawState

Used to define widget dirty state.

Specifies the different dirty states the widget can be assigned. This decides whether the particular widget would be re-drawn or not. Dirty widget are re-drawn and clean are not painted over.

◆ leWidgetType

enum leWidgetType

Used to define widget types.

Function Documentation

◆ _leWidget_AddChild()

leResult _leWidget_AddChild	(	leWidget *	_this,
		leWidget *	child
	)

Add child to widget.

Adds child widget to wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->addChild(wgt, child);

Parameters

param1	wgt is the widget to query
param2	child is the widget to add

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_ContainsDescendant()

leBool _leWidget_ContainsDescendant	(	const leWidget *	_this,
		const leWidget *	wgt
	)

Determine widget exists.

Returns the existence status of wgt in _this.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidget* descendent;

leBool exists = wgt->fn->getIndexOfChild(wgt, descendent);

Parameters

param1	wgt is the widget to query
param2	child is the child to get index

Returns: returns true if widget is a decendent, otherwise false.

◆ _leWidget_GetAlphaAmount()

uint32_t _leWidget_GetAlphaAmount ( const leWidget * _this )

Get alpha amount.

Gets the alpha amount of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t amount = wgt->fn->getAlphaAmount(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns the alpha amount.

◆ _leWidget_GetAlphaEnabled()

leBool _leWidget_GetAlphaEnabled ( const leWidget * _this )

Get alpha enable status.

Gets the alpha enable status of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool enabled = wgt->fn->getAlphaEnabled(wgt);

Parameters

param1 wgt is the widget to modify

Returns: returns leBool.

◆ _leWidget_GetBackgroundType()

leBackgroundType _leWidget_GetBackgroundType ( const leWidget * _this )

Get widget background type.

Returns the background type of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBackgroundType type = wgt->fn->getBorderType(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leBackgroundType.

◆ _leWidget_GetBorderType()

leBorderType _leWidget_GetBorderType ( const leWidget * _this )

Get widget bordertype.

Returns the border type of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBorderType type = wgt->fn->getBorderType(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leBorderType.

◆ _leWidget_GetChildAtIndex()

leWidget* _leWidget_GetChildAtIndex	(	const leWidget *	_this,
		uint32_t	idx
	)

Get child at index.

Returns the child widget at idx in wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidget * child = wgt->fn->getChildAtIndex(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leWidget.

◆ _leWidget_GetChildCount()

uint32_t _leWidget_GetChildCount ( const leWidget * _this )

Get child count.

Gets the number of children in wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t cnt = wgt->fn->getChildCount(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leWidget.

◆ _leWidget_GetCornerRadius()

uint32_t _leWidget_GetCornerRadius ( const leWidget * _this )

Get widget corner radius.

Returns the corner radius of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t radius = wgt->fn->getMargins(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns uint32_t.

◆ _leWidget_GetCumulativeAlphaAmount()

uint32_t _leWidget_GetCumulativeAlphaAmount ( const leWidget * _this )

Get cumulative alpha amount.

Gets the cumulative alpha amount of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t amount = wgt->fn->getCumulativeAlphaAmount(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns the alpha amount.

◆ _leWidget_GetCumulativeAlphaEnabled()

leBool _leWidget_GetCumulativeAlphaEnabled ( const leWidget * _this )

Get cumulative alpha enable status.

Gets the cumulative alpha enable status of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool enabled = wgt->fn->getCumulativeAlphaEnabled(wgt);

Parameters

param1 wgt is the widget to modify

Returns: returns leBool.

◆ _leWidget_GetEnabled()

leBool _leWidget_GetEnabled ( const leWidget * _this )

Get widget enabled flag.

Gets the enabled status of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool enabled = wgt->fn->getEnabled(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns true if widget is enabled, otherwise false.

◆ _leWidget_GetHAlignment()

leHAlignment _leWidget_GetHAlignment ( const leWidget * _this )

Get widget horizontal alignment.

Returns the horizontal alignment of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leHAlignment ha = wgt->fn->getHAlignment(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leHAlignment.

◆ _leWidget_GetHeight()

uint32_t _leWidget_GetHeight ( const leWidget * _this )

Get widget height.

Gets the height of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t height = wgt->fn->getHeight(wgt);

Parameters

param1 wgt is the widget to modify

Returns: returns leResult.

◆ _leWidget_GetIndexOfChild()

uint32_t _leWidget_GetIndexOfChild	(	const leWidget *	_this,
		const leWidget *	child
	)

Get index of child.

Returns the index of child in wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidget * child = wgt->fn->getIndexOfChild(wgt);

Parameters

param1	wgt is the widget to query
param2	child is the child to get index

Returns: returns leWidget.

◆ _leWidget_GetMargins()

leMargin _leWidget_GetMargins ( const leWidget * _this )

Get widget margins.

Returns the margins of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leMargin margin = wgt->fn->getMargins(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leMargin.

◆ _leWidget_GetRootWidget()

leWidget* _leWidget_GetRootWidget ( const leWidget * _this )

Get root widget.

Gets root widget of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidget* root = wgt->fn->getRootWidget(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leWidget.

◆ _leWidget_GetScheme()

leScheme* _leWidget_GetScheme ( const leWidget * _this )

Get widget scheme.

Returns the scheme of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme * sch = wgt->fn->getScheme(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leScheme.

◆ _leWidget_GetType()

leWidgetType _leWidget_GetType ( const leWidget * _this )

Get widget type.

Returns the widget type from wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidgetType type = wgt->fn->getType(wgt);

Parameters

param1 wgt is the widget to query

Returns: return leWidgetType.

◆ _leWidget_GetVAlignment()

leVAlignment _leWidget_GetVAlignment ( const leWidget * _this )

Get widget vertical alignment.

Returns the horizontal alignment of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leHAlignment ha = wgt->fn->getVAlignment(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leVAlignment.

◆ _leWidget_GetVisible()

leBool _leWidget_GetVisible ( const leWidget * _this )

Get widget visible status.

Gets the visible status of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool visible = wgt->fn->getVisible(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns true if widget is enabled, otherwise false.

◆ _leWidget_GetWidth()

uint32_t _leWidget_GetWidth ( const leWidget * _this )

Get widget width.

Gets the width of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t width = wgt->fn->getWidth(wgt);

Parameters

param1 wgt is the widget to modify

Returns: returns leResult.

◆ _leWidget_GetX()

int32_t _leWidget_GetX ( const leWidget * _this )

Get widget x position.

Returns the widget x position from wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidgetType type = wgt->fn->getX(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leWidgetType.

◆ _leWidget_GetY()

int32_t _leWidget_GetY ( const leWidget * _this )

Get widget y position.

Returns the y position from wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidgetType type = wgt->fn->getY(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leWidgetType.

◆ _leWidget_HasFocus()

leBool _leWidget_HasFocus ( const leWidget * _this )

Determines the focus status.

Returns the focus status of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->setScheme(wgt);

Parameters

param1 wgt is the widget to modify

Returns: returns true if widget has focus, otherwise false.

◆ _leWidget_InsertChild()

leResult _leWidget_InsertChild	(	leWidget *	_this,
		leWidget *	child,
		uint32_t	idx
	)

Adds child to widget at index.

Adds child widget to wgt at the given index.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->addChild(wgt, child, 0);

Parameters

param1	wgt is the widget to modify
param2	child is the widget to add
param3	idx is the index to insert at

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_InstallEventFilter()

leResult _leWidget_InstallEventFilter	(	leWidget *	_this,
		leWidgetEventFilter	fltr
	)

Install event filter.

Sets the event filter of wgt to fltr.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidgetEventFilter fltr;

leResult res = wgt->fn->invalidateContents(wgt, fltr);

Parameters

param1	wgt is the widget to modify
param2	fltr is the filter to install

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_Invalidate()

void _leWidget_Invalidate ( const leWidget * _this )

Invalidate widget.

Invalidate wgt. The invalidation will cause the widget to be redrawn.

Remarks: This is a Virtual Member Function
leWidget* wgt;

wgt->fn->invalidate(wgt);

Parameters

param1 wgt is the widget to invalidate

Returns: returns void.

◆ _leWidget_InvalidateContents()

void _leWidget_InvalidateContents ( const leWidget * _this )

Invalidate widget contents.

Invalidate contents of wgt contents.

Remarks: This is a Virtual Member Function
leWidget* wgt;

wgt->fn->invalidateContents(wgt);

Parameters

param1 wgt is the widget to invalidate

Returns: returns void.

◆ _leWidget_IsOpaque()

leBool _leWidget_IsOpaque ( const leWidget * _this )

Determine is widget is opaque.

Returns the opaque status of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool opaque = wgt->fn->isOpaque(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns true is widget is opaque, otherwise false.

◆ _leWidget_LocalRect()

leRect _leWidget_LocalRect ( const leWidget * _this )

Get widget rectangle.

Gets the bounding rectangle of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leRect rec = wgt->fn->localRect(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leRect.

◆ _leWidget_RectToParentSpace()

leRect _leWidget_RectToParentSpace ( const leWidget * _this )

Get widget rectangle.

Gets the bounding rectangle of wgt relative to parent.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leRect rec = wgt->fn->rectToParent(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leRect.

◆ _leWidget_RectToScreenSpace()

leRect _leWidget_RectToScreenSpace ( const leWidget * _this )

Get widget rectangle.

Gets the bounding rectangle of wgt relative to screen.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leRect rec = wgt->fn->rectToScreen(wgt);

Parameters

param1 wgt is the widget to query

Returns: returns leRect.

◆ _leWidget_RemoveAllChildren()

void _leWidget_RemoveAllChildren ( leWidget * _this )

Remove all children from widget.

Removes all children from wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

wgt->fn->removeAllChildren(wgt, child);

Parameters

param1 wgt is the widget to query

Returns: returns void.

◆ _leWidget_RemoveChild()

leResult _leWidget_RemoveChild	(	leWidget *	_this,
		leWidget *	child
	)

Remove child from widget.

Remove child widget from wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->removeChild(wgt, child);

Parameters

param1	wgt is the widget to query
param2	child is the widget to remove

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_RemoveChildAt()

leResult _leWidget_RemoveChildAt	(	leWidget *	_this,
		uint32_t	idx
	)

Remove child from widget at index.

Remove child widget from wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->removeChild(wgt, idx);

Parameters

param1	wgt is the widget to query
param2	idx is the index of the child to remove

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_RemoveEventFilter()

leResult _leWidget_RemoveEventFilter	(	leWidget *	_this,
		leWidgetEventFilter	fltr
	)

Remove event filter.

Removes the event filter fltr from wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leWidgetEventFilter fltr;

leResult res = wgt->fn->removeEventFilter(wgt, fltr);

Parameters

param1	wgt is the widget to modify
param2	fltr is the filter to install

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_Resize()

leResult _leWidget_Resize	(	leWidget *	_this,
		int32_t	width,
		int32_t	height
	)

Resize widget.

Resizes the size of wgt to width and height.

Remarks: This is a Virtual Member Function
leWidget* wgt;

int32_t width;

uint32_t height;

leResult res = wgt->fn->resize(wgt, width, height);

Parameters

param1	wgt is the widget to modify
param2	width is the new width of widget
param3	height is the new height of widget

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetAlphaAmount()

leResult _leWidget_SetAlphaAmount	(	leWidget *	_this,
		uint32_t	alpha
	)

Set alpha amount.

Sets the alpha amount of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t alpha;

leResult res = wgt->fn->setAlphaAmount(wgt, alpha);

Parameters

param1 wgt is the widget to query

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetAlphaEnabled()

leResult _leWidget_SetAlphaEnabled	(	leWidget *	_this,
		leBool	enable
	)

Set cumulative alpha enable status.

Sets the cumulative alpha enable status of wgt.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool enable;

leResult res = wgt->fn->setAlphaEnabled(wgt, enable);

Parameters

param1 wgt is the widget to modify

Returns: returns leBool.

◆ _leWidget_SetBackgroundType()

leResult _leWidget_SetBackgroundType	(	leWidget *	_this,
		leBackgroundType	type
	)

Set widget scheme.

Sets the scheme of wgt to scheme.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme* scheme

leResult res = wgt->fn->setScheme(wgt, scheme);

Parameters

param1	wgt is the widget to modify
param1	scheme is the scheme to set

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetBorderType()

leResult _leWidget_SetBorderType	(	leWidget *	_this,
		leBorderType	type
	)

Set widget scheme.

Sets the scheme of wgt to scheme.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme* scheme

leResult res = wgt->fn->setScheme(wgt, scheme);

Parameters

param1	wgt is the widget to modify
param1	scheme is the scheme to set

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetCornerRadius()

leResult _leWidget_SetCornerRadius	(	leWidget *	_this,
		uint32_t	radius
	)

Set widget scheme.

Sets the scheme of wgt to scheme.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme* scheme

leResult res = wgt->fn->setScheme(wgt, scheme);

Parameters

param1	wgt is the widget to modify
param1	scheme is the scheme to set

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetEnabled()

leResult _leWidget_SetEnabled	(	leWidget *	_this,
		leBool	enable
	)

Set widget enabled flag.

Sets the enabled status of wgt to the value of enable.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool enable;

leResult res = wgt->fn->setEnabled(wgt, enable);

Parameters

param1 wgt is the widget to query

Returns: returns true if widget is enabled, otherwise false.

◆ _leWidget_SetFocus()

leResult _leWidget_SetFocus ( leWidget * _this )

Set widget scheme.

Sets the scheme of wgt to scheme.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme* scheme

leResult res = wgt->fn->setScheme(wgt, scheme);

Parameters

param1	wgt is the widget to modify
param1	scheme is the scheme to set

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetHAlignment()

leResult _leWidget_SetHAlignment	(	leWidget *	_this,
		leHAlignment	align
	)

Set widget scheme.

Sets the scheme of wgt to scheme.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme* scheme

leResult res = wgt->fn->setScheme(wgt, scheme);

Parameters

param1	wgt is the widget to modify
param1	scheme is the scheme to set

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetHeight()

leResult _leWidget_SetHeight	(	leWidget *	_this,
		uint32_t	height
	)

Set widget height.

Sets the widget height of wgt to width.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t height;

leResult res = wgt->fn->getHeight(wgt, height);

Parameters

param1	wgt is the widget to modify
param2	height is the new height of widget

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetMargins()

leResult _leWidget_SetMargins	(	leWidget *	_this,
		uint32_t	l,
		uint32_t	t,
		uint32_t	r,
		uint32_t	b
	)

Set widget margins.

Sets the margins for wgt to the specified values left top right bottom.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme* scheme

leResult res = wgt->fn->setScheme(wgt, l, t, r,b );

Parameters

param1 wgt is the widget to modify

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetParent()

leResult _leWidget_SetParent	(	leWidget *	_this,
		leWidget *	parent
	)

Set parent widget.

Sets the parent widget of wgt to parent.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->setParent(wgt);

Parameters

param1	wgt is the widget to modify
param2	parent is the new parent widget

Returns: returns leWidget.

◆ _leWidget_SetPosition()

leResult _leWidget_SetPosition	(	leWidget *	_this,
		int32_t	x,
		int32_t	y
	)

Set widget x and y position.

Sets the x and y position of wgt to x and y.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->setPosition(wgt, x, y);

Parameters

param1	wgt is the widget to modify
param1	x is the new x position
param1	y is the new y position

Returns: returns leResult.

◆ _leWidget_SetScheme()

leResult _leWidget_SetScheme	(	leWidget *	_this,
		const leScheme *	scheme
	)

Set widget scheme.

Sets the scheme of wgt to scheme.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leScheme* scheme

leResult res = wgt->fn->setScheme(wgt, scheme);

Parameters

param1	wgt is the widget to modify
param1	scheme is the scheme to set

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetSize()

leResult _leWidget_SetSize	(	leWidget *	_this,
		uint32_t	width,
		uint32_t	height
	)

Set widget height.

Sets the widget height of wgt to width.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t height;

leResult res = wgt->fn->getHeight(wgt, height);

Parameters

param1	wgt is the widget to modify
param2	height is the new height of widget

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetVAlignment()

leResult _leWidget_SetVAlignment	(	leWidget *	_this,
		leVAlignment	align
	)

Set widget vertical alignment.

Sets the vertical alignment of wgt to scheme.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leVAlignment align;

leResult res = wgt->fn->setVAlignment(wgt, align);

Parameters

param1	wgt is the widget to modify
param1	scheme is the alignment to set

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetVisible()

leResult _leWidget_SetVisible	(	leWidget *	_this,
		leBool	visible
	)

Set widget visible status.

Sets the visible status of wgt to the value of visible.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leBool enable;

leResult res = wgt->fn->setVisible(wgt, visible);

Parameters

param1	wgt is the widget to query
param1	visible is the new flag status

Returns: LE_SUCCESS if set, otherwise LE_FAILURE.

◆ _leWidget_SetWidth()

leResult _leWidget_SetWidth	(	leWidget *	_this,
		uint32_t	width
	)

Set the widget width.

Sets the width of wgt to width.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t width;

leResult res = wgt->fn->setWidth(wgt, width);

Parameters

param1	wgt is the widget to modify
param2	width is the new width of widget

Returns: returns leResult.

◆ _leWidget_SetX()

leResult _leWidget_SetX	(	leWidget *	_this,
		int32_t	x
	)

Set widget x position.

Sets the widget x position of wgt to x.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->setX(wgt);

Parameters

param1	wgt is the widget to modify
param1	x is the new x position

Returns: returns leResult.

◆ _leWidget_SetY()

leResult _leWidget_SetY	(	leWidget *	_this,
		int32_t	y
	)

Set widget y position.

Sets the y position of wgt to y.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->setY(wgt);

Parameters

param1	wgt is the widget to modify
param1	y is the new y position

Returns: returns leResult.

◆ _leWidget_Translate()

leResult _leWidget_Translate	(	leWidget *	_this,
		int32_t	x,
		int32_t	y
	)

Translate widget x and y position.

Translates the x and y position of wgt to x and y.

Remarks: This is a Virtual Member Function
leWidget* wgt;

leResult res = wgt->fn->translate(wgt, x, y);

Parameters

param1	wgt is the widget to modify
param1	x is the new x position
param1	y is the new y position

Returns: returns leResult.

◆ _leWidget_Update()

void _leWidget_Update	(	leWidget *	_this,
		uint32_t	dt
	)

Update widget.

Updates wgt. This is automatically called from the task machine.

Remarks: This is a Virtual Member Function
leWidget* wgt;

uint32_t dt;

wgt->fn->update(wgt);

Parameters

param1	wgt is the widget to modify
param2	dt is

Returns: returns void.

◆ leWidget_Constructor()

LIB_EXPORT void leWidget_Constructor ( leWidget * wgt )

Initialize widget.

Initializes wgt.

leWidget* wgt;

leWidget_Constructor(wgt);

Parameters

wgt	is the widget to initialize

Returns: void.

◆ leWidget_Delete()

LIB_EXPORT void leWidget_Delete ( leWidget * wgt )

Delete widget.

Deletes wgt.

leWidget* wgt;

leWidget_Delete(wgt);

Parameters

param1 wgt is the widget to delete

Returns: void.

◆ leWidget_New()

LIB_EXPORT leWidget* leWidget_New ( )

Create widget.

Creates a new widget and allocates memory for the widget through the current active context. Application is responsible for managing the widget pointer until the widget is added to a widget tree.

leWidget* wgt = leWidget_New();

Returns: a widget object pointer.

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Typedef Documentation

◆ leBackgroundType

◆ leBorderType

◆ leWidget

◆ leWidget_MoveEvent

◆ leWidget_ResizeEvent

◆ leWidgetDirtyState

◆ leWidgetDrawState

◆ leWidgetEvent_TouchDown

◆ leWidgetEvent_TouchMove

◆ leWidgetEvent_TouchUp

◆ leWidgetType

Enumeration Type Documentation

◆ leBackgroundType

◆ leBorderType

◆ leWidgetDirtyState

◆ leWidgetDrawState

◆ leWidgetType

Function Documentation

◆ _leWidget_AddChild()

◆ _leWidget_ContainsDescendant()

◆ _leWidget_GetAlphaAmount()

◆ _leWidget_GetAlphaEnabled()

◆ _leWidget_GetBackgroundType()

◆ _leWidget_GetBorderType()

◆ _leWidget_GetChildAtIndex()

◆ _leWidget_GetChildCount()

◆ _leWidget_GetCornerRadius()

◆ _leWidget_GetCumulativeAlphaAmount()

◆ _leWidget_GetCumulativeAlphaEnabled()

◆ _leWidget_GetEnabled()

◆ _leWidget_GetHAlignment()

◆ _leWidget_GetHeight()

◆ _leWidget_GetIndexOfChild()

◆ _leWidget_GetMargins()

◆ _leWidget_GetRootWidget()

◆ _leWidget_GetScheme()

◆ _leWidget_GetType()

◆ _leWidget_GetVAlignment()

◆ _leWidget_GetVisible()

◆ _leWidget_GetWidth()

◆ _leWidget_GetX()

◆ _leWidget_GetY()

◆ _leWidget_HasFocus()

◆ _leWidget_InsertChild()

◆ _leWidget_InstallEventFilter()

◆ _leWidget_Invalidate()

◆ _leWidget_InvalidateContents()

◆ _leWidget_IsOpaque()

◆ _leWidget_LocalRect()

◆ _leWidget_RectToParentSpace()

◆ _leWidget_RectToScreenSpace()

◆ _leWidget_RemoveAllChildren()

◆ _leWidget_RemoveChild()

◆ _leWidget_RemoveChildAt()

◆ _leWidget_RemoveEventFilter()

◆ _leWidget_Resize()

◆ _leWidget_SetAlphaAmount()

◆ _leWidget_SetAlphaEnabled()

◆ _leWidget_SetBackgroundType()

◆ _leWidget_SetBorderType()

◆ _leWidget_SetCornerRadius()

◆ _leWidget_SetEnabled()

◆ _leWidget_SetFocus()

◆ _leWidget_SetHAlignment()

◆ _leWidget_SetHeight()

◆ _leWidget_SetMargins()

◆ _leWidget_SetParent()

◆ _leWidget_SetPosition()

◆ _leWidget_SetScheme()

◆ _leWidget_SetSize()

◆ _leWidget_SetVAlignment()

◆ _leWidget_SetVisible()

◆ _leWidget_SetWidth()

◆ _leWidget_SetX()