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

homogenize doxygen comments

Browse Source
This commit is contained in:
Alexander Bruy 2017-04-07 11:06:24 +03:00
parent 8b7a6b80a7
commit 22ea3ac48f
2 changed files with 57 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
python/gui/qgscheckablecombobox.sip
View File

@ -26,66 +26,66 @@ class QgsCheckableComboBox : QComboBox
QgsCheckableComboBox( QWidget *parent = 0 ); QgsCheckableComboBox( QWidget *parent = 0 );
%Docstring %Docstring
Constructor for QgsCheckableComboBox. Constructor for QgsCheckableComboBox.
@param parent parent object \param parent parent object
%End %End
QString separator() const; QString separator() const;
%Docstring %Docstring
Returns separator used to separate items in the display text. Returns separator used to separate items in the display text.
@see setSeparator() \see setSeparator()
%End %End
void setSeparator( const QString &separator ); void setSeparator( const QString &separator );
%Docstring %Docstring
Set separator used to separate items in the display text. Set separator used to separate items in the display text.
@param separator separator to use \param separator separator to use
@see separator() \see separator()
%End %End
QString defaultText() const; QString defaultText() const;
%Docstring %Docstring
Returns default text which will be displayed in the widget Returns default text which will be displayed in the widget
when no items selected. when no items selected.
@see setDefaultText() \see setDefaultText()
%End %End
void setDefaultText( const QString &text ); void setDefaultText( const QString &text );
%Docstring %Docstring
Set default text which will be displayed in the widget when Set default text which will be displayed in the widget when
no items selected. no items selected.
@param text default text \param text default text
@see defaultText() \see defaultText()
%End %End
QStringList checkedItems() const; QStringList checkedItems() const;
%Docstring %Docstring
Returns currently checked items. Returns currently checked items.
@see setCheckedItems() \see setCheckedItems()
%End %End
Qt::CheckState itemCheckState( int index ) const; Qt::CheckState itemCheckState( int index ) const;
%Docstring %Docstring
Returns the checked state of the item identified by index Returns the checked state of the item identified by index
@param index item index \param index item index
@see setItemCheckState() \see setItemCheckState()
@see toggleItemCheckState() \see toggleItemCheckState()
%End %End
void setItemCheckState( int index, Qt::CheckState state ); void setItemCheckState( int index, Qt::CheckState state );
%Docstring %Docstring
Sets the item check state to state Sets the item check state to state
@param index item index \param index item index
@param state check state \param state check state
@see itemCheckState() \see itemCheckState()
@see toggleItemCheckState() \see toggleItemCheckState()
%End %End
void toggleItemCheckState( int index ); void toggleItemCheckState( int index );
%Docstring %Docstring
Toggles the item check state Toggles the item check state
@param index item index \param index item index
@see itemCheckState() \see itemCheckState()
@see setItemCheckState() \see setItemCheckState()
%End %End
virtual void hidePopup(); virtual void hidePopup();
@ -111,8 +111,8 @@ class QgsCheckableComboBox : QComboBox
void setCheckedItems( const QStringList &items ); void setCheckedItems( const QStringList &items );
%Docstring %Docstring
Set items which should be checked/selected. Set items which should be checked/selected.
@param items items to select \param items items to select
@see checkedItems() \see checkedItems()
%End %End
protected: protected:

74
src/gui/qgscheckablecombobox.h
View File

@ -31,8 +31,8 @@ class QEvent;
* \ingroup gui * \ingroup gui
* QStandardItemModel subclass which makes all items checkable * QStandardItemModel subclass which makes all items checkable
* by default. * by default.
* @note added in QGIS 3.0 * \note added in QGIS 3.0
* @note not available in Python bindings * \note not available in Python bindings
**/ **/
#ifndef SIP_RUN #ifndef SIP_RUN
class QgsCheckableItemModel : public QStandardItemModel class QgsCheckableItemModel : public QStandardItemModel
@ -42,29 +42,29 @@ class QgsCheckableItemModel : public QStandardItemModel
public: public:
/** Constructor for QgsCheckableItemModel. /** Constructor for QgsCheckableItemModel.
* @param parent parent object * \param parent parent object
*/ */
QgsCheckableItemModel( QObject *parent = nullptr ); QgsCheckableItemModel( QObject *parent = nullptr );
/** Returns a combination of the item flags: items are enabled /** Returns a combination of the item flags: items are enabled
* (ItemIsEnabled), selectable (ItemIsSelectable) and checkable * (ItemIsEnabled), selectable (ItemIsSelectable) and checkable
* (ItemIsUserCheckable). * (ItemIsUserCheckable).
* @param index item index * \param index item index
*/ */
virtual Qt::ItemFlags flags( const QModelIndex &index ) const; virtual Qt::ItemFlags flags( const QModelIndex &index ) const;
/** Returns the data stored under the given role for the item /** Returns the data stored under the given role for the item
* referred to by the index. * referred to by the index.
* @param index item index * \param index item index
* @param role data role * \param role data role
*/ */
virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const; virtual QVariant data( const QModelIndex &index, int role = Qt::DisplayRole ) const;
/** Sets the role data for the item at index to value. /** Sets the role data for the item at index to value.
* @param index item index * \param index item index
* @param value data value * \param value data value
* @param role data role * \param role data role
* @returns true on success, false otherwise * \returns true on success, false otherwise
*/ */
virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole ); virtual bool setData( const QModelIndex &index, const QVariant &value, int role = Qt::EditRole );
@ -80,8 +80,8 @@ class QgsCheckableItemModel : public QStandardItemModel
* \ingroup gui * \ingroup gui
* QStyledItemDelegate subclass for QgsCheckableComboBox. Needed for * QStyledItemDelegate subclass for QgsCheckableComboBox. Needed for
* correct drawing of the checkable items on Mac and GTK. * correct drawing of the checkable items on Mac and GTK.
* @note added in QGIS 3.0 * \note added in QGIS 3.0
* @note not available in Python bindings * \note not available in Python bindings
**/ **/
class QgsCheckBoxDelegate : public QStyledItemDelegate class QgsCheckBoxDelegate : public QStyledItemDelegate
@ -91,15 +91,15 @@ class QgsCheckBoxDelegate : public QStyledItemDelegate
public: public:
/** Constructor for QgsCheckBoxDelegate. /** Constructor for QgsCheckBoxDelegate.
* @param parent parent object * \param parent parent object
*/ */
QgsCheckBoxDelegate( QObject *parent = nullptr ); QgsCheckBoxDelegate( QObject *parent = nullptr );
/** Renders the delegate using the given painter and style option /** Renders the delegate using the given painter and style option
* for the item specified by index. * for the item specified by index.
* @param painter painter to use * \param painter painter to use
* @param option style option * \param option style option
* @param index item index * \param index item index
*/ */
virtual void paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const; virtual void paint( QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index ) const;
}; };
@ -108,7 +108,7 @@ class QgsCheckBoxDelegate : public QStyledItemDelegate
/** \class QgsCheckableComboBox /** \class QgsCheckableComboBox
* \ingroup gui * \ingroup gui
* QComboBox subclass which allows selecting multiple items. * QComboBox subclass which allows selecting multiple items.
* @note added in QGIS 3.0 * \note added in QGIS 3.0
**/ **/
class GUI_EXPORT QgsCheckableComboBox : public QComboBox class GUI_EXPORT QgsCheckableComboBox : public QComboBox
@ -122,58 +122,58 @@ class GUI_EXPORT QgsCheckableComboBox : public QComboBox
public: public:
/** Constructor for QgsCheckableComboBox. /** Constructor for QgsCheckableComboBox.
* @param parent parent object * \param parent parent object
*/ */
QgsCheckableComboBox( QWidget *parent = nullptr ); QgsCheckableComboBox( QWidget *parent = nullptr );
/** Returns separator used to separate items in the display text. /** Returns separator used to separate items in the display text.
* @see setSeparator() * \see setSeparator()
*/ */
QString separator() const; QString separator() const;
/** Set separator used to separate items in the display text. /** Set separator used to separate items in the display text.
* @param separator separator to use * \param separator separator to use
* @see separator() * \see separator()
*/ */
void setSeparator( const QString &separator ); void setSeparator( const QString &separator );
/** Returns default text which will be displayed in the widget /** Returns default text which will be displayed in the widget
* when no items selected. * when no items selected.
* @see setDefaultText() * \see setDefaultText()
*/ */
QString defaultText() const; QString defaultText() const;
/** Set default text which will be displayed in the widget when /** Set default text which will be displayed in the widget when
* no items selected. * no items selected.
* @param text default text * \param text default text
* @see defaultText() * \see defaultText()
*/ */
void setDefaultText( const QString &text ); void setDefaultText( const QString &text );
/** Returns currently checked items. /** Returns currently checked items.
* @see setCheckedItems() * \see setCheckedItems()
*/ */
QStringList checkedItems() const; QStringList checkedItems() const;
/** Returns the checked state of the item identified by index /** Returns the checked state of the item identified by index
* @param index item index * \param index item index
* @see setItemCheckState() * \see setItemCheckState()
* @see toggleItemCheckState() * \see toggleItemCheckState()
*/ */
Qt::CheckState itemCheckState( int index ) const; Qt::CheckState itemCheckState( int index ) const;
/** Sets the item check state to state /** Sets the item check state to state
* @param index item index * \param index item index
* @param state check state * \param state check state
* @see itemCheckState() * \see itemCheckState()
* @see toggleItemCheckState() * \see toggleItemCheckState()
*/ */
void setItemCheckState( int index, Qt::CheckState state ); void setItemCheckState( int index, Qt::CheckState state );
/** Toggles the item check state /** Toggles the item check state
* @param index item index * \param index item index
* @see itemCheckState() * \see itemCheckState()
* @see setItemCheckState() * \see setItemCheckState()
*/ */
void toggleItemCheckState( int index ); void toggleItemCheckState( int index );
@ -195,8 +195,8 @@ class GUI_EXPORT QgsCheckableComboBox : public QComboBox
public slots: public slots:
/** Set items which should be checked/selected. /** Set items which should be checked/selected.
* @param items items to select * \param items items to select
* @see checkedItems() * \see checkedItems()
*/ */
void setCheckedItems( const QStringList &items ); void setCheckedItems( const QStringList &items );