oaPropDisplay Class Reference

Inheritance diagram for oaPropDisplay:

oaTextDisplay oaShape oaPinFig oaConnFig oaFig oaBlockObject oaDesignObject oaObject


Public Methods

oaProp * getProp () const

Static Public Methods

oaPropDisplay * create (oaProp *prop, oaLayerNum layerNum, oaPurposeNum purposeNum, const oaPoint &origin, oaTextAlign alignment, oaOrient orient, oaFont font, oaDist height, oaTextDisplayFormat format=oacNameTextDisplayFormat, oaBoolean overbar=false, oaBoolean visible=true, oaBoolean drafting=true)

Detailed Description

The oaPropDisplay class creates a shape similar to an oaText object, except that it presents a string that is the value of the specified oaProp object. Whenever the value of the oaProp changes, calling the getText function on this display object returns the updated text string that represents the oaProp value.

The oaPropDisplay object is contained in the design database that contains the oaProp object.

Member Function Documentation

oaPropDisplay * oaPropDisplay::create (  oaProp *    prop,
oaLayerNum    layerNum,
oaPurposeNum    purposeNum,
const oaPoint &    origin,
oaTextAlign    alignment,
oaOrient    orient,
oaFont    font,
oaDist    height,
oaTextDisplayFormat    format = oacNameTextDisplayFormat,
oaBoolean    overbar = false,
oaBoolean    visible = true,
oaBoolean    drafting = true
)  [static]
 

This function creates a propDisplay object with the specified attributes.

Parameters:
prop The oaProp object with which this textDisplay is associated
layerNum The number of the layer for this textDisplay
purposeNum The number of the purpose for this textDisplay
origin The origin point of this textDisplay shape
alignment The alignment related to the origin
orient The orientation of this textDisplay shape
font The font used to display textDisplay shape
height The height of this display
format The format used to create the textDisplay
overbar Specifies if this textDisplay has an overbar; the default is false
visible Specifies if this textDisplay is actually displayed; the default is true
drafting Specifies the drafting of this textDisplay shape; the default is true
Exceptions:
oacNonDesignTextDisplay 

oaProp * oaPropDisplay::getProp (    )  const
 

This function returns the owner oaProp object of this oaPropDisplay.

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.