- Auto expand folders in effect list when searching (1)

[kdenlive] / src / effectslistview.h

diff --git a/src/effectslistview.h b/src/effectslistview.h
index 6f17209f75369cce4eb51a8196de8312a334f49f..e83fde871d2332d656dc4b362387c5dfe93fc323 100644 (file)
--- a/src/effectslistview.h
+++ b/src/effectslistview.h
@@ -33,30 +33,56 @@ class EffectsList;
 class EffectsListWidget;
 class QTreeWidget;
 
+/**
+ * @class EffectsListView
+ * @brief Manages the controls for the treewidget containing the effects.
+ * @author Jean-Baptiste Mardelle
+ */
+
 class EffectsListView : public QWidget, public Ui::EffectList_UI
 {
     Q_OBJECT
 
 public:
     EffectsListView(QWidget *parent = 0);
+
+    /** @brief Re-initializes the list of effets. */
     void reloadEffectList();
     //void slotAddEffect(GenTime pos, int track, QString name);
 
-protected:
-    virtual void focusInEvent(QFocusEvent * event);
-
 private:
     EffectsListWidget *m_effectsList;
 
 private slots:
+    /** @brief Applies the type filter to the effect list.
+    * @param pos Index of the combo box; where 0 = All, 1 = Video, 2 = Audio, 3 = Custom */
     void filterList(int pos);
+
+    /** @brief Updates the info panel to match the selected effect. */
     void slotUpdateInfo();
+
+    /** @brief Toggles the info panel's visibility. */
     void showInfoPanel();
+
+    /** @brief Emits addEffect signal for the selected effect. */
     void slotEffectSelected();
+
+    /** @brief Removes the XML file for the selected effect.
+    *
+    * Only used for custom effects */
     void slotRemoveEffect();
+
+    /** @brief Makes sure the item fits the type filter.
+    * @param item Current item
+    * @param hidden Hidden or not
+    *
+    * This is necessary to make the search obey to the type filter.
+    * Called when the visibility of this item was changed by searching */
     void slotUpdateSearch(QTreeWidgetItem *item, bool hidden);
 
-public slots:
+    /** @brief Expands folders that match our search.
+    * @param text Current search string */
+    void slotAutoExpand(QString text);
 
 signals:
     void addEffect(const QDomElement);