Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

RVC::STYLE Class Reference

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

#include <rvc/style.h>

Inheritance diagram for RVC::STYLE:

Inheritance graph
[legend]
List of all members.

Public Types

enum  PATTERN {
  PATTERN_Symbol = 0, PATTERN_Line, PATTERN_Bitmap, PATTERN_Hatch,
  PATTERN_NumTypes
}
enum  TYPE {
  TYPE_First = 0, TYPE_Point = 0, TYPE_Line = 1, TYPE_Polygon = 2,
  TYPE_Text = 3, TYPE_NumTypes = 4
}

Public Member Functions

INT32 AddPattern (const SYMBOLPATTERN &Pattern)
INT32 AddPattern (const LINEPATTERN &Pattern)
INT32 AddPattern (const HATCHPATTERN &Pattern)
INT32 AddPattern (const BITMAPPATTERN &Pattern)
INT32 AddPattern (PATTERN PattType, const BASEPATTERN &Pattern)
INT32 AddPattern (PATTERN PattType, void *Pattern)
INT32 AddStyle (const RVC::OBJECTNAME &name, const TEXTSTYLE &style)
INT32 AddStyle (RVCTEXTSTYLE &style)
INT32 AddStyle (const RVC::OBJECTNAME &name, const LINESTYLE &style)
INT32 AddStyle (RVCLINESTYLE &style)
INT32 AddStyle (const RVC::OBJECTNAME &name, const POLYSTYLE &style)
INT32 AddStyle (RVCPOLYSTYLE &style)
INT32 AddStyle (const RVC::OBJECTNAME &name, const POINTSTYLE &style)
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[PATTERN_NumTypes])
void ConvertStyle (TEXTSTYLE &textstyle, const RVCTEXTSTYLE &rvcstyle) const
void ConvertStyle (RVCTEXTSTYLE &rvcstyle, const TEXTSTYLE &textstyle)
void ConvertStyle (POLYSTYLE &polystyle, const RVCPOLYSTYLE &rvcstyle) const
void ConvertStyle (RVCPOLYSTYLE &rvcstyle, const POLYSTYLE &polystyle) const
void ConvertStyle (POINTSTYLE &pointstyle, const RVCPOINTSTYLE &rvcstyle) const
void ConvertStyle (RVCPOINTSTYLE &rvcstyle, const POINTSTYLE &pointstyle) const
void ConvertStyle (LINESTYLE &linestyle, const RVCLINESTYLE &rvcstyle) const
void ConvertStyle (RVCLINESTYLE &rvcstyle, const LINESTYLE &linestyle) const
INT32 DeletePattern (PATTERN PattType, INT32 PattNum)
INT32 DeleteStyle (TYPE StyleType, INT32 StyleNum)
ERRVALUE DeleteStyleType (TYPE StyleType)
INT32 FindFontName (INT32 start, const MISTRING &name) const
INT32 FindPattern (PATTERN PattType, INT32 StartPattNum, const RVC::OBJECTNAME &name) const
INT32 FindStyle (TYPE 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 (PATTERN PattType) const
INT32 GetPatternMaxSize (PATTERN PattType) const
INT32 GetPatternSize (PATTERN PattType, INT32 PattNum) const
INT32 GetStyleCount (TYPE StyleType) const
ERRVALUE Make (const RVC::OBJITEM &ObjItem, const char *Source=0)
ERRVALUE Make (const RVC::OBJECT &parent, const RVC::OBJECTNAME &name, const RVC::OBJECTDESC &desc, const char *Source=0)
RVC::STYLE & operator= (const RVC::STYLE &rhs)
ERRVALUE ReadPattern (INT32 PatternNum, SYMBOLPATTERN &Pattern) const
ERRVALUE ReadPattern (INT32 PatternNum, LINEPATTERN &Pattern) const
ERRVALUE ReadPattern (INT32 PatternNum, HATCHPATTERN &Pattern) const
ERRVALUE ReadPattern (INT32 PatternNum, BITMAPPATTERN &Pattern) const
ERRVALUE ReadPattern (PATTERN PattType, INT32 PatternNum, BASEPATTERN &Pattern) const
ERRVALUE ReadPattern (PATTERN PattType, INT32 PatternNum, void *Pattern) const
ERRVALUE ReadPatternHdr (PATTERN PattType, INT32 PatternNum, void *PattHdr) const
ERRVALUE ReadPatternName (PATTERN PattType, INT32 PattNum, RVC::OBJECTNAME &name) const
ERRVALUE ReadStyle (INT32 StyleNum, TEXTSTYLE &style) const
ERRVALUE ReadStyle (INT32 StyleNum, RVCTEXTSTYLE &style) const
ERRVALUE ReadStyle (INT32 StyleNum, LINESTYLE &style) const
ERRVALUE ReadStyle (INT32 StyleNum, RVCLINESTYLE &style) const
ERRVALUE ReadStyle (INT32 StyleNum, POLYSTYLE &style) const
ERRVALUE ReadStyle (INT32 StyleNum, RVCPOLYSTYLE &style) const
ERRVALUE ReadStyle (INT32 StyleNum, POINTSTYLE &style) const
ERRVALUE ReadStyle (INT32 StyleNum, RVCPOINTSTYLE &style) const
ERRVALUE ReadStyleName (TYPE StyleType, INT32 StyleNum, RVC::OBJECTNAME &name) const
 STYLE (const RVC::STYLE &obj)
 STYLE ()
ERRVALUE WritePattern (INT32 PatternNum, const SYMBOLPATTERN &Pattern)
ERRVALUE WritePattern (INT32 PatternNum, const LINEPATTERN &Pattern)
ERRVALUE WritePattern (INT32 PatternNum, const HATCHPATTERN &Pattern)
ERRVALUE WritePattern (INT32 PatternNum, const BITMAPPATTERN &Pattern)
ERRVALUE WritePattern (PATTERN PattType, INT32 PatternNum, const BASEPATTERN &Pattern)
ERRVALUE WritePattern (PATTERN PattType, INT32 PatternNum, void *Pattern)
ERRVALUE WritePatternName (PATTERN PattType, INT32 PatternNum, const OBJECTNAME &name)
ERRVALUE WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const TEXTSTYLE &style)
ERRVALUE WriteStyle (INT32 StyleNum, RVCTEXTSTYLE &style)
ERRVALUE WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const LINESTYLE &style)
ERRVALUE WriteStyle (INT32 StyleNum, RVCLINESTYLE &style)
ERRVALUE WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const POLYSTYLE &style)
ERRVALUE WriteStyle (INT32 StyleNum, RVCPOLYSTYLE &style)
ERRVALUE WriteStyle (INT32 StyleNum, const RVC::OBJECTNAME &name, const POINTSTYLE &style)
ERRVALUE WriteStyle (INT32 StyleNum, RVCPOINTSTYLE &style)
ERRVALUE WriteStyleName (TYPE StyleType, INT32 StyleNum, const RVC::OBJECTNAME &name)
virtual ~STYLE ()

Detailed Description

Manages RVC::OBJTYPE_Style RVC objects.

RVC Object Types that this class supports: RVC::OBJTYPE_Style.

Default RVC Object Type for this class: RVC::OBJTYPE_Style.

Valid parents for this class:

Definition at line 240 of file style.h.

Member Enumeration Documentation

enum RVC::STYLE::PATTERN
 

Pattern type.

Enumeration values:
PATTERN_Symbol 
PATTERN_Line 
PATTERN_Bitmap 
PATTERN_Hatch 
PATTERN_NumTypes 

Definition at line 267 of file style.h.

enum RVC::STYLE::TYPE
 

Style type.

Enumeration values:
TYPE_First 
TYPE_Point 
TYPE_Line 
TYPE_Polygon 
TYPE_Text 
TYPE_NumTypes 

Definition at line 257 of file style.h.

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 SYMBOLPATTERN &  Pattern  ) 
 

Add pattern to rvc style object.

Returns:
New pattern number
Parameters:
Pattern  Pattern to add

INT32 RVC::STYLE::AddPattern (  const LINEPATTERN &  Pattern  ) 
 

Add pattern to rvc style object.

Returns:
New pattern number
Parameters:
Pattern  Pattern to add

INT32 RVC::STYLE::AddPattern (  const HATCHPATTERN &  Pattern  ) 
 

Add pattern to rvc style object.

Returns:
New pattern number
Parameters:
Pattern  Pattern to add

INT32 RVC::STYLE::AddPattern (  const BITMAPPATTERN &  Pattern  ) 
 

Add pattern to rvc style object.

Returns:
New pattern number
Parameters:
Pattern  Pattern to add

INT32 RVC::STYLE::AddPattern (  PATTERN  PattType,
const BASEPATTERN &  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 (  PATTERN  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

INT32 RVC::STYLE::AddStyle (  RVCTEXTSTYLE &  style  ) 
 

Add text style to rvc style object.

Returns:
New style number or error < 0.
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

INT32 RVC::STYLE::AddStyle (  RVCLINESTYLE &  style  ) 
 

Add line style to rvc style object.

Returns:
New style number or error < 0.
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

INT32 RVC::STYLE::AddStyle (  RVCPOLYSTYLE &  style  ) 
 

Add polygon style to rvc style object.

Returns:
New style number or error < 0.
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

INT32 RVC::STYLE::AddStyle (  RVCPOINTSTYLE &  style  ) 
 

Add point style to rvc style object.

Returns:
New style number or error < 0.
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[PATTERN_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

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

Convert between memory and rvc text styles.

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

Convert between memory and rvc text styles.

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

Convert between memory and rvc polygon styles.

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

Convert between memory and rvc polygon styles.

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

Convert between memory and rvc point styles.

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

Convert between memory and rvc point styles.

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

Convert between memory and rvc line styles.

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

Convert between memory and rvc line styles.

INT32 RVC::STYLE::DeletePattern (  PATTERN  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 (  TYPE  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 (  TYPE  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 (  PATTERN  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 (  TYPE  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 (  PATTERN  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 (  PATTERN  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 (  PATTERN  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 (  TYPE  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 (  const RVC::OBJITEM &  ObjItem,
const char *  Source = 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
Source  Source of new style object, default is application name

ERRVALUE RVC::STYLE::Make (  const RVC::OBJECT &  parent,
const RVC::OBJECTNAME &  name,
const RVC::OBJECTDESC &  desc,
const char *  Source = 0
) 
 

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
name  Name of new style object
desc  Description of new style object
Source  Source of new style object, default is application name

RVC::STYLE& RVC::STYLE::operator= (  const RVC::STYLE &  rhs  ) 
 

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

ERRVALUE RVC::STYLE::ReadPattern (  INT32  PatternNum,
SYMBOLPATTERN &  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,
LINEPATTERN &  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,
HATCHPATTERN &  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,
BITMAPPATTERN &  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 (  PATTERN  PattType,
INT32  PatternNum,
BASEPATTERN &  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 (  PATTERN  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::ReadPatternHdr (  PATTERN  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 (  PATTERN  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

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

Read a text style item.

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

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

Read a line style item.

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

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

Read a polygon style item.

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

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

Read a point style item.

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

ERRVALUE RVC::STYLE::ReadStyleName (  TYPE  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 SYMBOLPATTERN &  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 LINEPATTERN &  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 HATCHPATTERN &  Pattern
) 
  <