commandDialogExtensionInterface.h

Go to the documentation of this file.

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



#pragma once


#include <vrfGuiTaskSetQt/vrfGuiTaskSetQt.h>
#include <vrfGuiTaskSetQt/simCommandObjectWrapper.h>
#include <vrfGuiCore/vrfSelectionFilters.h>

#include <vrvUtil/DtUnicode.h>
#include <vrvCore/DtSimEntry.h>

#include <vector>

#include <vlutil/vlString.h>

#include <QtCore/QObject>
#include <QtCore/QString>

class QWidget;
class DtUUID;

class DtSetDataRequest;
class DtSimTask;
class DtSimStatement;

namespace makVrv
{
   class DtSimEntry;
}

namespace makVrf
{
   class DtVrfTaskSetMenu;
   class DtVrfTaskSetAction;
   class DtMapFocusHandlerInterface;

   class DT_DLL_VRFGUITASKSETQT DtCommandDialogExtensionInterface
   {
   public:
      //DTOR
      virtual ~DtCommandDialogExtensionInterface()
      {
      }

      virtual QWidget* widget() = 0;

      virtual bool editStatement(const std::vector<makVrv::DtSimEntry*>&, const DtSimStatement*) = 0;

      virtual void run(const std::vector<makVrv::DtSimEntry*>&) = 0;

      virtual bool valid() const = 0;

      virtual bool okEnabled() const = 0;

      virtual void setOKEnabled(bool) = 0;

      virtual void setApplyVisible(bool) = 0;

      virtual void setCancelEnabled(bool) = 0;

      virtual void setCancelButtonText(const QString&) = 0;

      virtual bool initiallyBroadcast() const
      {
         return false;
      }

      virtual bool alwaysPopOut() const
      {
         return false;
      }

      virtual bool allowBroadcasting() const
      {
         return true;
      }

      virtual bool hasUserEntry() const
      {
         return true;
      }

      virtual QString entitySelectionGroupBoxTitle() const
      {
         return QObject::tr("Apply Command To");
      }

      virtual void filterAboutToBeAdded(DtVrfSelectionFilter*)
      {
      }

      virtual void parentShown(QWidget*)
      {
      }

      virtual bool insertMapFocusHandler(DtMapFocusHandlerInterface*, int index = -1) = 0;

      virtual std::vector<std::string> commandDialogFiltersFor(const std::vector<makVrv::DtSimEntry*>& data, const DtSimStatement* stmt,
         int& initialSelection) const = 0;

      virtual void setupFrom(const std::vector<makVrv::DtSimEntry*>&) = 0;

      virtual void selectionChanged(const DtUUID & selection) = 0;

      virtual bool wantsSelectionOfObjectInCommandMode(const std::vector<makVrv::DtSimEntry*>&) const = 0;

      virtual void noObjectsSelected() = 0;

      virtual void initializeFromAction(DtVrfTaskSetAction*) = 0;

      virtual void setReadOnlyMode(bool) = 0;

      virtual void onCancel() = 0;

      virtual void onOK() = 0;

      virtual void hideButtons(bool) = 0;

      virtual makVrv::DtUnicode broadcastTitle() const
      {
         return makVrv::DtUnicode::tr("Broadcast");
      }

      virtual QWidget* takeOKCancelButtonCanvas(QWidget* newParent) = 0;

      virtual void giveOKCancelButtonCanvas(QWidget*) = 0;

   public:
      boost::signals2::signal<void ()> signal_cancelled;

      boost::signals2::signal<void (bool)> signal_enableCommandModeSelection;
      boost::signals2::signal<void (bool)> signal_validStateChanged;
      boost::signals2::signal<void (bool)> signal_disableCancel;
      boost::signals2::signal<void (std::vector<DtUUID> names, const DtSetDataRequest&)> signal_sendSetRequest;
      boost::signals2::signal<void (std::vector<DtUUID> names, const DtSimTask&)> signal_sendTaskRequest;
      boost::signals2::signal<void (const DtSimCommandObjectWrapper&)> signal_sendCommandRequest;
      boost::signals2::signal<void (const std::vector<DtUUID>&, const DtSimTask&, DtVrfTaskSetMenu*)> signal_commandActivated;
      boost::signals2::signal<void (const DtSimCommandObjectWrapper&)> signal_simCommandActivated;

      boost::signals2::signal<void (const std::vector<makVrv::DtSimEntry*>&)> signal_stopWatching;

   };
}