Widget system

Manages the widgets displayed onto screen. More...

Files
file	iwidget.c
	iWidget file
file	wclass.c
	Widget Class file.
file	widget.c
	Widget system core file.
file	widget.h
	Widget system header file.
Modules
group	Ireal Widget
	System to store widgets design in ressources files.
group	Widget Class
group	Widget flags
	Values that can be set into TWidget Flags field.
Data Structures
struct	TPropType
	Generic property class structure. More...
struct	TWidgetProp
	Widget property structure. More...
struct	TWidgetClass
	Widget Class structure. More...
struct	TiWidget
	Irreal Widget structure. More...
struct	TWidget
	Widget structure. More...
struct	TToolTip
	Tool tip widget. More...
Typedefs
typedef TPropType	TPropType
	Generic property class structure.
typedef TPropType *	PPropType
	Generic property class structure.
typedef TWidgetProp	TWidgetProp
	Widget property structure.
typedef TWidgetProp *	PWidgetProp
	Widget property structure.
typedef TWidgetClass	TWidgetClass
	Widget Class structure.
typedef TiWidget	TiWidget
	Irreal Widget structure.
typedef TWidget	TWidget
	Widget structure.
typedef TToolTip	TToolTip
	Tool tip widget.
typedef TToolTip *	PToolTip
	Tool tip widget.
Functions
l_bool	WidgetCheckVisible (PWidget o)
	Check if all widget parent are visible.
void	WidgetDrawOnRect (PWidget o, TRect w, PWidget Ignore)
	Draw widget and all its childs clipped by specified Rect.
void	WidgetDrawAll (PWidget o)
	Draw widget and all its childs.
void	WidgetDraw (PWidget o, PRect w)
	Draw widget clipped by specified Rect (can be NULL).
void	WidgetRemove (PWidget o, PWidget i)
	Remove a widget (i) from its parent (o).
void	WidgetInsert (PWidget o, PWidget i)
	Insert a widget (i) into an other (o).
l_long	WidgetGetIndex (PWidget o)
	Calculate widget index in its parent.
PWidget	WidgetGetName (PWidget o, l_text Name)
	Get a sub-widget by its name.
void	WidgetDispose (PWidget o)
	Remove and free a widget.
PWidget	CreateWidget (PApplication App, TRect r)
	Create a new standart widget.
void	WidgetSetTooltipText (PWidget o, l_text t)
	Set a widget tooltip text.
l_bool	WidgetIsClassId (PWidget o, l_ulong Id)
	Determines if class of widget is specified class of a sub-class.
PWidget	ComplieiWidget (PApplication App, PiWidget iw)
	Generate widgets from iwidgets.

---

Detailed Description

Manages the widgets displayed onto screen.

This is the base of all other provided widgets. By exemple a window is a standart widget with special extentions, so can parse it to functions but don't forget to convert the pointer type : use WIDGET(pointer).

---

Function Documentation

PWidget ComplieiWidget (  PApplication  App, PiWidget  iw )

Generate widgets from iwidgets. Parameters: App  Application which want to allocate the widget( use &Me in most cases) iw  iWidget source data Returns: Pointer to the widget corresponding to iw. Use iWidgetGetCompiled to get pointers to sub-widgets. See also: iWidgetGetCompiled

PWidget CreateWidget (  PApplication  App, TRect  r )

Create a new standart widget. Parameters: App  Application which want to allocate the widget( use &Me in most cases) r  Relative coordinates of new widget

l_bool WidgetCheckVisible (  PWidget  o  )

Check if all widget parent are visible. Using this function you ensure that widget is really visible. Parameters: o  Widget to check Returns: true if widget and all its parents are visible, else return false

void WidgetDispose (  PWidget  o  )

Remove and free a widget. Parameters: o  Widget to dispose

void WidgetDraw (  PWidget  o, PRect  w )

Draw widget clipped by specified Rect (can be NULL). Do not redraw its childs. Parameters: o  Widget to redraw w  Pointer to the clipping rect, if NULL use widget DrawAbsolute See also: WidgetDrawAll WidgetDrawOnRect

void WidgetDrawAll (  PWidget  o  )

Draw widget and all its childs. Parameters: o  Widget to redraw

void WidgetDrawOnRect (  PWidget  o, TRect  w, PWidget  Ignore )

Draw widget and all its childs clipped by specified Rect. Parameters: o  Widget to redraw w  Pointer to the clipping rect. Can't be NULL use WidgetDrawAll instead. Ignore  A widget to ignore (won't be redraw). Can be NULL. See also: WidgetDrawAll

l_long WidgetGetIndex (  PWidget  o  )

Calculate widget index in its parent. Parameters: o  Widget Returns: Widget index or -1 on error (widget not found)

PWidget WidgetGetName (  PWidget  o, l_text  Name )

Get a sub-widget by its name. Parameters: o  Widget to search in Name  Case sensitive name of widget to found Returns: Pointer to widget or NULL if not found.

void WidgetInsert (  PWidget  o, PWidget  i )

Insert a widget (i) into an other (o). Parameters: o  Destination widget i  Widget to insert

l_bool WidgetIsClassId (  PWidget  o, l_ulong  Id )

Determines if class of widget is specified class of a sub-class. Parameters: o  Widget to test Id  32bits identifier of class

void WidgetRemove (  PWidget  o, PWidget  i )

Remove a widget (i) from its parent (o). Parameters: o  Parent widget i  Widget to remove

void WidgetSetTooltipText (  PWidget  o, l_text  t )

Set a widget tooltip text. Parameters: o  Widget to affect t  Text to set as tooltip text (text is duplicated, so you can free t after)

---