lgrGuiModel.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 1992-2024 MAK Technologies, Inc
** All rights reserved.
******************************************************************************/


#ifndef lgrGuiModel_H_
#define lgrGuiModel_H_

#include <lgrGui/lgrGui.h>
#include <lgrUtil/virtualConstructor.h>
#include <lgrUtil/absoluteTime.h>

#include <vlutil/vlFilename.h>

#include <QString>
#include <map>
#include <set>
#include <QVector>

class QAction;
class QDialog;
class QObject;
class QStyle;
class QTimer;
class QWidget;
class QProcess;
class QDockWidget;

namespace MAKLogger
{
   class DtAbsoluteTime;
   class DtBoundsSlider;
   class DtLgrTimeBarWidget;
   class DtLgrEditorInterface;
   class DtLgrFullInterface;
   class DtLgrAppGui;
   class DtLgrGuiComponent;
   class DtLgrMainWindow;
   class DtLgrMainWindow;
   class DtLgrMenu;
   class DtLgrPlaybackInterface;
   class DtLgrRecordInterface;
   class DtLgrSimInterface;
   class DtLgrSystemInterface;
   class DtLgrTimeInterface;
   class DtLgrToolBar;
   class DtTimeComponent;
   class DtLgrExportDialog;
   class DtLgrTimeBarZoomBox;
   struct DtLgrMediaPlayPipelineInfo;

   class DT_DLL_LGRGUI DtLgrGuiModel
   {
   public:
      typedef std::map<QString,bool> DtComponentVisibilityMap;

   public:

      DT_VIRTUAL_CTR(DtLgrGuiModel,(DtLgrAppGui* appGui));

      virtual ~DtLgrGuiModel();

      virtual void initialize(DtLgrMainWindow* mainWindow,QObject* eventHandler);

      virtual void addExportType( QString exportName, int exportType);

      virtual void addNewMenu( DtLgrMenu* menu, QString previousMenuName = QString() );

      virtual void addNewToolbar( QWidget* toolBar, QString toolBarName );

      virtual void addGuiComponent( DtLgrGuiComponent* component, bool addAbove=true, bool floating=false);

      virtual void removeGuiComponent( QString componentName);

      virtual DtLgrGuiComponent* guiComponent( QString componentName );

      virtual void changeGuiComponentVisibility(QString componentName, bool visible);

      virtual void setGuiComponentInitialVisibility(QString componentName, bool visible);

      virtual void updateLgrComponent(QString componentName,bool visible);

      virtual void showLgrComponent( QString componentName );

      virtual void hideLgrComponent( QString componentName );

      virtual void getComponentsVisibility(DtComponentVisibilityMap& visibilityMap) const;

      virtual void addNewStatusWidget( QWidget* widget );

      virtual void connectMenuItemToAction(QString menuName,QString menuItemName,
         QAction* action);

      typedef DtLgrExportDialog* (*ExportDialogCreator)(DtLgrGuiModel*,QWidget* parent);

      virtual void addExportDialog(QString exportType,ExportDialogCreator creator);

      //@name Application Operations

      virtual bool exit();

      virtual void startLongOperation();

      virtual void finishLongOperation();

      virtual void updateLongOperation();

      virtual void cancelLongOperation();


      //@name File Operations

      virtual QString getLoggerFileFilter() const;

      virtual QString getDefaultLoggerFileDirectory() const;

      virtual QString getSaveLoggerFileName(QWidget* parentWindow,QString title, 
         QString& description, bool& descriptionChanged, DtString* streamConfiguration=0, int mediaPort=5000, bool activeStream=0);

      virtual bool openFile();

      virtual bool openFile( const QString& filename, bool checkMediaFile = false );

      virtual bool needDifferentConnectionSettings( DtString& filename );

      virtual bool saveFileAs(bool reopenAfterSave = true);

      virtual void saveFile(bool reopenAfterSave = true);

      virtual bool fileSaved() const;

      virtual bool canCloseFile();

      virtual bool closeFile();

      virtual void exportSection(const DtString& fileFormat);

      virtual void exportFile(const DtString& fileFormat);

      virtual bool openLoggerInformation();

     virtual QVector<QString> recentFiles();

     virtual void setRecentFiles(QVector<QString> recentFiles);

     virtual void addRecentFile(QString filename);

      //@name Record Operations

      virtual void recordAs();

      virtual void recordFile(QString filename, QString description, bool overwrite);

      virtual void queryToRecordMultipleFiles();

      virtual void recordToMultipleFiles(QString filename, QString description);

      virtual bool queryStopRecordingEmptyTape();

      virtual void saveRecordingData();

      virtual void setZoom();

      virtual void setZoom(const DtAbsoluteTime& start,const DtAbsoluteTime& end);


      virtual QString fileNameForDisplay() const;

      virtual void upgradeFile();

      virtual void repairFile(const QString& filename, bool queryRepair);

      virtual void recoverLastPacket(const QString& filename);

      virtual void exportCompleted();

      virtual void revert();


      //@name Playback Operations

      virtual void setSpeed();

      virtual void setStartStopTimes();

      virtual void setStartStopTimes(const DtAbsoluteTime& start,
         const DtAbsoluteTime& stop);

      virtual void stop();


      //@name Editing Operations

      virtual void clearSelection();

      virtual void cutSelection();

      virtual void setDarkModeEnabled(bool enable);

      virtual void loadStylesheet(bool enabled);

      virtual void mergeInFile();

      virtual void appendFile();

      virtual void prefixFile();

      virtual void offsetTime();


      virtual const DtLgrFullInterface* fullInterface() const;
      virtual DtLgrFullInterface* fullInterface();

      virtual const DtLgrAppGui* appGui() const;
      virtual DtLgrAppGui* appGui();

      virtual const DtLgrEditorInterface* editorInterface() const;
      virtual DtLgrEditorInterface* editorInterface();

      virtual const DtLgrPlaybackInterface* playbackInterface() const;
      virtual DtLgrPlaybackInterface* playbackInterface();

      virtual const DtLgrRecordInterface* recordInterface() const;
      virtual DtLgrRecordInterface* recordInterface();

      virtual const DtLgrSimInterface* simulationInterface() const;
      virtual DtLgrSimInterface* simulationInterface();

      virtual const DtLgrSystemInterface* systemInterface() const;
      virtual DtLgrSystemInterface* systemInterface();

      virtual const DtLgrTimeInterface* timeInterface() const;
      virtual DtLgrTimeInterface* timeInterface();

      virtual void updateInterfaces();

      virtual void deleteAssistant();

      virtual void toggleConnection();

      virtual bool disconnect(QWidget* dialog=0);

      virtual QObject* eventHandler();

      virtual DtLgrMainWindow* mainWindow();

      virtual void crippleGui(bool disableAndMinimize);

      virtual void openUrl(const QString& urlText);

      virtual void showHelp(const char* filename = 0);

      virtual void showUserGuide();

      virtual void showReleaseNotes();

      virtual void showClassDocs();

      virtual void showAboutBox();

      virtual void launchVersionWebsite();

      virtual void launchProductWebsite();

      virtual const DtTimeComponent& displayTime() const;

      virtual void playbackFileEvent(const QString& filename);

      virtual void recordFileEvent(const QString& filename);

      virtual bool isZoomEnabled() const;

      virtual void setFollowMode(bool enableFollow);

      virtual void setFollowInterval(double interval);

      virtual bool isFollowMode() const;

      virtual void jumpTimeChanged(const DtAbsoluteTime& jumpTime);

      virtual void mediaPlayInWindowOperationActive(bool isActive, bool onCloseMainWindow = false);

      virtual void changeGuiComponentVisibilityWithLocking(QString componentName, bool visible, int initialSize = -1, bool lockOtherViewsX = true, bool lockOtherViewsY = true, bool ignoreVisibility = false);

      virtual void openDroppedFile(DtString& filename);

      virtual bool protocolIsMatch(DtString& filename, DtString& protocol);

      virtual bool darkModeEnabled();

      virtual void replaceAll(std::string& searchText,
         const std::string& stringToFind,
         const std::string& stringToReplace) const;
      
      virtual std::string resolveVars(const std::string& s);

   protected:

      virtual void longOperationChangedCallback(const bool& state);
      virtual void longOperationMessageChangedCallback(const DtString& message);
      virtual void longOperationProgressChangedCallback(const int& percent);

      virtual QString showExportDialog(QString fileFormat,QString filter, QString dialogName);
      virtual QString browseOpenLoggerFile(QString title, DtLgrMediaPlayPipelineInfo* pipelineInfo=0);

   protected:
      DtLgrMainWindow* myMainWindow;
      QObject* myEventHandler;
      DtLgrFullInterface* myFullInterface;
      DtLgrAppGui* myAppGui;
      DtLgrTimeBarWidget* myTimeBar;
      DtBoundsSlider* myTimeControl;
      DtLgrTimeBarZoomBox* myZoomControl;
      QProcess* myHelpAssistant;
      DtTimeComponent* myTimeComponent;
      QDockWidget* myTimeLineDocWidget;

      typedef std::map<QString,DtLgrGuiComponent*> GuiComponentMap;
      GuiComponentMap myComponents;
      DtComponentVisibilityMap myComponentsInitialVisibility;

      typedef std::map<QString,ExportDialogCreator> ExportDialogMap;
      ExportDialogMap myExportDialogMap;

      typedef std::set<QString> ExportTypes;
      ExportTypes myExportTypes;

      QStyle* myNewDockStyle;
      //Flag used to store if the model is already exiting.
      bool myExitingFlag;

      bool myJumpPending;
      DtAbsoluteTime myJumpTime;
      bool myResetZoom;

      DtFilename myRepairedFilename;

      QString myDataViewName;
      QString mySizeViewName;
      QString myStreamViewName;

      QVector<QString> myRecentFiles;

      bool myDarkModeEnabled;
      std::string myAppPath;
      std::string myDataPath;

   };
}

#endif