pawsBookReadingWindow Class Reference

A window that shows the description of an item. More...

#include <pawsbookreadingwindow.h>

List of all members.

Public Member Functions
void	HandleMessage (MsgEntry *message)
virtual bool	OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *widget)
	Called whenever a button is pressed.
virtual bool	OnKeyDown (utf32_char keyCode, utf32_char key, int modifiers)
	Process keydown messages.
virtual bool	OnMouseDown (int button, int modifiers, int x, int y)
	Manage mouse down event to test for and apply window changes.
	pawsBookReadingWindow ()
bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
void	SetPage (int page)
	Turn to a given page.
void	TurnPage (int count)
	Turn a number of pages.
virtual	~pawsBookReadingWindow ()

---

Detailed Description

A window that shows the description of an item.

Definition at line 30 of file pawsbookreadingwindow.h.

---

Constructor & Destructor Documentation

pawsBookReadingWindow::pawsBookReadingWindow

(

)

virtual pawsBookReadingWindow::~pawsBookReadingWindow

(

)

[virtual]

---

Member Function Documentation

void pawsBookReadingWindow::HandleMessage

(

MsgEntry *

message

)

[virtual]

Implements psClientNetSubscriber.

virtual bool pawsBookReadingWindow::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.

virtual bool pawsBookReadingWindow::OnKeyDown	(	utf32_char	keyCode,
		utf32_char	keyChar,
		int	modifiers
	)		[virtual]

Process keydown messages.

Parameters:

keyCode	The code for the pressed key.
keyChar	The key pressed.
modifiers	Used to modify tab behavior.

Returns:

bool TRUE for success FALSE if no action.

Remarks:

If you override this, be sure to also override GetFocusOverridesControls() as returning true

Reimplemented from pawsWidget.

virtual bool pawsBookReadingWindow::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.

bool pawsBookReadingWindow::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.

void pawsBookReadingWindow::SetPage

(

int

page

)

Turn to a given page.

Will turn to start of a double side where the given page is.

Parameters:

page	The page to view

void pawsBookReadingWindow::TurnPage

(

int

count

)

Turn a number of pages.

Will turn two and two pages as you turn a book.

Parameters:

count

The number of pages to turn in the book.

---

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

• client/gui/pawsbookreadingwindow.h