oaFigGroupStatus Class Reference
Detailed Description
The oaFigGroupStatus class is an enum wrapper for the values that describe whether a FigGroup's content may be changed by manual editing, automatic layout tools, or both. See oaFigGroup::getFigGroupStatus for usage information.
OpenAccess does not enforce these settings. Tools that modify FigGroups, or figures that belong to FigGroups, must enforce them.
See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.
| enum oaFigGroupStatusEnum
|
|
|
|
- Enumeration values:
-
| oacNormalFigGroupStatus |
"normal" |
| oacFixedFigGroupStatus |
"fixed" |
| oacLockedFigGroupStatus |
"locked" |
|
Constructor & Destructor Documentation
|
|
This oaFigGroupStatus constructor takes an oaFigGroupStatusEnum as input.
- Parameters:
-
| valueIn | An oaFigGroupStatusEnum value. |
|
| oaFigGroupStatus::oaFigGroupStatus |
( |
const oaString & |
name |
) |
|
|
|
|
This constructor creates an oaFigGroupStatus object based on the specified constant string, which is the name associated with an oaFigGroupStatusEnum value.
- Parameters:
-
| name | A reference to a constant oaString associated with an oaFigGroupStatusEnum value. |
- Exceptions:
-
|
Member Function Documentation
| const oaString & oaFigGroupStatus::getName |
( |
|
) |
const |
|
|
|
This function returns the string name that corresponds to the oaFigGroupStatusEnum value represented by this oaFigGroupStatus object. |
|
|
This operator returns the oaFigGroupStatusEnum value that this oaFigGroupStatus object represents. |
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.
