diff options
| author | isanae <14251494+isanae@users.noreply.github.com> | 2019-05-20 18:44:41 -0400 |
|---|---|---|
| committer | isanae <14251494+isanae@users.noreply.github.com> | 2019-05-20 18:44:41 -0400 |
| commit | 0088ee963b25495e6cce790005dcf1356a73e7b8 (patch) | |
| tree | 6fed65fb7e507fb84cda2d2b0f74897010164865 /src/modinfodialog.h | |
| parent | 513eaaa3556bc08c7ac9d03944ee35deff9d7ceb (diff) | |
documented ExpanderWidget, removed checkable stuff because the state is kept internally
Diffstat (limited to 'src/modinfodialog.h')
| -rw-r--r-- | src/modinfodialog.h | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/src/modinfodialog.h b/src/modinfodialog.h index 3ce76740..dc04deb3 100644 --- a/src/modinfodialog.h +++ b/src/modinfodialog.h @@ -183,16 +183,38 @@ private: };
+/* Takes a QToolButton and a widget and creates an expandable widget.
+ **/
class ExpanderWidget
{
public:
+ /** empty expander, use set()
+ **/
ExpanderWidget();
+
+ /** see set()
+ **/
ExpanderWidget(QToolButton* button, QWidget* content);
+ /** @brief sets the button and content widgets to use
+ * the button will be given an arrow icon, clicking it will toggle the
+ * visibility of the given widget
+ * @param button the button that toggles the content
+ * @param content the widget that will be shown or hidden
+ * @param opened initial state, defaults to closed
+ **/
void set(QToolButton* button, QWidget* content, bool opened=false);
+ /** either opens or closes the expander depending on the current state
+ **/
void toggle();
+
+ /** sets the current state of the expander
+ **/
void toggle(bool b);
+
+ /** returns whether the expander is currently opened
+ **/
bool opened() const;
private:
|