oaRowSpacingType Class Reference


Public Methods

 oaRowSpacingType (oaRowSpacingTypeEnum typeIn)
 oaRowSpacingType (const oaString &name)
const oaStringgetName () const
 operator oaRowSpacingTypeEnum () const

Detailed Description

The oaRowSpacingType class is an enum wrapper that indicates which rows the extra spacing between rows in an oaCoreBoxSpec applies to. See oaCoreBoxSpec::setRowSpacingType for an example of its use.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum oaRowSpacingTypeEnum
 

Enumeration values:
oacEveryRowSpacingType  "every"
oacEvenRowSpacingType  "even"
oacOddRowSpacingType  "odd"


Constructor & Destructor Documentation

oaRowSpacingType::oaRowSpacingType oaRowSpacingTypeEnum    typeIn [inline]
 

This function constructs an instance of an oaRowSpacingType object using the specified oaRowSpacingTypeEnum value.

oaRowSpacingType::oaRowSpacingType const oaString &    name
 

This function constructs an instance of an oaRowSpacingType class using the oaRowSpacingTypeEnum associated with the specified string name. This name must be defined in the legal set of names associated with oaRowSpacingTypeEnum.

Exceptions:
oacInvalidRowSpacingTypeName 


Member Function Documentation

const oaString & oaRowSpacingType::getName   const
 

This function returns the name string associated with the encapsulated oaRowSpacingTypeEnum object.

oaRowSpacingType::operator oaRowSpacingTypeEnum   const [inline]
 

This operator casts this oaRowSpacingType object into the corresponding oaRowSpacingTypeEnum value.


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

Return to top of page