Subgroup: Scale

Class: QgsScaleComboBox¶

class qgis.gui.QgsScaleComboBox¶

Bases: PyQt5.QtWidgets.QComboBox

A combobox which lets the user select map scale from predefined list and highlights nearest to current scale value *

Methods

acceptDrops

accessibleDescription

accessibleName

actionEvent

actions

activateWindow

addAction

addActions

addItem addItem(self, QIcon, str, userData: Any = None)

addItems

adjustSize

autoFillBackground

backgroundRole

baseSize

blockSignals

changeEvent

childAt childAt(self, int, int) -> QWidget

childEvent

children

childrenRect

childrenRegion

clear

clearEditText

clearFocus

clearMask

close

closeEvent

colorCount

completer

connectNotify

contentsMargins

contentsRect

contextMenuEvent

contextMenuPolicy

count

create

createWindowContainer

currentData

currentIndex

currentText

cursor

customEvent

deleteLater

depth

destroy

devType

devicePixelRatio

devicePixelRatioF

devicePixelRatioFScale

disconnect

disconnectNotify

dragEnterEvent

dragLeaveEvent

dragMoveEvent

dropEvent

dumpObjectInfo

dumpObjectTree

duplicatesEnabled

dynamicPropertyNames

effectiveWinId

ensurePolished

enterEvent

event

eventFilter

find

findChild findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject

findChildren findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]

findData

findText

focusInEvent

focusNextChild

focusNextPrevChild

focusOutEvent

focusPolicy

focusPreviousChild

focusProxy

focusWidget

font

fontInfo

fontMetrics

foregroundRole

frameGeometry

frameSize

geometry

getContentsMargins

grab

grabGesture

grabKeyboard

grabMouse grabMouse(self, Union[QCursor, Qt.CursorShape])

grabShortcut

graphicsEffect

graphicsProxyWidget

hasFocus

hasFrame

hasHeightForWidth

hasMouseTracking

hasTabletTracking

height

heightForWidth

heightMM

hide

hideEvent

hidePopup

iconSize

inherits

initPainter

initStyleOption

inputMethodEvent

inputMethodHints

inputMethodQuery inputMethodQuery(self, Qt.InputMethodQuery, Any) -> Any

insertAction

insertActions

insertItem insertItem(self, int, QIcon, str, userData: Any = None)

insertItems

insertPolicy

insertSeparator

installEventFilter

isActiveWindow

isAncestorOf

isEditable

isEnabled

isEnabledTo

isFullScreen

isHidden

isLeftToRight

isMaximized

isMinimized

isModal

isRightToLeft

isSignalConnected

isVisible

isVisibleTo

isWidgetType

isWindow

isWindowModified

isWindowType

itemData

itemDelegate

itemIcon

itemText

keyPressEvent

keyReleaseEvent

keyboardGrabber

killTimer

layout

layoutDirection

leaveEvent

lineEdit

locale

logicalDpiX

logicalDpiY

lower

mapFrom

mapFromGlobal

mapFromParent

mapTo

mapToGlobal

mapToParent

mask

maxCount

maxVisibleItems

maximumHeight

maximumSize

maximumWidth

metaObject

metric

minScale Returns the minimum scale, or 0 if no minimum scale set.

minimumContentsLength

minimumHeight

minimumSize

minimumSizeHint

minimumWidth

model

modelColumn

mouseDoubleClickEvent

mouseGrabber

mouseMoveEvent

mousePressEvent

mouseReleaseEvent

move move(self, int, int)

moveEvent

moveToThread

nativeEvent

nativeParentWidget

nextInFocusChain

normalGeometry

objectName

overrideWindowFlags

overrideWindowState

paintEngine

paintEvent

paintingActive

palette

parent

parentWidget

physicalDpiX

physicalDpiY

pos

previousInFocusChain

property

pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.

raise_

receivers

rect

releaseKeyboard

releaseMouse

releaseShortcut

removeAction

removeEventFilter

removeItem

render render(self, QPainter, targetOffset: QPoint = QPoint(), sourceRegion: QRegion = QRegion(), flags: Union[QWidget.RenderFlags, QWidget.RenderFlag] = QWidget.RenderFlags(QWidget.DrawWindowBackground|QWidget.DrawChildren))

repaint repaint(self, int, int, int, int)

resize resize(self, int, int)

resizeEvent

restoreGeometry

rootModelIndex

saveGeometry

scale Returns the selected scale as a double.

scaleString Returns the selected scale as a string, e.g.

scroll scroll(self, int, int, QRect)

sender

senderSignalIndex

setAcceptDrops

setAccessibleDescription

setAccessibleName

setAttribute

setAutoFillBackground

setBackgroundRole

setBaseSize setBaseSize(self, QSize)

setCompleter

setContentsMargins setContentsMargins(self, QMargins)

setContextMenuPolicy

setCurrentIndex

setCurrentText

setCursor

setDisabled

setDuplicatesEnabled

setEditText

setEditable

setEnabled

setFixedHeight

setFixedSize setFixedSize(self, int, int)

setFixedWidth

setFocus setFocus(self, Qt.FocusReason)

setFocusPolicy

setFocusProxy

setFont

setForegroundRole

setFrame

setGeometry setGeometry(self, int, int, int, int)

setGraphicsEffect

setHidden

setIconSize

setInputMethodHints

setInsertPolicy

setItemData

setItemDelegate

setItemIcon

setItemText

setLayout

setLayoutDirection

setLineEdit

setLocale

setMask setMask(self, QRegion)

setMaxCount

setMaxVisibleItems

setMaximumHeight

setMaximumSize setMaximumSize(self, QSize)

setMaximumWidth

setMinScale Set the minimum allowed scale.

setMinimumContentsLength

setMinimumHeight

setMinimumSize setMinimumSize(self, QSize)

setMinimumWidth

setModel

setModelColumn

setMouseTracking

setObjectName

setPalette

setParent setParent(self, QWidget, Union[Qt.WindowFlags, Qt.WindowType])

setProperty

setRootModelIndex

setScale Set the selected scale from a double.

setScaleString Set the selected scale from a string, e.g.

setShortcutAutoRepeat

setShortcutEnabled

setSizeAdjustPolicy

setSizeIncrement setSizeIncrement(self, QSize)

setSizePolicy setSizePolicy(self, QSizePolicy.Policy, QSizePolicy.Policy)

setStatusTip

setStyle

setStyleSheet

setTabOrder

setTabletTracking

setToolTip

setToolTipDuration

setUpdatesEnabled

setValidator

setView

setVisible

setWhatsThis

setWindowFilePath

setWindowFlag

setWindowFlags

setWindowIcon

setWindowIconText

setWindowModality

setWindowModified

setWindowOpacity

setWindowRole

setWindowState

setWindowTitle

sharedPainter

show

showEvent

showFullScreen

showMaximized

showMinimized

showNormal

showPopup

signalsBlocked

size

sizeAdjustPolicy

sizeHint

sizeIncrement

sizePolicy

stackUnder

startTimer

statusTip

style

styleSheet

tabletEvent

testAttribute

thread

timerEvent

toDouble Helper function to convert a scale string to double.

toString Helper function to convert a scale double to scale string.

toolTip

toolTipDuration

tr

underMouse

ungrabGesture

unsetCursor

unsetLayoutDirection

unsetLocale

update update(self, QRect)

updateGeometry

updateMicroFocus

updateScales Sets the list of predefined scales to show in the combobox.

updatesEnabled

validator

view

visibleRegion

whatsThis

wheelEvent

width

widthMM

winId

window

windowFilePath

windowFlags

windowHandle

windowIcon

windowIconText

windowModality

windowOpacity

windowRole

windowState

windowTitle

windowType

x

y

Attributes

AdjustToContents

AdjustToContentsOnFirstShow

AdjustToMinimumContentsLength

AdjustToMinimumContentsLengthWithIcon

DrawChildren

DrawWindowBackground

IgnoreMask

InsertAfterCurrent

InsertAlphabetically

InsertAtBottom

InsertAtCurrent

InsertAtTop

InsertBeforeCurrent

NoInsert

PdmDepth

PdmDevicePixelRatio

PdmDevicePixelRatioScaled

PdmDpiX

PdmDpiY

PdmHeight

PdmHeightMM

PdmNumColors

PdmPhysicalDpiX

PdmPhysicalDpiY

PdmWidth

PdmWidthMM

activated activated(self, int) [signal]

currentIndexChanged currentIndexChanged(self, int) [signal]

currentTextChanged currentTextChanged(self, str) [signal]

customContextMenuRequested customContextMenuRequested(self, QPoint) [signal]

destroyed destroyed(self, QObject = None) [signal]

editTextChanged editTextChanged(self, str) [signal]

highlighted highlighted(self, int) [signal]

objectNameChanged objectNameChanged(self, str) [signal]

scaleChanged Emitted when user has finished editing/selecting a new scale.

staticMetaObject

windowIconChanged windowIconChanged(self, QIcon) [signal]

windowIconTextChanged windowIconTextChanged(self, str) [signal]

windowTitleChanged windowTitleChanged(self, str) [signal]

actionEvent()¶

changeEvent()¶

childEvent()¶

closeEvent()¶

connectNotify()¶

contextMenuEvent()¶

create()¶

customEvent()¶

destroy()¶

disconnectNotify()¶

dragEnterEvent()¶

dragLeaveEvent()¶

dragMoveEvent()¶

dropEvent()¶

enterEvent()¶

focusInEvent()¶

focusNextChild()¶

focusNextPrevChild()¶

focusOutEvent()¶

focusPreviousChild()¶

hideEvent()¶

initPainter()¶

initStyleOption()¶

inputMethodEvent()¶

isSignalConnected()¶

keyPressEvent()¶

keyReleaseEvent()¶

leaveEvent()¶

metric()¶

minScale(self) → float¶: Returns the minimum scale, or 0 if no minimum scale set. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. Any scale lower than the minimum scale will automatically be converted to the minimum scale. Except for 0 which is always allowed.

mouseDoubleClickEvent()¶

mouseMoveEvent()¶

mousePressEvent()¶

mouseReleaseEvent()¶

moveEvent()¶

nativeEvent()¶

paintEvent()¶

receivers()¶

resizeEvent()¶

scale(self) → float¶: Returns the selected scale as a double. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

setScale()

scaleChanged¶: Emitted when user has finished editing/selecting a new scale. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. [signal]

scaleString(self) → str¶: Returns the selected scale as a string, e.g. “1:150”.

See also

setScaleString()

sender()¶

senderSignalIndex()¶

setMinScale(self, scale: float)¶: Set the minimum allowed scale. Set to 0 to disable the minimum scale. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. Any scale lower than the minimum scale will automatically be converted to the minimum scale. Except for 0 which is always allowed.

setScale(self, scale: float)¶: Set the selected scale from a double. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

See also

scale()

setScaleString(self, string: str) → bool¶: Set the selected scale from a string, e.g. “1:150”.

See also

scaleString()

sharedPainter()¶

showEvent()¶

showPopup(self)¶

tabletEvent()¶

timerEvent()¶

toDouble(string: str) → Tuple[float, bool]¶: Helper function to convert a scale string to double. The returned value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map. If specified, ok will be set to true if the string was successfully interpreted as a scale.

See also

toString()

toString(scale: float) → str¶

Helper function to convert a scale double to scale string. The scale value indicates the scale denominator, e.g. 1000.0 for a 1:1000 map.

The returned string will be rounded (e.g. 1:1000, not 1:1000.345).