DtPageCollection.h

Go to the documentation of this file.

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


#pragma once
#include <vrvCore/vrvCore.h>
#include <vrvCore/DtPageConfiguration.h>
#include <boost/signal.hpp>
#include <string>
#include <vector>

namespace makVrv
{
   class DtDe;

   class DT_DLL_VRVCORE DtPageCollection
   {
   public:
      typedef std::vector<std::string> PageClassList;

      DtPageCollection(DtDe& de, const std::string& collectionClassName);

      virtual ~DtPageCollection();

      const std::string& collectionClassName() const;

      const PageClassList& pageClasses() const;

      void show(const std::string& page = std::string(""));

      void hide();

      bool visible() const;

      virtual int tabIndex() const;

      virtual bool isTabbed() const;

      DtPageConfiguration::PageCollectionLocation location() const;

      void setLocation(DtPageConfiguration::PageCollectionLocation location);

      DtPageConfiguration::PageCollectionGeometry& floatingGeometry();

      void setFloatingGeometry( DtPageConfiguration::PageCollectionGeometry geometry );

      void setFloatingGeometry(int px, int py, int width, int height);

      virtual DtPageConfiguration::PageCollectionGeometry dockedGeometry();

      void setDockedGeometry( DtPageConfiguration::PageCollectionGeometry geometry );

      void setDockedGeometry(int px, int py, int width, int height);

      boost::signal<void ()> signal_shown;
      boost::signal<void ()> signal_hidden;
      boost::signal<void (const std::string&)> signal_pageSelected;

   protected:

      virtual void changeVisibility(bool newVisibility) = 0;

      virtual void changeLocation(DtPageConfiguration::PageCollectionLocation) = 0;

      virtual void changeFloatingGeometry(int px, int py, int width, int height) = 0;

      virtual void changeFloatingGeometry(DtPageConfiguration::PageCollectionGeometry geometry) = 0;

      virtual void changeDockedGeometry(int px, int py, int width, int height) = 0;

      virtual void changeDockedGeometry(DtPageConfiguration::PageCollectionGeometry geometry) = 0;

      virtual void selectPage(const std::string& pageClassName) = 0;

      void addPageClass(const std::string& pageClassName);

      void removePageClass(const std::string& pageClassName);

   protected:

      DtDe& myDe;      
      std::string myClassName;
      bool myVisibility;
      PageClassList myPageClasses;
      DtPageConfiguration::PageCollectionLocation myLocation;
      DtPageConfiguration::PageCollectionGeometry myFloatingGeometry;
      DtPageConfiguration::PageCollectionGeometry myDockedGeometry;
   };
}