owl::THotKey Class Reference

#include <hotkey.h>

Inheritance diagram for owl::THotKey:

List of all members.

Public Member Functions
	THotKey (TWindow *parent, int id, int x, int y, int w, int h, TModule *module=0)
	THotKey (TWindow *parent, int resourceId, TModule *module=0)
	THotKey (THandle hWnd, TModule *module=0)
uint16	GetHotKey ()
void	SetHotKey (uint16 hotKey)
void	SetHotKey (uint8 vk, uint8 mods)
void	SetRules (uint16 invalid, uint16 defFlag)
uint	Transfer (uint16 &key, TTransferDirection direction)
Protected Member Functions
uint	Transfer (void *buffer, TTransferDirection direction)
virtual TGetClassNameReturnType	GetClassName ()

---

Detailed Description

THotKey encapsulates the hot-key control, a window that allows the user to enter a combination of keystrokes to be used as a a hot key. [A hot key is a key combination that the user can press to perform an action quickly].

---

Constructor & Destructor Documentation

owl::THotKey::THotKey	(	TWindow *	parent,
		int	id,
		int	x,
		int	y,
		int	w,
		int	h,
		TModule *	module = 0
	)

Constructors for THotKey initialize data fields using parameters passed and default values. By default, a Hotkey control associated with the TColumnHeader will be visible upon creation and will have a border.

References owl::TWindow::ModifyStyle().

owl::THotKey::THotKey	(	TWindow *	parent,
		int	resourceId,
		TModule *	module = 0
	)

Constructs a hot key control from resource.

owl::THotKey::THotKey	(	THandle	hWnd,
		TModule *	module = 0
	)

Constructs a hot key object to encapsulate (alias) an existing control.

---

Member Function Documentation

TWindow::TGetClassNameReturnType owl::THotKey::GetClassName

(

)

[protected, virtual]

Return the class name for a hot key control.

Reimplemented from owl::TWindow.

uint16 owl::THotKey::GetHotKey

(

)

Returns the 16-bit virtual key code for the control.

References owl::TWindow::SendMessage().

void owl::THotKey::SetHotKey

(

uint16

hotKey

)

Sets the virtual key code and modifier flags for the hot key. See the Windows API for more details on VK_xxxx and modifier flags.

References owl::TWindow::SendMessage().

void owl::THotKey::SetHotKey	(	uint8	vk,
		uint8	mods
	)

Sets the virtual key code and modifier flags for the hot key.

References SetHotKey().

void owl::THotKey::SetRules	(	uint16	invalid,
		uint16	defFlag
	)

Set the invalid key combinations for this control.

Sets the invalid key combinations for the hotkey control.

References owl::TWindow::SendMessage().

uint owl::THotKey::Transfer	(	uint16 &	key,
		TTransferDirection	direction
	)		[inline]

Safe overload.

References Transfer().

uint owl::THotKey::Transfer	(	void *	buffer,
		TTransferDirection	direction
	)		[protected, virtual]

Transfer a uint16 (the virtual key code) for the control.

Reimplemented from owl::TWindow.

References GetHotKey(), SetHotKey(), owl::tdGetData, and owl::tdSetData.

---

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

• D:/Work/OWLNext/Subversion/branches/632/include/owl/hotkey.h
• D:/Work/OWLNext/Subversion/branches/632/source/owlcore/hotkey.cpp