vrfMenu.h

Go to the documentation of this file.

/*********************************************************************
** Copyright (c) 2017 MaK Technologies, Inc.
** All rights reserved.
*********************************************************************/

#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrfGuiCore/vrfMenuEntry.h>
#include <set>

class DtObjectType;
class DtFilename;

namespace makVrf
{
   class DtEntityMapperKey;
   class DT_DLL_VRFGUICORE DtVrfMenu : public DtVrfMenuEntry
   {

   public:

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

      virtual ~DtVrfMenu();

      DtVrfMenu(const DtVrfMenu& orig);

      DtVrfMenu& operator=(const DtVrfMenu& orig);
      virtual bool operator==(const DtVrfMenuEntry&) const;

      virtual const DtList& entries() const;
      
      virtual void getSelf(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
         const DtVariableBindingsList& variableBindings);

      virtual DtlObjPtr getLocalData(DtlObjPtr args);

      virtual DtlObjPtr getData(DtlObjPtr args, const DtReaderWriter::SearchPaths& searchPaths,
         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 DtVrfMenuEntry* findEntry(DtVrfMenuEntry*) const;

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

      virtual void merge(DtVrfMenu*);

      virtual void add(DtVrfMenuEntry*);

      virtual DtVrfMenuEntry* clone() const;

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

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

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

   protected:
      DtList      myEntries;
      DtString     myComment;
      DtFilename  myFilename;
      std::set<DtVrfMenuEntry*> mySetEntries;
   };

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

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