IText Class Reference

Inheritance diagram for IText:

IBase


Public Methods

virtual void getName (oaString &name)=0
virtual void getBBox (const oaText *text, oaBox &bBox)=0
virtual void getBBox (const oaTextDisplay *textDisplay, oaBox &bBox)=0
virtual void init (ITextInvalidate *textInvalidate)=0
void disableRefCounting (bool val)

Static Public Methods

const Guid & getId ()

Detailed Description

The IText class is an interface that is used by an oaText or oaTextDisplay object to find the bounding box (bBox) of the object. Any application that wants to customize bBox calculations must implement this interface by defining a class derived from this interface.

An IText implementation can be provided in memory or through a plug-in component. Applications can initialize their bBox component with OpenAccess. For more information, refer to How to Write a Plug-in to Calculate Bounding Boxes for Text in the Programmers Guide.

Member Function Documentation

void IText::disableRefCounting (  bool    val ) 
 

void IText::getBBox (  const oaTextDisplay *    textDisplay,
oaBox &    bBox
)  [pure virtual]
 

This function calculates the bBox for the specified textDisplay object and places the result in bBox.

Parameters:
textDisplay Pointer to the textDisplay object.
bBox Output parameter for the calculated bBox.

void IText::getBBox (  const oaText *    text,
oaBox &    bBox
)  [pure virtual]
 

This function calculates the bBox for the specified text object and places the result in bBox.

Parameters:
text Pointer to the text object.
bBox Output parameter for the calculated bBox.

const Guid & IText::getId (    )  [static]
 

This function returns the ID of this interface.

void IText::getName (  oaString &    name )  [pure virtual]
 

This function returns the name of this plug-in.

Parameters:
name Output parameter for the plug-in name.

void IText::init (  ITextInvalidate *    textInvalidate )  [pure virtual]
 

OpenAccess calls this function on the plug-in to provide the plug-in with a handle to the ITextInvalidate object.

The plug-in should provide a way to pass this ITextInvalidate object to the application, which can then call the appropriate ITextInvalidate::invalidate function when it needs to invalidate a text bBox. Either the plug-in or the application should retain the textInvalidate pointer.

Parameters:
textInvalidate Pointer to the ITextInvalidate object supplied by OpenAccess.

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.