oaTextAlign Class Reference


Public Methods

 oaTextAlign (oaTextAlignEnum valueIn)
 oaTextAlign (const oaString &name)
 ~oaTextAlign ()
const oaStringgetName () const
 operator oaTextAlignEnum () const

Detailed Description

The oaTextAlign class encapsulates the enumerated values that describe the different types of text alignment for oaText objects.

enum oaTextAlignEnum
 

Enumeration values:
oacUpperLeftTextAlign  "upperLeft"
oacCenterLeftTextAlign  "centerLeft"
oacLowerLeftTextAlign  "lowerLeft"
oacUpperCenterTextAlign  "upperCenter"
oacCenterCenterTextAlign  "centerCenter"
oacLowerCenterTextAlign  "lowerCenter"
oacUpperRightTextAlign  "upperRight"
oacCenterRightTextAlign  "centerRight"
oacLowerRightTextAlign  "lowerRight"


Constructor & Destructor Documentation

oaTextAlign::oaTextAlign oaTextAlignEnum    valueIn [inline]
 

This function constructs an instance of an oaTextAlign class using the specified oaTextAlignEnum value.

oaTextAlign::oaTextAlign const oaString &    name
 

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

Exceptions:
oacInvalidTextAlignName 

oaTextAlign::~oaTextAlign   [inline]
 

This function destroys this oaTextAlign class.


Member Function Documentation

const oaString & oaTextAlign::getName   const
 

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

oaTextAlign::operator oaTextAlignEnum   const [inline]
 

This operator casts this oaTextAlign object into the corresponding oaTextAlignEnum value.


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

Return to top of page