CCopyPasteSettings Class Reference

Copy/cut/paste settings. More...

#include <Dapfor/GUI/CopyPasteSettings.h>

List of all members.

Public Types
enum	PasteType { pasteAsFirstClild, pasteAsLastClild, pasteAfterFocusedRow, pasteAsRootItem }
	Paste placement. More...
enum	EnsureVisibleMode { ensureVisibleNone, ensureVisibleFirstInserted, ensureVisibleLastInserted, ensureVisibleFocusedRow }
	Scrolling & visibility ensuring. More...
enum	FocusMode { focusRemove, focusFirstInserted, focusLastInserted, focusFlatLastInserted }
	Focus manipulation. More...
Public Member Functions
	CCopyPasteSettings ()
	Constructor.
	CCopyPasteSettings (const CCopyPasteSettings &settings)
	Copy constructor.
	~CCopyPasteSettings ()
	Destructor.
void	Serialize (CArchive &ar)
	Serializes/deserializes object to/from the archive.
Get- methods
bool	CanCopyFromFixedContext () const
	Indicates whether items can be copied from the fixed context.
bool	CanCopyFromScrollableContext () const
	Indicates whether items can be copied from the scrollable context.
bool	CanCopyNonSelectedChildren () const
	Indicates whether non-selected children can be copied with their parent.
bool	CanCopyFilteredChildren () const
	Indicates whether CGrid can copy the items, filtered by IGridFilter interface.
bool	CanCutFromFixedContext () const
	Indicates whether items can be cut from the fixed context.
bool	CanCutFromScrollableContext () const
	Indicates whether items can be cut from the scrollable context.
bool	CanPasteToFixedContext () const
	Indicates whether items can be pasted to the fixed context.
bool	CanPasteToScrollableContext () const
	Indicates whether items can be pasted to the scrollable context.
bool	CanPasteWhenNoFocus () const
	Indicates whether a paste operation is possible if CGrid doesn't have the focused line.
bool	CanPasteWhenNoFocusToEnd () const
	Indicates that CGrid pastes items to the end of the scrollable (if cannot to the fixed) context if there is no focus.
bool	CanImportDataFromAnotherApplication () const
	Indicates, whether CGrid can import data from other applications.
PasteType	GetPasteType () const
	Gets paste position.
EnsureVisibleMode	GetEnsureVisibleMode () const
	Visibility ensuring operations to be performed.
FocusMode	GetFocusMode () const
	Focus displacement.
Set- methods
void	EnableCopyFromFixedContext (bool bEnable)
	Enables to copy from the fixed context.
void	EnableCopyFromScrollableContext (bool bEnable)
	Enables to copy from the scrollable context.
void	EnableCopyNonSelectedChildren (bool bEnable)
	Enables to copy non-selected children with their parent.
void	EnableCopyFilteredChildren (bool bEnable)
	Enables to copy the items, filtered by IGridFilter interface.
void	EnableCutFromFixedContext (bool bEnable)
	Enables to cut from the fixed context.
void	EnableCutFromScrollableContext (bool bEnable)
	Enables to cut from the scrollable context.
void	EnablePasteToFixedContext (bool bEnable)
	Enables to paste to the fixed context.
void	EnablePasteToScrollableContext (bool bEnable)
	Enables to paste to the scrollable context.
void	EnablePasteWhenNoFocus (bool bEnable)
	Enables a paste operation when CGrid doesn't have the focused line.
void	EnablePasteWhenNoFocusToEnd (bool bEnable)
	Permits CGrid to paste items to the end of the scrollable (if cannot to the fixed) context if there is no focus.
void	EnableImportDataFromAnotherApplication (bool bEnable)
	Enables to copy data from other applications.
void	SetPasteType (PasteType pasteType)
	Sets a new paste position.
void	SetEnsureVisibleMode (EnsureVisibleMode ensureVisibleMode)
	Sets new visibility ensuring operations to be performed.
void	SetFocusMode (FocusMode focusMode)
	Sets a new focus displacement mode.
Static Public Member Functions
static int	GetSerializeVertion ()
	Serialization version.

---

Detailed Description

Copy/cut/paste settings.

Version:

1.0.0.0 Initial version

---

Member Enumeration Documentation

enum PasteType

Paste placement.

Enumerator:

pasteAsFirstClild	Paste as the first child of the focused row.
pasteAsLastClild	Paste as the last child of the focused row.
pasteAfterFocusedRow	Paste after the focused row at the same hierarchical level.
pasteAsRootItem	Paste after the focused row as the root item (hierarchical level = 0).

enum EnsureVisibleMode

Scrolling & visibility ensuring.

Enumerator:

ensureVisibleNone	Don't ensure visibility.
ensureVisibleFirstInserted	Ensures visibility to the first inserted row.
ensureVisibleLastInserted	Ensures visibility to the last inserted row.
ensureVisibleFocusedRow	Ensures visibility to the focused row.

enum FocusMode

Focus manipulation.

Enumerator:

focusRemove	Removes the focus.
focusFirstInserted	Focuses the first inserted row.
focusLastInserted	Focuses the last inserted row.
focusFlatLastInserted	Focuses the last inserted row on the same hierarchical level as the first one.

---

Member Function Documentation

bool CanCopyFromFixedContext

(

)

const

Indicates whether items can be copied from the fixed context.

Returns:

True if items can be copied from the fixed context. Otherwise false.

bool CanCopyFromScrollableContext

(

)

const

Indicates whether items can be copied from the scrollable context.

Returns:

True if items can be copied from the scrollable context. Otherwise false.

bool CanCopyNonSelectedChildren

(

)

const

Indicates whether non-selected children can be copied with their parent.

Returns:

True if non-selected children can be copied with their parent. Otherwise false.

bool CanCopyFilteredChildren

(

)

const

Indicates whether CGrid can copy the items, filtered by IGridFilter interface.

Returns:

True if CGrid can copy the items, filtered by IGridFilter interface. Otherwise false.

bool CanCutFromFixedContext

(

)

const

Indicates whether items can be cut from the fixed context.

Returns:

True if items can be cut from the fixed context. Otherwise false.

bool CanCutFromScrollableContext

(

)

const

Indicates whether items can be cut from the scrollable context.

Returns:

True if items can be cut from the scrollable context. Otherwise false.

bool CanPasteToFixedContext

(

)

const

Indicates whether items can be pasted to the fixed context.

Returns:

True if items can be pasted to the fixed context. Otherwise false.

bool CanPasteToScrollableContext

(

)

const

Indicates whether items can be pasted to the scrollable context.

Returns:

True if items can be pasted to the scrollable context. Otherwise false.

bool CanPasteWhenNoFocus

(

)

const

Indicates whether a paste operation is possible if CGrid doesn't have the focused line.

Returns:

True if a paste operation is possible if CGrid doesn't have a focused line. Otherwise false.

bool CanPasteWhenNoFocusToEnd

(

)

const

Indicates that CGrid pastes items to the end of the scrollable (if cannot to the fixed) context if there is no focus.

Returns:

True if CGrid pastes items to the end of the scrollable (if cannot to the fixed) context if there is no focus. Otherwise false.

bool CanImportDataFromAnotherApplication

(

)

const

Indicates, whether CGrid can import data from other applications.

Returns:

True if CGrid can import data from other applications. Otherwise false.

CCopyPasteSettings::PasteType GetPasteType

(

)

const

Gets paste position.

Returns:

Paste position

CCopyPasteSettings::EnsureVisibleMode GetEnsureVisibleMode

(

)

const

Visibility ensuring operations to be performed.

Returns:

Visibility ensuring operations to be performed

CCopyPasteSettings::FocusMode GetFocusMode

(

)

const

Focus displacement.

Returns:

Focus displacement mode

void EnableCopyFromFixedContext

(

bool

bEnable

)

Enables to copy from the fixed context.

Parameters:

[in]

bEnable

Enables to copy from the fixed context

void EnableCopyFromScrollableContext

(

bool

bEnable

)

Enables to copy from the scrollable context.

Parameters:

[in]

bEnable

Enables to copy from the scrollable context

void EnableCopyNonSelectedChildren

(

bool

bEnable

)

Enables to copy non-selected children with their parent.

Parameters:

[in]

bEnable

Enables to copy non-selected children with their parent

void EnableCopyFilteredChildren

(

bool

bEnable

)

Enables to copy the items, filtered by IGridFilter interface.

Parameters:

[in]

bEnable

Enables to copy the items, filtered by IGridFilter interface

void EnableCutFromFixedContext

(

bool

bEnable

)

Enables to cut from the fixed context.

Parameters:

[in]

bEnable

Enables to cut from the fixed context

void EnableCutFromScrollableContext

(

bool

bEnable

)

Enables to cut from the scrollable context.

Parameters:

[in]

bEnable

Enables to cut from the scrollable context

void EnablePasteToFixedContext

(

bool

bEnable

)

Enables to paste to the fixed context.

Parameters:

[in]

bEnable

Enables to paste to the fixed context

void EnablePasteToScrollableContext

(

bool

bEnable

)

Enables to paste to the scrollable context.

Parameters:

[in]

bEnable

Enables to paste to the scrollable context

void EnablePasteWhenNoFocus

(

bool

bEnable

)

Enables a paste operation when CGrid doesn't have the focused line.

Parameters:

[in]

bEnable

Enables a paste operation when CGrid doesn't have a focused line

void EnablePasteWhenNoFocusToEnd

(

bool

bEnable

)

Permits CGrid to paste items to the end of the scrollable (if cannot to the fixed) context if there is no focus.

Parameters:

[in]

bEnable

Permits CGrid to paste items to the end of the scrollable (if cannot to the fixed) context if there is no focus.

void EnableImportDataFromAnotherApplication

(

bool

bEnable

)

Enables to copy data from other applications.

Parameters:

[in]

bEnable

Enables to copy data from other applications

void SetPasteType

(

PasteType

pasteType

)

Sets a new paste position.

Parameters:

[in]

pasteType

A new paste position

void SetEnsureVisibleMode

(

EnsureVisibleMode

ensureVisibleMode

)

Sets new visibility ensuring operations to be performed.

Parameters:

[in]

ensureVisibleMode

New visibility ensuring operations to be performed

void SetFocusMode

(

FocusMode

focusMode

)

Sets a new focus displacement mode.

Parameters:

[in]

focusMode

A new focus displacement mode

int GetSerializeVertion

(

)

[static]

Serialization version.

Returns:

Serialization version

void Serialize

(

CArchive &

ar

)

Serializes/deserializes object to/from the archive.

Parameters:

[in]

ar

Archive to serialize/deserialize this object.