RVC::STYLE Class Reference

Manages RVC::OBJTYPE_Style RVC objects. More...

#include <rvc/style.h>

Inheritance diagram for RVC::STYLE:

[legend]

List of all members.

Classes
class	GETOBJFILTER_HASPATTERNTYPE
	Style object selection filter to disallow selection of non style objects or style objects that do not have the requested pattern type. More...
class	GETOBJFILTER_HASSTYLETYPE
	Style object selection filter to disallow selection of non style objects or style objects that do not have the requested style type. More...
class	GETOBJFILTER_ISSELECTABLE
	Style object selection filter to disallow selection of non style objects. More...
class	UNIQUEPATTERNNAMEFILTER
	Style pattern name uniquification filter. More...
class	UNIQUESTYLENAMEFILTER
	Style type name uniquification filter. More...
Public Member Functions
	STYLE (const RVC::STYLE &obj)
	STYLE ()
virtual	~STYLE ()
INT32	AddPattern (const STYLEPATTERN_SYMBOL &Pattern)
INT32	AddPattern (const STYLEPATTERN_LINE &Pattern)
INT32	AddPattern (const STYLEPATTERN_HATCH &Pattern)
INT32	AddPattern (const STYLEPATTERN_BITMAP &Pattern)
INT32	AddPattern (RVC::PATTERNTYPE PattType, const STYLEPATTERN_BASE &Pattern)
INT32	AddPattern (RVC::PATTERNTYPE PattType, void *Pattern)
INT32	AddStyle (const RVC::OBJECTNAME &name, const TEXTSTYLE &style)
DEPRECATED INT32	AddStyle (RVCTEXTSTYLE &style)
INT32	AddStyle (const RVC::OBJECTNAME &name, const LINESTYLE &style)
DEPRECATED INT32	AddStyle (RVCLINESTYLE &style)
INT32	AddStyle (const RVC::OBJECTNAME &name, const POLYSTYLE &style)
DEPRECATED INT32	AddStyle (RVCPOLYGONSTYLE &style)
INT32	AddStyle (const RVC::OBJECTNAME &name, const POINTSTYLE &style)
DEPRECATED INT32	AddStyle (RVCPOINTSTYLE &style)
ERRVALUE	Combine (const RVC::OBJECT &DestParentObj, RVC::STYLE &DestStyleObj)
ERRVALUE	Combine (const RVC::OBJECT &DestParentObj, RVC::STYLE &DestStyleObj, SIMPLE_ARRAY< INT32 > &FontTrans, SIMPLE_ARRAY< INT32 > PattTrans[PATTERNTYPE_NumTypes])
DEPRECATED void	ConvertStyle (TEXTSTYLE &textstyle, const RVCTEXTSTYLE &rvcstyle) const
DEPRECATED void	ConvertStyle (RVCTEXTSTYLE &rvcstyle, const TEXTSTYLE &textstyle)
DEPRECATED void	ConvertStyle (POLYSTYLE &polystyle, const RVCPOLYGONSTYLE &rvcstyle) const
DEPRECATED void	ConvertStyle (RVCPOLYGONSTYLE &rvcstyle, const POLYSTYLE &polystyle) const
DEPRECATED void	ConvertStyle (POINTSTYLE &pointstyle, const RVCPOINTSTYLE &rvcstyle) const
DEPRECATED void	ConvertStyle (RVCPOINTSTYLE &rvcstyle, const POINTSTYLE &pointstyle) const
DEPRECATED void	ConvertStyle (LINESTYLE &linestyle, const RVCLINESTYLE &rvcstyle) const
DEPRECATED void	ConvertStyle (RVCLINESTYLE &rvcstyle, const LINESTYLE &linestyle) const
INT32	DeletePattern (PATTERNTYPE PattType, INT32 PattNum)
INT32	DeleteStyle (STYLETYPE StyleType, INT32 StyleNum)
ERRVALUE	DeleteStyleType (STYLETYPE StyleType)
INT32	FindFontName (INT32 start, const MISTRING &name) const
INT32	FindPattern (PATTERNTYPE PattType, const RVC::DESCRIPTOR &Descriptor, INT32 StartPattNum=0) const
INT32	FindPattern (PATTERNTYPE PattType, INT32 StartPattNum, const RVC::OBJECTNAME &name) const
INT32	FindStyle (STYLETYPE StyleType, const RVC::DESCRIPTOR &Descriptor, INT32 StartStyleNum=0) const
INT32	FindStyle (STYLETYPE StyleType, INT32 StartStyleNum, const RVC::OBJECTNAME &name) const
INT32	FontTransAdd (const MISTRING &name)
INT32	FontTransIndexToHandle (INT32 FontNum)
ERRVALUE	FontTransIndexToName (INT32 FontNum, MISTRING &name) const
INT32	GetFontNameCount () const
INT32	GetPatternCount (PATTERNTYPE PattType) const
INT32	GetPatternMaxSize (PATTERNTYPE PattType) const
INT32	GetPatternSize (PATTERNTYPE PattType, INT32 PattNum) const
INT32	GetStyleCount (STYLETYPE StyleType) const
ERRVALUE	Make (RVC::OBJITEM &ObjItem, const char *Source=0, const CREDENTIALS *Credentials=0)
ERRVALUE	Make (const RVC::OBJECT &parent, const RVC::DESCRIPTOR &Descriptor, const CREDENTIALS *Credentials RVC_DEFAULT_CREDENTIALS)
RVC::STYLE &	operator= (const RVC::STYLE &rhs)
ERRVALUE	ReadPattern (INT32 PatternNum, STYLEPATTERN_SYMBOL &Pattern) const
ERRVALUE	ReadPattern (INT32 PatternNum, STYLEPATTERN_LINE &Pattern) const
ERRVALUE	ReadPattern (INT32 PatternNum, STYLEPATTERN_HATCH &Pattern) const
ERRVALUE	ReadPattern (INT32 PatternNum, STYLEPATTERN_BITMAP &Pattern) const
ERRVALUE	ReadPattern (PATTERNTYPE PattType, INT32 PatternNum, STYLEPATTERN_BASE &Pattern) const
ERRVALUE	ReadPattern (PATTERNTYPE PattType, INT32 PatternNum, void *Pattern) const
ERRVALUE	ReadPatternDescriptor (PATTERNTYPE PattType, INT32 PattNum, RVC::DESCRIPTOR &Descriptor) const
ERRVALUE	ReadPatternHdr (PATTERNTYPE PattType, INT32 PatternNum, void *PattHdr) const
ERRVALUE	ReadPatternName (PATTERNTYPE PattType, INT32 PattNum, RVC::OBJECTNAME &name) const
ERRVALUE	ReadStyle (INT32 StyleNum, TEXTSTYLE &style) const
DEPRECATED ERRVALUE	ReadStyle (INT32 StyleNum, RVCTEXTSTYLE &style) const
ERRVALUE	ReadStyle (INT32 StyleNum, LINESTYLE &style) const
DEPRECATED ERRVALUE	ReadStyle (INT32 StyleNum, RVCLINESTYLE &style) const
ERRVALUE	ReadStyle (INT32 StyleNum, POLYSTYLE &style) const
DEPRECATED ERRVALUE	ReadStyle (INT32 StyleNum, RVCPOLYGONSTYLE &style) const
ERRVALUE	ReadStyle (INT32 StyleNum, POINTSTYLE &style) const
DEPRECATED ERRVALUE	ReadStyle (INT32 StyleNum, RVCPOINTSTYLE &style) const
ERRVALUE	ReadStyleDescriptor (STYLETYPE StyleType, INT32 StyleNum, RVC::DESCRIPTOR &Descriptor) const
ERRVALUE	ReadStyleName (STYLETYPE StyleType, INT32 StyleNum, RVC::OBJECTNAME &name) const
ERRVALUE	WritePattern (INT32 PatternNum, const STYLEPATTERN_SYMBOL &Pattern)
ERRVALUE	WritePattern (INT32 PatternNum, const STYLEPATTERN_LINE &Pattern)
ERRVALUE	WritePattern (INT32 PatternNum, const STYLEPATTERN_HATCH &Pattern)
ERRVALUE	WritePattern (INT32 PatternNum, const STYLEPATTERN_BITMAP &Pattern)
ERRVALUE	WritePattern (PATTERNTYPE PattType, INT32 PatternNum, const STYLEPATTERN_BASE &Pattern)
ERRVALUE	WritePattern (PATTERNTYPE PattType, INT32 PatternNum, void *Pattern)
ERRVALUE	WritePatternDescriptor (PATTERNTYPE PattType, INT32 PatternNum, const DESCRIPTOR &Descriptor)
ERRVALUE	WritePatternName (PATTERNTYPE PattType, INT32 PatternNum, const OBJECTNAME &name)
ERRVALUE	WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const TEXTSTYLE &style)
DEPRECATED ERRVALUE	WriteStyle (INT32 StyleNum, RVCTEXTSTYLE &style)
ERRVALUE	WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const LINESTYLE &style)
DEPRECATED ERRVALUE	WriteStyle (INT32 StyleNum, RVCLINESTYLE &style)
ERRVALUE	WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const POLYSTYLE &style)
DEPRECATED ERRVALUE	WriteStyle (INT32 StyleNum, RVCPOLYGONSTYLE &style)
ERRVALUE	WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const POINTSTYLE &style)
DEPRECATED ERRVALUE	WriteStyle (INT32 StyleNum, RVCPOINTSTYLE &style)
ERRVALUE	WriteStyleDescriptor (STYLETYPE StyleType, INT32 StyleNum, const DESCRIPTOR &Descriptor)
ERRVALUE	WriteStyleName (STYLETYPE StyleType, INT32 StyleNum, const RVC::OBJECTNAME &name)

---

Detailed Description

Manages RVC::OBJTYPE_Style RVC objects.

Valid parents for this class:

• RVC::OBJTYPE_File
• RVC::OBJTYPE_Folder
• RVC::OBJTYPE_Vector
• RVC::OBJTYPE_TIN
• RVC::OBJTYPE_CAD
• RVC::OBJTYPE_Table
• RVC::OBJTYPE_Raster
• RVC::OBJTYPE_Hyperspectral
• RVC::OBJTYPE_Script_SML
• RVC::OBJTYPE_Script_Query
• RVC::OBJTYPE_Theme

---

Constructor & Destructor Documentation

RVC::STYLE::STYLE

(

)

Default constructor.

RVC::STYLE::STYLE

(

const RVC::STYLE &

obj

)

Copy constructor.

virtual RVC::STYLE::~STYLE

(

)

[virtual]

Destructor.

---

Member Function Documentation

INT32 RVC::STYLE::AddPattern

(

const STYLEPATTERN_SYMBOL &

Pattern

)

Add pattern to rvc style object.

Returns:

New pattern number

Parameters:

Pattern

Pattern to add

INT32 RVC::STYLE::AddPattern

(

const STYLEPATTERN_LINE &

Pattern

)

Add pattern to rvc style object.

Returns:

New pattern number

Parameters:

Pattern

Pattern to add

INT32 RVC::STYLE::AddPattern

(

const STYLEPATTERN_HATCH &

Pattern

)

Add pattern to rvc style object.

Returns:

New pattern number

Parameters:

Pattern

Pattern to add

INT32 RVC::STYLE::AddPattern

(

const STYLEPATTERN_BITMAP &

Pattern

)

Add pattern to rvc style object.

Returns:

New pattern number

Parameters:

Pattern

Pattern to add

INT32 RVC::STYLE::AddPattern	(	RVC::PATTERNTYPE	PattType,
		const STYLEPATTERN_BASE &	Pattern
	)

Add pattern to rvc style object.

Returns:

New pattern number

Parameters:

	PattType	Type of pattern to add
	Pattern	Pattern to add

INT32 RVC::STYLE::AddPattern	(	RVC::PATTERNTYPE	PattType,
		void *	Pattern
	)

Add pattern to rvc style object.

Returns:

New pattern number

Parameters:

	PattType	Type of pattern to add
	Pattern	Pattern to add

INT32 RVC::STYLE::AddStyle	(	const RVC::OBJECTNAME &	name,
		const TEXTSTYLE &	style
	)

Add text style to rvc style object.

Returns:

New style number or error < 0.

Parameters:

style

Text style to add

DEPRECATED INT32 RVC::STYLE::AddStyle

(

RVCTEXTSTYLE &

style

)

Add text style to rvc style object.

Returns:

New style number or error < 0.

Deprecated:

Use AddStyle(const RVC::OBJECTNAME&, const TEXTSTYLE&)

Parameters:

style

Text style to add

INT32 RVC::STYLE::AddStyle	(	const RVC::OBJECTNAME &	name,
		const LINESTYLE &	style
	)

Add line style to rvc style object.

Returns:

New style number or error < 0.

Parameters:

style

Line style to add

DEPRECATED INT32 RVC::STYLE::AddStyle

(

RVCLINESTYLE &

style

)

Add line style to rvc style object.

Returns:

New style number or error < 0.

Deprecated:

Use AddStyle(const RVC::OBJECTNAME&, const LINESTYLE&)

Parameters:

style

Line style to add

INT32 RVC::STYLE::AddStyle	(	const RVC::OBJECTNAME &	name,
		const POLYSTYLE &	style
	)

Add polygon style to rvc style object.

Returns:

New style number or error < 0.

Parameters:

style

Polygon style to add

DEPRECATED INT32 RVC::STYLE::AddStyle

(

RVCPOLYGONSTYLE &

style

)

Add polygon style to rvc style object.

Returns:

New style number or error < 0.

Deprecated:

Use AddStyle(const RVC::OBJECTNAME&, const POLYSTYLE&)

Parameters:

style

Polygon style to add

INT32 RVC::STYLE::AddStyle	(	const RVC::OBJECTNAME &	name,
		const POINTSTYLE &	style
	)

Add point style to rvc style object.

Returns:

New style number or error < 0.

Parameters:

style

Point style to add

DEPRECATED INT32 RVC::STYLE::AddStyle

(

RVCPOINTSTYLE &

style

)

Add point style to rvc style object.

Returns:

New style number or error < 0.

Deprecated:

Use AddStyle(const RVC::OBJECTNAME&, const POINTSTYLE&)

Parameters:

style

Point style to add

ERRVALUE RVC::STYLE::Combine	(	const RVC::OBJECT &	DestParentObj,
		RVC::STYLE &	DestStyleObj
	)

Combine two style objects together using 'this' as the source and either findint or making the destination style object.

The destination style object is returned in 'DestStyleObj'.

Parameters:

	DestParentObj	Parent object to combine / copy to
	DestStyleObj	Destination object created or found

ERRVALUE RVC::STYLE::Combine	(	const RVC::OBJECT &	DestParentObj,
		RVC::STYLE &	DestStyleObj,
		SIMPLE_ARRAY< INT32 > &	FontTrans,
		SIMPLE_ARRAY< INT32 >	PattTrans[PATTERNTYPE_NumTypes]
	)

Combine two style objects together using 'this' as the source and either findint or making the destination style object.

The destination style object is returned in 'DestStyleObj'.

Parameters:

	DestParentObj	Parent object to combine / copy to
	DestStyleObj	Destination object created or found

DEPRECATED void RVC::STYLE::ConvertStyle	(	TEXTSTYLE &	textstyle,
		const RVCTEXTSTYLE &	rvcstyle
	)			const

Not const, can change object.

Convert between memory and rvc text styles

Deprecated:

Use ReadStyle(INT32 StyleNum, const TEXTSTYLE&)

DEPRECATED void RVC::STYLE::ConvertStyle	(	RVCTEXTSTYLE &	rvcstyle,
		const TEXTSTYLE &	textstyle
	)

Convert between memory and rvc text styles.

Deprecated:

Do not use

DEPRECATED void RVC::STYLE::ConvertStyle	(	POLYSTYLE &	polystyle,
		const RVCPOLYGONSTYLE &	rvcstyle
	)			const

Convert between memory and rvc polygon styles.

Deprecated:

Use ReadStyle(INT32 StyleNum, const POLYSTYLE&)

DEPRECATED void RVC::STYLE::ConvertStyle	(	RVCPOLYGONSTYLE &	rvcstyle,
		const POLYSTYLE &	polystyle
	)			const

Convert between memory and rvc polygon styles.

Deprecated:

Do not use

DEPRECATED void RVC::STYLE::ConvertStyle	(	POINTSTYLE &	pointstyle,
		const RVCPOINTSTYLE &	rvcstyle
	)			const

Convert between memory and rvc point styles.

Deprecated:

Use ReadStyle(INT32 StyleNum, const POINTSTYLE&)

DEPRECATED void RVC::STYLE::ConvertStyle	(	RVCPOINTSTYLE &	rvcstyle,
		const POINTSTYLE &	pointstyle
	)			const

Convert between memory and rvc point styles.

Deprecated:

Do not use

DEPRECATED void RVC::STYLE::ConvertStyle	(	LINESTYLE &	linestyle,
		const RVCLINESTYLE &	rvcstyle
	)			const

Convert between memory and rvc line styles.

Deprecated:

Use ReadStyle(INT32 StyleNum, const LINESTYLE&)

DEPRECATED void RVC::STYLE::ConvertStyle	(	RVCLINESTYLE &	rvcstyle,
		const LINESTYLE &	linestyle
	)			const

Convert between memory and rvc line styles.

Deprecated:

Do not use

INT32 RVC::STYLE::DeletePattern	(	PATTERNTYPE	PattType,
		INT32	PattNum
	)

Delete pattern from rvc style object, modifies styles that referenced the pattern.

Returns:

Pattern number that replaced the deleted pattern or <0 if error

Parameters:

	PattType	Type of pattern to delete
	PattNum	Pattern index to delete

INT32 RVC::STYLE::DeleteStyle	(	STYLETYPE	StyleType,
		INT32	StyleNum
	)

Delete style from rvc style object.

Returns:

Style number that replaced the deleted style or <0 if error

Parameters:

	StyleType	Type of style to delete
	StyleNum	Style index to delete

ERRVALUE RVC::STYLE::DeleteStyleType

(

STYLETYPE

StyleType

)

Delete all styles of a specified type from rvc style object.

Parameters:

StyleType

Type of style to delete

INT32 RVC::STYLE::FindFontName	(	INT32	start,
		const MISTRING &	name
	)			const

Locate a font based on a font name and initial position.

Returns:

Index of font name if found, -1 if none found, < -1 error code

Parameters:

	start	Best guess of initial font location
	name	Font to search for

INT32 RVC::STYLE::FindPattern	(	PATTERNTYPE	PattType,
		const RVC::DESCRIPTOR &	Descriptor,
		INT32	StartPattNum = 0
	)			const

Find a pattern given a name and the pattern type.

Returns:

-1 if pattern not found, >= 0 Pattern index if found, < -1 error

Parameters:

	PattType	Type of pattern to search for
	Descriptor	Name of pattern to find
	StartPattNum	Best guess of initial pattern location

INT32 RVC::STYLE::FindPattern	(	PATTERNTYPE	PattType,
		INT32	StartPattNum,
		const RVC::OBJECTNAME &	name
	)			const

Find a pattern given a name and the pattern type.

Returns:

-1 if pattern not found, >= 0 Pattern index if found, < -1 error

Parameters:

	PattType	Type of pattern to search for
	StartPattNum	Best guess of initial pattern location
	name	Name of pattern to find

INT32 RVC::STYLE::FindStyle	(	STYLETYPE	StyleType,
		const RVC::DESCRIPTOR &	Descriptor,
		INT32	StartStyleNum = 0
	)			const

Find a style given a name and the style type.

Returns:

-1 if style not found, >= 0 Style index if found, < -1 error

Parameters:

	StyleType	Type of style to search for
	Descriptor	Name of style to find
	StartStyleNum	Best guess of initial style location

INT32 RVC::STYLE::FindStyle	(	STYLETYPE	StyleType,
		INT32	StartStyleNum,
		const RVC::OBJECTNAME &	name
	)			const

Find a style given a name and the style type.

Returns:

-1 if style not found, >= 0 Style index if found, < -1 error

Parameters:

	StyleType	Type of style to search for
	StartStyleNum	Best guess of initial style location
	name	Name of style to find

INT32 RVC::STYLE::FontTransAdd

(

const MISTRING &

name

)

Add a font name to the font name list.

Returns:

Index of added font name or error if < 0

Parameters:

name

Name of font to add

INT32 RVC::STYLE::FontTransIndexToHandle

(

INT32

FontNum

)

Obtain font handle from a font index.

Returns:

font handle of error if < 0

Parameters:

FontNum

Font index to translate into a font handle

ERRVALUE RVC::STYLE::FontTransIndexToName	(	INT32	FontNum,
		MISTRING &	name
	)			const

Obtain font index from a font name.

Returns:

font index of error if < 0

Parameters:

name

Name of font to translate into an index

INT32 RVC::STYLE::GetFontNameCount

(

)

const

Obtain the number of font names in the list.

Returns:

Number of font names

INT32 RVC::STYLE::GetPatternCount

(

PATTERNTYPE

PattType

)

const

Obtain the number of patterns of a specific pattern type.

Returns:

Number of patterns of the requested pattern type or < 0 if error

Parameters:

PattType

Type of pattern to get count of

INT32 RVC::STYLE::GetPatternMaxSize

(

PATTERNTYPE

PattType

)

const

Obtain the maximum pattern size of a specific pattern type.

Returns:

Maximum pattern size of the requested pattern type or < 0 if error

Parameters:

PattType

Type of pattern to get the maximum size of

INT32 RVC::STYLE::GetPatternSize	(	PATTERNTYPE	PattType,
		INT32	PattNum
	)			const

Obtain the pattern size of a specific pattern type.

Returns:

Pattern size of the requested pattern type or < 0 if error

Parameters:

	PattType	Type of pattern to get the size of
	PattNum	Pattern index to get the size of

INT32 RVC::STYLE::GetStyleCount

(

STYLETYPE

StyleType

)

const

Obtain the number of styles of a specific style type.

Returns:

Number of styles of the requested style type or < 0 if error

Parameters:

StyleType

Type of style to get count of

ERRVALUE RVC::STYLE::Make	(	RVC::OBJITEM &	ObjItem,
		const char *	Source = 0,
		const CREDENTIALS *	Credentials = 0
	)

Create a new rvc style object under a specified parent rvc object with name, description, and source.

Parameters:

	ObjItem	Name, Desc of object to create, location RETURNED
	Source	Source of new style object, default is application name
	Credentials	User credentials passed in, NULL for default behavior

ERRVALUE RVC::STYLE::Make	(	const RVC::OBJECT &	parent,
		const RVC::DESCRIPTOR &	Descriptor,
		const CREDENTIALS *Credentials	RVC_DEFAULT_CREDENTIALS
	)

Create a new rvc style object under a specified parent rvc object with name, description, and source.

Parameters:

	parent	Parent object to create style object under
	RVC_DEFAULT_CREDENTIALS	User credentials passed in, NULL for default behavior

RVC::STYLE& RVC::STYLE::operator=

(

const RVC::STYLE &

rhs

)

Assignment. Will close if necessary and reopen if 'rhs' is open.

Reimplemented from RVC::OBJECT.

ERRVALUE RVC::STYLE::ReadPattern	(	INT32	PatternNum,
		STYLEPATTERN_SYMBOL &	Pattern
	)			const

Read a pattern into a buffer. The format of the pattern is pattern type specific.

Parameters:

	PatternNum	Index of pattern to read
	Pattern	Pattern buffer to read into

ERRVALUE RVC::STYLE::ReadPattern	(	INT32	PatternNum,
		STYLEPATTERN_LINE &	Pattern
	)			const

Read a pattern into a buffer. The format of the pattern is pattern type specific.

Parameters:

	PatternNum	Index of pattern to read
	Pattern	Pattern buffer to read into

ERRVALUE RVC::STYLE::ReadPattern	(	INT32	PatternNum,
		STYLEPATTERN_HATCH &	Pattern
	)			const

Read a pattern into a buffer. The format of the pattern is pattern type specific.

Parameters:

	PatternNum	Index of pattern to read
	Pattern	Pattern buffer to read into

ERRVALUE RVC::STYLE::ReadPattern	(	INT32	PatternNum,
		STYLEPATTERN_BITMAP &	Pattern
	)			const

Read a pattern into a buffer. The format of the pattern is pattern type specific.

Parameters:

	PatternNum	Index of pattern to read
	Pattern	Pattern buffer to read into

ERRVALUE RVC::STYLE::ReadPattern	(	PATTERNTYPE	PattType,
		INT32	PatternNum,
		STYLEPATTERN_BASE &	Pattern
	)			const

Read a pattern into a buffer. The format of the pattern is pattern type specific.

Parameters:

	PattType	Type of pattern to read
	PatternNum	Index of pattern to read
	Pattern	Pattern buffer to read into

ERRVALUE RVC::STYLE::ReadPattern	(	PATTERNTYPE	PattType,
		INT32	PatternNum,
		void *	Pattern
	)			const

Read a pattern into a buffer. The format of the pattern is pattern type specific.

Parameters:

	PattType	Type of pattern to read
	PatternNum	Index of pattern to read
	Pattern	Pattern buffer to read into

ERRVALUE RVC::STYLE::ReadPatternDescriptor	(	PATTERNTYPE	PattType,
		INT32	PattNum,
		RVC::DESCRIPTOR &	Descriptor
	)			const

Read a pattern name.

Parameters:

	PattType	Type of pattern to read
	PattNum	Index of pattern to read
	Descriptor	Place to store pattern name

ERRVALUE RVC::STYLE::ReadPatternHdr	(	PATTERNTYPE	PattType,
		INT32	PatternNum,
		void *	PattHdr
	)			const

Read a pattern header into a buffer.

Parameters:

	PattType	Type of pattern to read
	PatternNum	Index of pattern to read
	PattHdr	Pattern header buffer to read into

ERRVALUE RVC::STYLE::ReadPatternName	(	PATTERNTYPE	PattType,
		INT32	PattNum,
		RVC::OBJECTNAME &	name
	)			const

Read a pattern name.

Parameters:

	PattType	Type of pattern to read
	PattNum	Index of pattern to read
	name	Place to store pattern name

ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		TEXTSTYLE &	style
	)			const

Read a text style item.

Parameters:

	StyleNum	Index of text style to read
	style	Tezt style instance to read into

DEPRECATED ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		RVCTEXTSTYLE &	style
	)			const

Read a text style item.

Deprecated:

Use ReadStyle(INT32 StyleNum, const TEXTSTYLE&)

Parameters:

	StyleNum	Index of text style to read
	style	Tezt style instance to read into

ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		LINESTYLE &	style
	)			const

Read a line style item.

Parameters:

	StyleNum	Index of line style to read
	style	Line style instance to read into

DEPRECATED ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		RVCLINESTYLE &	style
	)			const

Read a line style item.

Deprecated:

Use ReadStyle(INT32 StyleNum, const LINESTYLE&)

Parameters:

	StyleNum	Index of line style to read
	style	Line style instance to read into

ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		POLYSTYLE &	style
	)			const

Read a polygon style item.

Parameters:

	StyleNum	Index of polygon style to read
	style	Polygon style instance to read into

DEPRECATED ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		RVCPOLYGONSTYLE &	style
	)			const

Read a polygon style item.

Deprecated:

Use ReadStyle(INT32 StyleNum, const POLYSTYLE&)

Parameters:

	StyleNum	Index of polygon style to read
	style	Polygon style instance to read into

ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		POINTSTYLE &	style
	)			const

Read a point style item.

Parameters:

	StyleNum	Index of point style to read
	style	Point style instance to read into

DEPRECATED ERRVALUE RVC::STYLE::ReadStyle	(	INT32	StyleNum,
		RVCPOINTSTYLE &	style
	)			const

Read a point style item.

Deprecated:

Use ReadStyle(INT32 StyleNum, const POINTSTYLE&)

Parameters:

	StyleNum	Index of point style to read
	style	Point style instance to read into

ERRVALUE RVC::STYLE::ReadStyleDescriptor	(	STYLETYPE	StyleType,
		INT32	StyleNum,
		RVC::DESCRIPTOR &	Descriptor
	)			const

Read a style descriptor.

Parameters:

	StyleType	Type of pattern to read
	StyleNum	Index of pattern to read
	Descriptor	Place to store pattern name

ERRVALUE RVC::STYLE::ReadStyleName	(	STYLETYPE	StyleType,
		INT32	StyleNum,
		RVC::OBJECTNAME &	name
	)			const

Read style name given a style type.

Parameters:

	StyleType	Type of style to get the name of
	StyleNum	Index of style to get the name of
	name	Place to store style name

ERRVALUE RVC::STYLE::WritePattern	(	INT32	PatternNum,
		const STYLEPATTERN_SYMBOL &	Pattern
	)

Write pattern out to rvc style object.

Parameters:

	PatternNum	Index of pattern to write, Use AddPattern() to write out a new pattern
	Pattern	Pattern to write

ERRVALUE RVC::STYLE::WritePattern	(	INT32	PatternNum,
		const STYLEPATTERN_LINE &	Pattern
	)

Write pattern out to rvc style object.

Parameters:

	PatternNum	Index of pattern to write, Use AddPattern() to write out a new pattern
	Pattern	Pattern to write

ERRVALUE RVC::STYLE::WritePattern	(	INT32	PatternNum,
		const STYLEPATTERN_HATCH &	Pattern
	)

Write pattern out to rvc style object.

Parameters:

	PatternNum	Index of pattern to write, Use AddPattern() to write out a new pattern
	Pattern	Pattern to write

ERRVALUE RVC::STYLE::WritePattern	(	INT32	PatternNum,
		const STYLEPATTERN_BITMAP &	Pattern
	)

Write pattern out to rvc style object.

Parameters:

	PatternNum	Index of pattern to write, Use AddPattern() to write out a new pattern
	Pattern	Pattern to write

ERRVALUE RVC::STYLE::WritePattern	(	PATTERNTYPE	PattType,
		INT32	PatternNum,
		const STYLEPATTERN_BASE &	Pattern
	)

Write pattern out to rvc style object.

Parameters:

	PattType	Type of pattern to write
	PatternNum	Index of pattern to write, Use AddPattern() to write out a new pattern
	Pattern	Pattern to write

ERRVALUE RVC::STYLE::WritePattern	(	PATTERNTYPE	PattType,
		INT32	PatternNum,
		void *	Pattern
	)

Write pattern out to rvc style object.

Parameters:

	PattType	Type of pattern to write
	PatternNum	Index of pattern to write, Use AddPattern() to write out a new pattern
	Pattern	Pattern to write

ERRVALUE RVC::STYLE::WritePatternDescriptor	(	PATTERNTYPE	PattType,
		INT32	PatternNum,
		const DESCRIPTOR &	Descriptor
	)

Write pattern name given a pattern type.

Parameters:

	PattType	Type of pattern to write name
	PatternNum	Index of pattern to write name
	Descriptor	New name of pattern

ERRVALUE RVC::STYLE::WritePatternName	(	PATTERNTYPE	PattType,
		INT32	PatternNum,
		const OBJECTNAME &	name
	)

Write pattern name given a pattern type.

Parameters:

	PattType	Type of pattern to write name
	PatternNum	Index of pattern to write name
	name	New name of pattern

ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		const RVC::OBJECTNAME &	name,
		const TEXTSTYLE &	style
	)

Write text style to rvc style object.

Parameters:

	StyleNum	Index of text style to write. Use AddStyle() to add a style.
	style	Text style to write

DEPRECATED ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		RVCTEXTSTYLE &	style
	)

Write text style to rvc style object.

Deprecated:

Use WriteStyle(INT32 StyleNum, const RVC::OBJECTNAME& name, const TEXTSTYLE&)

Parameters:

	StyleNum	Index of text style to write. Use AddStyle() to add a style.
	style	Text style to write

ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		const RVC::OBJECTNAME &	name,
		const LINESTYLE &	style
	)

Write line style to rvc style object.

Parameters:

	StyleNum	Index of line style to write. Use AddStyle() to add a style.
	style	Line style to write

DEPRECATED ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		RVCLINESTYLE &	style
	)

Write line style to rvc style object.

Deprecated:

Use WriteStyle(INT32 StyleNum, const RVC::OBJECTNAME& name, const LINESTYLE&)

Parameters:

	StyleNum	Index of line style to write. Use AddStyle() to add a style.
	style	Line style to write

ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		const RVC::OBJECTNAME &	name,
		const POLYSTYLE &	style
	)

Write polygon style to rvc style object.

Parameters:

	StyleNum	Index of polygon style to write. Use AddStyle() to add a style.
	style	Polygon style to write

DEPRECATED ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		RVCPOLYGONSTYLE &	style
	)

Write polygon style to rvc style object.

Deprecated:

Use WriteStyle(INT32 StyleNum, const RVC::OBJECTNAME& name, const POLYSTYLE&)

Parameters:

	StyleNum	Index of polygon style to write. Use AddStyle() to add a style.
	style	Polygon style to write

ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		const RVC::OBJECTNAME &	name,
		const POINTSTYLE &	style
	)

Write point style to rvc style object.

Parameters:

	StyleNum	Index of point style to write. Use AddStyle() to add a style
	style	Point style to write

DEPRECATED ERRVALUE RVC::STYLE::WriteStyle	(	INT32	StyleNum,
		RVCPOINTSTYLE &	style
	)

Write point style to rvc style object.

Deprecated:

Use WriteStyle(INT32 StyleNum, const RVC::OBJECTNAME& name, const POINTSTYLE&)

Parameters:

	StyleNum	Index of point style to write. Use AddStyle() to add a style
	style	Point style to write

ERRVALUE RVC::STYLE::WriteStyleDescriptor	(	STYLETYPE	StyleType,
		INT32	StyleNum,
		const DESCRIPTOR &	Descriptor
	)

Write style descriptor given a style type.

Parameters:

	StyleType	Type of style
	StyleNum	Index of style
	Descriptor	Style name to write

ERRVALUE RVC::STYLE::WriteStyleName	(	STYLETYPE	StyleType,
		INT32	StyleNum,
		const RVC::OBJECTNAME &	name
	)

Write style name given a style type.

Parameters:

	StyleType	Type of style
	StyleNum	Index of style
	name	Style name to write

---

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

• rvc/style.h