Skip to content
Permalink
Browse files
Add missing docs
  • Loading branch information
nyalldawson committed Apr 26, 2017
1 parent fa21311 commit 8d24a9a189e9789b564bd32d046466a1a95f5cf0
@@ -19,7 +19,11 @@ class QgsDoubleBoxScaleBarRenderer: QgsScaleBarRenderer
#include "qgsdoubleboxscalebarrenderer.h"
%End
public:

QgsDoubleBoxScaleBarRenderer();
%Docstring
Constructor for QgsDoubleBoxScaleBarRenderer.
%End

virtual QString name() const;

@@ -19,7 +19,11 @@ class QgsNumericScaleBarRenderer: QgsScaleBarRenderer
#include "qgsnumericscalebarrenderer.h"
%End
public:

QgsNumericScaleBarRenderer();
%Docstring
Constructor for QgsNumericScaleBarRenderer.
%End

virtual QString name() const;

@@ -47,6 +47,9 @@ Scale denominator
};

QgsScaleBarRenderer();
%Docstring
Constructor for QgsScaleBarRenderer.
%End
virtual ~QgsScaleBarRenderer();

virtual QString name() const = 0;
@@ -22,6 +22,9 @@ class QgsSingleBoxScaleBarRenderer: QgsScaleBarRenderer
public:

QgsSingleBoxScaleBarRenderer();
%Docstring
Constructor for QgsSingleBoxScaleBarRenderer.
%End

virtual QString name() const;

@@ -28,6 +28,9 @@ class QgsTicksScaleBarRenderer: QgsScaleBarRenderer
};

QgsTicksScaleBarRenderer();
%Docstring
Constructor for QgsTicksScaleBarRenderer.
%End

virtual QString name() const;

@@ -215,7 +215,14 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
double height() const { return mSettings.height(); }
void setHeight( double h ) { mSettings.setHeight( h );}

/**
* Sets the \a map item linked to the scalebar.
*/
void setComposerMap( QgsComposerMap *map );

/**
* Returns the map item linked to the scalebar.
*/
QgsComposerMap *composerMap() const {return mComposerMap;}

double labelBarSpace() const {return mSettings.labelBarSpace();}
@@ -224,13 +231,24 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
double boxContentSpace() const {return mSettings.boxContentSpace();}
void setBoxContentSpace( double space );

//! Left / Middle/ Right
/**
* Returns the alignment of the scalebar.
*/
QgsScaleBarSettings::Alignment alignment() const { return mSettings.alignment(); }

void setAlignment( QgsScaleBarSettings::Alignment a );
/**
* Sets the \a alignment of the scalebar.
*/
void setAlignment( QgsScaleBarSettings::Alignment alignment );

/**
* Returns the scalebar distance units.
*/
QgsUnitTypes::DistanceUnit units() const { return mSettings.units(); }

/**
* Sets the scalebar distance units.
*/
void setUnits( QgsUnitTypes::DistanceUnit u );

/** Returns the join style used for drawing lines in the scalebar
@@ -30,6 +30,10 @@
class CORE_EXPORT QgsDoubleBoxScaleBarRenderer: public QgsScaleBarRenderer
{
public:

/**
* Constructor for QgsDoubleBoxScaleBarRenderer.
*/
QgsDoubleBoxScaleBarRenderer() = default;

QString name() const override { return QStringLiteral( "Double Box" ); }
@@ -30,6 +30,10 @@
class CORE_EXPORT QgsNumericScaleBarRenderer: public QgsScaleBarRenderer
{
public:

/**
* Constructor for QgsNumericScaleBarRenderer.
*/
QgsNumericScaleBarRenderer() = default;

QString name() const override { return QStringLiteral( "Numeric" ); }
@@ -58,6 +58,9 @@ class CORE_EXPORT QgsScaleBarRenderer

};

/**
* Constructor for QgsScaleBarRenderer.
*/
QgsScaleBarRenderer() = default;
virtual ~QgsScaleBarRenderer() = default;

@@ -32,6 +32,9 @@ class CORE_EXPORT QgsSingleBoxScaleBarRenderer: public QgsScaleBarRenderer
{
public:

/**
* Constructor for QgsSingleBoxScaleBarRenderer.
*/
QgsSingleBoxScaleBarRenderer() = default;

QString name() const override { return QStringLiteral( "Single Box" ); }
@@ -38,6 +38,9 @@ class CORE_EXPORT QgsTicksScaleBarRenderer: public QgsScaleBarRenderer
TicksMiddle, //!< Render ticks crossing line
};

/**
* Constructor for QgsTicksScaleBarRenderer.
*/
QgsTicksScaleBarRenderer() = default;

QString name() const override;

0 comments on commit 8d24a9a

Please sign in to comment.