LibrePCB

/*
 * 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_EDITABLETABLEWIDGET_H
#define LIBREPCB_EDITOR_EDITABLETABLEWIDGET_H

/*******************************************************************************
 *  Includes
 ******************************************************************************/
#include <QtCore>
#include <QtWidgets>

/*******************************************************************************
 *  Namespace / Forward Declarations
 ******************************************************************************/
namespace librepcb {
namespace editor {

/*******************************************************************************
 *  Class EditableTableWidget
 ******************************************************************************/

/**
 * @brief A QTableView subclass which adds buttons to edit the underlying model
 */
class EditableTableWidget : public QTableView {
  Q_OBJECT

  typedef void (EditableTableWidget::*Signal)(const QPersistentModelIndex&);

public:
  // Constructors / Destructor
  explicit EditableTableWidget(QWidget* parent = nullptr) noexcept;
  EditableTableWidget(const EditableTableWidget& other) = delete;
  virtual ~EditableTableWidget() noexcept;

  // Setters
  virtual void setModel(QAbstractItemModel* model) noexcept override;
  void setReadOnly(bool readOnly) noexcept;
  void setAddButtonOnLastRow(bool btn) noexcept { mAddButtonOnLastRow = btn; }
  void setShowCopyButton(bool show) noexcept { mShowCopyButton = show; }
  void setShowEditButton(bool show) noexcept { mShowEditButton = show; }
  void setShowMoveButtons(bool show) noexcept { mShowMoveButtons = show; }
  void setBrowseButtonColumn(int col) noexcept { mBrowseButtonColumn = col; }
  void setMinimumRowCount(int count) noexcept;

  // Inherited
  using QAbstractItemView::edit;  // Required to override edit() overload below.
  virtual void reset() override;

  // Operator Overloadings
  EditableTableWidget& operator=(const EditableTableWidget& rhs) = delete;

protected:
  virtual bool edit(const QModelIndex& index, EditTrigger trigger,
                    QEvent* event) override;
  virtual void currentChanged(const QModelIndex& current,
                              const QModelIndex& previous) override;
  virtual void rowsInserted(const QModelIndex& parent, int start,
                            int end) override;

signals:
  void readOnlyChanged(bool readOnly);
  void canRemoveChanged(bool canRemove);
  void currentRowChanged(int row);
  void btnAddClicked(const QPersistentModelIndex& itemIndex);
  void btnRemoveClicked(const QPersistentModelIndex& itemIndex);
  void btnCopyClicked(const QPersistentModelIndex& itemIndex);
  void btnEditClicked(const QPersistentModelIndex& itemIndex);
  void btnMoveUpClicked(const QPersistentModelIndex& itemIndex);
  void btnMoveDownClicked(const QPersistentModelIndex& itemIndex);
  void btnBrowseClicked(const QPersistentModelIndex& itemIndex);

private:
  void updateCanRemove() noexcept;
  void installButtons(int row) noexcept;
  QToolButton* createButton(const QString& objectName, const QIcon& icon,
                            const QString& text, const QString& toolTip,
                            int width, int height, Signal clickedSignal,
                            const QPersistentModelIndex& itemIndex,
                            bool doesModify, bool doesRemove) noexcept;
  void buttonClickedHandler(Signal clickedSignal,
                            const QPersistentModelIndex& itemIndex) noexcept;

  bool mAddButtonOnLastRow;
  bool mShowCopyButton;
  bool mShowEditButton;
  bool mShowMoveButtons;
  int mBrowseButtonColumn;
  int mMinimumRowCount;
  bool mCanRemove;
  bool mReadOnly;

  QScopedPointer<QAction> mActionAddRow;
  QScopedPointer<QAction> mActionRemoveRow;
  QMetaObject::Connection mRowsRemovedConnection;
};

/*******************************************************************************
 *  End of File
 ******************************************************************************/

}  // namespace editor
}  // namespace librepcb

#endif