GRE::LAYER::TYPEDEFN Class Reference

Layer type definition structure. More...

#include <gre/layer.h>

Public Types
enum	FLAGS { FLAG_None = 0, FLAG_NotEditable = 0x0001, FLAG_OnePerGroup = 0x0002, FLAG_NoHighlightColors = 0x0010, FLAG_CanQuickAdd = 0x0020, FLAG_CanShowDataTip = 0x0040, FLAG_IsRemote = 0x0080, FLAG_CanShowRegionZoomedOut = 0x0100, FLAG_HasPossibleOverlay = 0x0200 }
Public Member Functions
void	AddTypesToFilter (MGUI::DLG_GETOBJECT_FILTER &filter) const
bool	CanQuickAdd () const
bool	CanShowDataTip () const
bool	CanShowRegionZoomedOut () const
ERRVALUE	Construct (GRE::GROUP group, LAYER retlayer=0, CREATEFLAGS createflags=CREATEFLAG_None, GRE::LISTPOS listpos=GRE::LISTPOS_Last, LAYER reflayer=0) const
bool	CreateMenuAdd (MGUI::MENU &menuret) const
const char *	GetFileExtns () const
ICONID	GetIconID () const
TYPE	GetLayerType () const
DEPRECATED MENUITEM *	GetMenuItemCreate () const
const RVC::OBJTYPESET &	GetObjTypeSet () const
const char *	GetSerializeTagCommonParm () const
const char *	GetSerializeTagLayer () const
const char *	GetSerializeTagTemplate () const
int	GetTreeViewImageIdx () const
int	GetTreeViewImageIdxEdit () const
TEXTID	GetTypeNameTextID () const
bool	HasPossibleOverlay () const
bool	IsEditable () const
int	IsFileSelectable (const FILEPATH &filepath, MISTRING &msg, int position=-1) const
int	IsObjectSelectable (const RVC::OBJITEM &objitem, MISTRING &msg, int position=-1) const
bool	IsOnePerGroup () const
bool	IsRemote () const
void	SetupTreeViewShared ()
bool	UsesHighlightColors () const
Protected Member Functions
	TYPEDEFN (TYPE LayerType, TEXTID TypeNameTextID, const RVC::OBJTYPESET &ObjTypeSet, const char FileExtns, const char SerializeTagLayer, const char SerializeTagTemplate, ICONID IconID, FLAGS flags, const char SerializeTagCommonParm=0)
	TYPEDEFN (TYPE LayerType, TEXTID TypeNameTextID, const char FileExtns, const char SerializeTagLayer, const char SerializeTagTemplate, ICONID IconID, FLAGS flags, const char SerializeTagCommonParm=0)
	TYPEDEFN (TYPE LayerType, TEXTID TypeNameTextID, const RVC::OBJTYPESET &ObjTypeSet, const char SerializeTagLayer, const char SerializeTagTemplate, ICONID IconID, FLAGS flags, const char *SerializeTagCommonParm=0)
	TYPEDEFN (TYPE LayerType, TEXTID TypeNameTextID, const char SerializeTagLayer, const char SerializeTagTemplate, ICONID IconID, FLAGS flags, const char *SerializeTagCommonParm=0)
virtual	~TYPEDEFN ()=0
void	SetIconIdEdit (ICONID iconid)

Detailed Description

Layer type definition structure.

Member Enumeration Documentation

enum GRE::LAYER::TYPEDEFN::FLAGS

Enumerator:

FLAG_None
FLAG_NotEditable	Layer is not editable.
FLAG_OnePerGroup	Only one layer of this type per group.
FLAG_NoHighlightColors	No "Highlight" or "Active" color for layer.
FLAG_CanQuickAdd	Can do "quick-add" for this layer type.
FLAG_CanShowDataTip	Can show DataTips for layer.
FLAG_IsRemote	Layer content delivered by remote service.
FLAG_CanShowRegionZoomedOut	Can display region when zoomed out.
FLAG_HasPossibleOverlay	Layer has possible overlay.

Constructor & Destructor Documentation

GRE::LAYER::TYPEDEFN::TYPEDEFN	(	TYPE	LayerType,
		TEXTID	TypeNameTextID,
		const char *	SerializeTagLayer,
		const char *	SerializeTagTemplate,
		ICONID	IconID,
		FLAGS	flags,
		const char *	SerializeTagCommonParm = `0`
	)			`[protected]`

Construct type that does not use file/object.

GRE::LAYER::TYPEDEFN::TYPEDEFN	(	TYPE	LayerType,
		TEXTID	TypeNameTextID,
		const RVC::OBJTYPESET &	ObjTypeSet,
		const char *	SerializeTagLayer,
		const char *	SerializeTagTemplate,
		ICONID	IconID,
		FLAGS	flags,
		const char *	SerializeTagCommonParm = `0`
	)			`[protected]`

Construct with RVC::OBJTYPESET.

GRE::LAYER::TYPEDEFN::TYPEDEFN	(	TYPE	LayerType,
		TEXTID	TypeNameTextID,
		const char *	FileExtns,
		const char *	SerializeTagLayer,
		const char *	SerializeTagTemplate,
		ICONID	IconID,
		FLAGS	flags,
		const char *	SerializeTagCommonParm = `0`
	)			`[protected]`

Construct with file extensions.

GRE::LAYER::TYPEDEFN::TYPEDEFN	(	TYPE	LayerType,
		TEXTID	TypeNameTextID,
		const RVC::OBJTYPESET &	ObjTypeSet,
		const char *	FileExtns,
		const char *	SerializeTagLayer,
		const char *	SerializeTagTemplate,
		ICONID	IconID,
		FLAGS	flags,
		const char *	SerializeTagCommonParm = `0`
	)			`[protected]`

Construct with file extensions and RVC::OBJTYPESET.

virtual GRE::LAYER::TYPEDEFN::~TYPEDEFN ( ) [protected, pure virtual]

Member Function Documentation

void GRE::LAYER::TYPEDEFN::AddTypesToFilter ( MGUI::DLG_GETOBJECT_FILTER & filter ) const

Add file/object types and delegates to filter.

bool GRE::LAYER::TYPEDEFN::CanQuickAdd ( ) const [inline]

bool GRE::LAYER::TYPEDEFN::CanShowDataTip ( ) const [inline]

bool GRE::LAYER::TYPEDEFN::CanShowRegionZoomedOut ( ) const [inline]

ERRVALUE GRE::LAYER::TYPEDEFN::Construct	(	GRE::GROUP *	group,
		LAYER **	retlayer = `0`,
		CREATEFLAGS	createflags = `CREATEFLAG_None`,
		GRE::LISTPOS	listpos = `GRE::LISTPOS_Last`,
		LAYER *	reflayer = `0`
	)			const

Construct layer for this type.

Parameters:

	group	Group to contain new layer
	retlayer	New layer returned
	createflags	Creation flags
	listpos	Position of new layer in list
	reflayer	Reference layer for insertion

bool GRE::LAYER::TYPEDEFN::CreateMenuAdd ( MGUI::MENU & menuret ) const [inline]

Create MGUI::MENU for add-layer options.

Returns:: true if has menu, false if not. Only layers which have multiple choices for creating layer will typically have a menu.

Parameters:

menuret

Menu created and returned

const char* GRE::LAYER::TYPEDEFN::GetFileExtns ( ) const [inline]

Get file extensions.

Returns:: NULL if no extensions supported by layer type.

ICONID GRE::LAYER::TYPEDEFN::GetIconID ( ) const [inline]

Get icon ID.

TYPE GRE::LAYER::TYPEDEFN::GetLayerType ( ) const [inline]

Get layer type.

DEPRECATED MENUITEM* GRE::LAYER::TYPEDEFN::GetMenuItemCreate ( ) const [inline]

Get MENUITEM array for layer creation menu choices (X only).

Deprecated:: , replaced by CreateMenuAdd.

const RVC::OBJTYPESET& GRE::LAYER::TYPEDEFN::GetObjTypeSet ( ) const [inline]

Get set of valid object types for this layer.

const char* GRE::LAYER::TYPEDEFN::GetSerializeTagCommonParm ( ) const [inline]

Get serializer tag for common parameters.

const char* GRE::LAYER::TYPEDEFN::GetSerializeTagLayer ( ) const [inline]

Get serializer tag for layer.

const char* GRE::LAYER::TYPEDEFN::GetSerializeTagTemplate ( ) const [inline]

Get serializer tag for template.

int GRE::LAYER::TYPEDEFN::GetTreeViewImageIdx ( ) const [inline]

Get image index for layer in object tree.

int GRE::LAYER::TYPEDEFN::GetTreeViewImageIdxEdit ( ) const [inline]

Get image index for editable layer in object tree.

TEXTID GRE::LAYER::TYPEDEFN::GetTypeNameTextID ( ) const [inline]

bool GRE::LAYER::TYPEDEFN::HasPossibleOverlay ( ) const [inline]

bool GRE::LAYER::TYPEDEFN::IsEditable ( ) const [inline]

int GRE::LAYER::TYPEDEFN::IsFileSelectable	(	const FILEPATH &	filepath,
		MISTRING &	msg,
		int	position = `-1`
	)			const

Determine if file is selectable for constructing layer of this type.

Returns:: TRUE if selectable, FALSE if not, < 0 if error.

int GRE::LAYER::TYPEDEFN::IsObjectSelectable	(	const RVC::OBJITEM &	objitem,
		MISTRING &	msg,
		int	position = `-1`
	)			const

Determine if object is selectable for constructing layer of this type.

Returns:: TRUE if selectable, FALSE if not, < 0 if error.

bool GRE::LAYER::TYPEDEFN::IsOnePerGroup ( ) const [inline]

bool GRE::LAYER::TYPEDEFN::IsRemote ( ) const [inline]

void GRE::LAYER::TYPEDEFN::SetIconIdEdit ( ICONID iconid ) [inline, protected]

void GRE::LAYER::TYPEDEFN::SetupTreeViewShared ( )

bool GRE::LAYER::TYPEDEFN::UsesHighlightColors ( ) const [inline]

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

gre/layer.h

GRE::LAYER::TYPEDEFN Class Reference

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation