documentation and sip coverage

pierstitus · nyalldawson · commit 2556c7ce9498 · 2016-06-02T15:54:39.000+10:00
diff --git a/python/gui/raster/qgsrasterminmaxwidget.sip b/python/gui/raster/qgsrasterminmaxwidget.sip
@@ -11,6 +11,9 @@ class QgsRasterMinMaxWidget: QWidget
 
     void setBands( const QList<int> & theBands );
 
+    QgsRectangle extent();
+    int sampleSize();
+
     // Load programmaticaly with current values
     void load();
 
diff --git a/python/gui/raster/qgssinglebandpseudocolorrendererwidget.sip b/python/gui/raster/qgssinglebandpseudocolorrendererwidget.sip
@@ -9,6 +9,7 @@ class QgsSingleBandPseudoColorRendererWidget : QgsRasterRendererWidget
     {
       Continuous,    // Using breaks from color palette
       EqualInterval,
+      Quantile,
     };
 
     QgsSingleBandPseudoColorRendererWidget( QgsRasterLayer* layer, const QgsRectangle &extent = QgsRectangle() );
@@ -23,3 +24,17 @@ class QgsSingleBandPseudoColorRendererWidget : QgsRasterRendererWidget
     void loadMinMax( int theBandNo, double theMin, double theMax, int theOrigin );
 
 };
+
+class QgsTreeWidgetItem: QObject, QTreeWidgetItem
+{
+%TypeHeaderCode
+#include <qgssinglebandpseudocolorrendererwidget.h>
+%End
+  public:
+    explicit QgsTreeWidgetItem( QTreeWidget * parent, int type = Type );
+    virtual void setData( int column, int role, const QVariant & value );
+    virtual bool operator< ( const QTreeWidgetItem & other ) const;
+
+  signals:
+    void itemEdited( QTreeWidgetItem* item, int column );
+};
diff --git a/src/gui/raster/qgsrasterminmaxwidget.h b/src/gui/raster/qgsrasterminmaxwidget.h
@@ -32,8 +32,10 @@ class GUI_EXPORT QgsRasterMinMaxWidget: public QWidget, private Ui::QgsRasterMin
     void setExtent( const QgsRectangle & theExtent ) { mExtent = theExtent; }
 
     void setBands( const QList<int> & theBands ) { mBands = theBands; }
-
+    /** Return the extent selected by the user.
+        Either an empty extent for 'full' or the current visible extent. */
     QgsRectangle extent() { QgsRectangle myExtent; return mCurrentExtentRadioButton->isChecked() ? mExtent : myExtent; }
+    /** Return the selected sample size. */
     int sampleSize() { return mEstimateRadioButton->isChecked() ? 250000 : 0; }
 
     // Load programmaticaly with current values
diff --git a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.cpp
@@ -39,11 +39,29 @@ void QgsTreeWidgetItem::setData( int column, int role, const QVariant & value )
   }
 }
 
-// override < operator to allow sorting
+// override < operator to allow numeric sorting
+/** Returns true if the text in the item is less than the text in the other item, otherwise returns false.
+ *
+ *  Compares on numeric value of text if possible, otherwise on text.
+ */
 bool QgsTreeWidgetItem::operator<( const QTreeWidgetItem & other ) const
 {
-  // could use treeWidget()->sortColumn() instead of 0
-  return text( 0 ).toDouble() < other.text( 0 ).toDouble();
+  int column = treeWidget()->sortColumn();
+  bool ok1, ok2, val;
+  val = text( column ).toDouble( &ok1 ) < other.text( column ).toDouble( &ok2 );
+  if ( ok1 && ok2 )
+  {
+    return val;
+  }
+  else if ( ok1 || ok2 )
+  {
+    // sort numbers before strings
+    return ok1;
+  }
+  else
+  {
+    return text( column ) < other.text( column );
+  }
 }
 
 QgsSingleBandPseudoColorRendererWidget::QgsSingleBandPseudoColorRendererWidget( QgsRasterLayer* layer, const QgsRectangle &extent )
@@ -183,6 +201,10 @@ QgsRasterRenderer* QgsSingleBandPseudoColorRendererWidget::renderer()
   return renderer;
 }
 
+/** Generate labels from the values in the color map.
+ *  Skip labels which were manually edited (black text).
+ *  Text of generated labels is made gray
+ */
 void QgsSingleBandPseudoColorRendererWidget::autoLabel()
 {
   bool discrete = mColorInterpolationComboBox->currentText() == tr( "Discrete" );
@@ -223,6 +245,7 @@ void QgsSingleBandPseudoColorRendererWidget::autoLabel()
   }
 }
 
+/** Extract the unit out of the current labels and set the unit field. */
 void QgsSingleBandPseudoColorRendererWidget::setUnitFromLabels()
 {
   bool discrete = mColorInterpolationComboBox->currentText() == tr( "Discrete" );
@@ -712,12 +735,14 @@ void QgsSingleBandPseudoColorRendererWidget::on_mColormapTreeWidget_itemDoubleCl
   {
     if ( column == 2 )
     {
+      // Set text color to default black, which signifies a manually edited label
       item->setForeground( 2, QBrush() );
     }
     item->setFlags( Qt::ItemIsEnabled | Qt::ItemIsEditable | Qt::ItemIsSelectable );
   }
 }
 
+/** Update the colormap table after manual edit. */
 void QgsSingleBandPseudoColorRendererWidget::mColormapTreeWidget_itemEdited( QTreeWidgetItem* item, int column )
 {
   Q_UNUSED( item );
diff --git a/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h b/src/gui/raster/qgssinglebandpseudocolorrendererwidget.h
@@ -81,17 +81,23 @@ class GUI_EXPORT QgsSingleBandPseudoColorRendererWidget: public QgsRasterRendere
     int mMinMaxOrigin;
 };
 
+/**
+ * Custom QTreeWidgetItem with extra signal when item is edited and numeric sorting.
+ */
 class GUI_EXPORT QgsTreeWidgetItem: public QObject, public QTreeWidgetItem
 {
     Q_OBJECT
   public:
+    /** Constructs a tree widget item of the specified type and appends it to the items in the given parent. */
     explicit QgsTreeWidgetItem( QTreeWidget * parent, int type = Type ) : QTreeWidgetItem( parent, type ) {}
 
   public:
+    /** Sets the value for the item's column and role to the given value. */
     virtual void setData( int column, int role, const QVariant & value );
     virtual bool operator< ( const QTreeWidgetItem & other ) const;
 
   signals:
+    /** This signal is emitted when the contents of the column in the specified item has been edited by the user. */
     void itemEdited( QTreeWidgetItem* item, int column );
 };
 

Original file line number	Diff line number	Diff line change
`@@ -39,11 +39,29 @@ void QgsTreeWidgetItem::setData( int column, int role, const QVariant & value )`
`39`	`39`	`}`
`40`	`40`	`}`
`41`	`41`
`42`		`-// override < operator to allow sorting`
	`42`	`+// override < operator to allow numeric sorting`
	`43`	`+/** Returns true if the text in the item is less than the text in the other item, otherwise returns false.`
	`44`	`+ *`
	`45`	`+ * Compares on numeric value of text if possible, otherwise on text.`
	`46`	`+ */`
`43`	`47`	`bool QgsTreeWidgetItem::operator<( const QTreeWidgetItem & other ) const`
`44`	`48`	`{`
`45`		`- // could use treeWidget()->sortColumn() instead of 0`
`46`		`- return text( 0 ).toDouble() < other.text( 0 ).toDouble();`
	`49`	`+ int column = treeWidget()->sortColumn();`
	`50`	`+ bool ok1, ok2, val;`
	`51`	`+ val = text( column ).toDouble( &ok1 ) < other.text( column ).toDouble( &ok2 );`
	`52`	`+ if ( ok1 && ok2 )`
	`53`	`+ {`
	`54`	`+ return val;`
	`55`	`+ }`
	`56`	`+ else if ( ok1 \|\| ok2 )`
	`57`	`+ {`
	`58`	`+ // sort numbers before strings`
	`59`	`+ return ok1;`
	`60`	`+ }`
	`61`	`+ else`
	`62`	`+ {`
	`63`	`+ return text( column ) < other.text( column );`
	`64`	`+ }`
`47`	`65`	`}`
`48`	`66`
`49`	`67`	`QgsSingleBandPseudoColorRendererWidget::QgsSingleBandPseudoColorRendererWidget( QgsRasterLayer* layer, const QgsRectangle &extent )`
`@@ -183,6 +201,10 @@ QgsRasterRenderer* QgsSingleBandPseudoColorRendererWidget::renderer()`
`183`	`201`	`return renderer;`
`184`	`202`	`}`
`185`	`203`
	`204`	`+/** Generate labels from the values in the color map.`
	`205`	`+ * Skip labels which were manually edited (black text).`
	`206`	`+ * Text of generated labels is made gray`
	`207`	`+ */`
`186`	`208`	`void QgsSingleBandPseudoColorRendererWidget::autoLabel()`
`187`	`209`	`{`
`188`	`210`	`bool discrete = mColorInterpolationComboBox->currentText() == tr( "Discrete" );`
`@@ -223,6 +245,7 @@ void QgsSingleBandPseudoColorRendererWidget::autoLabel()`
`223`	`245`	`}`
`224`	`246`	`}`
`225`	`247`
	`248`	`+/** Extract the unit out of the current labels and set the unit field. */`
`226`	`249`	`void QgsSingleBandPseudoColorRendererWidget::setUnitFromLabels()`
`227`	`250`	`{`
`228`	`251`	`bool discrete = mColorInterpolationComboBox->currentText() == tr( "Discrete" );`
`@@ -712,12 +735,14 @@ void QgsSingleBandPseudoColorRendererWidget::on_mColormapTreeWidget_itemDoubleCl`
`712`	`735`	`{`
`713`	`736`	`if ( column == 2 )`
`714`	`737`	`{`
	`738`	`+ // Set text color to default black, which signifies a manually edited label`
`715`	`739`	`item->setForeground( 2, QBrush() );`
`716`	`740`	`}`
`717`	`741`	`item->setFlags( Qt::ItemIsEnabled \| Qt::ItemIsEditable \| Qt::ItemIsSelectable );`
`718`	`742`	`}`
`719`	`743`	`}`
`720`	`744`
	`745`	`+/** Update the colormap table after manual edit. */`
`721`	`746`	`void QgsSingleBandPseudoColorRendererWidget::mColormapTreeWidget_itemEdited( QTreeWidgetItem* item, int column )`
`722`	`747`	`{`
`723`	`748`	`Q_UNUSED( item );`