qelectrotech-source-mirror/sources/qetdiagrameditor.h

/*
	Copyright 2006-2026 The QElectroTech Team
	This file is part of QElectroTech.
	
	QElectroTech is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.
	
	QElectroTech is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.
	
	You should have received a copy of the GNU General Public License
	along with QElectroTech.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef QET_DIAGRAM_EDITOR_H
#define QET_DIAGRAM_EDITOR_H

#include "SearchAndReplace/ui/searchandreplacewidget.h"
#include "qetmainwindow.h"

#include <QActionGroup>
#include <QCloseEvent>
#include <QDir>
#include <QMdiArea>
#include <QPointer>
#include <QSignalMapper>
#include <QUndoGroup>

class QToolButton;

class QMdiSubWindow;
class QETProject;
class QETResult;
class ProjectView;
class ConductorColorToolButton;
class CustomElement;
class DiagramBgColorToolButton;
class Diagram;
class DiagramView;
class Element;
class ElementsPanelWidget;
class ElementsLocation;
class RecentFiles;
class DiagramPropertiesEditorDockWidget;
class ElementsCollectionWidget;
class ElementPickerPopup;
class CommandSearchPopup;
class AutoNumberingDockWidget;
class TerminalNumberingDialog;

class KAutoSaveFile;
/**
	This class represents the main window of the QElectroTech diagram editor and,
	ipso facto, the most important part of the QElectroTech user interface.
*/
class QETDiagramEditor : public QETMainWindow
{
	Q_OBJECT

        friend class TerminalStripEditorWindow;
	
	public:
		QETDiagramEditor(
				const QStringList & = QStringList(),
				QWidget * = nullptr);
		~QETDiagramEditor() override;
		void                 closeEvent        (QCloseEvent *) override;
		QList<ProjectView *> openedProjects    () const;
		void                 addProjectView    (ProjectView *);
		bool                 openAndAddProject (const QString &, bool = true);
		QList<QString>       editedFiles       () const;
		ProjectView         *viewForFile       (const QString &) const;
		ProjectView *currentProjectView() const;
		QETProject *currentProject() const;
		void templateSaved(const ElementsLocation &location);
		bool drawGrid() const;
		void openBackupFiles (QList<KAutoSaveFile *> backup_files);

	  protected:
		bool event(QEvent *) override;
	private:
		// Declared first so it is initialised before any member whose
		// constructor may dispatch a Qt event calling event() (e.g. the
		// QActionGroup members below trigger QObject::setParent events).
		bool m_first_show = true;

		QETDiagramEditor(const QETDiagramEditor &);
		void setUpElementsPanel ();
		void setUpElementsCollectionWidget();
		void setUpUndoStack     ();
		void setUpSelectionPropertiesEditor();
		void setUpAutonumberingWidget();
		void setUpActions       ();
		void setUpToolBar       ();
		void setUpMenu          ();
		
		bool addProject(QETProject *, bool = true);
			/**
				Checked while the cable tool is about to start, when the
				project has no numbering rule for its cables. He is then
				asked whether one should be defined now (the window which
				opens goes straight to the cable page of the automatic
				numbering) or not -- and having answered no, he is not
				asked again, whatever he draws from then on. A project
				which does number its cables is never asked at all, and
				one which lost the rule again is.
				@return true when the cable tool may start.
			*/
			bool cableNumberingGate(Diagram *diagram);
		DiagramView *currentDiagramView() const;
		Element *currentElement() const;
		ProjectView *findProject(DiagramView *) const;
		ProjectView *findProject(Diagram *) const;
		ProjectView *findProject(QETProject *) const;
		ProjectView *findProject(const QString &) const;
		QMdiSubWindow *subWindowForWidget(QWidget *) const;
		void updateUsageTrackersActiveState();
		void updateWindowModifiedState();

	signals:
		void syncElementsPanel();

	public slots:
		void save();
		void saveAs();
		bool newProject();
		bool openProject();
		bool openRecentFile(const QString &);
		bool closeProject(ProjectView *);
		bool closeProject(QETProject *);
		void zoomGroupTriggered      (QAction *action);
		void selectGroupTriggered    (QAction *action);
		void addItemGroupTriggered   (QAction *action);
		void selectionGroupTriggered (QAction *action);
		void alignGroupTriggered     (QAction *action);
		void rowColumnGroupTriggered (QAction *action);
		void slot_updateActions();
		void slot_updateUndoStack();
		void slot_updateModeActions();
		void slot_updateComplexActions();
		void slot_updatePasteAction();
		void slot_updateWindowsMenu();
		void slot_updateAutoNumDock();
		void insertElementFromCollection(const ElementsLocation &location);
		void insertLastElement();
		void rememberPlacedElement(const ElementsLocation &location);
		void showElementPicker();
		void showShortcutBar();
		bool repeatLastCommand();
		void generateTerminalBlock();
		void setWindowedMode();
		void setTabbedMode();
		void readSettings();
		void readSettingsState();
		void writeSettings();
		void activateProject(QETProject *);
		void activateProject(ProjectView *);
		void activateWidget(QWidget *);
		void projectWasClosed(ProjectView *);
		void editProjectProperties(ProjectView *);
		void editProjectProperties(QETProject *);
		void slot_terminalNumbering();
		void slot_cableNumbering();
		void slot_reloadElementDrawings();
#ifdef QET_HAS_SCRIPTING
		void slot_runScript();
#endif
		void editDiagramProperties(DiagramView *);
		void editDiagramProperties(Diagram *);
		void addDiagramToProject(QETProject *);
		void addDiagramToProjectAt(QETProject *, int);
		void removeDiagram(Diagram *);
		void removeDiagrams(const QList<Diagram *> &diagrams);
		void removeDiagramFromProject();
		void moveDiagramUp(const QList<Diagram *> &diagrams);
		void moveDiagramDown(const QList<Diagram *> &diagrams);
		void moveDiagramUpTop(const QList<Diagram *> &diagrams);
		void moveDiagramUpx10(const QList<Diagram *> &diagrams);
		void moveDiagramDownx10(const QList<Diagram *> &diagrams);
		void moveDiagramUpx100(const QList<Diagram *> &diagrams);
		void moveDiagramDownx100(const QList<Diagram *> &diagrams);
		void reloadOldElementPanel();
		void diagramWasAdded(DiagramView *);
		void findElementInPanel(const ElementsLocation &);
		void showError(const QETResult &);
		void showError(const QString &);
		void subWindowActivated(QMdiSubWindow *subWindows);

	private slots:
		void updateTextGridButton();
		void selectionChanged();

	public:
		QAction
		*m_edit_diagram_properties, ///< Show a dialog to edit diagram properties
		*m_conductor_reset,         ///< Reset paths of selected conductors
		*m_cut,                     ///< Cut selection to clipboard
		*m_copy,                    ///< Copy selection to clipboard
		*m_insert_last_element = nullptr; ///< Place the last placed element again
		
		QActionGroup
		m_row_column_actions_group, /// Action related to add/remove rows/column in diagram
		m_selection_actions_group,  ///Action related to edit a selected item
		m_align_actions_group,      ///Action related to align the selected items
		*m_depth_action_group = nullptr;

		QMenu
		*m_add_item_menu = nullptr,   ///< Submenu of m_add_item_actions_group
		*m_align_menu = nullptr,      ///< Submenu of m_align_actions_group
		*m_row_column_menu = nullptr; ///< Submenu of m_row_column_actions_group
	
	private:
		QActionGroup
		*grp_visu_sel,            ///< Action group for visualisation vs edition mode
		*m_group_view_mode,       ///< Action group for project
		m_add_item_actions_group, ///Action related to adding (add text image shape...)
		m_zoom_actions_group,     ///Action related to zoom for diagram
		m_select_actions_group,   ///Action related to global selections
		m_file_actions_group;     ///Actions related to file (open, close, save...)
		
		QAction
		*m_tabbed_view_mode,		///< Display projects as tabs
		*m_windowed_view_mode,		///< Display projects as windows
		*m_mode_selection,		///< Set edition mode
		*m_mode_visualise,		///< Set visualisation mode
		*m_export_to_images,		///< Export diagrams of the current project as imagess
		*m_export_to_pdf = nullptr, ///< Export project to pdf.
		*m_print,			///< Print diagrams of the current project
		*m_quit_editor,			///< Quit the diagram editor
		*undo,				///< Cancel the latest action
		*redo,				///< Redo the latest cancelled operation
		*m_paste,			///< Paste clipboard content on the current diagram
		*m_duplicate,			///< Copy selection, offset by the configured step (#991)
		*m_configure_duplicate,		///< Reopen the duplicate offset/direction dialog (#991)
		*m_auto_conductor,		///< Enable/Disable the use of auto conductor
		*m_auto_break_conductor,	///< Enable/Disable the use of auto break conductor
		*m_add_cable = nullptr,		///< Draw the trunk line of a cable
		*m_draw_grid,			///< Switch the background grid display or not
		*m_draw_guides = nullptr,	///< Switch the custom guides display or not
		*m_cell_rulers = nullptr,	///< Keep the folio column/row headers in sight or not
		*m_cell_lines = nullptr,	///< Draw the folio column/row limits across the drawing or not
		*m_project_edit_properties,	///< Edit the properties of the current project.
		*m_project_add_diagram,		///< Add a diagram to the current project.
		*m_remove_diagram_from_project,	///< Delete a diagram from the current project
		*m_clean_project,		///< Clean the content of the current project by removing useless items
		*m_csv_export,			///< generate nomenclature
		*m_add_nomenclature,		///< Add nomenclature graphics item;
		*m_add_summary,			///<Add summary graphics item
		*m_terminal_strip_dialog = nullptr, ///<Launch terminal strip dialog
		*m_project_terminalBloc,	///< generate terminal block
		*m_project_export_conductor_num,///<Export the wire num to csv
		*m_project_export_wiring_list, ///< Action to export the wiring list
		*m_project_wiring_list_view,   ///< Action to show the wiring list read from the project database
		*m_terminal_numbering,         ///< Action to launch terminal numbering
		*m_cable_numbering,            ///< Action to open the cable numbering window (rule + numbering of every cable)
		*m_add_cable_list,             ///< Add a cable list graphics item
		*m_export_cable_list,          ///< Export the cable list of the project to CSV
		*m_reload_element_drawings,    ///< Action to redraw every placed element from its current definition
#ifdef QET_HAS_SCRIPTING
		*m_run_script,                 ///< Action to run a JavaScript macro against the current project
#endif
		*m_export_project_db,		///Export to file the internal database of the current project
		*m_tile_window,			///< Show MDI subwindows as tile
		*m_cascade_window,		///< Show MDI subwindows as cascade
		*m_previous_window,		///< Switch to the previous document
		*m_next_window,			///< Switch to the next document
		*m_edit_selection,		///< To edit selected item
		*m_delete_selection,		///< Delete selection
		*m_rotate_selection,		///< Rotate selected elements and text items by 90 degrees
		*m_rotate_group_selection = nullptr, ///< Rotate the selection as a whole around its shared center, instead of each item in place
		*m_rotate_texts,		///< Direct selected text items to a specific angle
		*m_find_element,		///< Find the selected element in the panel
		*m_group_selected_texts = nullptr,
		*m_group_selection = nullptr,   ///< Group the selected items (#1070)
		*m_ungroup_selection = nullptr, ///< Ungroup the selected groups
		*m_close_file,			///< Close current project file
		*m_save_file,			///< Save current project
		*m_save_file_as,		///< Save current project as a specific file
		*m_find = nullptr,
		*m_jump_to_element = nullptr;	///< Open the "jump to element" quick-open popup

		///< One-click conductor colour, in the "Schéma" toolbar
		ConductorColorToolButton *m_conductor_color_button = nullptr;
		///< Diagram background color picker, in the "Affichage" toolbar
		DiagramBgColorToolButton *m_background_color_button = nullptr;
		QMenu *m_text_grid_menu = nullptr;		///< Snap step used when dragging texts
		QToolButton *m_text_grid_button = nullptr;

		QList <QAction *> m_zoom_action_toolBar; ///Only zoom action must displayed in the toolbar

		void removeDiagramSilent(Diagram *diagram);

		QMdiArea m_workspace;
		QSignalMapper windowMapper;
		QDir open_dialog_dir; /// Directory to use for file dialogs such as File > save

		QDockWidget
		*qdw_pa, /// Dock for the elements panel
		*m_qdw_elmt_collection,
		*qdw_undo; /// Dock for the undo list

		ElementPickerPopup *elementPicker();
		QAction *m_show_element_picker = nullptr;
		QAction *m_show_shortcut_bar = nullptr;
		QAction *m_repeat_last_command = nullptr;
			/// What Enter on the folio repeats
		QPointer<QAction> m_last_command;
		void setLastCommand(QAction *action);
		ElementPickerPopup *m_element_picker = nullptr; ///< Built on first use
		QAction *m_command_search = nullptr;
		CommandSearchPopup *m_command_search_popup = nullptr; ///< Built on first use
		ElementsCollectionWidget *m_element_collection_widget;
			/// Last element placed from the collection, for "insert last"
		ElementsLocation m_last_inserted_element;
			
		DiagramPropertiesEditorDockWidget *m_selection_properties_editor;
			/// Elements panel
		ElementsPanelWidget *pa;
		QMenu *windows_menu;
		
		QToolBar
		*main_tool_bar       = nullptr,
		*view_tool_bar       = nullptr,
		*diagram_tool_bar    = nullptr,
		*m_add_item_tool_bar = nullptr,
		*m_depth_tool_bar    = nullptr;
		
		QUndoGroup undo_group;
		AutoNumberingDockWidget *m_autonumbering_dock;
		int activeSubWindowIndex;
		SearchAndReplaceWidget m_search_and_replace_widget;
};
#endif