From 953c06ba5976489da46f9618cfb68d77c1f99f99 Mon Sep 17 00:00:00 2001 From: Denis Rouzaud Date: Tue, 2 Jun 2015 07:40:17 +0200 Subject: [PATCH] add documentation for QgsUserInputDockWidget --- src/gui/qgsuserinputdockwidget.h | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/src/gui/qgsuserinputdockwidget.h b/src/gui/qgsuserinputdockwidget.h index 2805e3d7622..4dd065bf435 100644 --- a/src/gui/qgsuserinputdockwidget.h +++ b/src/gui/qgsuserinputdockwidget.h @@ -24,6 +24,13 @@ class QFrame; class QBoxLayout; + +/** + * @brief The QgsUserInputDockWidget class is a dock widget that shall be used to display widgets for user inputs. + * It can be used by map tools, plugins, etc. + * Several widgets can be displayed at once, they will be separated by a separator. Widgets will be either layout horizontally or vertically. + * The dock is automatically hidden if it contains no widget. + */ class GUI_EXPORT QgsUserInputDockWidget : public QDockWidget { Q_OBJECT @@ -35,6 +42,7 @@ class GUI_EXPORT QgsUserInputDockWidget : public QDockWidget void addUserInputWidget( QWidget* widget ); protected: + //! will not display the dock if it contains no widget void paintEvent( QPaintEvent *event ) override; private slots: @@ -45,8 +53,7 @@ class GUI_EXPORT QgsUserInputDockWidget : public QDockWidget void floatingChanged( bool floating ); private: - void createLayout(); - + //! change layout according to dock location void updateLayoutDirection(); // list of widget with their corresponding line separator