DtMenu.h

Go to the documentation of this file.

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


#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/DtMenuEntry.h>

class DtObjectType;
class DtFilename;

namespace makVrf
{
   class DtEntityMapperKey;
   class DT_DLL_VRFGUICORE 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 DtString& item, const DtObjectType& type, int force, const DtString& at = "");
      virtual void addEntity(const DtString& item, const DtObjectType& type, int force, const DtString& at = "");

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

      virtual bool load(const DtFilename&);

      virtual bool save(const DtFilename&);

      virtual void setComment(const DtString&);
      virtual const DtString& 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 DtString& item, const DtObjectType& type, int force, const char* name, const DtString& at);
      virtual void writeSelf(FILE* fp, int i, bool writeUnspecified,
                                  const DtFilename& path);

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

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

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