OdDbTableStyle Class Reference

#include <DbTableStyle.h>

Inheritance diagram for OdDbTableStyle:

Public Member Functions
	ODDB_DECLARE_MEMBERS (OdDbTableStyle)
	OdDbTableStyle ()
virtual OdString	getName () const
virtual void	setName (const OdString &name)
virtual OdString	description () const
virtual void	setDescription (const OdString &description)
virtual OdUInt32	bitFlags () const
virtual void	setBitFlags (OdUInt32 bitFlags)
virtual OdDb::FlowDirection	flowDirection () const
virtual void	setFlowDirection (OdDb::FlowDirection flowDirection)
virtual double	horzCellMargin () const
virtual void	setHorzCellMargin (double cellMargin)
virtual double	vertCellMargin () const
virtual void	setVertCellMargin (double cellMargin)
virtual bool	isTitleSuppressed () const
virtual void	suppressTitleRow (bool suppress)
virtual bool	isHeaderSuppressed () const
virtual void	suppressHeaderRow (bool suppress)
virtual OdDbObjectId	textStyle (OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setTextStyle (const OdDbObjectId textStyleId, int rowTypes=OdDb::kAllRows)
virtual double	textHeight (OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setTextHeight (double height, int rowTypes=OdDb::kAllRows)
virtual OdDb::CellAlignment	alignment (OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setAlignment (OdDb::CellAlignment alignment, int rowTypes=OdDb::kAllRows)
virtual OdCmColor	color (OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setColor (const OdCmColor &color, int rowTypes=OdDb::kAllRows)
virtual OdCmColor	backgroundColor (OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setBackgroundColor (const OdCmColor &color, int rowTypes=OdDb::kAllRows)
virtual bool	isBackgroundColorNone (OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setBackgroundColorNone (bool disable, int rowTypes=OdDb::kAllRows)
virtual OdDb::LineWeight	gridLineWeight (OdDb::GridLineType gridlineType, OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setGridLineWeight (OdDb::LineWeight lineWeight, int gridlineTypes=OdDb::kAllGridLines, int rowTypes=OdDb::kAllRows)
virtual OdCmColor	gridColor (OdDb::GridLineType gridlineType, OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setGridColor (const OdCmColor color, int gridlineTypes=OdDb::kAllGridLines, int rowTypes=OdDb::kAllRows)
virtual OdDb::Visibility	gridVisibility (OdDb::GridLineType gridlineType, OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setGridVisibility (OdDb::Visibility gridVisiblity, int gridlineTypes=OdDb::kAllGridLines, int rowTypes=OdDb::kAllRows)
virtual void	getDataType (OdValue::DataType &nDataType, OdValue::UnitType &nUnitType, OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setDataType (OdValue::DataType nDataType, OdValue::UnitType nUnitType, int rowTypes=OdDb::kAllRows)
virtual OdString	format (OdDb::RowType rowType=OdDb::kDataRow) const
virtual void	setFormat (const OdString &pszFormat, int rowTypes=OdDb::kAllRows)
virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)
virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const
virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)
virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const
void	setDatabaseDefaults (OdDbDatabase *pDb=0)
virtual OdDbObjectId	postTableStyleToDb (OdDbDatabase *pDb, const OdString &styleName)
const OdString	createCellStyle (void)
void	createCellStyle (const OdString &cellStyle)
void	createCellStyle (const OdString &cellStyle, const OdString &fromCellStyle)
void	renameCellStyle (const OdString &oldName, const OdString &newName)
void	deleteCellStyle (const OdString &cellStyle)
void	copyCellStyle (const OdString &srcCellStyle, const OdString &targetCellStyle)
void	copyCellStyle (const OdDbTableStyle *pSrc, const OdString &srcCellStyle, const OdString &targetCellStyle)
void	getUniqueCellStyleName (const OdString &baseName, OdString &sUniqueName) const
bool	isCellStyleInUse (const OdString &cellStyle) const
OdInt32	numCellStyles (void) const
OdInt32	getCellStyles (OdStringArray &cellstyles) const
OdInt32	cellStyleId (const OdString &cellStyle) const
OdString	cellStyleName (OdInt32 cellStyle) const
OdDbObjectId	textStyle (const OdString &cellStyle) const
void	setTextStyle (const OdDbObjectId &id, const OdString &cellStyle)
double	textHeight (const OdString &cellStyle) const
void	setTextHeight (double dHeight, const OdString &cellStyle)
OdDb::CellAlignment	alignment (const OdString &cellStyle) const
void	setAlignment (OdDb::CellAlignment alignment, const OdString &cellStyle)
OdCmColor	color (const OdString &cellStyle) const
void	setColor (const OdCmColor &color, const OdString &cellStyle)
OdCmColor	backgroundColor (const OdString &cellStyle) const
void	setBackgroundColor (const OdCmColor &color, const OdString &cellStyle)
void	getDataType (OdValue::DataType &nDataType, OdValue::UnitType &nUnitType, const OdString &cellStyle) const
void	setDataType (OdValue::DataType nDataType, OdValue::UnitType nUnitType, const OdString &cellStyle)
const OdString	format (const OdString &cellStyle) const
void	setFormat (const OdString &format, const OdString &cellStyle)
OdInt32	cellClass (const OdString &cellStyle) const
void	setCellClass (OdInt32 nClass, const OdString &cellStyle)
double	rotation (const OdString &cellStyle) const
void	setRotation (double rotation, const OdString &cellStyle)
bool	isMergeAllEnabled (const OdString &cellStyle) const
void	enableMergeAll (bool bEnable, const OdString &cellStyle)
double	margin (OdDb::CellMargin nMargin, const OdString &cellStyle) const
void	setMargin (OdDb::CellMargin nMargins, double fMargin, const OdString &cellStyle)
OdDb::LineWeight	gridLineWeight (OdDb::GridLineType gridLineType, const OdString &cellStyle) const
void	setGridLineWeight (OdDb::LineWeight lineWeight, OdDb::GridLineType gridLineTypes, const OdString &cellStyle)
OdCmColor	gridColor (OdDb::GridLineType gridLineType, const OdString &cellStyle) const
void	setGridColor (const OdCmColor color, OdDb::GridLineType gridLineTypes, const OdString &cellStyle)
OdDb::Visibility	gridVisibility (OdDb::GridLineType gridLineType, const OdString &cellStyle) const
void	setGridVisibility (OdDb::Visibility visible, OdDb::GridLineType gridLineTypes, const OdString &cellStyle)
double	gridDoubleLineSpacing (OdDb::GridLineType gridLineType, const OdString &cellStyle) const
void	setGridDoubleLineSpacing (double fSpacing, OdDb::GridLineType gridLineTypes, const OdString &cellStyle)
OdDb::GridLineStyle	gridLineStyle (OdDb::GridLineType gridLineType, const OdString &cellStyle) const
void	setGridLineStyle (OdDb::GridLineStyle nLineStyle, OdDb::GridLineType gridLineTypes, const OdString &cellStyle)
OdDbObjectId	gridLinetype (OdDb::GridLineType gridLineType, const OdString &cellStyle) const
void	setGridLinetype (const OdDbObjectId &id, OdDb::GridLineType gridLineTypes, const OdString &cellStyle)
void	getGridProperty (OdGridProperty &gridProp, OdDb::GridLineType nGridLineTypes, const OdString &cellStyle) const
void	setGridProperty (const OdGridProperty &gridProp, OdDb::GridLineType nGridLineTypes, const OdString &cellStyle)
virtual OdResult	subGetClassID (void *pClsid) const
OdDbObjectId	getTemplate (void) const
void	setTemplate (const OdDbObjectId templateId, OdDb::MergeCellStyleOption nOption)
OdDbObjectId	removeTemplate (void)
Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)
	~OdDbObject ()
void	addRef ()
void	release ()
long	numRefs () const
OdDbObjectId	objectId () const
OdDbHandle	getDbHandle () const
OdDbHandle	handle () const
OdDbObjectId	ownerId () const
virtual void	setOwnerId (OdDbObjectId ownerId)
OdDbDatabase *	database () const
void	createExtensionDictionary ()
OdDbObjectId	extensionDictionary () const
bool	releaseExtensionDictionary ()
OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)
void	upgradeOpen ()
void	downgradeOpen ()
void	cancel ()
virtual OdResult	subOpen (OdDb::OpenMode mode)
virtual void	subClose ()
OdResult	erase (bool eraseIt=true)
virtual OdResult	subErase (bool erasing)
void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)
virtual void	subHandOverTo (OdDbObject *pNewObject)
void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)
virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)
virtual void	audit (OdDbAuditInfo *pAuditInfo)
void	dwgIn (OdDbDwgFiler *pFiler)
void	dwgOut (OdDbDwgFiler *pFiler) const
virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)
virtual void	dxfOut (OdDbDxfFiler *pFiler) const
virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)
virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const
virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)
virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const
virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)
virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const
virtual OdDb::DuplicateRecordCloning	mergeStyle () const
virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const
virtual void	setXData (const OdResBuf *pRb)
bool	isEraseStatusToggled () const
bool	isErased () const
bool	isReadEnabled () const
bool	isWriteEnabled () const
bool	isNotifyEnabled () const
bool	isModified () const
bool	isModifiedXData () const
bool	isModifiedGraphics () const
bool	isNewObject () const
bool	isNotifying () const
bool	isUndoing () const
bool	isReallyClosing () const
bool	isDBRO () const
void	assertReadEnabled () const
void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
void	assertNotifyEnabled () const
void	disableUndoRecording (bool disable)
bool	isUndoRecordingDisabled () const
OdDbDwgFiler *	undoFiler ()
virtual void	applyPartialUndo (OdDbDwgFiler *pUndoFiler, OdRxClass *pClassObj)
void	addReactor (OdDbObjectReactor *pReactor) const
void	removeReactor (OdDbObjectReactor *pReactor) const
virtual void	addPersistentReactor (const OdDbObjectId &objId)
virtual void	removePersistentReactor (const OdDbObjectId &objId)
bool	hasPersistentReactor (const OdDbObjectId &objId) const
OdDbObjectIdArray	getPersistentReactors () const
OdDbObjectReactorArray	getTransientReactors () const
virtual void	recvPropagateModify (const OdDbObject *pSubObj)
virtual void	xmitPropagateModify () const
ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &idMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED
virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &idMap)
void	setOdDbObjectIdsInFlux ()
bool	isOdDbObjectIdsInFlux () const
virtual void	copied (const OdDbObject *pObject, const OdDbObject *pNewObject)
virtual void	erased (const OdDbObject *pObject, bool erasing=true)
virtual void	goodbye (const OdDbObject *pObject)
virtual void	openedForModify (const OdDbObject *pObject)
virtual void	modified (const OdDbObject *pObject)
virtual void	subObjModified (const OdDbObject *pObject, const OdDbObject *pSubObj)
virtual void	modifyUndone (const OdDbObject *pObject)
virtual void	modifiedXData (const OdDbObject *pObject)
virtual void	unappended (const OdDbObject *pObject)
virtual void	reappended (const OdDbObject *pObject)
bool	isAProxy () const
virtual void	objectClosed (const OdDbObjectId &objectId)
virtual void	modifiedGraphics (const OdDbObject *pObject)
virtual void	copyFrom (const OdRxObject *pSource)
bool	hasSaveVersionOverride () const
void	setHasSaveVersionOverride (bool hasSaveVersionOverride)
virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler *pFiler, OdDb::MaintReleaseVer *pMaintVer=0) const
virtual OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)
void	convertForSave (OdDb::DwgVersion ver)
virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)
virtual OdGiDrawable *	drawable ()
virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const
virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const
virtual void	subViewportDraw (OdGiViewportDraw *pVd) const
virtual bool	isPersistent () const
virtual OdDbStub *	id () const
ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_SEALED
void	setGsNode (OdGsCache *pNode)
OdGsCache *	gsNode () const
void	xDataTransformBy (const OdGeMatrix3d &xfm)
bool	hasFields () const
OdDbObjectId	getField (const OdString &fieldName) const
OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const
virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)
virtual OdResult	removeField (OdDbObjectId fieldId)
virtual OdDbObjectId	removeField (const OdString &fieldName)
OdDbObjectId	getFieldDictionary () const
OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const
virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const
Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)
virtual DrawableType	drawableType () const
ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED
ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED
ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED
virtual bool	isPersistent () const =0
virtual OdDbStub *	id () const =0
virtual void	setGsNode (OdGsCache *pGsNode)=0
virtual OdGsCache *	gsNode () const =0
ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED
virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const
ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED
Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()
	OdRxObject ()
virtual	~OdRxObject ()
virtual OdRxObject *	queryX (const OdRxClass *pClass) const
virtual OdRxObject *	x (const OdRxClass *pClass) const
virtual OdRxClass *	isA () const
virtual void	addRef ()=0
virtual void	release ()=0
virtual long	numRefs () const
bool	isKindOf (const OdRxClass *pClass) const
virtual OdRxObjectPtr	clone () const
virtual void	copyFrom (const OdRxObject *pSource)
virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const
virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Public Types inherited from OdGiDrawable
enum	SetAttributesFlags {   kDrawableNone = 0 , kDrawableIsAnEntity = 1 , kDrawableUsesNesting = 2 , kDrawableIsCompoundObject = 4 ,   kDrawableViewIndependentViewportDraw = 8 , kDrawableIsInvisible = 16 , kDrawableHasAttributes = 32 , kDrawableRegenTypeDependantGeometry = 64 ,   kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128) , kDrawableRegenDraw = 256 , kDrawableStandardDisplaySingleLOD = 512 , kDrawableShadedDisplaySingleLOD = 1024 ,   kDrawableViewDependentViewportDraw = 2048 , kDrawableBlockDependentViewportDraw = 4096 , kDrawableIsExternalReference = 8192 , kDrawableNotPlottable = 16384 ,   kDrawableNotAllowLCS = 32768 , kDrawableMergeControlOff = 65536 , kLastFlag = kDrawableMergeControlOff }
enum	DrawableType {   kGeometry = 0 , kDistantLight = 1 , kPointLight = 2 , kSpotLight = 3 ,   kAmbientLight , kSolidBackground , kGradientBackground , kImageBackground ,   kGroundPlaneBackground , kViewport , kWebLight , kSkyBackground ,   kImageBasedLightingBackground }
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)
static OdRxClass *	desc ()
Protected Member Functions inherited from OdDbObject
	OdDbObject ()
virtual OdResult	subGetClassID (void *pClsid) const
virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const
Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()
virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *traits) const =0
virtual bool	subWorldDraw (OdGiWorldDraw *wd) const =0
virtual void	subViewportDraw (OdGiViewportDraw *vd) const =0
virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const
virtual OdUInt32	subRegenSupportFlags () const
Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

This class represents TableStyles for OdDbTable entities in an OdDbDatabase instance.

<group OdDb_Classes>

Definition at line 420 of file DbTableStyle.h.

Constructor & Destructor Documentation

OdDbTableStyle()

OdDbTableStyle::OdDbTableStyle

(

)

Member Function Documentation

alignment() [1/2]

OdDb::CellAlignment OdDbTableStyle::alignment

(

const OdString &

cellStyle

)

const

alignment() [2/2]

virtual OdDb::CellAlignment OdDbTableStyle::alignment ( OdDb::RowType  rowType = OdDb::kDataRow ) const

virtual

Returns the cell alignment for the specified row type in this TableStyle object (DXF 170).

Parameters

rowType

[in] Row type

Remarks

rowType() returns one of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

alignment() returns one of the following:

Value OdDb::kTopLeft 1 OdDb::kTopCenter 2 OdDb::kTopRight 3 OdDb::kMiddleLeft 4 OdDb::kMiddleCenter 5 OdDb::kMiddleRight 6 OdDb::kBottomLeft 7 OdDb::kBottomCenter 8 OdDb::kBottomRight 9

backgroundColor() [1/2]

OdCmColor OdDbTableStyle::backgroundColor

(

const OdString &

cellStyle

)

const

backgroundColor() [2/2]

virtual OdCmColor OdDbTableStyle::backgroundColor ( OdDb::RowType  rowType = OdDb::kDataRow ) const

virtual

Returns the background color for the specified row type in this TableStyle object (DXF 63).

Parameters

rowType

[in] Row type.

Remarks

rowType must be one of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

bitFlags()

virtual OdUInt32 OdDbTableStyle::bitFlags ( ) const

virtual

Returns the bit flags for this TableStyle object (DXF 71).

Remarks

bitFlags() returns a combination of zero or more of the following:

Value kHorzInsideLineFirst 1 kHorzInsideLineSecond 2 kHorzInsideLineThird 4 kTableStyleModified 8

cellClass()

OdInt32 OdDbTableStyle::cellClass

(

const OdString &

cellStyle

)

const

cellStyleId()

OdInt32 OdDbTableStyle::cellStyleId

(

const OdString &

cellStyle

)

const

cellStyleName()

OdString OdDbTableStyle::cellStyleName

(

OdInt32

cellStyle

)

const

color() [1/2]

OdCmColor OdDbTableStyle::color

(

const OdString &

cellStyle

)

const

color() [2/2]

virtual OdCmColor OdDbTableStyle::color ( OdDb::RowType  rowType = OdDb::kDataRow ) const

virtual

Returns the text color for the specified row type in this TableStyle object (DXF 62).

Parameters

rowTypes

[in] Row types.

Remarks

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

copyCellStyle() [1/2]

void OdDbTableStyle::copyCellStyle	(	const OdDbTableStyle *	pSrc,
		const OdString &	srcCellStyle,
		const OdString &	targetCellStyle
	)

copyCellStyle() [2/2]

void OdDbTableStyle::copyCellStyle	(	const OdString &	srcCellStyle,
		const OdString &	targetCellStyle
	)

createCellStyle() [1/3]

void OdDbTableStyle::createCellStyle

(

const OdString &

cellStyle

)

createCellStyle() [2/3]

void OdDbTableStyle::createCellStyle	(	const OdString &	cellStyle,
		const OdString &	fromCellStyle
	)

createCellStyle() [3/3]

const OdString OdDbTableStyle::createCellStyle

(

void

)

deleteCellStyle()

void OdDbTableStyle::deleteCellStyle

(

const OdString &

cellStyle

)

description()

virtual OdString OdDbTableStyle::description ( ) const

virtual

Returns the description of this TableStyle object.

dwgInFields()

virtual OdResult OdDbTableStyle::dwgInFields ( OdDbDwgFiler *  pFiler )

virtual

Reads the .dwg file data of this object.

Parameters

pFiler

[in] Filer object from which data are read.

Returns

Returns the filer status.

This function is called by dwgIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

dwgOutFields()

virtual void OdDbTableStyle::dwgOutFields ( OdDbDwgFiler *  pFiler ) const

virtual

Writes the .dwg file data of this object.

Parameters

pFiler

[in] Pointer to the filer to which data are written.

Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

dxfInFields()

virtual OdResult OdDbTableStyle::dxfInFields ( OdDbDxfFiler *  pFiler )

virtual

Reads the DXF data of this object.

Parameters

pFiler

[in] Pointer to the filer from which data are read.

Returns

Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

dxfOutFields()

virtual void OdDbTableStyle::dxfOutFields ( OdDbDxfFiler *  pFiler ) const

virtual

Writes the DXF data of this object.

Parameters

pFiler

[in] Pointer to the filer to which data are to be written.

Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbObject.

enableMergeAll()

void OdDbTableStyle::enableMergeAll	(	bool	bEnable,
		const OdString &	cellStyle
	)

flowDirection()

virtual OdDb::FlowDirection OdDbTableStyle::flowDirection ( ) const

virtual

Returns the direction this TableStyle object flows from its first row to its last (DXF 70).

Remarks

flowDirection() returns one of the following:

Value Description OdDb::kTtoB 0 Top to Bottom OdDb::kBtoT 1 Bottom to Top

format() [1/2]

const OdString OdDbTableStyle::format

(

const OdString &

cellStyle

)

const

format() [2/2]

virtual OdString OdDbTableStyle::format ( OdDb::RowType  rowType = OdDb::kDataRow ) const

virtual

getCellStyles()

OdInt32 OdDbTableStyle::getCellStyles

(

OdStringArray &

cellstyles

)

const

getDataType() [1/2]

void OdDbTableStyle::getDataType	(	OdValue::DataType &	nDataType,
		OdValue::UnitType &	nUnitType,
		const OdString &	cellStyle
	)		const

getDataType() [2/2]

virtual void OdDbTableStyle::getDataType ( OdValue::DataType &  nDataType, OdValue::UnitType &  nUnitType, OdDb::RowType  rowType = OdDb::kDataRow  ) const

virtual

getGridProperty()

void OdDbTableStyle::getGridProperty	(	OdGridProperty &	gridProp,
		OdDb::GridLineType	nGridLineTypes,
		const OdString &	cellStyle
	)		const

getName()

virtual OdString OdDbTableStyle::getName ( ) const

virtual

Returns the name of this TableStyle object.

getTemplate()

OdDbObjectId OdDbTableStyle::getTemplate

(

void

)

const

getUniqueCellStyleName()

void OdDbTableStyle::getUniqueCellStyleName	(	const OdString &	baseName,
		OdString &	sUniqueName
	)		const

gridColor() [1/2]

OdCmColor OdDbTableStyle::gridColor	(	OdDb::GridLineType	gridLineType,
		const OdString &	cellStyle
	)		const

gridColor() [2/2]

virtual OdCmColor OdDbTableStyle::gridColor ( OdDb::GridLineType  gridlineType, OdDb::RowType  rowType = OdDb::kDataRow  ) const

virtual

Returns the grid color for the specified gridline type and row type in this TableStyle object (DXF 63,64,65,66,68,69).

Parameters

gridlineType	[in] Gridline type.
rowType	[in] Row type.

Remarks

gridlineType must be one of the following:

Value OdDb::kHorzTop 1 OdDb::kHorzInside 2 OdDb::kHorzBottom 4

rowType must be one of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

gridDoubleLineSpacing()

double OdDbTableStyle::gridDoubleLineSpacing	(	OdDb::GridLineType	gridLineType,
		const OdString &	cellStyle
	)		const

gridLineStyle()

OdDb::GridLineStyle OdDbTableStyle::gridLineStyle	(	OdDb::GridLineType	gridLineType,
		const OdString &	cellStyle
	)		const

gridLinetype()

OdDbObjectId OdDbTableStyle::gridLinetype	(	OdDb::GridLineType	gridLineType,
		const OdString &	cellStyle
	)		const

gridLineWeight() [1/2]

OdDb::LineWeight OdDbTableStyle::gridLineWeight	(	OdDb::GridLineType	gridLineType,
		const OdString &	cellStyle
	)		const

gridLineWeight() [2/2]

virtual OdDb::LineWeight OdDbTableStyle::gridLineWeight ( OdDb::GridLineType  gridlineType, OdDb::RowType  rowType = OdDb::kDataRow  ) const

virtual

Returns the grid lineweight for the specified gridline type and row type in this TableStyle object (DXF 274-279).

Parameters

gridlineType	[in] Gridline type.
rowType	[in] Row type.

Remarks

gridlineType must be one of the following:

Value OdDb::kHorzTop 1 OdDb::kHorzInside 2 OdDb::kHorzBottom 4 OdDb::kVertLeft 8 OdDb::kVertInside 0x10 OdDb::kVertRight 0x20

rowType must be one of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

gridVisibility() [1/2]

OdDb::Visibility OdDbTableStyle::gridVisibility	(	OdDb::GridLineType	gridLineType,
		const OdString &	cellStyle
	)		const

gridVisibility() [2/2]

virtual OdDb::Visibility OdDbTableStyle::gridVisibility ( OdDb::GridLineType  gridlineType, OdDb::RowType  rowType = OdDb::kDataRow  ) const

virtual

Returns the grid visibility for the specified gridline type and row type, in this TableStyle object (DXF 284-289).

Parameters

gridlineType	[in] Gridline type.
rowType	[in] Row type.

Remarks

gridVisibility() returns one of the following:

Value OdDb::kInvisible 1 OdDb::kVisible 0

gridlineType must be one of the following:

Value OdDb::kHorzTop 1 OdDb::kHorzInside 2 OdDb::kHorzBottom 4 OdDb::kVertLeft 8 OdDb::kVertInside 0x10 OdDb::kVertRight 0x20

rowType must be one of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

horzCellMargin()

virtual double OdDbTableStyle::horzCellMargin ( ) const

virtual

Returns the horizontal cell margin for this TableStyle object (DXF 40).

Remarks

The horizontal cell margin is the horizontal space between the cell text and the cell border.

isBackgroundColorNone()

virtual bool OdDbTableStyle::isBackgroundColorNone ( OdDb::RowType  rowType = OdDb::kDataRow ) const

virtual

Returns true if and only if the background color for the specified row type is disabled for this TableStyle object (DXF 283).

Parameters

rowType	[in] Row type
row	[in] Row index of the cell.
column	[in] Column index of the cell.

Remarks

rowType must be one of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

isCellStyleInUse()

bool OdDbTableStyle::isCellStyleInUse

(

const OdString &

cellStyle

)

const

isHeaderSuppressed()

virtual bool OdDbTableStyle::isHeaderSuppressed ( ) const

virtual

Returns true if and only if the header row is suppressed for this TableStyle object (DXF 281).

isMergeAllEnabled()

bool OdDbTableStyle::isMergeAllEnabled

(

const OdString &

cellStyle

)

const

isTitleSuppressed()

virtual bool OdDbTableStyle::isTitleSuppressed ( ) const

virtual

Returns true if and only if the title row is suppressed for this TableStyle object (DXF 280).

margin()

double OdDbTableStyle::margin	(	OdDb::CellMargin	nMargin,
		const OdString &	cellStyle
	)		const

numCellStyles()

OdInt32 OdDbTableStyle::numCellStyles

(

void

)

const

ODDB_DECLARE_MEMBERS()

OdDbTableStyle::ODDB_DECLARE_MEMBERS

(

OdDbTableStyle

)

postTableStyleToDb()

virtual OdDbObjectId OdDbTableStyle::postTableStyleToDb ( OdDbDatabase *  pDb, const OdString &  styleName  )

virtual

Adds this TableStyle object to the specified database.

Parameters

pDb	[in] Pointer to the database in which to post.
styleName	[in] Name for the table style.
tableStyleId	[out] Receives

Returns

Returns the Object ID of the posted table style.

removeTemplate()

OdDbObjectId OdDbTableStyle::removeTemplate

(

void

)

renameCellStyle()

void OdDbTableStyle::renameCellStyle	(	const OdString &	oldName,
		const OdString &	newName
	)

rotation()

double OdDbTableStyle::rotation

(

const OdString &

cellStyle

)

const

setAlignment() [1/2]

void OdDbTableStyle::setAlignment	(	OdDb::CellAlignment	alignment,
		const OdString &	cellStyle
	)

setAlignment() [2/2]

virtual void OdDbTableStyle::setAlignment ( OdDb::CellAlignment  alignment, int  rowTypes = OdDb::kAllRows  )

virtual

Sets the cell alignment for the specified row types in this TableStyle object (DXF 170).

Parameters

rowTypes	[in] Row types.
alignment	[in] Alignment.

Remarks

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

alignment must be one of the following:

Value OdDb::kTopLeft 1 OdDb::kTopCenter 2 OdDb::kTopRight 3 OdDb::kMiddleLeft 4 OdDb::kMiddleCenter 5 OdDb::kMiddleRight 6 OdDb::kBottomLeft 7 OdDb::kBottomCenter 8 OdDb::kBottomRight 9

setBackgroundColor() [1/2]

void OdDbTableStyle::setBackgroundColor	(	const OdCmColor &	color,
		const OdString &	cellStyle
	)

setBackgroundColor() [2/2]

virtual void OdDbTableStyle::setBackgroundColor ( const OdCmColor &  color, int  rowTypes = OdDb::kAllRows  )

virtual

Sets the background color for the specified row type in this TableStyle object (DXF 63).

Parameters

rowTypes	[in] Row types.
color	[in] Background color.

Remarks

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

setBackgroundColorNone()

virtual void OdDbTableStyle::setBackgroundColorNone ( bool  disable, int  rowTypes = OdDb::kAllRows  )

virtual

Controls the background color setting for the specified row types or cell in this TableStyle object (DXF 283).

Parameters

disable	[in] Disables the background color if true, enables if false.
rowTypes	[in] Row types.

Remarks

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

setBitFlags()

virtual void OdDbTableStyle::setBitFlags ( OdUInt32  bitFlags )

virtual

Sets the bit flags for this TableStyle object (DXF 71).

Parameters

bitFlags

[in] Bit flags.

Remarks

bitFlags must be a combination of one or more of the following:

Value kHorzInsideLineFirst 1 kHorzInsideLineSecond 2 kHorzInsideLineThird 4 kTableStyleModified 8

setCellClass()

void OdDbTableStyle::setCellClass	(	OdInt32	nClass,
		const OdString &	cellStyle
	)

setColor() [1/2]

void OdDbTableStyle::setColor	(	const OdCmColor &	color,
		const OdString &	cellStyle
	)

setColor() [2/2]

virtual void OdDbTableStyle::setColor ( const OdCmColor &  color, int  rowTypes = OdDb::kAllRows  )

virtual

Sets the text color for the specified row types in this TableStyle object (DXF 62).

Parameters

rowTypes	[in] Row types.
color	[in] Color.

Remarks

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

setDatabaseDefaults()

void OdDbTableStyle::setDatabaseDefaults

(

OdDbDatabase *

pDb = 0

)

Applies the default properties of the specified database to this TableStyle object.

Parameters

pDb	[in] Pointer to the database whose default values are to be used.

Remarks

If pDb is null, the database containing this object is used

setDataType() [1/2]

void OdDbTableStyle::setDataType	(	OdValue::DataType	nDataType,
		OdValue::UnitType	nUnitType,
		const OdString &	cellStyle
	)

setDataType() [2/2]

virtual void OdDbTableStyle::setDataType ( OdValue::DataType  nDataType, OdValue::UnitType  nUnitType, int  rowTypes = OdDb::kAllRows  )

virtual

setDescription()

virtual void OdDbTableStyle::setDescription ( const OdString &  description )

virtual

Sets the description of this TableStyle object.

Parameters

description

[in] Description.

setFlowDirection()

virtual void OdDbTableStyle::setFlowDirection ( OdDb::FlowDirection  flowDirection )

virtual

Sets the direction this TableStyle objectflows from its first row to its last. (DXF 70).

Parameters

flowDirection

[in] Flow direction.

Remarks

flowDirection must be one of the following:

Value Description OdDb::kTtoB 0 Top to Bottom OdDb::kBtoT 1 Bottom to Top

setFormat() [1/2]

void OdDbTableStyle::setFormat	(	const OdString &	format,
		const OdString &	cellStyle
	)

setFormat() [2/2]

virtual void OdDbTableStyle::setFormat ( const OdString &  pszFormat, int  rowTypes = OdDb::kAllRows  )

virtual

setGridColor() [1/2]

virtual void OdDbTableStyle::setGridColor ( const OdCmColor  color, int  gridlineTypes = OdDb::kAllGridLines, int  rowTypes = OdDb::kAllRows  )

virtual

Returns the grid color for the specified gridline types and row type in this TableStyle object (DXF 63,64,65,66,68,69).

Parameters

gridlineTypes	[in] Gridline types.
rowTypes	[in] Row types.

Remarks

gridlineTypes must be a combination of one or more of the following:

Value OdDb::kHorzTop 1 OdDb::kHorzInside 2 OdDb::kHorzBottom 4

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

setGridColor() [2/2]

void OdDbTableStyle::setGridColor	(	const OdCmColor	color,
		OdDb::GridLineType	gridLineTypes,
		const OdString &	cellStyle
	)

setGridDoubleLineSpacing()

void OdDbTableStyle::setGridDoubleLineSpacing	(	double	fSpacing,
		OdDb::GridLineType	gridLineTypes,
		const OdString &	cellStyle
	)

setGridLineStyle()

void OdDbTableStyle::setGridLineStyle	(	OdDb::GridLineStyle	nLineStyle,
		OdDb::GridLineType	gridLineTypes,
		const OdString &	cellStyle
	)

setGridLinetype()

void OdDbTableStyle::setGridLinetype	(	const OdDbObjectId &	id,
		OdDb::GridLineType	gridLineTypes,
		const OdString &	cellStyle
	)

setGridLineWeight() [1/2]

virtual void OdDbTableStyle::setGridLineWeight ( OdDb::LineWeight  lineWeight, int  gridlineTypes = OdDb::kAllGridLines, int  rowTypes = OdDb::kAllRows  )

virtual

Sets the grid lineweight for the specified gridline types and row types, or the specified cell and edges in this Table entity (DXF 274-279).

Parameters

lineWeight	[in] Lineweight.
gridlineTypes	[in] Gridline types.
rowTypes	[in] Row types.

Remarks

gridlineTypes must be a combination of one or more of the following:

Value OdDb::kHorzTop 1 OdDb::kHorzInside 2 OdDb::kHorzBottom 4 OdDb::kVertLeft 8 OdDb::kVertInside 0x10 OdDb::kVertRight 0x20

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

setGridLineWeight() [2/2]

void OdDbTableStyle::setGridLineWeight	(	OdDb::LineWeight	lineWeight,
		OdDb::GridLineType	gridLineTypes,
		const OdString &	cellStyle
	)

setGridProperty()

void OdDbTableStyle::setGridProperty	(	const OdGridProperty &	gridProp,
		OdDb::GridLineType	nGridLineTypes,
		const OdString &	cellStyle
	)

setGridVisibility() [1/2]

virtual void OdDbTableStyle::setGridVisibility ( OdDb::Visibility  gridVisiblity, int  gridlineTypes = OdDb::kAllGridLines, int  rowTypes = OdDb::kAllRows  )

virtual

Sets the grid visibility for the specified gridline types and row types, in this TableStyle object (DXF 284-289).

Parameters

gridVisibility	[in] Grid visibility.
gridlineTypes	[in] Gridline types.
rowTypes	[in] Row types.

Remarks

gridVisibility must be one of the following:

Value OdDb::kInvisible 1 OdDb::kVisible 0

gridlineTypes must be a combination of one or more of the following:

Value OdDb::kHorzTop 1 OdDb::kHorzInside 2 OdDb::kHorzBottom 4 OdDb::kVertLeft 8 OdDb::kVertInside 0x10 OdDb::kVertRight 0x20

rowTypes must be a combination of one or more of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

setGridVisibility() [2/2]

void OdDbTableStyle::setGridVisibility	(	OdDb::Visibility	visible,
		OdDb::GridLineType	gridLineTypes,
		const OdString &	cellStyle
	)

setHorzCellMargin()

virtual void OdDbTableStyle::setHorzCellMargin ( double  cellMargin )

virtual

Sets the horizontal cell margin for this TableStyle object (DXF 40).

Parameters

cellMargin

[in] Cell margin.

Remarks

The horizontal cell margin is the horizontal space between the cell text and the cell border.

setMargin()

void OdDbTableStyle::setMargin	(	OdDb::CellMargin	nMargins,
		double	fMargin,
		const OdString &	cellStyle
	)

setName()

virtual void OdDbTableStyle::setName ( const OdString &  name )

virtual

Sets the name of this TableStyle object.

Parameters

name	[in] Name.

setRotation()

void OdDbTableStyle::setRotation	(	double	rotation,
		const OdString &	cellStyle
	)

setTemplate()

void OdDbTableStyle::setTemplate	(	const OdDbObjectId	templateId,
		OdDb::MergeCellStyleOption	nOption
	)

setTextHeight() [1/2]

void OdDbTableStyle::setTextHeight	(	double	dHeight,
		const OdString &	cellStyle
	)

setTextHeight() [2/2]

virtual void OdDbTableStyle::setTextHeight ( double  height, int  rowTypes = OdDb::kAllRows  )

virtual

Sets the text height for the specified row types in this TableStyle object (DXF 140).

Parameters

rowTypes	[in] Row types.
height	[in] Text height.

Remarks

rowTypes must be a combination of one or more of the following:

Value kTitleRow 1 kHeaderRow 2 kDataRow 4

setTextStyle() [1/2]

void OdDbTableStyle::setTextStyle	(	const OdDbObjectId &	id,
		const OdString &	cellStyle
	)

setTextStyle() [2/2]

virtual void OdDbTableStyle::setTextStyle ( const OdDbObjectId  textStyleId, int  rowTypes = OdDb::kAllRows  )

virtual

Sets the Object ID of the text style for the specified row types for this TableStyle object (DXF 7).

Parameters

rowTypes	[in] Row types.
textStyleId	[in] Text style Object ID.

Remarks

rowTypes must be a combination of one or more of the following:

Value kTitleRow 1 kHeaderRow 2 kDataRow 4

setVertCellMargin()

virtual void OdDbTableStyle::setVertCellMargin ( double  cellMargin )

virtual

Sets the vertical cell margin for this Table entity (DXF 41).

Parameters

cellMargin

[in] Cell margin.

Remarks

The vertical cell margin is the vertical space between the cell text and the cell border.

subGetClassID()

virtual OdResult OdDbTableStyle::subGetClassID ( void *  pClsid ) const

virtual

Reimplemented from OdDbObject.

suppressHeaderRow()

virtual void OdDbTableStyle::suppressHeaderRow ( bool  suppress )

virtual

Controls the suppression of the header row for this TableStyle object (DXF 280).

Parameters

enable

[in] Controls suppression.

suppressTitleRow()

virtual void OdDbTableStyle::suppressTitleRow ( bool  suppress )

virtual

Controls the suppression of the title row (DXF 280).

Parameters

suppress

[in] Controls suppression.

textHeight() [1/2]

double OdDbTableStyle::textHeight

(

const OdString &

cellStyle

)

const

textHeight() [2/2]

virtual double OdDbTableStyle::textHeight ( OdDb::RowType  rowType = OdDb::kDataRow ) const

virtual

Returns the text height for the specified row type in this TableStyle object (DXF 140).

Parameters

rowType

[in] Row type

Remarks

rowType must be one of the following:

Value OdDb::kTitleRow 1 OdDb::kHeaderRow 2 OdDb::kDataRow 4

textStyle() [1/2]

OdDbObjectId OdDbTableStyle::textStyle

(

const OdString &

cellStyle

)

const

textStyle() [2/2]

virtual OdDbObjectId OdDbTableStyle::textStyle ( OdDb::RowType  rowType = OdDb::kDataRow ) const

virtual

Returns the Object ID of the text style for the specified row type in this TableStyle object (DXF 7).

Parameters

rowType

[in] Row type.

Remarks

rowType must be one of the following:

Value kTitleRow 1 kHeaderRow 2 kDataRow 4

vertCellMargin()

virtual double OdDbTableStyle::vertCellMargin ( ) const

virtual

Returns the vertical cell margin for this TableStyle object (DXF 41).

Remarks

The vertical cell margin is the vertical space between the cell text and the cell border.

---

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

• DbTableStyle.h