PythonQt.Qt.QSaveFile
QSaveFile
PythonQtInstanceWrapper object
Native bases: PythonQtInstanceWrapper
Supplemental documentation: Qt 5 reference:
Detailed Description
QSaveFile is an I/O device for writing text and binary files, without losing existing data if the writing operation fails.
While writing, the contents will be written to a temporary file, and if no error happened, commit() will move it to the final file. This ensures that no data at the final file is lost in case an error happens while writing, and no partially-written file is ever present at the final location. Always use QSaveFile when saving entire documents to disk.
QSaveFile automatically detects errors while writing, such as the full partition situation, where write() cannot write all the bytes. It will remember that an error happened, and will discard the temporary file in commit().
Much like with QFile, the file is opened with open(). Data is usually read and written using QDataStream or QTextStream, but you can also call the QIODevice-inherited functions read(), readLine(), readAll(), write().
Unlike QFile, calling close() is not allowed. commit() replaces it. If commit() was not called and the QSaveFile instance is destroyed, the temporary file is discarded.
To abort saving due to an application error, call cancelWriting(), so that even a call to commit() later on will not save.
Source: https://doc.qt.io/archives/qt-5.15/qsavefile.html
Complete member index
Every captured member retains its own identity. Identical captured declaration text is linked once; this does not establish native inheritance or interchangeable objects.
| Member | Kind | Signature | Summary |
|---|---|---|---|
AbortError |
attribute | Any |
(shared captured text) |
Append |
attribute | Any |
(shared captured text) |
AutoCloseHandle |
attribute | Any |
(shared captured text) |
CopyError |
attribute | Any |
(shared captured text) |
DontCloseHandle |
attribute | Any |
(shared captured text) |
ExeGroup |
attribute | Any |
(shared captured text) |
ExeOther |
attribute | Any |
(shared captured text) |
ExeOwner |
attribute | Any |
(shared captured text) |
ExeUser |
attribute | Any |
(shared captured text) |
FatalError |
attribute | Any |
(shared captured text) |
FileError |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
FileHandleFlag |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
FileHandleFlags |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
MapPrivateOption |
attribute | Any |
(shared captured text) |
MemoryMapFlags |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
NoError |
attribute | Any |
(shared captured text) |
NoOptions |
attribute | Any |
(shared captured text) |
NotOpen |
attribute | Any |
(shared captured text) |
OpenError |
attribute | Any |
(shared captured text) |
OpenMode |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
OpenModeFlag |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
Permission |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
Permissions |
attribute | type |
Convert a number or string to an integer, or return 0 if no arguments are given. (shared captured text) |
PermissionsError |
attribute | Any |
(shared captured text) |
PositionError |
attribute | Any |
(shared captured text) |
ReadError |
attribute | Any |
(shared captured text) |
ReadGroup |
attribute | Any |
(shared captured text) |
ReadOnly |
attribute | Any |
(shared captured text) |
ReadOther |
attribute | Any |
(shared captured text) |
ReadOwner |
attribute | Any |
(shared captured text) |
ReadUser |
attribute | Any |
(shared captured text) |
ReadWrite |
attribute | Any |
(shared captured text) |
RemoveError |
attribute | Any |
(shared captured text) |
RenameError |
attribute | Any |
(shared captured text) |
ResizeError |
attribute | Any |
(shared captured text) |
ResourceError |
attribute | Any |
(shared captured text) |
Text |
attribute | Any |
(shared captured text) |
TimeOutError |
attribute | Any |
(shared captured text) |
Truncate |
attribute | Any |
(shared captured text) |
Unbuffered |
attribute | Any |
(shared captured text) |
UnspecifiedError |
attribute | Any |
(shared captured text) |
WriteError |
attribute | Any |
(shared captured text) |
WriteGroup |
attribute | Any |
(shared captured text) |
WriteOnly |
attribute | Any |
(shared captured text) |
WriteOther |
attribute | Any |
(shared captured text) |
WriteOwner |
attribute | Any |
(shared captured text) |
WriteUser |
attribute | Any |
(shared captured text) |
__init__ |
function | (self, *args: Any, **kwargs: Any) -> None |
Native constructor; consult class documentation for supported overloads. (shared captured text) |
aboutToClose |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.aboutToClose; argument details are not documented. |
atEnd |
function | (self) -> bool |
X.atEnd() -> bool (shared captured text) |
blockSignals |
function | (self, b: Any) -> bool |
X.blockSignals(b) -> bool (shared captured text) |
bytesAvailable |
function | (self) -> int |
X.bytesAvailable() -> int (shared captured text) |
bytesToWrite |
function | (self) -> int |
X.bytesToWrite() -> int (shared captured text) |
bytesWritten |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.bytesWritten; argument details are not documented. |
canReadLine |
function | (self) -> bool |
X.canReadLine() -> bool (shared captured text) |
cancelWriting |
function | (self) -> None |
Cancels writing the new file. (shared captured text) |
channelBytesWritten |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.channelBytesWritten; argument details are not documented. |
channelReadyRead |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.channelReadyRead; argument details are not documented. |
childEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
children |
function | (self) -> tuple |
X.children() -> tuple (shared captured text) |
className |
function | (self, *args: Any, **kwargs: Any) -> Any |
Return the classname of the object (shared captured text) |
close |
function | (self) -> None |
(shared captured text) |
commit |
function | (self) -> bool |
X.commit() -> bool (shared captured text) |
connect |
function | (self, signal: Any, receiver: Any, slot: Any, type: Any) -> bool |
X.connect(signal, receiver, slot, type) -> bool (shared captured text) |
customEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
delete |
function | (self, *args: Any, **kwargs: Any) -> Any |
Deletes the C++ object (at your own risk, my friend!) (shared captured text) |
deleteLater |
function | (self) -> Any |
(shared captured text) |
destroyed |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.destroyed; argument details are not documented. |
directWriteFallback |
function | (self) -> bool |
X.directWriteFallback() -> bool (shared captured text) |
disconnect |
function | (self, signal: Any, receiver: Any, slot: Any) -> bool |
X.disconnect(signal, receiver, slot) -> bool (shared captured text) |
dumpObjectInfo |
function | (self) -> Any |
(shared captured text) |
dumpObjectTree |
function | (self) -> Any |
(shared captured text) |
dynamicPropertyNames |
function | (self) -> Any |
(shared captured text) |
error |
function | (self) -> Any |
(shared captured text) |
errorString |
function | (self) -> str |
X.errorString() -> str (shared captured text) |
event |
function | (self, event: Any) -> bool |
X.event(event) -> bool (shared captured text) |
eventFilter |
function | (self, watched: Any, event: Any) -> bool |
X.eventFilter(watched, event) -> bool (shared captured text) |
fileName |
function | (self) -> str |
X.fileName() -> str (shared captured text) |
findChild |
function | (self, type: Any, name: Any) -> Any |
X.findChild(type, name) -> PythonQt.private.QObject (shared captured text) |
findChildren |
function | (self, type: Any, name: Any) -> tuple |
X.findChildren(type, name) -> tuple (shared captured text) |
flush |
function | (self) -> bool |
X.flush() -> bool (shared captured text) |
getChar |
function | (self, c: Any) -> bool |
X.getChar(c) -> bool (shared captured text) |
handle |
function | (self) -> int |
X.handle() -> int (shared captured text) |
help |
function | (self, *args: Any, **kwargs: Any) -> Any |
Shows the help of available methods for this class (shared captured text) |
inherits |
function | (self, *args: Any, **kwargs: Any) -> Any |
Returns if the class inherits or is of given type name (shared captured text) |
installEventFilter |
function | (self, filterObj: Any) -> Any |
(shared captured text) |
isOpen |
function | (self) -> bool |
X.isOpen() -> bool (shared captured text) |
isReadable |
function | (self) -> bool |
X.isReadable() -> bool (shared captured text) |
isSequential |
function | (self) -> bool |
X.isSequential() -> bool (shared captured text) |
isSignalConnected |
function | (self, signal: Any) -> bool |
X.isSignalConnected(signal) -> bool (shared captured text) |
isTextModeEnabled |
function | (self) -> bool |
X.isTextModeEnabled() -> bool (shared captured text) |
isWidgetType |
function | (self) -> bool |
X.isWidgetType() -> bool (shared captured text) |
isWindowType |
function | (self) -> bool |
X.isWindowType() -> bool (shared captured text) |
isWritable |
function | (self) -> bool |
X.isWritable() -> bool (shared captured text) |
killTimer |
function | (self, id: Any) -> Any |
(shared captured text) |
map |
function | (self, offset: Any, size: Any, arg2: flags) -> int |
X.map(offset, size, flags) -> int (shared captured text) |
metaObject |
function | (self) -> Any |
X.metaObject() -> PythonQt.QtCore.QMetaObject (shared captured text) |
moveToThread |
function | (self, thread: Any) -> Any |
(shared captured text) |
objectName |
attribute | Any |
(shared captured text) |
objectNameChanged |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.objectNameChanged; argument details are not documented. |
open |
function | (self, arg0: flags) -> bool |
X.open(flags) -> bool (shared captured text) |
openMode |
function | (self) -> Any |
(shared captured text) |
parent |
function | (self) -> Any |
X.parent() -> PythonQt.private.QObject (shared captured text) |
peek |
function | (self, maxlen: Any) -> Any |
X.peek(maxlen) -> PythonQt.QtCore.QByteArray (shared captured text) |
permissions |
function | (self) -> Any |
(shared captured text) |
pos |
function | (self) -> int |
X.pos() -> int (shared captured text) |
property |
function | (self, name: Any) -> Any |
X.property(name) -> object (shared captured text) |
putChar |
function | (self, c: Any) -> bool |
X.putChar(c) -> bool (shared captured text) |
read |
function | (self, maxlen: Any) -> Any |
X.read(maxlen) -> PythonQt.QtCore.QByteArray (shared captured text) |
readAll |
function | (self) -> Any |
X.readAll() -> PythonQt.QtCore.QByteArray (shared captured text) |
readChannelFinished |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.readChannelFinished; argument details are not documented. |
readData |
function | (self, data: Any, maxlen: Any) -> int |
X.readData(data, maxlen) -> int (shared captured text) |
readLine |
function | (self, maxlen: Any) -> Any |
X.readLine(maxlen) -> PythonQt.QtCore.QByteArray (shared captured text) |
readLineData |
function | (self, data: Any, maxlen: Any) -> int |
X.readLineData(data, maxlen) -> int (shared captured text) |
readyRead |
function | (self, *args: Any, **kwargs: Any) -> Any |
Native PythonQt.Qt.QSaveFile.readyRead; argument details are not documented. |
removeEventFilter |
function | (self, obj: Any) -> Any |
(shared captured text) |
reset |
function | (self) -> bool |
X.reset() -> bool (shared captured text) |
resize |
function | (self, sz: Any) -> bool |
X.resize(sz) -> bool (shared captured text) |
seek |
function | (self, offset: Any) -> bool |
X.seek(offset) -> bool (shared captured text) |
sender |
function | (self) -> Any |
X.sender() -> PythonQt.private.QObject (shared captured text) |
senderSignalIndex |
function | (self) -> int |
X.senderSignalIndex() -> int (shared captured text) |
setDirectWriteFallback |
function | (self, enabled: bool) -> None |
Allows writing over the existing file if necessary. (shared captured text) |
setErrorString |
function | (self, errorString: Any) -> Any |
(shared captured text) |
setFileName |
function | (self, name: str) -> None |
Sets the name of the file. (shared captured text) |
setObjectName |
function | (self, name: Any) -> Any |
(shared captured text) |
setOpenMode |
function | (self, openMode: Any) -> Any |
(shared captured text) |
setParent |
function | (self, parent: Any) -> Any |
(shared captured text) |
setPermissions |
function | (self, permissionSpec: Any) -> bool |
X.setPermissions(permissionSpec) -> bool (shared captured text) |
setProperty |
function | (self, name: Any, value: Any) -> bool |
X.setProperty(name, value) -> bool (shared captured text) |
setTextModeEnabled |
function | (self, enabled: Any) -> Any |
(shared captured text) |
signalsBlocked |
function | (self) -> bool |
X.signalsBlocked() -> bool (shared captured text) |
size |
function | (self) -> int |
X.size() -> int (shared captured text) |
startTimer |
function | (self, interval: Any, timerType: Any) -> int |
X.startTimer(interval, timerType) -> int (shared captured text) |
thread |
function | (self) -> Any |
(shared captured text) |
timerEvent |
function | (self, event: Any) -> Any |
(shared captured text) |
tr |
function | (self, text: Any, ambig: Any, n: Any) -> str |
X.tr(text, ambig, n) -> str (shared captured text) |
ungetChar |
function | (self, c: Any) -> Any |
(shared captured text) |
unmap |
function | (self, address: Any) -> bool |
X.unmap(address) -> bool (shared captured text) |
unsetError |
function | (self) -> Any |
(shared captured text) |
waitForBytesWritten |
function | (self, msecs: Any) -> bool |
X.waitForBytesWritten(msecs) -> bool (shared captured text) |
waitForReadyRead |
function | (self, msecs: Any) -> bool |
X.waitForReadyRead(msecs) -> bool (shared captured text) |
write |
function | (self, data: Any) -> int |
X.write(data) -> int (shared captured text) |
writeData |
function | (self, data: str, len: int) -> int |
X.writeData(data, len) -> int (shared captured text) |