oaPlugInLibDefInterfaces.h

Go to the documentation of this file.

// *****************************************************************************
// *****************************************************************************
// oaPlugInLibDefInterfaces.h
//
// This file contains the definitions for LibDef interface classes, and public
// supporting objects. These include:
//
//  ILibDef
//     This is an abstract class which specifies the interface for the LibDef
//     plug-in that is used to call the LibDef library plug-in from OA.
//
//  ILibDefAccess
//     This is an abstract class which specifies an access interface for LibDef
//     plug-in components. This interface can be used by LibDef plug-in
//     components to call back to OA DM.
//
// *****************************************************************************
// 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-2008 Cadence Design Systems, Inc.
//                           All Rights Reserved.
//
//  $Author: icftcm $
//  $Revision: #1 $
//  $Date: 2008/08/26 $
//  $State: Exp $
// *****************************************************************************
// *****************************************************************************



#if !defined(oaPlugInLibDefInterfaces_P)
#define oaPlugInLibDefInterfaces_P



// *****************************************************************************
// Nested includes
// *****************************************************************************
#include "oaPlugInDMTypes.h"
#include "oaPlugInIDMObject.h"
#include "oaString.h"
#include "oaLibDefList.h"
#include "oaLib.h"



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



// *****************************************************************************
// ILibDefAccess
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ILibDefAccess;

class OA_PLUGIN_DLL_API ILibDefAccess : public IBase {
public:
    virtual void            warn(const oa::oaLibDefList *defList,
                                 const oa::oaString     &message) = 0;

    static const Guid       &getId();
};



// *****************************************************************************
// ILibDef
// *****************************************************************************
extern OA_PLUGIN_DLL_API const Guid IID_ILibDef;

class OA_PLUGIN_DLL_API ILibDef : public IBase {
public:

    virtual oa::oaLibDefList    *open() = 0;
    virtual oa::oaLibDefList    *open(const oa::oaString    &filePath,
                                      oa::oaBoolean         openReferences) = 0;

    virtual void                save(const oa::oaLibDefList *libList) = 0;
    virtual void                saveAs(const oa::oaLibDefList   *libList,
                                       const oa::oaString       &path) = 0;

    virtual void                getDefaultPath(oa::oaString &defaultPath) = 0;
    virtual void                getDefaultFileName(oa::oaString &filename) = 0;

    virtual oa::oaBoolean       hasPath() const = 0;
    virtual oa::oaBoolean       hasWritePath() const = 0;

    virtual void                getLibPath(const oa::oaLibDef   *libDef,
                                           oa::oaString         &libPath) = 0;
    virtual void                getLibWritePath(const oa::oaLibDef  *libDef,
                                                oa::oaString        &libWritepath) = 0;

    virtual void                init(ILibDefAccess *libDefAccess) = 0;

    static const Guid           &getId();
};



END_OA_PLUGIN_NAMESPACE

#endif

Return to top of page

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