Class: QgsNewNameDialog¶
-
class
qgis.gui.
QgsNewNameDialog
(source: str = '', initial: str = '', extensions: Iterable[str] = [], existing: Iterable[str] = [], regexp: QRegExp = QRegExp(), cs: Qt.CaseSensitivity = Qt.CaseSensitive, parent: QWidget = None, flags: Union[Qt.WindowFlags, Qt.WindowType] = QgsGuiUtils.ModalDialogFlags)¶ Bases:
QgsDialog
New dialog constructor.
- Parameters
source (str = '') – original data source name, e.g. original layer name of the layer to be copied
initial (str = '') – initial name
extensions (Iterable[str] = []) – base name extensions, e.g. raster base name band extensions or vector layer type extensions
existing (Iterable[str] = []) – existing names
regexp (QRegExp = QRegExp()) – regular expression to be used as validator, for example db tables should have “[A-Za-z_][A-Za-z0-9_]+”
cs (Qt.CaseSensitivity = Qt.CaseSensitive) – case sensitivity for new name to existing names comparison
parent (QWidget = None) –
flags (Union[Qt.WindowFlags) –
New name, for example new layer name dialog. If existing names are provided, the dialog warns users if an entered name already exists.
Methods
Returns the string used for warning users if a conflicting name exists.
Test if name or name with at least one extension exists.
- param name
List of names with extensions
Returns the hint string for the dialog (the text shown above the name input box).
- param newNames
Name entered by user.
Returns whether users are permitted to overwrite existing names.
Sets the string used for warning users if a conflicting name exists.
Sets the hint string for the dialog (the text shown above the name input box).
Sets whether users are permitted to overwrite existing names.
Signals
Emitted when the name is changed in the dialog.
-
actionEvent
(self, QActionEvent)¶
-
changeEvent
(self, QEvent)¶
-
childEvent
(self, QChildEvent)¶
-
closeEvent
(self, QCloseEvent)¶
-
conflictingNameWarning
(self) → str¶ Returns the string used for warning users if a conflicting name exists.
See also
New in version 2.12.
- Return type
str
-
connectNotify
(self, QMetaMethod)¶
-
contextMenuEvent
(self, QContextMenuEvent)¶
-
create
(self, window: sip.voidptr = 0, initializeWindow: bool = True, destroyOldWindow: bool = True)¶
-
customEvent
(self, QEvent)¶
-
destroy
(self, destroyWindow: bool = True, destroySubWindows: bool = True)¶
-
disconnectNotify
(self, QMetaMethod)¶
-
dragEnterEvent
(self, QDragEnterEvent)¶
-
dragLeaveEvent
(self, QDragLeaveEvent)¶
-
dragMoveEvent
(self, QDragMoveEvent)¶
-
dropEvent
(self, QDropEvent)¶
-
enterEvent
(self, QEvent)¶
-
event
(self, QEvent) → bool¶
-
eventFilter
(self, QObject, QEvent) → bool¶
-
exists
(name: str, extensions: Iterable[str], existing: Iterable[str], cs: Qt.CaseSensitivity = Qt.CaseSensitive) → bool¶ Test if name or name with at least one extension exists.
- Parameters
name (str) – name or base name
extensions (Iterable[str]) – base name extensions
existing (Iterable[str]) – existing names
cs (Qt.CaseSensitivity = Qt.CaseSensitive) – case sensitivity for new name to existing names comparison
- Return type
bool
- Returns
True
if name exists
-
focusInEvent
(self, QFocusEvent)¶
-
focusNextChild
(self) → bool¶
-
focusNextPrevChild
(self, bool) → bool¶
-
focusOutEvent
(self, QFocusEvent)¶
-
focusPreviousChild
(self) → bool¶
-
fullNames
(name: str, extensions: Iterable[str]) → List[str]¶ - Parameters
name (str) –
extensions (Iterable[str]) –
- Return type
List[str]
-
hideEvent
(self, QHideEvent)¶
-
highlightText
(self, text: str) → str¶ List of names with extensions
- Parameters
text (str) –
- Return type
str
-
hintString
(self) → str¶ Returns the hint string for the dialog (the text shown above the name input box).
See also
New in version 2.12.
- Return type
str
-
initPainter
(self, QPainter)¶
-
inputMethodEvent
(self, QInputMethodEvent)¶
-
isSignalConnected
(self, QMetaMethod) → bool¶
-
keyPressEvent
(self, QKeyEvent)¶
-
keyReleaseEvent
(self, QKeyEvent)¶
-
leaveEvent
(self, QEvent)¶
-
matching
(newNames: Iterable[str], existingNames: Iterable[str], cs: Qt.CaseSensitivity = Qt.CaseSensitive) → List[str]¶ - Parameters
newNames (Iterable[str]) –
existingNames (Iterable[str]) –
cs (Qt.CaseSensitivity = Qt.CaseSensitive) –
- Return type
List[str]
-
metric
(self, QPaintDevice.PaintDeviceMetric) → int¶
-
mouseDoubleClickEvent
(self, QMouseEvent)¶
-
mouseMoveEvent
(self, QMouseEvent)¶
-
mousePressEvent
(self, QMouseEvent)¶
-
mouseReleaseEvent
(self, QMouseEvent)¶
-
moveEvent
(self, QMoveEvent)¶
-
name
(self) → str¶ Name entered by user.
- Return type
str
- Returns
new name
See also
-
nameChanged
(self)¶
-
nativeEvent
(self, Union[QByteArray, bytes, bytearray], sip.voidptr) → Tuple[bool, int]¶
-
newNameChanged
¶ Emitted when the name is changed in the dialog.
New in version 3.2: [signal]
-
overwriteEnabled
(self) → bool¶ Returns whether users are permitted to overwrite existing names.
See also
New in version 2.12.
- Return type
bool
-
paintEvent
(self, QPaintEvent)¶
-
receivers
(self, PYQT_SIGNAL) → int¶
-
resizeEvent
(self, QResizeEvent)¶
-
sender
(self) → QObject¶
-
senderSignalIndex
(self) → int¶
-
setConflictingNameWarning
(self, string: str)¶ Sets the string used for warning users if a conflicting name exists.
- Parameters
string (str) – warning string. If empty a default warning string will be used.
See also
New in version 2.12.
-
setHintString
(self, hintString: str)¶ Sets the hint string for the dialog (the text shown above the name input box).
- Parameters
hintString (str) – hint text
See also
New in version 2.12.
-
setOverwriteEnabled
(self, enabled: bool)¶ Sets whether users are permitted to overwrite existing names. If
True
, then the dialog will reflect that the new name will overwrite an existing name. IfFalse
, then the dialog will not accept names which already exist.See also
New in version 2.12.
- Parameters
enabled (bool) –
-
showEvent
(self, QShowEvent)¶
-
tabletEvent
(self, QTabletEvent)¶
-
timerEvent
(self, QTimerEvent)¶
-
updateMicroFocus
(self)¶
-
wheelEvent
(self, QWheelEvent)¶