informationPagePath.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2014 MAK Technologies, Inc.
** All rights reserved.
******************************************************************************/


#pragma once
#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvCore/DtPagePath.h>

#include <set>

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtInformationPagePath : public makVrv::DtPagePath
   {
      public:

         //Internal class which is used to ensure that it is not possible to incorrectly
         //build a menu path.
         struct DT_DLL_VRFGUICORE InformationPagePathBuilder : public PagePathBuilder
         {
         public:
            friend class DtInformationPagePath;

            InformationPagePathBuilder() : PagePathBuilder("") {};

            InformationPagePathBuilder(const std::string& name);

            DtInformationPagePath informationItem(const std::string& name) const;

            //Start main page.
            InformationPagePathBuilder page(const std::string& name);

            //Start main section
            InformationPagePathBuilder section(const std::string& name);

      };

      DtInformationPagePath(const std::string& path);

      DtInformationPagePath();

      DtInformationPagePath(const InformationPagePathBuilder& builder);

      DtInformationPagePath(const DtInformationPagePath& copy);

      DtInformationPagePath(const DtPagePath& copy);

      //Start main page.
      static InformationPagePathBuilder collection(const std::string& name);

      //Start main page.
      static InformationPagePathBuilder page(const std::string& name);

      //Start main page.
      static InformationPagePathBuilder section(const std::string& name);

      bool isInformationItem() const;

      bool isPage() const;

      bool isSection() const;

      void variables(std::set<std::string>&) const;

      std::string name() const;
      virtual bool isChildOf( const DtInformationPagePath& parent ) const;

      DtInformationPagePath parentPath() const;
      DtInformationPagePath collectionPart() const;
   };
}