mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
85 lines
3.1 KiB
Plaintext
85 lines
3.1 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsscaleutils.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
class QgsScaleUtils
|
|
{
|
|
%Docstring(signature="appended")
|
|
Contains utility functions for working with map scales.
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsscaleutils.h"
|
|
%End
|
|
public:
|
|
|
|
static bool saveScaleList( const QString &fileName, const QStringList &scales, QString &errorMessage );
|
|
%Docstring
|
|
Save scales to the given file
|
|
|
|
:param fileName: the name of the output file
|
|
:param scales: the list of scales to save
|
|
:param errorMessage: it will contain the error message if something
|
|
went wrong
|
|
|
|
:return: ``True`` on success and ``False`` if failed
|
|
%End
|
|
|
|
static bool loadScaleList( const QString &fileName, QStringList &scales, QString &errorMessage );
|
|
%Docstring
|
|
Load scales from the given file
|
|
|
|
:param fileName: the name of the file to process
|
|
:param scales: it will contain loaded scales
|
|
:param errorMessage: it will contain the error message if something
|
|
went wrong
|
|
|
|
:return: ``True`` on success and ``False`` if failed
|
|
%End
|
|
|
|
static bool equalToOrGreaterThanMinimumScale( const double scale, const double minScale );
|
|
%Docstring
|
|
Returns whether the ``scale`` is equal to or greater than the ``minScale``,
|
|
taking non-round numbers into account.
|
|
|
|
:param scale: The current scale to be compared.
|
|
:param minScale: The minimum map scale (i.e. most "zoomed out" scale) at
|
|
which features, labels or diagrams will be visible. The scale value
|
|
indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.
|
|
|
|
.. seealso:: :py:func:`lessThanMaximumScale`
|
|
|
|
.. versionadded:: 3.40
|
|
%End
|
|
|
|
static bool lessThanMaximumScale( const double scale, const double maxScale );
|
|
%Docstring
|
|
Returns whether the ``scale`` is less than the ``maxScale``, taking non-round
|
|
numbers into account.
|
|
|
|
:param scale: The current scale to be compared.
|
|
:param maxScale: The maximum map scale (i.e. most "zoomed in" scale) at which
|
|
features, labels or diagrams will be visible. The scale value indicates the
|
|
scale denominator, e.g. 1000.0 for a 1:1000 map.
|
|
|
|
.. seealso:: :py:func:`equalToOrGreaterThanMinimumScale`
|
|
|
|
.. versionadded:: 3.40
|
|
%End
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/core/qgsscaleutils.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|