Add missing docs

This commit is contained in:
Nyall Dawson 2017-04-23 08:06:03 +10:00
parent fa21311e4c
commit 8d24a9a189
11 changed files with 54 additions and 2 deletions

View File

@ -19,7 +19,11 @@ class QgsDoubleBoxScaleBarRenderer: QgsScaleBarRenderer
#include "qgsdoubleboxscalebarrenderer.h" #include "qgsdoubleboxscalebarrenderer.h"
%End %End
public: public:
QgsDoubleBoxScaleBarRenderer(); QgsDoubleBoxScaleBarRenderer();
%Docstring
Constructor for QgsDoubleBoxScaleBarRenderer.
%End
virtual QString name() const; virtual QString name() const;

View File

@ -19,7 +19,11 @@ class QgsNumericScaleBarRenderer: QgsScaleBarRenderer
#include "qgsnumericscalebarrenderer.h" #include "qgsnumericscalebarrenderer.h"
%End %End
public: public:
QgsNumericScaleBarRenderer(); QgsNumericScaleBarRenderer();
%Docstring
Constructor for QgsNumericScaleBarRenderer.
%End
virtual QString name() const; virtual QString name() const;

View File

@ -47,6 +47,9 @@ Scale denominator
}; };
QgsScaleBarRenderer(); QgsScaleBarRenderer();
%Docstring
Constructor for QgsScaleBarRenderer.
%End
virtual ~QgsScaleBarRenderer(); virtual ~QgsScaleBarRenderer();
virtual QString name() const = 0; virtual QString name() const = 0;

View File

@ -22,6 +22,9 @@ class QgsSingleBoxScaleBarRenderer: QgsScaleBarRenderer
public: public:
QgsSingleBoxScaleBarRenderer(); QgsSingleBoxScaleBarRenderer();
%Docstring
Constructor for QgsSingleBoxScaleBarRenderer.
%End
virtual QString name() const; virtual QString name() const;

View File

@ -28,6 +28,9 @@ class QgsTicksScaleBarRenderer: QgsScaleBarRenderer
}; };
QgsTicksScaleBarRenderer(); QgsTicksScaleBarRenderer();
%Docstring
Constructor for QgsTicksScaleBarRenderer.
%End
virtual QString name() const; virtual QString name() const;

View File

@ -215,7 +215,14 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
double height() const { return mSettings.height(); } double height() const { return mSettings.height(); }
void setHeight( double h ) { mSettings.setHeight( h );} void setHeight( double h ) { mSettings.setHeight( h );}
/**
* Sets the \a map item linked to the scalebar.
*/
void setComposerMap( QgsComposerMap *map ); void setComposerMap( QgsComposerMap *map );
/**
* Returns the map item linked to the scalebar.
*/
QgsComposerMap *composerMap() const {return mComposerMap;} QgsComposerMap *composerMap() const {return mComposerMap;}
double labelBarSpace() const {return mSettings.labelBarSpace();} double labelBarSpace() const {return mSettings.labelBarSpace();}
@ -224,13 +231,24 @@ class CORE_EXPORT QgsComposerScaleBar: public QgsComposerItem
double boxContentSpace() const {return mSettings.boxContentSpace();} double boxContentSpace() const {return mSettings.boxContentSpace();}
void setBoxContentSpace( double space ); void setBoxContentSpace( double space );
//! Left / Middle/ Right /**
* Returns the alignment of the scalebar.
*/
QgsScaleBarSettings::Alignment alignment() const { return mSettings.alignment(); } 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(); } QgsUnitTypes::DistanceUnit units() const { return mSettings.units(); }
/**
* Sets the scalebar distance units.
*/
void setUnits( QgsUnitTypes::DistanceUnit u ); void setUnits( QgsUnitTypes::DistanceUnit u );
/** Returns the join style used for drawing lines in the scalebar /** Returns the join style used for drawing lines in the scalebar

View File

@ -30,6 +30,10 @@
class CORE_EXPORT QgsDoubleBoxScaleBarRenderer: public QgsScaleBarRenderer class CORE_EXPORT QgsDoubleBoxScaleBarRenderer: public QgsScaleBarRenderer
{ {
public: public:
/**
* Constructor for QgsDoubleBoxScaleBarRenderer.
*/
QgsDoubleBoxScaleBarRenderer() = default; QgsDoubleBoxScaleBarRenderer() = default;
QString name() const override { return QStringLiteral( "Double Box" ); } QString name() const override { return QStringLiteral( "Double Box" ); }

View File

@ -30,6 +30,10 @@
class CORE_EXPORT QgsNumericScaleBarRenderer: public QgsScaleBarRenderer class CORE_EXPORT QgsNumericScaleBarRenderer: public QgsScaleBarRenderer
{ {
public: public:
/**
* Constructor for QgsNumericScaleBarRenderer.
*/
QgsNumericScaleBarRenderer() = default; QgsNumericScaleBarRenderer() = default;
QString name() const override { return QStringLiteral( "Numeric" ); } QString name() const override { return QStringLiteral( "Numeric" ); }

View File

@ -58,6 +58,9 @@ class CORE_EXPORT QgsScaleBarRenderer
}; };
/**
* Constructor for QgsScaleBarRenderer.
*/
QgsScaleBarRenderer() = default; QgsScaleBarRenderer() = default;
virtual ~QgsScaleBarRenderer() = default; virtual ~QgsScaleBarRenderer() = default;

View File

@ -32,6 +32,9 @@ class CORE_EXPORT QgsSingleBoxScaleBarRenderer: public QgsScaleBarRenderer
{ {
public: public:
/**
* Constructor for QgsSingleBoxScaleBarRenderer.
*/
QgsSingleBoxScaleBarRenderer() = default; QgsSingleBoxScaleBarRenderer() = default;
QString name() const override { return QStringLiteral( "Single Box" ); } QString name() const override { return QStringLiteral( "Single Box" ); }

View File

@ -38,6 +38,9 @@ class CORE_EXPORT QgsTicksScaleBarRenderer: public QgsScaleBarRenderer
TicksMiddle, //!< Render ticks crossing line TicksMiddle, //!< Render ticks crossing line
}; };
/**
* Constructor for QgsTicksScaleBarRenderer.
*/
QgsTicksScaleBarRenderer() = default; QgsTicksScaleBarRenderer() = default;
QString name() const override; QString name() const override;