Skip to content
Permalink
Browse files

fix doxygen

  • Loading branch information
3nids committed Feb 4, 2018
1 parent a09b9e7 commit 1a117cf080044522e0898085fb5d7371812c1521
@@ -24,7 +24,14 @@ This uses stylesheets.
#include "qgsoptionsdialoghighlightwidget.h"
%End
public:

static QgsOptionsDialogHighlightWidget *createWidget( QWidget *widget ) /Factory/;
%Docstring
create a highlight widget implementation for the proper widget type.
For instance a QgsOptionsDialogHighlightButton for button.
@return a QgsOptionsDialogHighlightWidget or a None if there is no implementation
for the given widget.
%End

bool isValid();
%Docstring
@@ -17,6 +17,8 @@ class QgsOptionsDialogHighlightLabel : QgsOptionsDialogHighlightWidget
%Docstring
A highlight widget for labels.
This is used to search and highlight text in QgsOptionsDialogBase implementations.

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -38,6 +40,8 @@ class QgsOptionsDialogHighlightCheckBox : QgsOptionsDialogHighlightWidget
%Docstring
A highlight widget for checkboxes.
This is used to search and highlight text in QgsOptionsDialogBase implementations.

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -59,6 +63,8 @@ class QgsOptionsDialogHighlightButton : QgsOptionsDialogHighlightWidget
%Docstring
A highlight widget for buttons.
This is used to search and highlight text in QgsOptionsDialogBase implementations.

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -80,6 +86,8 @@ class QgsOptionsDialogHighlightGroupBox : QgsOptionsDialogHighlightWidget
%Docstring
A highlight widget for group boxes.
This is used to search and highlight text in QgsOptionsDialogBase implementations.

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -103,6 +111,8 @@ A highlight widget for trees.
This is used to search and highlight text in QgsOptionsDialogBase implementations.
Highlighting is only available for tree widgets only while searching can be performed
in any tree view or inherited class.

.. versionadded:: 3.0
%End

%TypeHeaderCode
@@ -25,7 +25,7 @@

/**
* \ingroup gui
* \class QgsSearchHighlightOptionWidget
* \class QgsOptionsDialogHighlightWidget
* Container for a widget to be used to search text in the option dialog
* If the widget type is handled, it is valid.
* It can perform a text search in the widget and highlight it in case of success.
@@ -37,6 +37,13 @@ class GUI_EXPORT QgsOptionsDialogHighlightWidget : public QObject

Q_OBJECT
public:

/**
* create a highlight widget implementation for the proper widget type.
* For instance a QgsOptionsDialogHighlightButton for button.
* @return a QgsOptionsDialogHighlightWidget or a nullptr if there is no implementation
* for the given widget.
*/
static QgsOptionsDialogHighlightWidget *createWidget( QWidget *widget ) SIP_FACTORY;

/**
@@ -38,6 +38,7 @@ class QTreeWidgetItem;
* \class QgsOptionsDialogHighlightLabel
* A highlight widget for labels.
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
* \since QGIS 3.0
*/
class GUI_EXPORT QgsOptionsDialogHighlightLabel : public QgsOptionsDialogHighlightWidget
{
@@ -58,6 +59,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightLabel : public QgsOptionsDialogHighlig
* \class QgsOptionsDialogHighlightCheckBox
* A highlight widget for checkboxes.
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
* \since QGIS 3.0
*/
class GUI_EXPORT QgsOptionsDialogHighlightCheckBox : public QgsOptionsDialogHighlightWidget
{
@@ -78,6 +80,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightCheckBox : public QgsOptionsDialogHigh
* \class QgsOptionsDialogHighlightButton
* A highlight widget for buttons.
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
* \since QGIS 3.0
*/
class GUI_EXPORT QgsOptionsDialogHighlightButton : public QgsOptionsDialogHighlightWidget
{
@@ -98,6 +101,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightButton : public QgsOptionsDialogHighli
* \class QgsOptionsDialogHighlightGroupBox
* A highlight widget for group boxes.
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
* \since QGIS 3.0
*/
class GUI_EXPORT QgsOptionsDialogHighlightGroupBox : public QgsOptionsDialogHighlightWidget
{
@@ -120,6 +124,7 @@ class GUI_EXPORT QgsOptionsDialogHighlightGroupBox : public QgsOptionsDialogHigh
* This is used to search and highlight text in QgsOptionsDialogBase implementations.
* Highlighting is only available for tree widgets only while searching can be performed
* in any tree view or inherited class.
* \since QGIS 3.0
*/
class GUI_EXPORT QgsOptionsDialogHighlightTree : public QgsOptionsDialogHighlightWidget
{

0 comments on commit 1a117cf

Please sign in to comment.
You can’t perform that action at this time.