oaText.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaText.h
//
// This file contains the definition for the oaText class. This class implements
// a text shape.
//
// *****************************************************************************
// Except as specified in the OpenAccess terms of use of Cadence or Silicon
// Integration Initiative, this material may not be copied, modified,
// re-published, uploaded, executed, or distributed in any way, in any medium,
// in whole or in part, without prior written permission from Cadence.
//
//                Copyright 2002-2005 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2010/08/09 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaText_P)
#define oaText_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaShape.h"
#include "oaBlock.h"
#include "oaFont.h"



// *****************************************************************************
// Declare and define types in the OpenAccess namespace.
// *****************************************************************************
BEGIN_OA_NAMESPACE



// *****************************************************************************
// oaText
// *****************************************************************************
class OA_DESIGN_DLL_API oaText : public oaShape {
public:
    static oaText           *create(oaBlock         *block,
                                    oaLayerNum      layerNum,
                                    oaPurposeNum    purposeNum,
                                    const oaString  &text,
                                    const oaPoint   &origin,
                                    oaTextAlign     alignment,
                                    oaOrient        orient,
                                    oaFont          font,
                                    oaDist          height,
                                    oaBoolean       overbar = false,
                                    oaBoolean       visible = true,
                                    oaBoolean       drafting = true);

    void                    getOrigin(oaPoint &origin) const;
    void                    getText(oaString &text) const;
    oaTextAlign             getAlignment() const;
    oaOrient                getOrient() const;
    oaFont                  getFont() const;
    oaDist                  getHeight() const;
    oaBoolean               hasOverbar() const;
    oaBoolean               isVisible() const;
    oaBoolean               isDrafting() const;

    void                    setOrigin(const oaPoint &origin);
    void                    setText(const oaString &text);
    void                    setAlignment(oaTextAlign alignment);
    void                    setOrient(oaOrient orient);
    void                    setFont(oaFont font);
    void                    setHeight(oaDist height);
    void                    setOverbar(oaBoolean overbar);
    void                    setVisible(oaBoolean visible);
    void                    setDrafting(oaBoolean drafting);
};



// *****************************************************************************
// oaEvalText
// *****************************************************************************
class OA_DESIGN_DLL_API oaEvalText : public oaText {
public:
    static oaEvalText       *create(oaBlock         *block,
                                    oaLayerNum      layerNum,
                                    oaPurposeNum    purposeNum,
                                    const oaString  &text,
                                    const oaPoint   &origin,
                                    oaTextAlign     alignment,
                                    oaOrient        orient,
                                    oaFont          font,
                                    oaDist          height,
                                    oaEvalTextLink  *linkIn = NULL,
                                    oaBoolean       overbar = false,
                                    oaBoolean       visible = true,
                                    oaBoolean       drafting = true);

    static oaEvalText       *create(oaBlock         *block,
                                    oaLayerNum      layerNum,
                                    oaPurposeNum    purposeNum,
                                    const oaString  &text,
                                    const oaPoint   &origin,
                                    oaTextAlign     alignment,
                                    oaOrient        orient,
                                    oaFont          font,
                                    oaDist          height,
                                    const oaString  &linkName,
                                    oaBoolean       overbar = false,
                                    oaBoolean       visible = true,
                                    oaBoolean       drafting = true);

    oaEvalTextLink          *getLink() const;
    void                    getExpression(oaString &text) const;
    void                    getEvaluatorName(oaString &name) const;

    void                    setLink(oaEvalTextLink *linkIn);
};



// *****************************************************************************
// Design Traits.
// *****************************************************************************
template<>
class oaTraits<oaText> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaShape             parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacTextType};
    enum {abstractTypeEnumVal = oacAbstractTextType};
};

template<>
class oaTraits<oaEvalText> {
public:
    typedef oaShapeModTypeEnum  modTypeType;
    typedef oaText              parentType;
    enum {dtIndex = oacShapeDataType};
    enum {dataTypeEnumVal = oacShapeDataType};
    enum {domain = oacBlockDomain};
    enum {dbType = oacDesignDBType};
    enum {isMultiDomain = false};
    enum {isConcrete = true};
    enum {objectTypeEnumVal = oacEvalTextType};
};

END_OA_NAMESPACE

#endif

Return to top of page

Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.