Discord-like Quick Switcher (#1588)

* Proof of Concept for Quick Switcher * Fix crash when suggestions are empty * QuickSwitcher: Use tab name instead of a single channel * Rebase later * Add missing include for <functional> * Move QuickSwitcher related classes into own subfolder * Refactor switcher list items Now, items are responsible for taking the right action when selected in the switcher list. This should allow for more focused code and responsibilities. * Add note about memory management * Add option to open channel in a new tab * Add support for using the mouse * Spawn switcher popup in the middle of the window Works reliably on i3 at least. Might need some additional testing on other WMs (and especially on Windows!). * Add some icons for switcher items Note that the final design of the list is not final but I do plan to incorporate these in the future. * Set Qt::Dialog window flag on switcher popup Prevents tiling window managers like i3 from trying to tile the window. * Rename "SwitcherItem" to "AbstractSwitcherItem" * Add comments about what items are inserted * Use custom model and view Still missing: Currently selected item is not highlighted yet. You can move between selected items with tab and arrow keys though. * Add helper function to convert QVariant to AbstractSwitcherItem * * Remove useless constant * Highlight currently selected switcher item * Use a different method for centering QuickSwitcherPopup window * QuickSwitcherModel: Add documentation * Add default parameter to QuickSwitcherModel::rowCount * QuickSwitcherPopup: Add comments * Remove outdated TODO * QuickSwitcherModel: Init vector with default capacity * Remove outdated comment * Add comment about 0 ms timeout interval * NewTabItem: Simplify interface * Only fetch opened splits once This is better than the prior approach since opened splits cannot change anyways while the switcher is open. * Use SplitContainer to pass information instead of custom type * Allow searching for tab titles as well Before this commit, only channel names could be searched. * Refactor switcher item interface to be more flexible Also show tab name and channel name in the switcher list. * Add documentation for AbstractSwitcherItem * Add documentation for NewTabItem * Add comments about {begin,end}{Insert,Remove}Rows * Remove unused method * Replace magic size with named constant * Add change log entry Co-authored-by: fourtf <tf.four@gmail.com>
2020-08-13 19:25:51 +02:00
parent ce57ad9b0d
commit a9080ceb3c
20 changed files with 927 additions and 11 deletions
@@ -0,0 +1,59 @@
+#pragma once
+
+#include "widgets/dialogs/switcher/AbstractSwitcherItem.hpp"
+
+namespace chatterino {
+
+class QuickSwitcherModel : public QAbstractListModel
+{
+public:
+    QuickSwitcherModel(QWidget *parent = nullptr);
+    ~QuickSwitcherModel();
+
+    /**
+     * @brief   Reimplements QAbstractItemModel::rowCount.
+     *
+     * @return  number of items currrently present in this model
+     */
+    int rowCount(const QModelIndex &parent = QModelIndex()) const;
+
+    /**
+     * @brief   Reimplements QAbstractItemModel::data. Currently, the role parameter
+     *          is not used and an AbstractSwitcherItem * is always returned.
+     *
+     * @param   index   index of item to fetch data from
+     * @param   role    (not used)
+     *
+     * @return  AbstractSwitcherItem * (wrapped as QVariant) at index
+     */
+    QVariant data(const QModelIndex &index, int role) const;
+
+    /**
+     * @brief   Add an item to this QuickSwitcherModel. It will be displayed in
+     *          attached views.
+     *
+     *          NOTE: The model will take ownership of the pointer. In particular,
+     *          the same item should not be passed to multiple QuickSwitcherModels.
+     *
+     * @param   item    item to add to the model
+     */
+    void addItem(AbstractSwitcherItem *item);
+
+    /**
+     * @brief   Clears this QuickSwitcherModel of all items. This will delete all
+     *          AbstractSwitcherItems added after the last invokation of
+     *          QuickSwitcherModel::clear (and invalidate their pointers).
+     */
+    void clear();
+
+private:
+    /*
+     * On my system, the default QVector capacity is 0. 20 is an attempt at preventing
+     * frequent reallocations. The number is not backed by any user data but rather a
+     * guess at how many switcher items are probably going to be added.
+     */
+    static constexpr int INITIAL_ITEMS_SIZE = 20;
+
+    QVector<AbstractSwitcherItem *> items_;
+};
+}  // namespace chatterino