include/vrvCore/DtToolbarPath.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2010 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/
/******************************************************************************
** $RCSfile: DtToolbarPath.h,v $ $Revision: 1.9 $ $State: Exp $
******************************************************************************/


#pragma once

#include <vrvCore/vrvCore.h>
#include <makArchives/DtSerialize.h>
#include <vrvCore/DtMenuPath.h>

#include <string>

namespace makVrv
{
   class DtMenuPath;

   class DT_DLL_VRVCORE DtToolbarPath
   {
   public:

      //Internal class which is used to ensure that it is not possible to incorrectly
      //build a toolbar path.
      struct DT_DLL_VRVCORE ToolbarPathBuilder
      {
      public:
         friend class DtToolbarPath;

         ToolbarPathBuilder(const DtMenuPath&);

         ToolbarPathBuilder mainMenu(const std::string&);

         DtToolbarPath widget(const std::string& name) const;

         //Add a menu to the path.
         ToolbarPathBuilder menu(const std::string& name) const;

         //Start a toolbar.
         ToolbarPathBuilder toolbar(const std::string& name) const;

         DtToolbarPath item(const std::string& name) const;

         DtToolbarPath separator(const std::string& name) const;

      protected:

         //Access the path.
         inline const std::string& path() const { return myPath; }

         //The CTOR this class is automatically created by the DtToolbarPath.
         ToolbarPathBuilder(const std::string& name);

         std::string myPath;
      };

      // CTOR. Used for serialization
      DtToolbarPath();

      //Useful CTOR.
      DtToolbarPath(const ToolbarPathBuilder& builder);

      //Useful CTOR.
      DtToolbarPath(const DtMenuPath& copy);
      
      DtToolbarPath(const DtToolbarPath& copy);

      //Start a toolbar.
      static ToolbarPathBuilder toolbar(const std::string& name);

      //Start a toolbar row.
      static ToolbarPathBuilder row(const std::string& name);

      //Create an empty menu path.
      static DtToolbarPath empty();

      //Create an empty root menu path.
      static DtToolbarPath root();

      DtToolbarPath menuPart() const;

      DtToolbarPath toolbarPart() const;

      DtToolbarPath parentMenu() const;

      bool isChildOf(const DtToolbarPath& parent) const;

      bool isDescendant(const DtToolbarPath& ancestor) const;

      bool isSiblingOf(const DtToolbarPath& sibling) const;

      bool isToolbar() const;

      bool isAbsolutePath() const;

      bool isWidget() const;

      //Get the current path.
      inline const std::string& path() const { return myPath; }

      bool isEmpty() const;

      bool isItem() const;

      bool isMainMenu() const;

      bool isSeparator() const;

      bool isMenu() const;

      bool isRow() const;

      DtToolbarPath rootParentMenu() const;

      std::string name() const;

      bool operator ==(const DtToolbarPath& other) const;
      bool operator <(const DtToolbarPath& other) const;
      bool operator !=(const DtToolbarPath& other) const;
      
      DT_DECLARE_serialize_FUNCTIONS

      protected:

         template<class Archive>
         void _serialize(Archive & ar, const unsigned int version)
         {              
            ar & DT_SERIALIZE_MEMBER(myPath);
         }

      DtToolbarPath(const std::string& path);

      protected:

      std::string myPath;
   };
}