File indexing completed on 2024-05-19 16:14:57

 /*
     SPDX-FileCopyrightText: 2008-2018 Thomas Baumgart <tbaumgart@kde.org>
     SPDX-FileCopyrightText: 2017-2018 Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.com>
     SPDX-License-Identifier: GPL-2.0-or-later
 */
 
 #ifndef KMYMONEYSPLITTABLE_H
 #define KMYMONEYSPLITTABLE_H
 
 // ----------------------------------------------------------------------------
 // QT Includes
 
 #include <QTableWidget>
 
 // ----------------------------------------------------------------------------
 // KDE Includes
 
 // ----------------------------------------------------------------------------
 // Project Includes
 
 class KMyMoneyCategory;
 class MyMoneyMoney;
 class MyMoneySplit;
 class MyMoneyTransaction;
 class MyMoneyAccount;
 class KTagContainer;
 
 template <class Key, class Value> class QMap;
 
 /**
   * @author Thomas Baumgart
   */
 class KMyMoneySplitTablePrivate;
 class KMyMoneySplitTable : public QTableWidget
 {
     Q_OBJECT
     Q_DISABLE_COPY(KMyMoneySplitTable)
 public:
     explicit KMyMoneySplitTable(QWidget *parent = nullptr);
     ~KMyMoneySplitTable();
 
     /**
       * This method is used to load the widget with the information about
       * the transaction @p t. The split referencing the account @p acc is
       * not shown in the widget.
       *
       * @param t reference to transaction to be shown/modified
       * @param s reference to split that is to be hidden
       * @param acc reference to account
       */
     void setTransaction(const MyMoneyTransaction& t, const MyMoneySplit& s, const MyMoneyAccount& acc);
 
     /**
       * This method is used to retrieve the transaction from the widget.
       */
     MyMoneyTransaction transaction() const;
 
     /**
       * Returns a list of MyMoneySplit objects. It contains all but the one
       * referencing the account passed in setTransaction().
       *
       * @param t reference to transaction
       * @return list of splits
       */
     QList<MyMoneySplit> getSplits(const MyMoneyTransaction& t) const;
 
     void setup(const QMap<QString, MyMoneyMoney>& priceInfo, int precision);
 
     int currentRow() const;
 
     /**
      * Setting @a readOnly to @c true forces the object into readonly mode.
      * It does not allow to modify any information.
      */
     void setReadOnlyMode(bool readOnly);
 
 protected:
     void mousePressEvent(QMouseEvent* e) override;
     void mouseReleaseEvent(QMouseEvent* e) override;
     void mouseDoubleClickEvent(QMouseEvent* e) override;
     bool eventFilter(QObject *o, QEvent *e) override;
 
     void resizeEvent(QResizeEvent*) override;
     KMyMoneyCategory* createEditWidgets(bool setFocus);
     void destroyEditWidgets();
     void destroyEditWidget(int r, int c);
 
     /**
       * This method handles the focus of the keyboard. When in edit mode
       * (m_editCategory widget is visible) the keyboard focus is handled
       * according to the widgets that are referenced in m_tabOrderWidgets.
       * If not in edit mode, the base class functionality is provided.
       *
       * @param next true if forward-tab, false if backward-tab was
       *             pressed by the user
       */
     bool focusNextPrevChild(bool next) override;
     void addToTabOrder(QWidget* w);
 
     void updateTransactionTableSize();
 
     /**
       * This method returns the current state of the inline editing mode
       *
       * @return true if inline edit mode is on, false otherwise
       */
     bool isEditMode() const;
 
     /**
       * This method returns true if the currently edited split is valid
       * and can be entered.
       *
       * @return true if the split can be entered, false otherwise
       */
     bool isEditSplitValid() const;
 
     void endEdit(bool keyboardDriven, bool setFocusToNextRow = true);
 
 public Q_SLOTS:
     /** No descriptions */
     virtual void setRowCount(int r);
 
     void selectRow(int row);
 
     void slotStartEdit();
     void slotEndEdit();
     void slotEndEditKeyboard();
     void slotDeleteSplit();
     void slotCancelEdit();
     void slotDuplicateSplit();
 
 protected Q_SLOTS:
     /// move the focus to the selected @p row.
     void slotSetFocus(const QModelIndex& index);
     void slotSetFocus(const QModelIndex& index, int button);
 
     /**
       * Calling this slot refills the widget with the data
       * passed in the argument @p t.
       *
       * @param t reference to transaction data
       */
     void slotUpdateData(const MyMoneyTransaction& t);
 
     void slotLoadEditWidgets();
 
 Q_SIGNALS:
     /**
       * This signal is emitted whenever the widget goes into edit mode.
       */
     void editStarted();
 
     /**
       * This signal is emitted whenever the widget ends edit mode.
       */
     void editFinished();
 
     /**
       * This signal is emitted whenever the return key is pressed
       * and the widget is not in edit mode.
       */
     void escapePressed();
 
     /**
       * This signal is emitted whenever the return key is pressed
       * and the widget is not in edit mode.
       */
     void returnPressed();
 
     /**
       * This signal is emitted whenever the transaction data has been changed
       *
       * @param t modified transaction data
       */
     void transactionChanged(const MyMoneyTransaction& t);
 
     /**
       * This signal is sent out, when a new category needs to be created
       * @sa KMyMoneyCombo::createItem()
       *
       * @param txt The name of the category to be created
       * @param id A connected slot should store the id of the created object in this variable
       */
     void createCategory(const QString& txt, QString& id);
 
     /**
       * This signal is sent out, when a new tag needs to be created
       * @sa KMyMoneyCombo::createItem()
       *
       * @param txt The name of the tag to be created
       * @param id A connected slot should store the id of the created object in this variable
       */
     void createTag(const QString& txt, QString& id);
 
     /**
       * Signal is emitted, if any of the widgets enters (@a state equals @a true)
       *  or leaves (@a state equals @a false) object creation mode.
       *
       * @param state Enter (@a true) or leave (@a false) object creation
       */
     void objectCreation(bool state);
 
 private:
     KMyMoneySplitTablePrivate * const d_ptr;
     Q_DECLARE_PRIVATE(KMyMoneySplitTable)
 };
 
 #endif