engauge-digitizer-devel-doc/html/MainWindow_8h_source.html

/******************************************************************************************************

 * (C) 2014 markummitchell@github.com. This file is part of Engauge Digitizer, which is released      *

 * under GNU General Public License version 2 (GPLv2) or (at your option) any later version. See file *

 * LICENSE or go to gnu.org/licenses for details. Distribution requires prior written permission.     *

 ******************************************************************************************************/


#ifndef MAIN_WINDOW_H

#define MAIN_WINDOW_H


#include "BackgroundImage.h"

#include "CoordSystemIndex.h"

#include "DigitizeStateAbstractBase.h"

#include "DocumentAxesPointsRequired.h"

#include "FittingCurveCoefficients.h"

#include "GridLines.h"

#include "MainWindowModel.h"

#include <QCursor>

#include <QMainWindow>

#include <QMap>

#include <QUrl>

#include "Transformation.h"

#include "ZoomControl.h"

#include "ZoomFactor.h"

#include "ZoomFactorInitial.h"


class BackgroundStateContext;

class ChecklistGuide;

class CmdMediator;

class CmdStackShadow;

class CurveStyles;

class DigitizeStateContext;

class DlgSettingsAxesChecker;

class DlgSettingsColorFilter;

class DlgSettingsCoords;

class DlgSettingsCurveList;

class DlgSettingsCurveProperties;

class DlgSettingsDigitizeCurve;

class DlgSettingsExportFormat;

class DlgSettingsGeneral;

class DlgSettingsGridDisplay;

class DlgSettingsGridRemoval;

class DlgSettingsMainWindow;

class DlgSettingsPointMatch;

class DlgSettingsSegments;

class DocumentModelAxesChecker;

class DocumentModelColorFilter;

class DocumentModelCoords;

class DocumentModelDigitizeCurve;

class DocumentModelExportFormat;

class DocumentModelGeneral;

class DocumentModelGridDisplay;

class DocumentModelGridRemoval;

class DocumentModelPointMatch;

class DocumentModelSegments;

class ExportToFile;

class FileCmdScript;

class FittingCurve;

class FittingWindow;

class GeometryWindow;

class Ghosts;

class GraphicsScene;

class GraphicsView;

#if !defined(OSX_DEBUG) && !defined(OSX_RELEASE)

class HelpWindow;

#endif

class LoadImageFromUrl;

class NetworkClient;

class QAction;

class QActionGroup;

class QCloseEvent;

class QComboBox;

class QDomDocument;

class QGraphicsLineItem;

class QMenu;

class QPushButton;

class QSettings;

class QSignalMapper;

class QTextStream;

class QTimer;

class QToolBar;

class QVBoxLayout;

class StatusBar;

class TransformationStateContext;

class TutorialDlg;

class ViewPointStyle;

class ViewSegmentFilter;


extern const unsigned int MAX_RECENT_FILE_LIST_SIZE;


class MainWindow : public QMainWindow

{

  Q_OBJECT


  friend class CreateActions;

  friend class CreateCentralWidget;

  friend class CreateCommandStackShadow;

  friend class CreateDockableWidgets;

  friend class CreateFacade;

  friend class CreateHelpWindow;

  friend class CreateIcons;

  friend class CreateLoadImage;

  friend class CreateMenus;

  friend class CreateNetwork;

  friend class CreateScene;

  friend class CreateSettingsDialogs;

  friend class CreateStateContexts;

  friend class CreateStatusBar;

  friend class CreateToolBars;

  friend class CreateTutorial;

  friend class CreateZoomMaps;


  friend class TestExport;


public:

  MainWindow(const QString &errorReportFile,

             const QString &fileCmdScriptFile,

             bool isDropRegression,

             bool isRegressionTest,

             bool isGnuplot,

             bool isReset,

             bool isExportOnly,

             bool isExtractImageOnly,

             const QString &extractImageOnlyExtension,

             const QStringList &loadStartupFiles,

             const QStringList &commandLineWithoutLoadStartupFiles,

             QWidget *parent = nullptr);

  ~MainWindow();


  void cmdFileClose();


  void cmdFileExport(const QString &fileName);


  void cmdFileImport(const QString &fileName);


  void cmdFileOpen(const QString &fileName);


  CmdMediator *cmdMediator();


  virtual bool eventFilter(QObject *, QEvent *);


  QImage imageFiltered () const;


  bool isGnuplot() const;


  MainWindowModel modelMainWindow () const;


  bool modeMap () const;


  void resizeEvent (QResizeEvent *event);


  void saveErrorReportFileAndExit(const char *comment,

                                  const char *file,

                                  int line,

                                  const char *context);


  GraphicsScene &scene();


  BackgroundImage selectOriginal(BackgroundImage backgroundImage);


  QString selectedGraphCurve () const;


  virtual void showEvent(QShowEvent *);


  void showTemporaryMessage (const QString &temporaryMessage);


  Transformation transformation() const;


  bool transformIsDefined() const;


  void updateAfterCommand();


  void updateAfterMouseRelease();


  void updateCoordSystem(CoordSystemIndex coordSystemIndex);


  void updateDigitizeStateIfSoftwareTriggered (DigitizeState digitizeState);


  void updateGraphicsLinesToMatchGraphicsPoints();


  void updateSettingsAxesChecker(const DocumentModelAxesChecker &modelAxesChecker);


  void updateSettingsColorFilter(const DocumentModelColorFilter &modelColorFilter);


  void updateSettingsCoords(const DocumentModelCoords &modelCoords);


  void updateSettingsCurveList (const CurvesGraphs &curvesGraphs);


  void updateSettingsCurveStyles(const CurveStyles &modelCurveStyles);


  void updateSettingsDigitizeCurve(const DocumentModelDigitizeCurve &modelDigitizeCurve);


  void updateSettingsExportFormat(const DocumentModelExportFormat &modelExport);


  void updateSettingsGeneral(const DocumentModelGeneral &modelGeneral);


  void updateSettingsGridDisplay(const DocumentModelGridDisplay &modelGridDisplay);


  void updateSettingsGridRemoval(const DocumentModelGridRemoval &modelGridRemoval);


  void updateSettingsMainWindow(const MainWindowModel &modelMainWindow);


  void updateSettingsPointMatch(const DocumentModelPointMatch &modelPointMatch);


  void updateSettingsSegments(const DocumentModelSegments &modelSegments);


  void updateViewsOfSettings (const QString &activeCurve);


  GraphicsView &view ();


  const GraphicsView &view () const;


private slots:

  void slotBtnPrintAll();

  void slotBtnShowAllPressed();

  void slotBtnShowAllReleased();

  void slotCanRedoChanged (bool);

  void slotCanUndoChanged (bool);

  void slotChecklistClosed ();

  void slotCleanChanged (bool);

  void slotCmbBackground(int);

  void slotCmbCoordSystem(int);

  void slotCmbCurve(int);

  void slotContextMenuEventAxis (QString);

  void slotContextMenuEventGraph (QStringList);

  void slotDigitizeAxis ();

  void slotDigitizeColorPicker ();

  void slotDigitizeCurve ();

  void slotDigitizePointMatch ();

  void slotDigitizeScale ();

  void slotDigitizeSegment ();

  void slotDigitizeSelect ();

  void slotEditCopy ();

  void slotEditCut ();

  void slotEditDelete ();

  void slotEditMenu ();

  void slotEditPaste ();

  void slotEditPasteAsNew ();

  void slotEditPasteAsNewAdvanced ();

  void slotFileClose ();

  void slotFileExport ();

  void slotFileImport();

  void slotFileImportAdvanced();

  void slotFileImportDraggedImage(QImage);

  void slotFileImportDraggedImageUrl(QUrl);

  void slotFileImportImage(QString, QImage);

  void slotFileImportImageReplace();

  void slotFileOpen();

  void slotFileOpenDraggedDigFile (QString);

  void slotFilePrint();

  bool slotFileSave();

  bool slotFileSaveAs();

  void slotFittingWindowClosed();

  void slotFittingWindowCurveFit(FittingCurveCoefficients, double, double, bool, bool);

  void slotGeometryWindowClosed();

  void slotHelpAbout();

  void slotHelpTutorial();

  void slotKeyPress (Qt::Key, bool);

  void slotLoadStartupFiles ();

  void slotMouseMove (QPointF);

  void slotMousePress (QPointF);

  void slotMouseRelease (QPointF);

  void slotRecentFileAction ();

  void slotRecentFileClear ();

  void slotRedoTextChanged (const QString &);

  void slotSettingsAxesChecker ();

  void slotSettingsColorFilter ();

  void slotSettingsCoords ();

  void slotSettingsCurveList ();

  void slotSettingsCurveProperties ();

  void slotSettingsDigitizeCurve ();

  void slotSettingsExportFormat ();

  void slotSettingsGeneral ();

  void slotSettingsGridDisplay ();

  void slotSettingsGridRemoval ();

  void slotSettingsMainWindow ();

  void slotSettingsPointMatch ();

  void slotSettingsSegments ();

  void slotTableStatusChange ();

  void slotTimeoutRegressionErrorReport ();

  void slotTimeoutRegressionFileCmdScript ();

  void slotUndoTextChanged (const QString &);

  void slotViewGridLines ();

  void slotViewGroupBackground(QAction*);

  void slotViewGroupCurves(QAction*);

  void slotViewGroupStatus(QAction*);

  void slotViewToolBarBackground ();

  void slotViewToolBarChecklistGuide ();

  void slotViewToolBarCoordSystem ();

  void slotViewToolBarDigitize ();

  void slotViewToolBarFittingWindow ();

  void slotViewToolBarGeometryWindow ();

  void slotViewToolBarSettingsViews ();

  void slotViewToolTips ();

  void slotViewZoomFactor (ZoomFactor);

  void slotViewZoomFactorInt (int);

  void slotViewZoom (int);

  void slotViewZoomIn ();

  void slotViewZoomInFromWheelEvent ();

  void slotViewZoomOut ();

  void slotViewZoomOutFromWheelEvent ();


signals:

  void signalDropRegression(QString);


  void signalZoom(int);


private:

  MainWindow();


  enum ImportType {

    IMPORT_TYPE_SIMPLE,

    IMPORT_TYPE_ADVANCED,

    IMPORT_TYPE_IMAGE_REPLACE

  };


  void addDockWindow (QDockWidget *dockWidget,

                      QSettings &settings,

                      const QString &settingsTokenArea,

                      const QString &settingsTokenGeometry,

                      Qt::DockWidgetArea dockWidgetArea);

  void applyZoomFactorAfterLoad();

  virtual void closeEvent(QCloseEvent *event);

  ZoomFactor currentZoomFactor () const;

#if !defined(OSX_DEBUG) && !defined(OSX_RELEASE)

  void exportAllCoordinateSystemsAfterRegressionTests();

#endif

  QString exportRegressionFilenameFromInputFilename (const QString &fileName) const;

  void fileExport(const QString &fileName,

                  ExportToFile exportStrategy);

  void fileExtractImage (const QString &fileName);

  void fileImport (const QString &fileName,

                   ImportType ImportType);

  void fileImportWithPrompts (ImportType ImportType);

  QString fileNameForExportOnly () const;

  QString fileNameForExtractImageOnly () const;

  void filePaste (ImportType importType);

  void ghostsCreate ();

  void ghostsDestroy ();

  void handlerFileExtractImage ();

  void loadCoordSystemListFromCmdMediator();

  void loadCurveListFromCmdMediator();

  void loadDocumentFile (const QString &fileName);

  void loadErrorReportFile(const QString &errorReportFile);

  bool loadImage (const QString &fileName,

                  const QImage &image,

                  ImportType ImportType);

  bool loadImageNewDocument (const QString &fileName,

                             const QImage &image,

                             ImportType ImportType);

  bool loadImageReplacingImage (const QString &fileName,

                                const QImage &image,

                                ImportType ImportType);

  void loadInputFileForErrorReport(QDomDocument &domInputFile) const;

  void loadToolTips ();

  bool maybeSave();

  DocumentModelExportFormat modelExportOverride (const DocumentModelExportFormat &modelExportFormatBefore,

                                                 const ExportToFile &exportStrategy,

                                                 const QString &selectedNameFilter) const;

  bool modeGraph () const; // True if document is loaded and it has all graphs

  void rebuildRecentFileListForCurrentFile(const QString &filePath);

  bool saveDocumentFile(const QString &fileName);

  QString saveErrorReportFileAndExitXml (const char *comment,

                                         const char *file,

                                         int line,

                                         const char *context) const;

  void saveStartingDocumentSnapshot();

  void setCurrentFile(const QString &fileName);

  void setCurrentPathFromFile (const QString &fileName);

  void setNonFillZoomFactor (ZoomFactor newZoomFactor);

  void setPixmap (const QString &curveSelected,

                  const QPixmap &pixmap);

  void settingsRead (bool isReset);

  void settingsReadEnvironment (QSettings &settings);

  void settingsReadMainWindow (QSettings &settings);

  void settingsWrite ();

  bool setupAfterLoadNewDocument (const QString &fileName,

                                  const QString &temporaryMessage,

                                  ImportType ImportType);

  bool setupAfterLoadReplacingImage (const QString &fileName,

                                     const QString &temporaryMessage,

                                     ImportType ImportType);

  void startRegressionTestErrorReport (const QString &regressionInputFile);

  void startRegressionDropTest (const QStringList &loadStartupFiles);

  void startRegressionTestFileCmdScript ();

  void updateAfterCommandStatusBarCoords ();

  void updateChecklistGuide ();

  void updateControls (); // Update the widgets (typically in terms of show/hide state) depending on the application state.

  void updateFittingWindow ();

  void updateGeometryWindow ();

  void updateGridLines();

  void updateHighlightOpacity();

  void updateRecentFileList();

  void updateSettingsMainWindow();

  void updateSmallDialogs();

  void updateTransformationAndItsDependencies();

  void updateViewedCurves ();

  void updateViewsOfSettings (); // Private version gets active curve name from DigitizeContext

  void updateWindowTitle ();

  void writeCheckpointToLogFile();


  QString m_originalFile; // Original filename for error report

  bool m_originalFileWasImported; // True/false for imported/opened

  bool m_isDocumentExported;

  QString m_engaugeFile; // Not empty when a Document is currently loaded AND it was loaded and/or saved as an Engauge file

  QString m_currentFile; // Not empty when a Document is currently loaded. No path or file extension

  QString m_currentFileWithPathAndFileExtension; // Adds path and file extension to m_currentFile. For display

  MainTitleBarFormat m_titleBarFormat;


  QMenu *m_menuFile;

  QAction *m_actionImport;

  QAction *m_actionImportAdvanced;

  QAction *m_actionImportImageReplace;

  QAction *m_actionOpen;

  QMenu *m_menuFileOpenRecent;

  QList<QAction*> m_actionRecentFiles;

  QAction *m_actionClose;

  QAction *m_actionSave;

  QAction *m_actionSaveAs;

  QAction *m_actionExport;

  QAction *m_actionPrint;

  QAction *m_actionExit;


  QMenu *m_menuEdit;

  QAction *m_actionEditUndo;

  QAction *m_actionEditRedo;

  QAction *m_actionEditCut;

  QAction *m_actionEditCopy;

  QAction *m_actionEditPaste;

  QAction *m_actionEditDelete;

  QAction *m_actionEditPasteAsNew;

  QAction *m_actionEditPasteAsNewAdvanced;


  QMenu *m_menuDigitize;

  QActionGroup *m_groupDigitize;

  QAction *m_actionDigitizeSelect;

  QAction *m_actionDigitizeAxis;

  QAction *m_actionDigitizeScale;

  QAction *m_actionDigitizeCurve;

  QAction *m_actionDigitizePointMatch;

  QAction *m_actionDigitizeColorPicker;

  QAction *m_actionDigitizeSegment;


  QMenu *m_menuView;

  QAction *m_actionViewBackground;

  QAction *m_actionViewChecklistGuide;

  QAction *m_actionViewCoordSystem;

  QAction *m_actionViewDigitize;

  QAction *m_actionViewFittingWindow;

  QAction *m_actionViewGeometryWindow;

  QAction *m_actionViewSettingsViews;

  QAction *m_actionViewToolTips;

  QAction *m_actionViewGridLines;

  QMenu *m_menuViewBackground;

  QActionGroup *m_groupBackground;

  QAction *m_actionViewBackgroundNone;

  QAction *m_actionViewBackgroundOriginal;

  QAction *m_actionViewBackgroundFiltered;

  QMenu *m_menuViewCurves;

  QActionGroup *m_groupCurves;

  QAction *m_actionViewCurvesNone;

  QAction *m_actionViewCurvesSelected;

  QAction *m_actionViewCurvesAll;

  QMenu *m_menuViewStatus;

  QActionGroup *m_groupStatus;

  QAction *m_actionStatusNever;

  QAction *m_actionStatusTemporary;

  QAction *m_actionStatusAlways;

  QMenu *m_menuViewZoom;

  QAction *m_actionZoomOut;

  QAction *m_actionZoomIn;

  QActionGroup *m_groupZoom;

  QSignalMapper *m_mapperZoomFactor;

  QAction *m_actionZoomFill;

  QAction *m_actionZoom16To1;

  QAction *m_actionZoom16To1Farther;

  QAction *m_actionZoom8To1Closer;

  QAction *m_actionZoom8To1;

  QAction *m_actionZoom8To1Farther;

  QAction *m_actionZoom4To1Closer;

  QAction *m_actionZoom4To1;

  QAction *m_actionZoom4To1Farther;

  QAction *m_actionZoom2To1Closer;

  QAction *m_actionZoom2To1;

  QAction *m_actionZoom2To1Farther;

  QAction *m_actionZoom1To1Closer;

  QAction *m_actionZoom1To1;

  QAction *m_actionZoom1To1Farther;

  QAction *m_actionZoom1To2Closer;

  QAction *m_actionZoom1To2;

  QAction *m_actionZoom1To2Farther;

  QAction *m_actionZoom1To4Closer;

  QAction *m_actionZoom1To4;

  QAction *m_actionZoom1To4Farther;

  QAction *m_actionZoom1To8Closer;

  QAction *m_actionZoom1To8;

  QAction *m_actionZoom1To8Farther;

  QAction *m_actionZoom1To16Closer;

  QAction *m_actionZoom1To16;


  QMenu *m_menuSettings;

  QAction *m_actionSettingsAxesChecker;

  QAction *m_actionSettingsColorFilter;

  QAction *m_actionSettingsCoords;

  QAction *m_actionSettingsCurveList;

  QAction *m_actionSettingsCurveProperties;

  QAction *m_actionSettingsDigitizeCurve;

  QAction *m_actionSettingsExport;

  QAction *m_actionSettingsGeneral;

  QAction *m_actionSettingsGridDisplay;

  QAction *m_actionSettingsGridRemoval;

  QAction *m_actionSettingsMainWindow;

  QAction *m_actionSettingsPointMatch;

  QAction *m_actionSettingsSegments;


  QMenu *m_menuHelp;

  QAction *m_actionHelpAbout;

  QAction *m_actionHelpChecklistGuideWizard;

  QAction *m_actionHelpHelp;

  QAction *m_actionHelpTutorial;

  QAction *m_actionHelpWhatsThis;


  QVBoxLayout *m_layout;

  GraphicsScene *m_scene;

  GraphicsView *m_view;


  StatusBar *m_statusBar;

  Transformation m_transformation;


  QComboBox *m_cmbCurve;

  QToolBar *m_toolDigitize;

  LoadImageFromUrl *m_loadImageFromUrl;


  QComboBox *m_cmbBackground;

  QToolBar *m_toolBackground;


  ViewPointStyle *m_viewPointStyle;

  ViewSegmentFilter *m_viewSegmentFilter;

  QToolBar *m_toolSettingsViews;

  ChecklistGuide *m_dockChecklistGuide;

  FittingWindow *m_dockFittingWindow;

  GeometryWindow *m_dockGeometryWindow;


  QComboBox *m_cmbCoordSystem;

  QPushButton *m_btnPrintAll;

  QPushButton *m_btnShowAll;

  QToolBar *m_toolCoordSystem;


#if !defined(OSX_DEBUG) && !defined(OSX_RELEASE)

  HelpWindow *m_helpWindow;

#endif

  TutorialDlg *m_tutorialDlg;


  CmdMediator *m_cmdMediator;

  CmdStackShadow *m_cmdStackShadow;


  // State machine for user interface states

  DigitizeStateContext *m_digitizeStateContext;


  // State machine for transformation states

  TransformationStateContext *m_transformationStateContext;


  // State machine for background image

  BackgroundStateContext *m_backgroundStateContext;


  DlgSettingsAxesChecker *m_dlgSettingsAxesChecker;

  DlgSettingsColorFilter *m_dlgSettingsColorFilter;

  DlgSettingsCoords *m_dlgSettingsCoords;

  DlgSettingsCurveList *m_dlgSettingsCurveList;

  DlgSettingsCurveProperties *m_dlgSettingsCurveProperties;

  DlgSettingsDigitizeCurve *m_dlgSettingsDigitizeCurve;

  DlgSettingsExportFormat *m_dlgSettingsExportFormat;

  DlgSettingsGeneral *m_dlgSettingsGeneral;

  DlgSettingsGridDisplay *m_dlgSettingsGridDisplay;

  DlgSettingsGridRemoval *m_dlgSettingsGridRemoval;

  DlgSettingsMainWindow *m_dlgSettingsMainWindow;

  DlgSettingsPointMatch *m_dlgSettingsPointMatch;

  DlgSettingsSegments *m_dlgSettingsSegments;


  // Crash reports

  QString m_startingDocumentSnapshot; // Serialized snapshot of document at startup. Included in error report if user approves

  NetworkClient *m_networkClient;


  // Main window settings

  bool m_isGnuplot; // From command line

  MainWindowModel m_modelMainWindow; // From settings file or DlgSettingsMainWindow


  // File names to be loaded at startup. Only one is loaded into the current instance, with external instances created for the other files

  QTimer *m_timerLoadStartupFiles;

  QStringList m_loadStartupFiles;


  // Command line arguments with load startup files omitted

  QStringList m_commandLineWithoutLoadStartupFiles;


  // Ghosts that are created for seeing all coordinate systems at once, when there are multiple coordinate systems

  Ghosts *m_ghosts;


  // Timers for regression testing. Neither or one is first started by the constructor for this class, but the first timeout

  // (and all succeeding timeouts) will be from after QMainWindow::exec is called. Each timeout results in one command

  // from the command stack getting executed

  QTimer *m_timerRegressionErrorReport;

  FileCmdScript *m_fileCmdScript;

  bool m_isErrorReportRegressionTest;

  QTimer *m_timerRegressionFileCmdScript;

  QString m_regressionFile;

  QString m_startupDirectory; // Used to restore original directory just before outputing regression test results, since

                              // directory changes when settings are read, and also when files are opened or imported.

                              // Restoring the directory means relative paths in the regression scripts will work consistently


  // Grid lines

  GridLines m_gridLines;


  // Map to/from/between zoom enumerations. These eliminate the need for switch statements

  QMap<ZoomFactorInitial, ZoomFactor> m_zoomMapFromInitial;

  QMap<ZoomFactor, QAction*> m_zoomMapToAction;


  // Fitted curve. Null if not currently applicable/defined

  FittingCurve *m_fittingCurve;


  // Export the single dig file that was loaded in the command line, as enforced by parseCmdLine

  bool m_isExportOnly;


  // Extract the image from the single dig file that was loaded in the command line, as enforced by parseCmdLine

  bool m_isExtractImageOnly;

  QString m_extractImageOnlyExtension;

};


#endif // MAIN_WINDOW_H