pawsFingeringWindow Class Reference

Class pawsFingeringWindow is a small dialog box that ask the user to press a key combination that will be bound to some action. More...

#include <pawsconfigkeys.h>

List of all members.

Public Member Functions
virtual bool	GetFocusOverridesControls () const
	Test if the widget should intercept all key presses.
virtual void	Hide ()
	Makes widget invisible and removes focus if widget has current focus.
virtual bool	OnButtonPressed (int mouseButton, int keyModifier, pawsWidget *widget)
	Called whenever a button is pressed.
virtual bool	OnKeyDown (utf32_char keyCode, utf32_char keyChar, 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.
	pawsFingeringWindow ()
virtual bool	PostSetup ()
	This is called after the widget and all of it's children have been created.
void	SetCollisionInfo (const char *action)
	Shows string describing collision with key combination 'event' associated with 'command'.
void	SetNotify (pawsFingeringReceiver *widget)
	Sets widget that should be notified the result.
void	SetupGUIForDetection (const csString &cmdName)
void	ShowDialog (pawsFingeringReceiver *receiver, const char *editedCmd)

---

Detailed Description

Class pawsFingeringWindow is a small dialog box that ask the user to press a key combination that will be bound to some action.

Definition at line 125 of file pawsconfigkeys.h.

---

Constructor & Destructor Documentation

pawsFingeringWindow::pawsFingeringWindow

(

)

---

Member Function Documentation

virtual bool pawsFingeringWindow::GetFocusOverridesControls

(

)

const [inline, virtual]

Test if the widget should intercept all key presses.

Remarks:

False by default, should be true for text entry widgets

Reimplemented from pawsWidget.

Definition at line 151 of file pawsconfigkeys.h.

virtual void pawsFingeringWindow::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.

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

virtual bool pawsFingeringWindow::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 pawsFingeringWindow::SetCollisionInfo

(

const char *

action

)

Shows string describing collision with key combination 'event' associated with 'command'.

void pawsFingeringWindow::SetNotify

(

pawsFingeringReceiver *

widget

)

Sets widget that should be notified the result.

void pawsFingeringWindow::SetupGUIForDetection

(

const csString &

cmdName

)

void pawsFingeringWindow::ShowDialog	(	pawsFingeringReceiver *	receiver,
		const char *	editedCmd
	)

---

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

• client/gui/pawsconfigkeys.h