QGIS/python/gui/qgshighlight.sip
Nyall Dawson 47683fca4f [needs-docs] Rename Outline and Border -> Stroke
This change is being driven by:

- need for consistent terminology in the api. Currently there's
a confusing mix of border/outline used
- need for consistent terminology in the gui - we have a mix
of "border"/"outline"/"pen"
- bringing QGIS into line with the standard terminology used
in other graphic editing programs
2017-02-22 19:22:45 +10:00

53 lines
1.5 KiB
Plaintext

class QgsHighlight : QgsMapCanvasItem
{
%TypeHeaderCode
#include <qgshighlight.h>
%End
public:
/** Constructor for QgsHighlight
* @param mapCanvas associated map canvas
* @param geom initial geometry of highlight
* @param layer associated map layer
*/
//QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry& geom, QgsMapLayer *layer );
/** Constructor for QgsHighlight
* @param mapCanvas associated map canvas
* @param geom initial geometry of highlight
* @param layer associated vector layer
*/
QgsHighlight( QgsMapCanvas *mapCanvas, const QgsGeometry& geom, QgsVectorLayer *layer );
~QgsHighlight();
/** Set line/stroke to color, polygon fill to color with alpha = 63.
* This is legacy function, use setFillColor() after setColor() if different fill color is required. */
void setColor( const QColor & color );
/** Set polygons fill color.
* @note: added in version 2.3 */
void setFillColor( const QColor & fillColor );
/** Set width. Ignored in feature mode. */
void setWidth( int width );
/** Set line / stroke buffer in millimeters.
* @note: added in version 2.3 */
void setBuffer( double buffer );
/** Set minimum line / stroke width in millimeters.
* @note: added in version 2.3 */
void setMinWidth( double width );
const QgsMapLayer *layer() const;
virtual void updatePosition();
protected:
virtual void paint( QPainter* p );
//! recalculates needed rectangle
void updateRect();
};