regcom::gui::Window

Window Class Reference

#include <Window.h>

Inheritance diagram for Window:

List of all members.


Public Member Functions
	Window ()
	(* add brief description here *)
virtual	~Window ()
	(* add brief description here *)
virtual void	Update (Rect rect)
	(* add brief description here *)
virtual void	UpdateChild (Window *child, Rect rect)
	(* add brief description here *)
virtual void	Draw (Rect rect)
	(* add brief description here *)
void	DrawSurface (Surface *surface, Rect rect)
	(* add brief description here *)
void	DrawSurface (Surface *surface, Rect src, int x, int y)
	(* add brief description here *)
void	FillRect (const Rect &rRect, const Color &rColor)
	(* add brief description here *)
virtual void	OnMouseMove (Point point)
	(* add brief description here *)
virtual void	OnMouseDown (int n, Point point)
	(* add brief description here *)
virtual void	OnMouseUp (int n, Point point)
	(* add brief description here *)
virtual void	Invalidate (Rect rect)
	(* add brief description here *)
virtual void	Invalidate ()
	(* add brief description here *)
Rect	Bounds ()
	(* add brief description here *)
Rect	Frame ()
	(* add brief description here *)
void	ResizeTo (int w, int h)
	(* add brief description here *)
void	ResizeBy (int w, int h)
	(* add brief description here *)
void	OffsetTo (int x, int y)
	(* add brief description here *)
void	OffsetBy (int x, int y)
	(* add brief description here *)
virtual void	FrameMoved (Point point)
	(* add brief description here *)
virtual void	FrameResized (int w, int h)
	(* add brief description here *)
int	Width ()
	(* add brief description here *)
int	Height ()
	(* add brief description here *)
virtual int	Contains (Point point)
	(* add brief description here *)
void	AddChild (Window *window)
	(* add brief description here *)
virtual Window *	FindWindow (Point point)
	(* add brief description here *)
Point	ConvertFromScreen (Point point)
	(* add brief description here *)
Point	ConvertToScreen (Point point)
	(* add brief description here *)
void	CaptureMouse (Rect rect)
	(* add brief description here *)
void	ReleaseMouse ()
	(* add brief description here *)
Window *	GetCaptureView ()
	(* add brief description here *)
Rect	GetCaptureRect ()
	(* add brief description here *)
void	SetMouseOverride (bool override)
	(* add brief description here *)
bool	GetMouseOverride ()
	(* add brief description here *)
void	SetMousePosition (Point position)
	(* add brief description here *)
Point	GetMousePosition ()
	(* add brief description here *)
Window *	GetParent ()
	(* add brief description here *)
void	SetParent (Window *window)
	(* add brief description here *)
virtual bool	CanFocus ()
	(* add brief description here *)
virtual void	OnFocus (bool hasFocus)
	(* add brief description here *)
virtual void	OnMouseButtonDown (SDL_MouseButtonEvent sdlEvent)
	(* add brief description here *)
virtual void	OnMouseButtonUp (SDL_MouseButtonEvent sdlEvent)
	(* add brief description here *)
virtual void	OnKeyDown (SDL_KeyboardEvent sdlEvent)
	(* add brief description here *)
virtual void	OnKeyUp (SDL_KeyboardEvent sdlEvent)
	(* add brief description here *)
virtual void	OnTimer (float deltaTime)
	(* add brief description here *)
Window *	GetNextWindow ()
	(* add brief description here *)
Private Attributes
Rect	m_Frame
	(* add brief description here *)
Window *	m_pParent
	(* add brief description here *)
Window *	m_pFirstChild
	(* add brief description here *)
Window *	m_pLastChild
	(* add brief description here *)
Window *	m_pPrevSibling
	(* add brief description here *)
Window *	m_pNextSibling
	(* add brief description here *)
Static Private Attributes
static Window *	s_pCaptureView = NULL
	(* add brief description here *)
static Rect	s_CaptureRect
	(* add brief description here *)
static Point	s_MousePosition
	(* add brief description here *)
static bool	s_MouseOverride = 0
	(* add brief description here *)

Detailed Description

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Constructor & Destructor Documentation

Window ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

~Window ( ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Member Function Documentation

void Update ( Rect rect ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Reimplemented in Desktop.

void UpdateChild	(	Window *	child,
		Rect	rect
	)			`[virtual]`

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void Draw ( Rect rect ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Reimplemented in Console, RadarView, Button, Cursor, EditBox, Image, ScrollView, StaticText, and StringView.

void DrawSurface	(	Surface *	surface,
		Rect	rect
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void DrawSurface	(	Surface *	surface,
		Rect	src,
		int	x,
		int	y
	)

(*** add brief description here ***)

void FillRect	(	const Rect &	rRect,
		const Color &	rColor
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void OnMouseMove ( Point point ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Reimplemented in Console, MapView, RadarView, Button, and EditBox.

void OnMouseDown	(	int	n,
		Point	point
	)			`[virtual]`

(*** add brief description here ***)

Reimplemented in Console, MapView, RadarView, Button, and EditBox.

void OnMouseUp	(	int	n,
		Point	point
	)			`[virtual]`

(*** add brief description here ***)

Reimplemented in Console, MapView, RadarView, Button, and EditBox.

void Invalidate ( Rect rect ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Reimplemented in Desktop.

void Invalidate ( ) [virtual]

(*** add brief description here ***)

Reimplemented in Desktop.

Rect Bounds ( ) [inline]

(*** add brief description here ***)

Rect Frame ( ) [inline]

(*** add brief description here ***)

void ResizeTo	(	int	w,
		int	h
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void ResizeBy	(	int	w,
		int	h
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void OffsetTo	(	int	x,
		int	y
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void OffsetBy	(	int	x,
		int	y
	)

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void FrameMoved ( Point point ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void FrameResized	(	int	w,
		int	h
	)			`[virtual]`

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Reimplemented in ScrollView.

int Width ( ) [inline]

(*** add brief description here ***)

int Height ( ) [inline]

(*** add brief description here ***)

virtual int Contains ( Point point ) [inline, virtual]

(*** add brief description here ***)

Reimplemented in Console, Cursor, and StringView.

void AddChild ( Window * window )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Window * FindWindow ( Point point ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Reimplemented in Desktop.

Point ConvertFromScreen ( Point point ) [inline]

(*** add brief description here ***)

Point ConvertToScreen ( Point point ) [inline]

(*** add brief description here ***)

void CaptureMouse ( Rect rect )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void ReleaseMouse ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Window * GetCaptureView ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Rect GetCaptureRect ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void SetMouseOverride ( bool override )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

bool GetMouseOverride ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

void SetMousePosition ( Point position )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Point GetMousePosition ( )

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Window* GetParent ( ) [inline]

(*** add brief description here ***)

void SetParent ( Window * window ) [inline]

(*** add brief description here ***)

virtual bool CanFocus ( ) [inline, virtual]

(*** add brief description here ***)

Reimplemented in EditBox.

virtual void OnFocus ( bool hasFocus ) [inline, virtual]

(*** add brief description here ***)

Reimplemented in EditBox.

virtual void OnMouseButtonDown ( SDL_MouseButtonEvent sdlEvent ) [inline, virtual]

(*** add brief description here ***)

Reimplemented in Desktop.

virtual void OnMouseButtonUp ( SDL_MouseButtonEvent sdlEvent ) [inline, virtual]

(*** add brief description here ***)

Reimplemented in Desktop.

virtual void OnKeyDown ( SDL_KeyboardEvent sdlEvent ) [inline, virtual]

(*** add brief description here ***)

Reimplemented in Desktop, and EditBox.

virtual void OnKeyUp ( SDL_KeyboardEvent sdlEvent ) [inline, virtual]

(*** add brief description here ***)

Reimplemented in Desktop.

void OnTimer ( float deltaTime ) [virtual]

(*** add brief description here ***)

Full Description: (*** add full description here ***)

Returns:: (*** add return description here ***)

Reimplemented in EditBox, and ScrollView.

Window* GetNextWindow ( ) [inline]

(*** add brief description here ***)

Member Data Documentation

Rect m_Frame [private]

(*** add brief description here ***)

Window * s_pCaptureView = NULL [static, private]

(*** add brief description here ***)

Rect s_CaptureRect [static, private]

(*** add brief description here ***)

Point s_MousePosition [static, private]

(*** add brief description here ***)

bool s_MouseOverride = 0 [static, private]

(*** add brief description here ***)

Window* m_pParent [private]

(*** add brief description here ***)

Window* m_pFirstChild [private]

(*** add brief description here ***)

Window* m_pLastChild [private]

(*** add brief description here ***)

Window* m_pPrevSibling [private]

(*** add brief description here ***)

Window* m_pNextSibling [private]

(*** add brief description here ***)

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