IEvalText Class Reference

Inheritance diagram for IEvalText:

IBase


Public Methods

virtual ~IEvalText ()
virtual void getName (oaString &name)=0
virtual void onEval (const oaString &textIn, oaString &textOut)=0

Static Public Methods

const Guid & getId ()

Detailed Description

The IEvalText class implements a callback used by an oaEvalText object to interpret the text string. Any application that must customize the oaEvalText text interpretation as a feature is required to derive this class. An IEvalText can be provided in memory or through a plug-in module. When the IEvalText is provided in memory, the application needs to create its IEvalText derived class and call oaEvalTextLink::create() to register with OpenAccess. When IEvalText is provided through a plug-in module, oaEvalTextLink::find() can be used to access the IEvalText in the plug-in module.

Constructor & Destructor Documentation

virtual IEvalText::~IEvalText (    )  [virtual]
 

Member Function Documentation

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

This function returns the GUID for IEvalText.

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

Parameters:
name The name of the IEvalText.
This function returns the name of the IEvalText.

void IEvalText::onEval (  const oaString &    textIn,
oaString &    textOut
)  [pure virtual]
 

Parameters:
textIn Original text.
textOut Application interpolated text.
Applications implement this function to interpolate the text passed in through textIn and returned as a text string in textOut.

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.