oaTextDisplayFormat Class Reference


Public Methods

 oaTextDisplayFormat (oaTextDisplayFormatEnum valueIn)
 oaTextDisplayFormat (const oaString &name)
 ~oaTextDisplayFormat ()
const oaString & getName () const
 operator oaTextDisplayFormatEnum () const

Detailed Description

The oaTextDisplayFormat class encapsulates the enumerated values that describe the different formats used by oaTextDisplay objects. The format indicates whether the oaTextDisplay object uses the name, the value, or both the name and value of the associated object.

enum oaTextDisplayFormatEnum
 

Enumeration values:
oacNameTextDisplayFormat  "name"
oacValueTextDisplayFormat  "value"
oacNameValueTextDisplayFormat  "name and value"

Constructor & Destructor Documentation

oaTextDisplayFormat::oaTextDisplayFormat (  oaTextDisplayFormatEnum    valueIn )  [inline]
 

This function constructs an instance of an oaTextDisplayFormat class using the specified oaTextDisplayFormatEnum value.

oaTextDisplayFormat::oaTextDisplayFormat (  const oaString &    name ) 
 

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

Exceptions:
oacInvalidTextDisplayFormatName 

oaTextDisplayFormat::~oaTextDisplayFormat (    )  [inline]
 

This function destroys this oaTextDisplayFormat class.

Member Function Documentation

const oaString & oaTextDisplayFormat::getName (    )  const
 

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

oaTextDisplayFormat::operator oaTextDisplayFormatEnum (    )  const [inline]
 

This operator casts this oaTextDisplayFormat object into the corresponding oaTextDisplayFormatEnum value.

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

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.