include/vrvCore/DtMenuPath.h

Go to the documentation of this file.

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


#ifndef DtMenuPath_H_
#define DtMenuPath_H_

#include <vrvCore/vrvCore.h>
#include <string>

namespace makVrv
{

   class DT_DLL_VRVCORE DtMenuPath
   {
   public:

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

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

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

         DtMenuPath operator/(const std::string& name) const;

         DtMenuPath 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 DtMenuPath.
         MenuPathBuilder(const std::string& name);

         std::string myPath;
      };

      //Useful CTOR.
      DtMenuPath(const MenuPathBuilder& builder);
      
      DtMenuPath(const DtMenuPath& copy);

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

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

      //Create an empty popup menu path.
      static DtMenuPath popup();

      //Start a main menu.
      static MenuPathBuilder mainMenu(const std::string& name);

      //Start a popup menu.
      static MenuPathBuilder popupMenu( const std::string& name );

      //Start a relative menu.
      static MenuPathBuilder menu(const std::string& name);

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

      DtMenuPath menuPart() const;

      DtMenuPath parentMenu() const;

      DtMenuPath rootParentMenu() const;

      std::string name() const;

      bool isEmpty() const;

      bool isAbsolutePath() const;

      bool isMainMenu() const;

      bool isPopupPath() const;

      bool isMenu() const;

      bool isItem() const;

      bool isChildOf(const DtMenuPath& parent) const;

      bool isDescendant(const DtMenuPath& ancestor) const;

      bool isSiblingOf(const DtMenuPath& sibling) const;

      bool isSeparator() const;

      bool operator ==(const DtMenuPath& other) const;
      bool operator <(const DtMenuPath& other) const;
      bool operator !=(const DtMenuPath& other) const;

   protected:

      DtMenuPath(const std::string& path);

      std::string myPath;
   };


}

#endif