mapFocusHandler.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCommonQt/vrfGuiCommonQt.h>
#include <vrvCoreQt/DtQtCursor.h>
#include <vrvCore/DtUniqueID.h>

#include <vector>

#include <QtCore/QString>

namespace makVrv
{
   class DtDe;
}

namespace makVrf
{
   class DtMapFocusHandler;

   class DT_DLL_VRFGUICOMMONQT DtMapFocusHandlerInterface
   {
   public:
      enum SelectionStatus
      {
         Unknown = 0,
         Valid = 1,
         Invalid = 2
      };

      enum CursorOver
      {
         ObjectList = 0,
         MapArea = 1
      };

      DtMapFocusHandlerInterface()
      {
      }

      virtual ~DtMapFocusHandlerInterface()
      {
      }

      virtual void setHasMapFocus(bool) = 0;
      virtual void setCanTakeMapFocus(bool) = 0;
      virtual bool canTakeMapFocus() const = 0;
      virtual bool hasMapFocus() const = 0;

      virtual makVrv::DtQtCursor cursorForSelectionStatus(SelectionStatus, CursorOver) const = 0;

      virtual SelectionStatus selectionStatusFor(makVrv::DtUniqueID id, CursorOver) const = 0;

      virtual void setDescription(const QString& s)
      {
         myDescription = s;
      }

      virtual QString operation() const
      {
         if (myDescription.length())
         {
            return myDescription;
         }
         
         return generatedDescription();
      }

      virtual QString generatedDescription() const
      {
         return "";
      }

      virtual void setOneClickMode(bool b)
      {
         myOneClickMode = b;
      }

      bool oneClickMode() const
      {
         return myOneClickMode;
      }

      boost::signals2::signal<void (DtMapFocusHandlerInterface*, bool)> signal_canTakeMapFocusChanged;
      boost::signals2::signal<void (DtMapFocusHandlerInterface*)> signal_selectionChangedByMapSelection;

   protected:
      QString myDescription;
      bool myOneClickMode = false;
   };

   class DT_DLL_VRFGUICOMMONQT DtMapFocusHandler
   {
   public:
      //CTOR
      DtMapFocusHandler(makVrv::DtDe&);

      //DTOR
      virtual ~DtMapFocusHandler();

      virtual void addMapFocusHandler(DtMapFocusHandlerInterface*, int index = -1);

      virtual void removeMapFocusHandler(DtMapFocusHandlerInterface*);

      virtual void focusToNext(bool becauseOfRightClick = false);

      virtual void removeAndDisconnectAll();

      typedef boost::function<makVrv::DtQtCursor ()> CursorOverride;

      virtual makVrv::DtQtCursor getOverrideCusror() const;
      virtual void setCursorOverride(CursorOverride);
      virtual CursorOverride cursorOverride() const;

      virtual void setAutoChangeToNext(bool);
      bool autoChangeToNext() const
      {
         return myAutoChangeToNext;
      }

      virtual void setTaskSetStatusTextPart(const QString&);
      const QString& taskSetStatusPart() const
      {
         return myTaskSetStatusPart;
      }

      virtual void resetFocus();

      virtual void takeMapFocus(DtMapFocusHandlerInterface*);

      std::vector<DtMapFocusHandlerInterface*>& managedViews() { return myManagedViews; };
      const std::vector<DtMapFocusHandlerInterface*>& managedViews() const { return myManagedViews; };

      virtual DtMapFocusHandlerInterface* hasMapFocus() const;

      virtual void setAllowCursorChange(bool);
      bool allowCursorChange() const
      {
         return myAllowCursorChange;
      }

      virtual void setOneClickMode(bool b);

      bool oneClickMode() const
      {
         return myOneClickMode;
      }

      virtual DtMapFocusHandlerInterface::SelectionStatus selectionStatusFor(makVrv::DtUniqueID id, DtMapFocusHandlerInterface::CursorOver) const;

      virtual makVrv::DtQtCursor cursorForSelectionStatus(DtMapFocusHandlerInterface::SelectionStatus, DtMapFocusHandlerInterface::CursorOver) const;

      boost::signals2::signal<void ()> signal_lostMapFocus;

   protected:
      virtual void onCanTakeMapFocusChanged(DtMapFocusHandlerInterface*, bool);
      virtual void onSelectionChangedByMapSelection(DtMapFocusHandlerInterface*);
      virtual void updateMainMapFocusHandler();

   protected:
      std::vector<DtMapFocusHandlerInterface*> myManagedViews;
      makVrv::DtDe& myDe;
      bool myAllowCursorChange;
      bool myAutoChangeToNext;
      CursorOverride myCursorOverride;
      QString myTaskSetStatusPart;
      bool myOneClickMode = false;
   };
}