sharpetronics/QGIS
1
0
Fork 0
mirror of https://github.com/qgis/QGIS.git synced 2025-03-03 00:02:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for QgsUserInputDockWidget

Browse Source
This commit is contained in:
Denis Rouzaud 2015-06-02 07:40:17 +02:00
parent d94cd88122
commit 953c06ba59
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/gui/qgsuserinputdockwidget.h
View File

@ -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