include/vrfGuiCommon/menu.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2000 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/
/*********************************************************************
** $RCSfile: menu.h,v $ $Revision: 1.8 $ $State: Exp $
*********************************************************************/


#ifndef MENU_H
#define MENU_H

#include "vrfGuiCommon/menuEntry.h"
#include <QtCore/QString>

class DtObjectType;
class DtEntityMapperKey;
class DtFilename;


#include "vrfGuiCommon/vrfGuiCommonDefines.h"
class DT_DLL_vrfGuiCommon DtMenu : public DtMenuEntry
{

public:

   DtMenu
   (
      const DtString& name,
      DtReaderWriterRegistry* const parentRegistry = NULL
   );

   virtual ~DtMenu();

   DtMenu(const DtMenu& orig);

   DtMenu& operator=(const DtMenu& orig);
   virtual bool operator==(const DtMenuEntry&) const;

   virtual const DtList& entries() const;
   
   virtual void getSelf(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual DtlObjPtr getLocalData(DtlObjPtr args);

   virtual DtlObjPtr getData(DtlObjPtr args, const DtFilename& searchPath,
      const DtVariableBindingsList& variableBindings);

   virtual void addObject(const QString& item, const DtObjectType& type, int force, const QString& at = QString::null);
   virtual void addEntity(const QString& item, const DtObjectType& type, int force, const QString& at = QString::null);

   virtual bool creationKeyFor(const QString& name, DtEntityMapperKey& retKey) const;

   virtual bool load(const DtFilename&);

   virtual bool save(const DtFilename&);

   virtual void setComment(const QString&);
   virtual const QString& comment() const;

   virtual DtMenuEntry* findEntry(DtMenuEntry*) const;

   virtual DtMenuEntry* findEntry(const DtString&, bool recurse = false) const;

   virtual void merge(DtMenu*);

   virtual void add(DtMenuEntry*);

   virtual DtMenuEntry* clone() const;

   const DtFilename& filename() const;
   void setFilename(const DtFilename&);

protected:
   virtual void copyMenuEntries(const DtList*);
   virtual void merge(DtMenuEntry*);

protected:
   virtual void addMenuItem(const QString& item, const DtObjectType& type, int force, const char* name, const QString& at);
   virtual void writeSelf(FILE* fp, int i, bool writeUnspecified,
                               const DtFilename& path);

protected:
   DtList      myEntries;
   QString     myComment;
   DtFilename  myFilename;
};

inline const DtFilename& DtMenu::filename() const
{
   return myFilename;
}

inline void DtMenu::setFilename(const DtFilename& f)
{
   myFilename = f;
}

#endif