CEditInPlaceSettings Class Reference

Edit in place settings. More...

#include <Dapfor/GUI/EditInPlaceSettings.h>

List of all members.

Public Types
enum	ActivationType { mouseClick, mouseDblClick }
	Action type that begins edit in place in a cell. More...
Public Member Functions
	CEditInPlaceSettings ()
	Constructor.
bool	IsEnabled () const
	Indicates whether edit in place is enabled.
ActivationType	GetActivationType () const
	Gets an activation type.
bool	CanActivateOnThumbClick () const
	Indicates, whether CGrid can start edit in place in a cell on the control thumb click.
bool	CanDrawHotFrame () const
	Indicates that CGrid can draw a frame around a hot editable cell.
bool	CanDrawHotThumb () const
	Indicates that CGrid can draw a specified picture in a hot editable cell.
bool	CanDrawThumbsAlways () const
	Indicates that CGrid can draw control-specified pictures for all editable controls.
COLORREF	GetFrameColor () const
	Gets a frame color.
bool	CanUseNavigation () const
	Indicates whether CGrid can use navigation between editable controls.
void	SetEnabled (bool bEnable)
	Enables edit in place.
void	SetActivationType (ActivationType type)
	Sets a new activation type.
void	SetActivateOnThumbClick (bool bCan)
	Enables activation when the user clicks on the control thumb.
void	SetDrawHotFrame (bool bCan)
	Enables to draw a frame around a hot cell.
void	SetDrawHotThumb (bool bCan)
	Enables to draw control-specified thumbs.
void	SetDrawThumbsAlways (bool bCan)
	Enables to draw control-specified thumbs in each editable cell.
void	SetFrameColor (COLORREF color)
	Sets a frame color.
void	SetUseNavigation (bool bUse)
	Enables to navigate between editable controls.
void	Serialize (CArchive &ar)
	Serializes/deserializes data to/from the archive.
Static Public Member Functions
static int	GetSerializeVertion ()
	Gets a serialization version.

---

Detailed Description

Edit in place settings.

Version:

2.0.0 Initial version

---

Member Enumeration Documentation

enum ActivationType

Action type that begins edit in place in a cell.

Enumerator:

mouseClick	Starts edit in place when the user clicks on a cell.
mouseDblClick	Starts edit in place when the user double clicks on a cell.

---

Member Function Documentation

bool IsEnabled

(

)

const [inline]

Indicates whether edit in place is enabled.

Returns:

True if cell editing is enabled. Otherwise false.

CEditInPlaceSettings::ActivationType GetActivationType

(

)

const [inline]

Gets an activation type.

Returns:

Activation type to start edit in a cell.

bool CanActivateOnThumbClick

(

)

const [inline]

Indicates, whether CGrid can start edit in place in a cell on the control thumb click.

CGrid can start edit in a cell, if the user clicks on the control-depended area inside of the cell. For comboboxes it may be dropdown button or spin button for other controls, etc.

Returns:

True if it can. Otherwise false.

bool CanDrawHotFrame

(

)

const [inline]

Indicates that CGrid can draw a frame around a hot editable cell.

CGrid can draw a frame when the mouse cursor is over an editable cell.

Returns:

True if it can. Otherwise false.

bool CanDrawHotThumb

(

)

const [inline]

Indicates that CGrid can draw a specified picture in a hot editable cell.

CGrid can draw a control-specified picture (for ex. dropdown button for comboboxes) when the mouse cursor is over an editable cell.

Returns:

True if it can. Otherwise false.

bool CanDrawThumbsAlways

(

)

const [inline]

Indicates that CGrid can draw control-specified pictures for all editable controls.

Returns:

True if it can. Otherwise false.

COLORREF GetFrameColor

(

)

const [inline]

Gets a frame color.

Returns:

Current color to draw a frame around a hot cell.

bool CanUseNavigation

(

)

const [inline]

Indicates whether CGrid can use navigation between editable controls.

Returns:

True, if CGrid has navigation between editable controls.

void SetEnabled

(

bool

bEnable

)

[inline]

Enables edit in place.

Parameters:

[in]

bEnable

True to enable editing in cells. Otherwise false.

void SetActivationType

(

ActivationType

type

)

[inline]

Sets a new activation type.

Parameters:

[in]

type

Indicates how the user can start edit in a cell.

void SetActivateOnThumbClick

(

bool

bCan

)

[inline]

Enables activation when the user clicks on the control thumb.

Parameters:

[in]

bCan

Allows activation of edit in place control if the user clicks on the control-depended area inside of the cell. For comboboxes it may be a dropdown button or spin button for other controls, etc.

void SetDrawHotFrame

(

bool

bCan

)

[inline]

Enables to draw a frame around a hot cell.

Parameters:

[in]

bCan

Allows to draw a frame when the mouse cursor is over an editable cell.

void SetDrawHotThumb

(

bool

bCan

)

[inline]

Enables to draw control-specified thumbs.

Parameters:

[in]

bCan

Allows to draw a control-specified picture (for ex. dropdown button for comboboxes) when a mouse cursor is over an editable cell.

void SetDrawThumbsAlways

(

bool

bCan

)

[inline]

Enables to draw control-specified thumbs in each editable cell.

Parameters:

[in]

bCan

Forces the thumb for drawing in editable cells.

void SetFrameColor

(

COLORREF

color

)

[inline]

Sets a frame color.

Parameters:

[in]

color

Sets a new hot frame color

void SetUseNavigation

(

bool

bUse

)

[inline]

Enables to navigate between editable controls.

Parameters:

[in]

bUse

Allows to use navigation between editable controls.

int GetSerializeVertion

(

)

[static]

Gets a serialization version.

Returns:

Serialization version

void Serialize

(

CArchive &

ar

)

Serializes/deserializes data to/from the archive.

Parameters:

[in]

ar

Archive, where the object is serialized/deserialized.