controlpanel.h

Go to the documentation of this file.

/*
 * LibrePCB - Professional EDA for everyone!
 * Copyright (C) 2013 LibrePCB Developers, see AUTHORS.md for contributors.
 * https://librepcb.org/
 *
 * This program 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 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef LIBREPCB_EDITOR_CONTROLPANEL_H
#define LIBREPCB_EDITOR_CONTROLPANEL_H
 
/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <librepcb/core/fileio/filepath.h>
 
#include <QtCore>
#include <QtWidgets>
 
/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
 
class FilePath;
class Library;
class Project;
class Workspace;
 
namespace editor {
 
class FavoriteProjectsModel;
class LibraryEditor;
class LibraryManager;
class ProjectEditor;
class ProjectLibraryUpdater;
class ProjectTreeModel;
class RecentProjectsModel;
class StandardEditorCommandHandler;
 
namespace Ui {
class ControlPanel;
}
 
/*******************************************************************************
 *  Class ControlPanel
 ******************************************************************************/
 
class ControlPanel final : public QMainWindow {
  Q_OBJECT
 
  // ProjectLibraryUpdater needs access to openProject() and getOpenProject()
  friend class ProjectLibraryUpdater;
 
public:
  // Constructors / Destructor
  ControlPanel() = delete;
  ControlPanel(const ControlPanel& other) = delete;
  explicit ControlPanel(Workspace& workspace, bool fileFormatIsOutdated);
  virtual ~ControlPanel() noexcept;
 
  // Operator Overloadings
  ControlPanel& operator=(const ControlPanel& rhs) = delete;
 
public slots:
  void showControlPanel() noexcept;
  void openProjectLibraryUpdater(const FilePath& project) noexcept;
 
protected:
  // Inherited Methods
  virtual void closeEvent(QCloseEvent* event) override;
  virtual bool eventFilter(QObject* watched, QEvent* event) override;
 
private slots:
  // private slots
  void openProjectsPassedByCommandLine() noexcept;
  void openProjectPassedByOs(const QString& file, bool silent = false) noexcept;
  void projectEditorClosed() noexcept;
 
  // Actions
  void on_projectTreeView_clicked(const QModelIndex& index);
  void on_projectTreeView_doubleClicked(const QModelIndex& index);
  void on_projectTreeView_customContextMenuRequested(const QPoint& pos);
  void on_recentProjectsListView_entered(const QModelIndex& index);
  void on_favoriteProjectsListView_entered(const QModelIndex& index);
  void on_recentProjectsListView_clicked(const QModelIndex& index);
  void on_favoriteProjectsListView_clicked(const QModelIndex& index);
  void on_recentProjectsListView_customContextMenuRequested(const QPoint& pos);
  void on_favoriteProjectsListView_customContextMenuRequested(
      const QPoint& pos);
 
private:
  // General private methods
  void createActions() noexcept;
  void createMenus() noexcept;
  void saveSettings();
  void loadSettings();
  void updateDesktopIntegrationMessage() noexcept;
  void openLibraryManager() noexcept;
  void addExampleProjects() noexcept;
  void switchWorkspace() noexcept;
  void showProjectReadmeInBrowser(const FilePath& projectFilePath) noexcept;
  void removeProjectsTreeItem(const FilePath& fp) noexcept;
 
  // Project Management
 
  ProjectEditor* newProject(bool eagleImport = false,
                            FilePath parentDir = FilePath()) noexcept;
 
  ProjectEditor* openProject(FilePath filepath = FilePath()) noexcept;
 
  bool closeProject(ProjectEditor& editor, bool askForSave) noexcept;
 
  bool closeProject(const FilePath& filepath, bool askForSave) noexcept;
 
  bool closeAllProjects(bool askForSave) noexcept;
 
  ProjectEditor* getOpenProject(const FilePath& filepath) const noexcept;
 
  static bool askForRestoringBackup(const FilePath& dir);
 
  // Library Management
  void openLibraryEditor(const FilePath& libDir) noexcept;
  void libraryEditorDestroyed() noexcept;
 
  bool closeAllLibraryEditors(bool askForSave) noexcept;
 
  // Attributes
  Workspace& mWorkspace;
  QScopedPointer<Ui::ControlPanel> mUi;
  QScopedPointer<StandardEditorCommandHandler> mStandardCommandHandler;
  QScopedPointer<ProjectTreeModel> mProjectTreeModel;
  QScopedPointer<RecentProjectsModel> mRecentProjectsModel;
  QScopedPointer<FavoriteProjectsModel> mFavoriteProjectsModel;
  QScopedPointer<LibraryManager> mLibraryManager;
  QHash<QString, ProjectEditor*> mOpenProjectEditors;
  QHash<FilePath, LibraryEditor*> mOpenLibraryEditors;
  QScopedPointer<ProjectLibraryUpdater> mProjectLibraryUpdater;
 
  // Actions
  QScopedPointer<QAction> mActionLibraryManager;
  QScopedPointer<QAction> mActionWorkspaceSettings;
  QScopedPointer<QAction> mActionRescanLibraries;
  QScopedPointer<QAction> mActionSwitchWorkspace;
  QScopedPointer<QAction> mActionNewProject;
  QScopedPointer<QAction> mActionOpenProject;
  QScopedPointer<QAction> mActionCloseAllProjects;
  QScopedPointer<QAction> mActionAddExampleProjects;
  QScopedPointer<QAction> mActionImportEagleProject;
  QScopedPointer<QAction> mActionAboutLibrePcb;
  QScopedPointer<QAction> mActionAboutQt;
  QScopedPointer<QAction> mActionOnlineDocumentation;
  QScopedPointer<QAction> mActionKeyboardShortcutsReference;
  QScopedPointer<QAction> mActionWebsite;
  QScopedPointer<QAction> mActionQtQuickTest;
  QScopedPointer<QAction> mActionQuit;
};
 
/*******************************************************************************
 *  End of File
 ******************************************************************************/
 
}  // namespace editor
}  // namespace librepcb
 
#endif