MFC Grid manual

IKeyManager Class Reference

Interface to perform some actions (copy, paste, navigation, etc.) in the grid in response. More...

#include <Dapfor/GUI/IKeyManager.h>

Inheritance diagram for IKeyManager:


Public Member Functions
virtual BOOL	OnKeyDown (CGrid &grid, UINT nChar, UINT nRepCnt, UINT nFlags)=0
	Called when a non-system key is pressed.
virtual BOOL	OnKeyUp (CGrid &grid, UINT nChar, UINT nRepCnt, UINT nFlags)=0
	Called when a non-system key is released.
virtual void	NavigateKeyUp (CGrid &grid, bool bShift, bool bCtrl)=0
	Moves the focus up and scrolls down one line according to specified values of bShift and bCtrl and navigation settings.
virtual void	NavigateKeyDown (CGrid &grid, bool bShift, bool bCtrl)=0
	Moves the focus down and scrolls up one line according to specified values of bShift and bCtrl and navigation settings.
virtual void	NavigateKeyPageUp (CGrid &grid, bool bShift, bool bCtrl)=0
	Moves the focus up and scrolls down one page according to specified values of bShift and bCtrl and navigation settings.
virtual void	NavigateKeyPageDown (CGrid &grid, bool bShift, bool bCtrl)=0
	Moves the focus down and scrolls up one page according to specified values of bShift and bCtrl and navigation settings.
virtual void	NavigateKeyHome (CGrid &grid, bool bShift, bool bCtrl)=0
	Focuses the first line in the fixed or scrollable context according to specified values of bShift and bCtrl and navigation settings.
virtual void	NavigateKeyEnd (CGrid &grid, bool bShift, bool bCtrl)=0
	Focuses the last line in the fixed or scrollable context according to specified values of bShift and bCtrl and navigation settings.
virtual void	NavigateKeyLeft (CGrid &grid, bool bShift, bool bCtrl)=0
	Collapses lines and Moves the focus up according to specified values of bShift and bCtrl and navigation settings.
virtual void	NavigateKeyRight (CGrid &grid, bool bShift, bool bCtrl)=0
	Expands lines and Moves the focus down according to specified values of bShift and bCtrl and navigation settings.

Detailed Description

Interface to perform some actions (copy, paste, navigation, etc.) in the grid in response.

Navigation handling and reaction on keystrokes are processed by the grid in a separate module. Grid behavior can be completely redefined in IKeyManager interface. GUI library provides a default implementation of this interface. The programmer can create his own implementation inheriting from CKeyManager or IKeyManager. The grid provides CGrid::SetKeyManager() function that enables setting of a new manager. When the manager is not set, the grid uses the default implementation returned by CPreferences::GetDefaultKeyManager().

Member Function Documentation

BOOL OnKeyDown	(	CGrid &	grid,
		UINT	nChar,
		UINT	nRepCnt,
		UINT	nFlags
	)			`[pure virtual]`

Called when a non-system key is pressed.

Parameters:

`[in]`	grid	The grid.
`[in]`	nChar	Specifies a virtual key code of a given key. For a list of standard virtual key codes, see Winuser.h
`[in]`	nRepCnt	Repeat a count (a number of times the keystroke is repeated as a result of the user holding down the key).
`[in]`	nFlags	Specifies a scan code, key-transition code, previous key state, and context code.

Returns:: TRUE if key pressing has been handled. Otherwise FALSE.

Implemented in CKeyManager.

BOOL OnKeyUp	(	CGrid &	grid,
		UINT	nChar,
		UINT	nRepCnt,
		UINT	nFlags
	)			`[pure virtual]`

Called when a non-system key is released.

Parameters:

`[in]`	grid	The grid.
`[in]`	nChar	Specifies a virtual key code of a given key. For a list of standard virtual key codes, see Winuser.h
`[in]`	nRepCnt	Repeat a count (a number of times the keystroke is repeated as a result of the user holding down the key).
`[in]`	nFlags	Specifies a scan code, key-transition code, previous key state, and context code.

Returns:: TRUE if key releasing has been handled. Otherwise FALSE.

Implemented in CKeyManager.

void NavigateKeyUp	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Moves the focus up and scrolls down one line according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

void NavigateKeyDown	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Moves the focus down and scrolls up one line according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

void NavigateKeyPageUp	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Moves the focus up and scrolls down one page according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

void NavigateKeyPageDown	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Moves the focus down and scrolls up one page according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

void NavigateKeyHome	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Focuses the first line in the fixed or scrollable context according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

void NavigateKeyEnd	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Focuses the last line in the fixed or scrollable context according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

void NavigateKeyLeft	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Collapses lines and Moves the focus up according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

void NavigateKeyRight	(	CGrid &	grid,
		bool	bShift,
		bool	bCtrl
	)			`[pure virtual]`

Expands lines and Moves the focus down according to specified values of bShift and bCtrl and navigation settings.

Parameters:

`[in]`	grid	The grid where a focus and selection are changed.
`[in]`	bShift	Indicates whether the shift button is pressed
`[in]`	bCtrl	Indicates whether the control button is pressed

Implemented in CKeyManager.

IKeyManager Class Reference

Public Member Functions

Detailed Description

Member Function Documentation