mirror of
https://github.com/qgis/QGIS.git
synced 2025-11-04 00:04:25 -05:00
252 lines
6.5 KiB
Plaintext
252 lines
6.5 KiB
Plaintext
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsunitselectionwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|
|
|
|
|
|
|
|
|
|
|
|
class QgsMapUnitScaleWidget : QgsPanelWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
A widget which allows the user to choose the minimum and maximum scale of an object in map units
|
|
and millimeters. This widget is designed to allow users to edit the properties of a
|
|
:py:class:`QgsMapUnitScale` object.
|
|
|
|
.. seealso:: :py:class:`QgsMapUnitScaleDialog`
|
|
|
|
.. seealso:: :py:class:`QgsUnitSelectionWidget`
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsunitselectionwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMapUnitScaleWidget( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsMapUnitScaleWidget.
|
|
|
|
:param parent: parent widget
|
|
%End
|
|
|
|
QgsMapUnitScale mapUnitScale() const;
|
|
%Docstring
|
|
Returns a :py:class:`QgsMapUnitScale` representing the settings shown in the
|
|
widget.
|
|
|
|
.. seealso:: :py:func:`setMapUnitScale`
|
|
|
|
.. seealso:: :py:func:`mapUnitScaleChanged`
|
|
%End
|
|
|
|
void setMapUnitScale( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Updates the widget to reflect the settings from the specified
|
|
:py:class:`QgsMapUnitScale` object.
|
|
|
|
:param scale: map unit scale to show in widget
|
|
|
|
.. seealso:: :py:func:`mapUnitScale`
|
|
|
|
.. seealso:: :py:func:`mapUnitScaleChanged`
|
|
%End
|
|
|
|
void setMapCanvas( QgsMapCanvas *canvas );
|
|
%Docstring
|
|
Sets the map canvas associated with the widget. This allows the
|
|
widget to retrieve the current map scale from the canvas.
|
|
|
|
:param canvas: map canvas
|
|
%End
|
|
|
|
signals:
|
|
|
|
void mapUnitScaleChanged( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Emitted when the settings in the widget are modified.
|
|
|
|
:param scale: :py:class:`QgsMapUnitScale` reflecting new settings from the widget
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsMapUnitScaleDialog : QDialog
|
|
{
|
|
%Docstring(signature="appended")
|
|
A dialog which allows the user to choose the minimum and maximum scale of an object in map units
|
|
and millimeters. This dialog is designed to allow users to edit the properties of a
|
|
:py:class:`QgsMapUnitScale` object.
|
|
|
|
.. seealso:: :py:class:`QgsMapUnitScaleWidget`
|
|
|
|
.. seealso:: :py:class:`QgsUnitSelectionWidget`
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsunitselectionwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsMapUnitScaleDialog( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsMapUnitScaleDialog.
|
|
|
|
:param parent: parent widget
|
|
%End
|
|
|
|
QgsMapUnitScale getMapUnitScale() const;
|
|
%Docstring
|
|
Returns a :py:class:`QgsMapUnitScale` representing the settings shown in the
|
|
dialog.
|
|
|
|
.. seealso:: :py:func:`setMapUnitScale`
|
|
%End
|
|
|
|
void setMapUnitScale( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Updates the dialog to reflect the settings from the specified
|
|
:py:class:`QgsMapUnitScale` object.
|
|
|
|
:param scale: map unit scale to show in dialog
|
|
|
|
.. seealso:: :py:func:`mapUnitScale`
|
|
%End
|
|
|
|
void setMapCanvas( QgsMapCanvas *canvas );
|
|
%Docstring
|
|
Sets the map canvas associated with the dialog. This allows the dialog to retrieve the current
|
|
map scale from the canvas.
|
|
|
|
:param canvas: map canvas
|
|
%End
|
|
|
|
};
|
|
|
|
class QgsUnitSelectionWidget : QWidget
|
|
{
|
|
%Docstring(signature="appended")
|
|
A widget displaying a combobox allowing the user to choose between various display units,
|
|
such as millimeters or map units.
|
|
|
|
If the user chooses map units, a button appears allowing adjustment of minimum and maximum scaling.
|
|
|
|
.. seealso:: :py:class:`QgsMapUnitScaleWidget`
|
|
|
|
.. seealso:: :py:class:`QgsMapUnitScaleDialog`
|
|
%End
|
|
|
|
%TypeHeaderCode
|
|
#include "qgsunitselectionwidget.h"
|
|
%End
|
|
public:
|
|
|
|
QgsUnitSelectionWidget( QWidget *parent /TransferThis/ = 0 );
|
|
%Docstring
|
|
Constructor for QgsUnitSelectionWidget.
|
|
|
|
:param parent: parent widget
|
|
%End
|
|
|
|
void setUnits( const QStringList &units, int mapUnitIdx );
|
|
%Docstring
|
|
Sets the units which the user can choose from in the combobox.
|
|
|
|
:param units: list of strings for custom units to display in the widget
|
|
:param mapUnitIdx: specifies which entry corresponds to the map units, or -1 if none
|
|
%End
|
|
|
|
void setUnits( const QgsUnitTypes::RenderUnitList &units );
|
|
%Docstring
|
|
Sets the units which the user can choose from in the combobox. Clears any existing units.
|
|
|
|
:param units: list of valid units
|
|
%End
|
|
|
|
int getUnit() const;
|
|
%Docstring
|
|
Gets the selected unit index
|
|
%End
|
|
|
|
Qgis::RenderUnit unit() const;
|
|
%Docstring
|
|
Returns the current predefined selected unit (if applicable).
|
|
|
|
:return: selected output unit, or :py:class:`QgsUnitTypes`.RenderUnknownUnit if the widget was populated with custom unit types
|
|
%End
|
|
|
|
void setUnit( int unitIndex ) /PyName=setUnitIndex/;
|
|
%Docstring
|
|
Sets the selected unit index
|
|
|
|
:param unitIndex: index of unit to set as current
|
|
|
|
.. note::
|
|
|
|
available in Python bindings as setUnitIndex
|
|
%End
|
|
|
|
void setUnit( Qgis::RenderUnit unit );
|
|
%Docstring
|
|
Sets the selected unit
|
|
|
|
:param unit: predefined unit to set as current
|
|
%End
|
|
|
|
QgsMapUnitScale getMapUnitScale() const;
|
|
%Docstring
|
|
Returns the map unit scale
|
|
%End
|
|
|
|
void setMapUnitScale( const QgsMapUnitScale &scale );
|
|
%Docstring
|
|
Sets the map unit scale
|
|
%End
|
|
|
|
void setMapCanvas( QgsMapCanvas *canvas );
|
|
%Docstring
|
|
Sets the map canvas associated with the widget. This allows the widget to retrieve the current
|
|
map scale from the canvas.
|
|
|
|
:param canvas: map canvas
|
|
%End
|
|
|
|
bool showMapScaleButton() const;
|
|
%Docstring
|
|
Returns ``True`` if the widget can show the map scale button when the Map Units option is selected.
|
|
|
|
.. seealso:: :py:func:`setShowMapScaleButton`
|
|
|
|
.. versionadded:: 3.22
|
|
%End
|
|
|
|
void setShowMapScaleButton( bool show );
|
|
%Docstring
|
|
Sets whether the widget can show the map scale button when the Map Units option is selected.
|
|
|
|
.. seealso:: :py:func:`showMapScaleButton`
|
|
|
|
.. versionadded:: 3.22
|
|
%End
|
|
|
|
signals:
|
|
|
|
void changed();
|
|
%Docstring
|
|
Emitted when the selected unit is changed, or the definition of the map unit scale is changed.
|
|
%End
|
|
|
|
};
|
|
|
|
/************************************************************************
|
|
* This file has been generated automatically from *
|
|
* *
|
|
* src/gui/qgsunitselectionwidget.h *
|
|
* *
|
|
* Do not edit manually ! Edit header and run scripts/sipify.py again *
|
|
************************************************************************/
|