oaTextOverride Class Reference

Inheritance diagram for oaTextOverride:

oaTextDisplay oaShape oaPinFig oaConnFig oaFig oaBlockObject oaDesignObject oaObject


Public Methods

oaText * getMasterText () const
void getMasterTextText (oaString &text) const
oaInst * getInst () const
oaBoolean isBound () const

Static Public Methods

oaTextOverride * create (oaText *masterText, oaInst *inst, 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 oaTextOverride class is a shape associated with an oaInst object and an oaText object in the master design of that instance. The oaTextOverride class supports changing the text attributes that are used to display the oaText object in the master design of that instance.

The oaTextOverride display object resides in the same design as the oaInst object it is associated with.

Member Function Documentation

oaTextOverride * oaTextOverride::create (  oaText *    masterText,
oaInst *    inst,
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 textOverride object for the specified text object in the specified instance master.

Note: You must open the instance master for this function to succeed. The oaText must be contained in the master of the instance.

Parameters:
masterText The pointer to the oaText object in instance master
inst The pointer to the instance
layerNum The number of the layer for this textOverride
purposeNum The number of the purpose for this textOverride
origin The origin point for this textOverride shape
alignment The alignments for this textDisplay shape
orient The orientation for this textDisplay shape
font The font used in the display for this textDisplay
height The height for this textDisplay shape
format The name or value format for this display shape; the default is oacNameTextDisplayFormat
overbar Indicates if the display has an overbar; the default is false
visible Indicates if this textOverride is actually displayed; the default is true
drafting Indicates the drafting of this textOverride shape; the default is true
Exceptions:
oacNoMasterForTextDisplay 
oacTextNotInInstanceMaster 

oaInst * oaTextOverride::getInst (    )  const
 

This function returns the instance associated with this textOverride object.

oaText * oaTextOverride::getMasterText (    )  const
 

This function returns the text object contained in the instance master associated with this textOverride object. This function returns NULL if the associated instance is not bound.

void oaTextOverride::getMasterTextText (  oaString &    text )  const
 

This function returns the master text associated with this textOverride object. This text is used when attempting to bind to the masterText object.

oaBoolean oaTextOverride::isBound (    )  const
 

This function returns a boolean, which indicates whether this text display is currently bound to the cross design master text object.

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.