pawsInteractWindow Class Reference

This is the window that allows you to interact with the world. More...

#include <pawsinteractwindow.h>

List of all members.

Public Member Functions
void	Draw ()
	Draws the widget and all of it's children.
void	HandleMessage (MsgEntry *message)
void	Hide ()
	Makes widget invisible and removes focus if widget has current focus.
bool	OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *widget)
	Called whenever a button is pressed.
bool	OnMouseDown (int button, int modifiers, int x, int y)
	Manage mouse down event to test for and apply window changes.
void	OnStringEntered (const char *name, int param, const char *value)
	When the pawsStringPromptWindow is created, a ptr to a class which implements this function is provided, and a "name" string is provided, so that a single window can use 1 callback for many fields.
	pawsInteractWindow ()
bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
virtual	~pawsInteractWindow ()

---

Detailed Description

This is the window that allows you to interact with the world.

It has buttons for things like pickup/examine/open/ etc.

Definition at line 32 of file pawsinteractwindow.h.

---

Constructor & Destructor Documentation

pawsInteractWindow::pawsInteractWindow

(

)

virtual pawsInteractWindow::~pawsInteractWindow

(

)

[virtual]

---

Member Function Documentation

void pawsInteractWindow::Draw

(

)

[virtual]

Draws the widget and all of it's children.

Remarks:

Uses clipping rect of it's parent to define drawing area. If the drawing area defined is empty it returns.

Reimplemented from pawsWidget.

void pawsInteractWindow::HandleMessage

(

MsgEntry *

message

)

[virtual]

Implements psClientNetSubscriber.

void pawsInteractWindow::Hide

(

)

[virtual]

Makes widget invisible and removes focus if widget has current focus.

Sets visible FALSE, hides border if present and then if focused when called it calls SetCurrentFocusedWidget(NULL).

Reimplemented from pawsWidget.

bool pawsInteractWindow::OnButtonPressed	(	int	button,
		int	keyModifier,
		pawsWidget *	widget
	)		[virtual]

Called whenever a button is pressed.

Parameters:

button	The button pressed.
keyModifier	Modifier key in effect.
widget	The widget the button belongs to.

Returns:

bool Parent's result or FALSE if no parent.

Reimplemented from pawsWidget.

bool pawsInteractWindow::OnMouseDown	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		[virtual]

Manage mouse down event to test for and apply window changes.

Parameters:

button	Type of button: 1 resizable or movable, 2 context menu or config window.
modifiers	Used with PAWS_CONSTRUCTION.
x	Used to test for resize.
y	Used to test for resize.

Returns:

bool TRUE if movable or resizable.

Remarks:

calls OnMouseDown on it's parent.

Reimplemented from pawsWidget.

void pawsInteractWindow::OnStringEntered	(	const char *	name,
		int	param,
		const char *	value
	)		[virtual]

When the pawsStringPromptWindow is created, a ptr to a class which implements this function is provided, and a "name" string is provided, so that a single window can use 1 callback for many fields.

Implements iOnStringEnteredAction.

bool pawsInteractWindow::PostSetup

(

)

[virtual]

This is called after the widget and all of it's children have been created.

Remarks:

This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented from pawsWidget.

---

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

• client/gui/pawsinteractwindow.h