cWidget Class Reference

List of all members.

Public Member Functions

mixed InitAsGroup (mixed parentwidget, mixed params)

mixed InitAsSpritePanel (mixed parentwidget, mixed params, mixed bVertexBufferDynamic, mixed bVertexCol)

mixed XMLCreate (mixed xmlnode)

see also lib.gui.xml.lua

mixed SetID (mixed id)

mixed GetChildByID (mixed id)

mixed FindChildByName (mixed name)

mixed CreateChildOrContentChild (mixed classname, mixed...)

mixed CreateContentChild (mixed classname, mixed...)

mixed _CreateChild (mixed classname, mixed...)

internal method, use CreateChild instead

mixed SetRenderGroup2D (mixed rendergroup2d)

baseclass-handle for controlling the widget, setpos,hit-test/bounds-calc etc...

mixed SetLayouter (mixed layouter)

mixed SetParent (mixed parentwidget)

mixed ForAllChilds (mixed fun)

mixed GetChild (mixed index)

mixed GetWidgetUnderRelPos (mixed relx, mixed rely)

mixed GetWidgetUnderPos (mixed x, mixed y)

coordinates absolute, returns self as well if hit local mx,my = GetMousePos()

mixed HitTest (mixed x, mixed y)

old name : IsUnderPos

mixed SetVisible (mixed bVal)

mixed SetHitTestIfInvis (mixed bVal)

if set to true, the hittest is performed even if the element is invis, default off

mixed SetConsumeChildHit (mixed bVal)

if set to true, the hittest reports self as being hit even if childs are hit, not needed for notifiers, as they pass themselves to the parent

mixed SetIgnoreBBoxHit (mixed bVal)

old name:mbIgnoreMouseOver, if this is true, hittest for self will fail unless a bitmask is set, but childs are still tested, default:false

mixed SetIgnoreChildHits (mixed bVal)

childs are not tested, e.g. tooltips

mixed SetBitMask (mixed bitmask)

bitmask

mixed SetClip (mixed l, mixed t, mixed r, mixed b)

relative to own position

mixed SetSize (mixed w, mixed h)

mixed SetPos (mixed x, mixed y, mixed z)

in relative coords

mixed SetLeftTop (mixed x, mixed y)

mixed ThemeModifyInitParams (mixed parentwidget, mixed params)

mixed StartMouseMove (mixed keywatch, mixed move_fun, mixed move_fun_param, mixed end_fun, mixed mx0, mixed my0)

mixed CancelDragDrop (mixed x, mixed y)

mixed EndDragDrop (mixed x, mixed y)

mixed AddToDestroyList (mixed o)

o:Destroy() will be called on all things in this list at widget destruction

mixed RemoveFromDestroyList (mixed o)

mixed RenderToTexture (mixed w, mixed h, mixed r, mixed g, mixed b, mixed a)

Detailed Description

Definition at line 491 of file lua_pseudo_code.cpp.

Member Function Documentation

mixed cWidget::InitAsGroup	(	mixed	parentwidget,
		mixed	params
	)			`[inline]`

Definition at line 493 of file lua_pseudo_code.cpp.

mixed cWidget::InitAsSpritePanel	(	mixed	parentwidget,
		mixed	params,
		mixed	bVertexBufferDynamic,
		mixed	bVertexCol
	)			`[inline]`

Definition at line 495 of file lua_pseudo_code.cpp.

mixed cWidget::XMLCreate ( mixed xmlnode ) [inline]

see also lib.gui.xml.lua

Definition at line 498 of file lua_pseudo_code.cpp.

mixed cWidget::SetID ( mixed id ) [inline]

Definition at line 500 of file lua_pseudo_code.cpp.

mixed cWidget::GetChildByID ( mixed id ) [inline]

Definition at line 502 of file lua_pseudo_code.cpp.

mixed cWidget::FindChildByName ( mixed name ) [inline]

Definition at line 504 of file lua_pseudo_code.cpp.

mixed cWidget::CreateChildOrContentChild	(	mixed	classname,
		mixed...
	)			`[inline]`

Definition at line 506 of file lua_pseudo_code.cpp.

mixed cWidget::CreateContentChild	(	mixed	classname,
		mixed...
	)			`[inline]`

Definition at line 508 of file lua_pseudo_code.cpp.

mixed cWidget::_CreateChild	(	mixed	classname,
		mixed...
	)			`[inline]`

internal method, use CreateChild instead

Definition at line 511 of file lua_pseudo_code.cpp.

mixed cWidget::SetRenderGroup2D ( mixed rendergroup2d ) [inline]

baseclass-handle for controlling the widget, setpos,hit-test/bounds-calc etc...

Definition at line 514 of file lua_pseudo_code.cpp.

mixed cWidget::SetLayouter ( mixed layouter ) [inline]

Definition at line 516 of file lua_pseudo_code.cpp.

mixed cWidget::SetParent ( mixed parentwidget ) [inline]

Definition at line 518 of file lua_pseudo_code.cpp.

mixed cWidget::ForAllChilds ( mixed fun ) [inline]

fun is called for all children in order (see GetChild()), if it returns a result that evaluates to true, iteration ends and the result is returned you shouldn't add/delete childs during iteration

Definition at line 522 of file lua_pseudo_code.cpp.

mixed cWidget::GetChild ( mixed index ) [inline]

see also GetChildCount(), index is ONE-based (1..n, first is 1) ordered back-to-front, e.g. the last one is in the foreground

Definition at line 526 of file lua_pseudo_code.cpp.

mixed cWidget::GetWidgetUnderRelPos	(	mixed	relx,
		mixed	rely
	)			`[inline]`

Definition at line 528 of file lua_pseudo_code.cpp.

mixed cWidget::GetWidgetUnderPos	(	mixed	x,
		mixed	y
	)			`[inline]`

coordinates absolute, returns self as well if hit local mx,my = GetMousePos()

Definition at line 531 of file lua_pseudo_code.cpp.

mixed cWidget::HitTest	(	mixed	x,
		mixed	y
	)			`[inline]`

old name : IsUnderPos

Definition at line 534 of file lua_pseudo_code.cpp.

mixed cWidget::SetVisible ( mixed bVal ) [inline]

Definition at line 536 of file lua_pseudo_code.cpp.

mixed cWidget::SetHitTestIfInvis ( mixed bVal ) [inline]

if set to true, the hittest is performed even if the element is invis, default off

Definition at line 539 of file lua_pseudo_code.cpp.

mixed cWidget::SetConsumeChildHit ( mixed bVal ) [inline]

if set to true, the hittest reports self as being hit even if childs are hit, not needed for notifiers, as they pass themselves to the parent

Definition at line 542 of file lua_pseudo_code.cpp.

mixed cWidget::SetIgnoreBBoxHit ( mixed bVal ) [inline]

old name:mbIgnoreMouseOver, if this is true, hittest for self will fail unless a bitmask is set, but childs are still tested, default:false

Definition at line 545 of file lua_pseudo_code.cpp.

mixed cWidget::SetIgnoreChildHits ( mixed bVal ) [inline]

childs are not tested, e.g. tooltips

Definition at line 548 of file lua_pseudo_code.cpp.

mixed cWidget::SetBitMask ( mixed bitmask ) [inline]

bitmask

Definition at line 551 of file lua_pseudo_code.cpp.

mixed cWidget::SetClip	(	mixed	l,
		mixed	t,
		mixed	r,
		mixed	b
	)			`[inline]`

relative to own position

Definition at line 554 of file lua_pseudo_code.cpp.

mixed cWidget::SetSize	(	mixed	w,
		mixed	h
	)			`[inline]`

set forced bounds, if they are set, GetRelBounds will be independent from the bounds calculated in c++ from the visuals useful for layouting, boxes and similar to remain consistent, it must be ensured that GetSize() always equals the last SetSize() most widget types have to react to this by implementing t:on_set_size(w,h)

Definition at line 560 of file lua_pseudo_code.cpp.

mixed cWidget::SetPos	(	mixed	x,
		mixed	y,
		mixed	z
	)			`[inline]`

in relative coords

Definition at line 563 of file lua_pseudo_code.cpp.

mixed cWidget::SetLeftTop	(	mixed	x,
		mixed	y
	)			`[inline]`

Definition at line 565 of file lua_pseudo_code.cpp.

mixed cWidget::ThemeModifyInitParams	(	mixed	parentwidget,
		mixed	params
	)			`[inline]`

should be called at the start of init for themable widgets parentwidget : allows css like hierarchy conditions (img inside table...) DEFINE : all css/theme params are capsuled inside params.style TODO : theme can request widget class here and modify param

Definition at line 571 of file lua_pseudo_code.cpp.

mixed cWidget::StartMouseMove	(	mixed	keywatch,
		mixed	move_fun,
		mixed	move_fun_param,
		mixed	end_fun,
		mixed	mx0,
		mixed	my0
	)			`[inline]`

mousemove, moves until keywatch=key_mouse1 is released e.g. dialogs, not really drag&drop.. see also old lib.movedialog.lua move_fun : can be nil, if set, x,y = move_fun(x,y,param) for widget:SetPos(), can be used as constraint if move_fun doesn't return anything, SetPos is not called, useful if position is set inside move_fun no need to transform coordinates, as the offset to GetPos() at initial call is used mx0,my0 can be used for custom offset, e.g. gLastMouseDownX,gLastMouseDownY

Definition at line 578 of file lua_pseudo_code.cpp.

mixed cWidget::CancelDragDrop	(	mixed	x,
		mixed	y
	)			`[inline]`

Definition at line 580 of file lua_pseudo_code.cpp.

mixed cWidget::EndDragDrop	(	mixed	x,
		mixed	y
	)			`[inline]`

Definition at line 582 of file lua_pseudo_code.cpp.

mixed cWidget::AddToDestroyList ( mixed o ) [inline]

o:Destroy() will be called on all things in this list at widget destruction

Definition at line 585 of file lua_pseudo_code.cpp.

mixed cWidget::RemoveFromDestroyList ( mixed o ) [inline]

Definition at line 587 of file lua_pseudo_code.cpp.

mixed cWidget::RenderToTexture	(	mixed	w,
		mixed	h,
		mixed	r,
		mixed	g,
		mixed	b,
		mixed	a
	)			`[inline]`

renders the current widget + childs into a newly created texture with size w,h and returns the texture name (name_texture) and texture object (tex) r,g,b,a : viewport background colour

Definition at line 592 of file lua_pseudo_code.cpp.

The documentation for this class was generated from the following file:

tmp/lua_pseudo_code.cpp


Public Member Functions
mixed	InitAsGroup (mixed parentwidget, mixed params)
mixed	InitAsSpritePanel (mixed parentwidget, mixed params, mixed bVertexBufferDynamic, mixed bVertexCol)
mixed	XMLCreate (mixed xmlnode)
	see also lib.gui.xml.lua
mixed	SetID (mixed id)
mixed	GetChildByID (mixed id)
mixed	FindChildByName (mixed name)
mixed	CreateChildOrContentChild (mixed classname, mixed...)
mixed	CreateContentChild (mixed classname, mixed...)
mixed	_CreateChild (mixed classname, mixed...)
	internal method, use CreateChild instead
mixed	SetRenderGroup2D (mixed rendergroup2d)
	baseclass-handle for controlling the widget, setpos,hit-test/bounds-calc etc...
mixed	SetLayouter (mixed layouter)
mixed	SetParent (mixed parentwidget)
mixed	ForAllChilds (mixed fun)
mixed	GetChild (mixed index)
mixed	GetWidgetUnderRelPos (mixed relx, mixed rely)
mixed	GetWidgetUnderPos (mixed x, mixed y)
	coordinates absolute, returns self as well if hit local mx,my = GetMousePos()
mixed	HitTest (mixed x, mixed y)
	old name : IsUnderPos
mixed	SetVisible (mixed bVal)
mixed	SetHitTestIfInvis (mixed bVal)
	if set to true, the hittest is performed even if the element is invis, default off
mixed	SetConsumeChildHit (mixed bVal)
	if set to true, the hittest reports self as being hit even if childs are hit, not needed for notifiers, as they pass themselves to the parent
mixed	SetIgnoreBBoxHit (mixed bVal)
	old name:mbIgnoreMouseOver, if this is true, hittest for self will fail unless a bitmask is set, but childs are still tested, default:false
mixed	SetIgnoreChildHits (mixed bVal)
	childs are not tested, e.g. tooltips
mixed	SetBitMask (mixed bitmask)
	bitmask
mixed	SetClip (mixed l, mixed t, mixed r, mixed b)
	relative to own position
mixed	SetSize (mixed w, mixed h)
mixed	SetPos (mixed x, mixed y, mixed z)
	in relative coords
mixed	SetLeftTop (mixed x, mixed y)
mixed	ThemeModifyInitParams (mixed parentwidget, mixed params)
mixed	StartMouseMove (mixed keywatch, mixed move_fun, mixed move_fun_param, mixed end_fun, mixed mx0, mixed my0)
mixed	CancelDragDrop (mixed x, mixed y)
mixed	EndDragDrop (mixed x, mixed y)
mixed	AddToDestroyList (mixed o)
	o:Destroy() will be called on all things in this list at widget destruction
mixed	RemoveFromDestroyList (mixed o)
mixed	RenderToTexture (mixed w, mixed h, mixed r, mixed g, mixed b, mixed a)