Referencia de la Clase zak::Widget

Diagrama de herencias de zak::Widget

Lista de todos los miembros.

Métodos públicos
virtual bool	Initialize ()
virtual void	OnFocus ()
virtual void	OnFocusLost ()
virtual void	OnClick ()
virtual void	OnPress ()
virtual void	OnDoubleClick ()
virtual void	OnRollOver ()
virtual void	OnRollOut ()
virtual void	OnDrag ()
virtual void	OnDropIn (Widget *widget)
virtual void	OnDropOut (Widget *widget)
virtual void	OnReturn ()
bool	SetFont (ZAK_FONT_TYPES ft, int size=15)
void	SetFontColor (unsigned int color)
int	GetFontHeight ()
ZAK_FONT_TYPES	GetFont ()
bool	Attach (Widget &widget)
bool	Detach (Widget &widget)
void	DetachAll ()
virtual void	Draw ()
virtual void	Update (float dt)
bool	GetFocused ()
void	SetRelPosX (float x)
void	SetRelPosY (float y)
void	SetRelPos (float x, float y)
float	GetRelPosX ()
float	GetRelPosY ()
void	SetDragable (bool dragable)
bool	GetDragable ()
void	SetEnable (bool enable)
bool	GetEnable ()
void	SetDoubleClickDelay (float dblClickDelay)
float	GetDoubleClickDelay ()
	Widget ()
virtual	~Widget ()
Métodos protegidos
virtual void	OnFocusInternal ()
virtual void	OnFocusLostInternal ()
virtual void	OnClickInternal ()
void	DrawString (string &text, float x, float y, float w, float h, unsigned int align=ZAK_TEXT_LEFT)
void	DrawString (wstring &text, float x, float y, float w, float h, unsigned int align=ZAK_TEXT_LEFT)
void	DrawString (char *text, float x, float y, float w, float h, unsigned int align=ZAK_TEXT_LEFT)
Widget *	DoEvents (int &event)
Widget *	GetParent ()
WidgetMgr *	GetMgr ()
void	Release ()
void	Reset ()
Atributos protegidos
ID3DXFont *	_pDefDXFont
Widget *	_parent
WidgetMgr *	_mgr
bool	_editing
unsigned int	_color
int	_size
Amigas
class	WidgetMgr
class	Widget

---

Descripción detallada

Clase que define el esqueleto de los widgets con sus eventos Ejemplo de uso:

Autor:

Juan Pablo "McKrackeN" Bettini

---

Documentación del constructor y destructor

zak::Widget::Widget

(

)

Constructor

zak::Widget::~Widget

(

)

[virtual]

Destructor

---

Documentación de las funciones miembro

bool zak::Widget::Initialize

(

)

[virtual]

Método virtual que debe invocarse al crearse un widget. Además puede ser sobrecargado.

Devuelve:

Devolverá true en el caso de que todo haya salido bien y false en caso contrario

Reimplementado en zak::WdgConsole.

virtual void zak::Widget::OnFocus

(

)

[inline, virtual]

Método virtual invocado cuando el widget toma el foco

Reimplementado en zak::WdgEditBox, y zak::WdgConsole.

virtual void zak::Widget::OnFocusLost

(

)

[inline, virtual]

Método virtual invocado cuando el widget pierde el foco

Reimplementado en zak::WdgEditBox, y zak::WdgConsole.

virtual void zak::Widget::OnClick

(

)

[inline, virtual]

Método virtual invocado cuando el usuario hace click con el botón izquierdo del mouse sobre el widget

virtual void zak::Widget::OnPress

(

)

[inline, virtual]

Método virtual invocado cuando el usuario mantiene presionado el botón izquierdo del mouse sobre el widget

virtual void zak::Widget::OnDoubleClick

(

)

[inline, virtual]

Método virtual invocado cuando el usuario hace doble click con el botón izquierdo del mouse sobre el widget

virtual void zak::Widget::OnRollOver

(

)

[inline, virtual]

Método virtual invocado cuando el mouse pasa por sobre el widget

virtual void zak::Widget::OnRollOut

(

)

[inline, virtual]

Método virtual invocado cuando el mouse escapa de la zona del widget

virtual void zak::Widget::OnDrag

(

)

[inline, virtual]

Método virtual invocado cuando el usuario trata de arrastrar el widget. Debe estar activado el arrastre para el widget, sino el evento será ignorado.

virtual void zak::Widget::OnDropIn

(

Widget *

widget

)

[inline, virtual]

Método virtual invocado si el usuario arrastra un widget sobre éste y lo suelta.

Parámetros:

widget

Puntero al widget que está siendo arrastrado

virtual void zak::Widget::OnDropOut

(

Widget *

widget

)

[inline, virtual]

Método virtual invocado si el usuario arrastra este widget y lo suelta sobre otro.

Parámetros:

widget

Puntero al widget que donde lo está colocando

virtual void zak::Widget::OnReturn

(

)

[inline, virtual]

Método virtual invocado si se presiona enter mientras el widget está en foco

bool zak::Widget::SetFont	(	ZAK_FONT_TYPES	ft,
		int	size = 15
	)

El método crea una fuente de sistema según los parámetros pasados´.

Parámetros:

	ft	Tipo de fuente.
	size	Tamaño de la fuente.

Devuelve:

Retorna true si fue posible crear la fuente y false en caso contrario

void zak::Widget::SetFontColor

(

unsigned int

color

)

[inline]

El método permite indicar el color de la fuente.

Parámetros:

color

Color de la fuente.

int zak::Widget::GetFontHeight

(

)

[inline]

Devuelve el alto de la fuente.

Devuelve:

Retorna un número entero que indica el alto de la fuente

ZAK_FONT_TYPES zak::Widget::GetFont

(

)

Devuelve el tipo de fuente actualmente seleccionada.

Devuelve:

Retorna el tipo de fuente seleccionada actualmente.

bool zak::Widget::Attach

(

Widget &

widget

)

Adjunta un widget al actual

Devuelve:

Retorna true en caso de haber podido adjuntar el widget y false en caso contrario

bool zak::Widget::Detach

(

Widget &

widget

)

Desprende un widget al actual

Devuelve:

Retorna true en caso de haber podido desprender el widget y false en caso contrario

void zak::Widget::DetachAll

(

)

Desprende todos los widgets del actual

void zak::Widget::Draw

(

)

[virtual]

Método virtual que muestra el widget

Reimplementado de zak::Sprite.

Reimplementado en zak::WdgEditBox, y zak::WdgConsole.

void zak::Widget::Update

(

float

dt

)

[virtual]

Método virtual que actualiza el widget

Reimplementado de zak::Sprite.

Reimplementado en zak::WdgEditBox, y zak::WdgConsole.

bool zak::Widget::GetFocused

(

)

[inline]

Devuelve si el widget está en foco o no

Devuelve:

Devuelve true en caso de estar en foco y false en caso contrario.

void zak::Widget::SetRelPosX

(

float

x

)

[inline]

Permite indicar la posición relativa al widget que contiene al actual.

Parámetros:

x

Componente x de la posición relativa

void zak::Widget::SetRelPosY

(

float

y

)

[inline]

Permite indicar la posición relativa al widget que contiene al actual.

Parámetros:

y

Componente y de la posición relativa

void zak::Widget::SetRelPos	(	float	x,
		float	y
	)			[inline]

Permite indicar la posición relativa al widget que contiene al actual.

Parámetros:

	x	Componente x de la posición relativa
	y	Componente y de la posición relativa

float zak::Widget::GetRelPosX

(

)

[inline]

Devuelve la posición relativa al widget que contiene al actual.

Devuelve:

Componente x de la posición relativa

float zak::Widget::GetRelPosY

(

)

[inline]

Devuelve la posición relativa al widget que contiene al actual.

Devuelve:

Componente y de la posición relativa

void zak::Widget::SetDragable

(

bool

dragable

)

[inline]

Indica si el widget puede arrastrarse

Parámetros:

dragable

Indica si el widget puede arrastrarse

bool zak::Widget::GetDragable

(

)

[inline]

Devuelve si el widget puede arrastrarse

Devuelve:

Devuelve si el widget puede arrastrarse

void zak::Widget::SetEnable

(

bool

enable

)

[inline]

Permite activar o desactivar el widget. En caso de estar desactivado, se mostrará pero no recibirá eventos.

Parámetros:

enable

Indica si está activado o no

bool zak::Widget::GetEnable

(

)

[inline]

Devuelve si el widget se encuentra activado o no.

Devuelve:

Devuelve si está activado o no

void zak::Widget::SetDoubleClickDelay

(

float

dblClickDelay

)

[inline]

Permite indicar el intervalo entre clicks para ser tomado como un doble click (en milisegundos)

Parámetros:

dblClickDelay

Número flotante que indica el intervalo de tiempo en milisegundos entre clicks

float zak::Widget::GetDoubleClickDelay

(

)

[inline]

Devuelve el intervalo entre clicks para ser tomado como un doble click (en milisegundos)

Devuelve:

Número flotante que indica el intervalo de tiempo en milisegundos entre clicks

---

La documentación para esta clase fué generada a partir de los siguientes archivos:

• widgets.h
• widgets.cpp

---