QCoreApplication#
The QCoreApplication
class provides an event loop for Qt applications without UI. More…
Inherited by: QGuiApplication, QApplication
Synopsis#
Properties#
applicationName
- The name of this applicationapplicationVersion
- The version of this applicationorganizationDomain
- The Internet domain of the organization that wrote this applicationorganizationName
- The name of the organization that wrote this applicationquitLockEnabled
- Whether the use of the QEventLoopLocker feature can cause the application to quit
Functions#
def
checkPermission
(permission)def
checkPermission
(permission)def
checkPermission
(permission)def
checkPermission
(permission)def
checkPermission
(permission)def
checkPermission
(permission)def
checkPermission
(permission)def
exec_
()def
installNativeEventFilter
(filterObj)def
removeNativeEventFilter
(filterObj)def
requestPermission
(permission, context, functor)def
requestPermission
(permission, context, functor)def
requestPermission
(permission, context, functor)def
requestPermission
(permission, context, functor)def
requestPermission
(permission, context, functor)def
requestPermission
(permission, context, functor)def
resolveInterface
(name, revision)def
shutdown
()
Virtual functions#
def
notify
(arg__1, arg__2)
Signals#
def
aboutToQuit
()def
applicationNameChanged
()def
applicationVersionChanged
()def
organizationDomainChanged
()def
organizationNameChanged
()
Static functions#
def
addLibraryPath
(arg__1)def
applicationDirPath
()def
applicationFilePath
()def
applicationName
()def
applicationPid
()def
applicationVersion
()def
arguments
()def
closingDown
()def
eventDispatcher
()def
exec
()def
exit
([retcode=0])def
installTranslator
(messageFile)def
instance
()def
isQuitLockEnabled
()def
isSetuidAllowed
()def
libraryPaths
()def
organizationDomain
()def
organizationName
()def
postEvent
(receiver, event[, priority=Qt.NormalEventPriority])def
processEvents
([flags=QEventLoop.AllEvents])def
processEvents
(flags, maxtime)def
quit
()def
removeLibraryPath
(arg__1)def
removePostedEvents
(receiver[, eventType=0])def
removeTranslator
(messageFile)def
sendEvent
(receiver, event)def
sendPostedEvents
([receiver=None[, event_type=0]])def
setApplicationName
(application)def
setApplicationVersion
(version)def
setAttribute
(attribute[, on=true])def
setEventDispatcher
(eventDispatcher)def
setLibraryPaths
(arg__1)def
setOrganizationDomain
(orgDomain)def
setOrganizationName
(orgName)def
setQuitLockEnabled
(enabled)def
setSetuidAllowed
(allow)def
startingUp
()def
testAttribute
(attribute)def
translate
(context, key[, disambiguation=None[, n=-1]])
Note
This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE
Detailed Description#
This class is used by non-GUI applications to provide their event loop. For non-GUI application that uses Qt, there should be exactly one QCoreApplication
object. For GUI applications, see QGuiApplication. For applications that use the Qt Widgets module, see QApplication.
QCoreApplication
contains the main event loop, where all events from the operating system (e.g., timer and network events) and other sources are processed and dispatched. It also handles the application’s initialization and finalization, as well as system-wide and application-wide settings.
The Event Loop and Event Handling#
The event loop is started with a call to exec()
. Long-running operations can call processEvents()
to keep the application responsive.
In general, we recommend that you create a QCoreApplication
, QGuiApplication or a QApplication object in your main()
function as early as possible. exec()
will not return until the event loop exits; e.g., when quit()
is called.
Several static convenience functions are also provided. The QCoreApplication
object is available from instance()
. Events can be sent with sendEvent()
or posted to an event queue with postEvent()
. Pending events can be removed with removePostedEvents()
or dispatched with sendPostedEvents()
.
The class provides a quit()
slot and an aboutToQuit()
signal.
Application and Library Paths#
An application has an applicationDirPath()
and an applicationFilePath()
. Library paths (see QLibrary
) can be retrieved with libraryPaths()
and manipulated by setLibraryPaths()
, addLibraryPath()
, and removeLibraryPath()
.
Internationalization and Translations#
Translation files can be added or removed using installTranslator()
and removeTranslator()
. Application strings can be translated using translate()
. The tr()
function is implemented in terms of translate()
.
Accessing Command Line Arguments#
The command line arguments which are passed to QCoreApplication
‘s constructor should be accessed using the arguments()
function.
Note
QCoreApplication
removes option -qmljsdebugger="..."
. It parses the argument of qmljsdebugger
, and then removes this option plus its argument.
For more advanced command line option handling, create a QCommandLineParser
.
Locale Settings#
On Unix/Linux Qt is configured to use the system locale settings by default. This can cause a conflict when using POSIX functions, for instance, when converting between data types such as floats and strings, since the notation may differ between locales. To get around this problem, call the POSIX function setlocale(LC_NUMERIC,"C")
right after initializing QApplication, QGuiApplication or QCoreApplication
to reset the locale that is used for number formatting to “C”-locale.
- class PySide6.QtCore.QCoreApplication#
PySide6.QtCore.QCoreApplication(arg__1)
- Parameters:
arg__1 – list of strings
Note
Properties can be used directly when from __feature__ import true_property
is used or via accessor functions otherwise.
- property PᅟySide6.QtCore.QCoreApplication.applicationName: str#
This property holds the name of this application.
The application name is used in various Qt classes and modules, most prominently in QSettings
when it is constructed using the default constructor. Other uses are in formatted logging output (see qSetMessagePattern()
), in output by QCommandLineParser
, in QTemporaryDir
and QTemporaryFile
default paths, and in some file locations of QStandardPaths
. Qt D-Bus, Accessibility, and the XCB platform integration make use of the application name, too.
If not set, the application name defaults to the executable name.
- Access functions:
setApplicationName
(application)Signal
applicationNameChanged
()
- property PᅟySide6.QtCore.QCoreApplication.applicationVersion: str#
This property holds the version of this application.
If not set, the application version defaults to a platform-specific value determined from the main application executable or package (since Qt 5.9):
Platform
Source
Windows (classic desktop)
PRODUCTVERSION parameter of the VERSIONINFO resource
macOS, iOS, tvOS, watchOS
CFBundleVersion property of the information property list
Android
android:versionName property of the AndroidManifest.xml manifest element
On other platforms, the default is the empty string.
- Access functions:
setApplicationVersion
(version)Signal
applicationVersionChanged
()
- property PᅟySide6.QtCore.QCoreApplication.organizationDomain: str#
This property holds the Internet domain of the organization that wrote this application.
The value is used by the QSettings
class when it is constructed using the default constructor. This saves having to repeat this information each time a QSettings
object is created.
On Mac, QSettings
uses organizationDomain() as the organization if it’s not an empty string; otherwise it uses organizationName()
. On all other platforms, QSettings
uses organizationName()
as the organization.
- Access functions:
setOrganizationDomain
(orgDomain)Signal
organizationDomainChanged
()
- property PᅟySide6.QtCore.QCoreApplication.organizationName: str#
This property holds the name of the organization that wrote this application.
The value is used by the QSettings
class when it is constructed using the default constructor. This saves having to repeat this information each time a QSettings
object is created.
On Mac, QSettings
uses organizationDomain()
as the organization if it’s not an empty string; otherwise it uses organizationName(). On all other platforms, QSettings
uses organizationName() as the organization.
See also
- Access functions:
setOrganizationName
(orgName)Signal
organizationNameChanged
()
- property PᅟySide6.QtCore.QCoreApplication.quitLockEnabled: bool#
This property holds Whether the use of the QEventLoopLocker
feature can cause the application to quit..
The default is true
.
See also
QEventLoopLocker
- Access functions:
setQuitLockEnabled
(enabled)
- PySide6.QtCore.QCoreApplication.ApplicationFlags#
New in version 4.8.
- PySide6.QtCore.QCoreApplication.aboutToQuit()#
This signal is emitted when the application is about to quit the main event loop, e.g. when the event loop level drops to zero. This may happen either after a call to quit()
from inside the application or when the user shuts down the entire desktop session.
The signal is particularly useful if your application has to do some last-second cleanup. Note that no user interaction is possible in this state.
Note
At this point the main event loop is still running, but will not process further events on return except DeferredDelete
events for objects deleted via deleteLater()
. If event processing is needed, use a nested event loop or call processEvents()
manually.
See also
- static PySide6.QtCore.QCoreApplication.addLibraryPath(arg__1)#
- Parameters:
arg__1 – str
Prepends path
to the beginning of the library path list, ensuring that it is searched for libraries first. If path
is empty or already in the path list, the path list is not changed.
The default path list consists of one or two entries. The first is the installation directory for plugins, which is INSTALL/plugins
, where INSTALL
is the directory where Qt was installed. The second is the application’s own directory (not the current directory), but only after the QCoreApplication
object is instantiated.
The library paths are reset to the default when an instance of QCoreApplication
is destructed.
- static PySide6.QtCore.QCoreApplication.applicationDirPath()#
- Return type:
str
Returns the directory that contains the application executable.
For example, if you have installed Qt in the C:\Qt
directory, and you run the regexp
example, this function will return “C:/Qt/examples/tools/regexp”.
On macOS and iOS this will point to the directory actually containing the executable, which may be inside an application bundle (if the application is bundled).
Warning
On Linux, this function will try to get the path from the /proc
file system. If that fails, it assumes that argv[0]
contains the absolute file name of the executable. The function also assumes that the current directory has not been changed by the application.
See also
- static PySide6.QtCore.QCoreApplication.applicationFilePath()#
- Return type:
str
Returns the file path of the application executable.
For example, if you have installed Qt in the /usr/local/qt
directory, and you run the regexp
example, this function will return “/usr/local/qt/examples/tools/regexp/regexp”.
Warning
On Linux, this function will try to get the path from the /proc
file system. If that fails, it assumes that argv[0]
contains the absolute file name of the executable. The function also assumes that the current directory has not been changed by the application.
See also
- static PySide6.QtCore.QCoreApplication.applicationName()#
- Return type:
str
See also
Getter of property applicationName
.
- PySide6.QtCore.QCoreApplication.applicationNameChanged()#
Notification signal of property applicationName
.
- static PySide6.QtCore.QCoreApplication.applicationPid()#
- Return type:
int
Returns the current process ID for the application.
- static PySide6.QtCore.QCoreApplication.applicationVersion()#
- Return type:
str
See also
Getter of property applicationVersion
.
- PySide6.QtCore.QCoreApplication.applicationVersionChanged()#
Notification signal of property applicationVersion
.
- static PySide6.QtCore.QCoreApplication.arguments()#
- Return type:
list of strings
Returns the list of command-line arguments.
Usually arguments().at(0) is the program name, arguments().at(1) is the first argument, and arguments().last() is the last argument. See the note below about Windows.
Calling this function is slow - you should store the result in a variable when parsing the command line.
Warning
On Unix, this list is built from the argc and argv parameters passed to the constructor in the main() function. The string-data in argv is interpreted using fromLocal8Bit()
; hence it is not possible to pass, for example, Japanese command line arguments on a system that runs in a Latin1 locale. Most modern Unix systems do not have this limitation, as they are Unicode-based.
On Windows, the list is built from the argc and argv parameters only if modified argv/argc parameters are passed to the constructor. In that case, encoding problems might occur.
Otherwise, the arguments() are constructed from the return value of GetCommandLine() . As a result of this, the string given by arguments().at(0) might not be the program name on Windows, depending on how the application was started.
See also
- PySide6.QtCore.QCoreApplication.checkPermission(permission)#
- Parameters:
permission –
PySide6.QtCore.QBluetoothPermission
- Return type:
Checks the status of the given permission
If the result is Undetermined
then permission should be requested via requestPermission()
to determine the user’s intent.
See also
requestPermission()
Application Permissions
- PySide6.QtCore.QCoreApplication.checkPermission(permission)
- Parameters:
permission –
PySide6.QtCore.QCalendarPermission
- Return type:
Checks the status of the given permission
If the result is Undetermined
then permission should be requested via requestPermission()
to determine the user’s intent.
See also
requestPermission()
Application Permissions
- PySide6.QtCore.QCoreApplication.checkPermission(permission)
- Parameters:
permission –
PySide6.QtCore.QCameraPermission
- Return type:
Checks the status of the given permission
If the result is Undetermined
then permission should be requested via requestPermission()
to determine the user’s intent.
See also
requestPermission()
Application Permissions
- PySide6.QtCore.QCoreApplication.checkPermission(permission)
- Parameters:
permission –
PySide6.QtCore.QContactsPermission
- Return type:
Checks the status of the given permission
If the result is Undetermined
then permission should be requested via requestPermission()
to determine the user’s intent.
See also
requestPermission()
Application Permissions
- PySide6.QtCore.QCoreApplication.checkPermission(permission)
- Parameters:
permission –
PySide6.QtCore.QLocationPermission
- Return type:
Checks the status of the given permission
If the result is Undetermined
then permission should be requested via requestPermission()
to determine the user’s intent.
See also
requestPermission()
Application Permissions
- PySide6.QtCore.QCoreApplication.checkPermission(permission)
- Parameters:
permission –
PySide6.QtCore.QMicrophonePermission
- Return type:
Checks the status of the given permission
If the result is Undetermined
then permission should be requested via requestPermission()
to determine the user’s intent.
See also
requestPermission()
Application Permissions
- PySide6.QtCore.QCoreApplication.checkPermission(permission)
- Parameters:
permission –
PySide6.QtCore.QPermission
- Return type:
Checks the status of the given permission
If the result is Undetermined
then permission should be requested via requestPermission()
to determine the user’s intent.
See also
requestPermission()
Application Permissions
- static PySide6.QtCore.QCoreApplication.closingDown()#
- Return type:
bool
Returns true
if the application objects are being destroyed; otherwise returns false
.
See also
- static PySide6.QtCore.QCoreApplication.eventDispatcher()#
- Return type:
Returns a pointer to the event dispatcher object for the main thread. If no event dispatcher exists for the thread, this function returns None
.
See also
- static PySide6.QtCore.QCoreApplication.exec()#
- Return type:
int
Enters the main event loop and waits until exit()
is called. Returns the value that was passed to exit()
(which is 0 if exit()
is called via quit()
).
It is necessary to call this function to start event handling. The main event loop receives events from the window system and dispatches these to the application widgets.
To make your application perform idle processing (by executing a special function whenever there are no pending events), use a QTimer
with 0 timeout. More advanced idle processing schemes can be achieved using processEvents()
.
We recommend that you connect clean-up code to the aboutToQuit()
signal, instead of putting it in your application’s main()
function because on some platforms the exec() call may not return. For example, on Windows when the user logs off, the system terminates the process after Qt closes all top-level windows. Hence, there is no guarantee that the application will have time to exit its event loop and execute code at the end of the main()
function after the exec() call.
See also
quit()
exit()
processEvents()
exec()
- PySide6.QtCore.QCoreApplication.exec_()#
- Return type:
int
- static PySide6.QtCore.QCoreApplication.exit([retcode=0])#
- Parameters:
retcode – int
Tells the application to exit with a return code.
After this function has been called, the application leaves the main event loop and returns from the call to exec()
. The exec()
function returns returnCode
. If the event loop is not running, this function does nothing.
By convention, a returnCode
of 0 means success, and any non-zero value indicates an error.
It’s good practice to always connect signals to this slot using a QueuedConnection
. If a signal connected (non-queued) to this slot is emitted before control enters the main event loop (such as before “int main” calls exec()
), the slot has no effect and the application never exits. Using a queued connection ensures that the slot will not be invoked until after control enters the main event loop.
Note that unlike the C library function of the same name, this function does return to the caller – it is event processing that stops.
Note also that this function is not thread-safe. It should be called only from the main thread (the thread that the QCoreApplication
object is processing events on). To ask the application to exit from another thread, either use quit()
or instead call this function from the main thread with QMetaMethod::invokeMethod().
- PySide6.QtCore.QCoreApplication.installNativeEventFilter(filterObj)#
- Parameters:
filterObj –
PySide6.QtCore.QAbstractNativeEventFilter
Installs an event filter filterObj
for all native events received by the application in the main thread.
The event filter filterObj
receives events via its nativeEventFilter()
function, which is called for all native events received in the main thread.
The nativeEventFilter()
function should return true if the event should be filtered, i.e. stopped. It should return false to allow normal Qt processing to continue: the native event can then be translated into a QEvent
and handled by the standard Qt event
filtering, e.g. installEventFilter()
.
If multiple event filters are installed, the filter that was installed last is activated first.
Note
The filter function set here receives native messages, i.e. MSG or XCB event structs.
Note
Native event filters will be disabled in the application when the AA_PluginApplication
attribute is set.
For maximum portability, you should always try to use QEvent
and installEventFilter()
whenever possible.
See also
- static PySide6.QtCore.QCoreApplication.installTranslator(messageFile)#
- Parameters:
messageFile –
PySide6.QtCore.QTranslator
- Return type:
bool
Adds the translation file translationFile
to the list of translation files to be used for translations.
Multiple translation files can be installed. Translations are searched for in the reverse order in which they were installed, so the most recently installed translation file is searched first and the first translation file installed is searched last. The search stops as soon as a translation containing a matching string is found.
Installing or removing a QTranslator
, or changing an installed QTranslator
generates a LanguageChange
event for the QCoreApplication
instance. A QApplication instance will propagate the event to all toplevel widgets, where a reimplementation of changeEvent can re-translate the user interface by passing user-visible strings via the tr()
function to the respective property setters. User-interface classes generated by Qt Designer provide a retranslateUi()
function that can be called.
The function returns true
on success and false on failure.
Note
QCoreApplication
does not take ownership of translationFile
.
See also
removeTranslator()
translate()
load()
Prepare for Dynamic Language Changes
- static PySide6.QtCore.QCoreApplication.instance()#
- Return type:
Returns a pointer to the application’s QCoreApplication
(or QGuiApplication/QApplication) instance.
If no instance has been allocated, None
is returned.
- static PySide6.QtCore.QCoreApplication.isQuitLockEnabled()#
- Return type:
bool
Getter of property quitLockEnabled
.
- static PySide6.QtCore.QCoreApplication.isSetuidAllowed()#
- Return type:
bool
- static PySide6.QtCore.QCoreApplication.libraryPaths()#
- Return type:
list of strings
Returns a list of paths that the application will search when dynamically loading libraries.
The return value of this function may change when a QCoreApplication
is created. It is not recommended to call it before creating a QCoreApplication
. The directory of the application executable (not the working directory) is part of the list if it is known. In order to make it known a QCoreApplication
has to be constructed as it will use argv[0]
to find it.
Qt provides default library paths, but they can also be set using a qt.conf file. Paths specified in this file will override default values. Note that if the qt.conf file is in the directory of the application executable, it may not be found until a QCoreApplication
is created. If it is not found when calling this function, the default library paths will be used.
The list will include the installation directory for plugins if it exists (the default installation directory for plugins is INSTALL/plugins
, where INSTALL
is the directory where Qt was installed). The colon separated entries of the QT_PLUGIN_PATH
environment variable are always added. The plugin installation directory (and its existence) may change when the directory of the application executable becomes known.
See also
setLibraryPaths()
addLibraryPath()
removeLibraryPath()
QLibrary
How to Create Qt Plugins
- PySide6.QtCore.QCoreApplication.notify(arg__1, arg__2)#
- Parameters:
arg__1 –
PySide6.QtCore.QObject
arg__2 –
PySide6.QtCore.QEvent
- Return type:
bool
Sends event
to receiver
: receiver
->event(event
). Returns the value that is returned from the receiver’s event handler. Note that this function is called for all events sent to any object in any thread.
For certain types of events (e.g. mouse and key events), the event will be propagated to the receiver’s parent and so on up to the top-level object if the receiver is not interested in the event (i.e., it returns false
).
There are five different ways that events can be processed; reimplementing this virtual function is just one of them. All five approaches are listed below:
Reimplementing paintEvent(), mousePressEvent() and so on. This is the most common, easiest, and least powerful way.
Reimplementing this function. This is very powerful, providing complete control; but only one subclass can be active at a time.
Installing an event filter on
instance()
. Such an event filter is able to process all events for all widgets, so it’s just as powerful as reimplementing notify(); furthermore, it’s possible to have more than one application-global event filter. Global event filters even see mouse events for disabled widgets. Note that application event filters are only called for objects that live in the main thread.Reimplementing
event()
(as QWidget does). If you do this you get Tab key presses, and you get to see the events before any widget-specific event filters.Installing an event filter on the object. Such an event filter gets all the events, including Tab and Shift+Tab key press events, as long as they do not change the focus widget.
Future direction: This function will not be called for objects that live outside the main thread in Qt 6. Applications that need that functionality should find other solutions for their event inspection needs in the meantime. The change may be extended to the main thread, causing this function to be deprecated.
Warning
If you override this function, you must ensure all threads that process events stop doing so before your application object begins destruction. This includes threads started by other libraries that you may be using, but does not apply to Qt’s own threads.
See also
- static PySide6.QtCore.QCoreApplication.organizationDomain()#
- Return type:
str
See also
Getter of property organizationDomain
.
- PySide6.QtCore.QCoreApplication.organizationDomainChanged()#
Notification signal of property organizationDomain
.
- static PySide6.QtCore.QCoreApplication.organizationName()#
- Return type:
str
See also
Getter of property organizationName
.
- PySide6.QtCore.QCoreApplication.organizationNameChanged()#
Notification signal of property organizationName
.
- static PySide6.QtCore.QCoreApplication.postEvent(receiver, event[, priority=Qt.NormalEventPriority])#
- Parameters:
receiver –
PySide6.QtCore.QObject
event –
PySide6.QtCore.QEvent
priority – int
Adds the event event
, with the object receiver
as the receiver of the event, to an event queue and returns immediately.
The event must be allocated on the heap since the post event queue will take ownership of the event and delete it once it has been posted. It is not safe to access the event after it has been posted.
When control returns to the main event loop, all events that are stored in the queue will be sent using the notify()
function.
Events are sorted in descending priority
order, i.e. events with a high priority
are queued before events with a lower priority
. The priority
can be any integer value, i.e. between INT_MAX and INT_MIN, inclusive; see EventPriority
for more details. Events with equal priority
will be processed in the order posted.
See also
sendEvent()
notify()
sendPostedEvents()
EventPriority
- static PySide6.QtCore.QCoreApplication.processEvents([flags=QEventLoop.AllEvents])#
- Parameters:
flags – Combination of
QEventLoop.ProcessEventsFlag
Processes some pending events for the calling thread according to the specified flags
.
Use of this function is discouraged. Instead, prefer to move long operations out of the GUI thread into an auxiliary one and to completely avoid nested event loop processing. If event processing is really necessary, consider using QEventLoop
instead.
In the event that you are running a local loop which calls this function continuously, without an event loop, the DeferredDelete
events will not be processed. This can affect the behaviour of widgets, e.g. QToolTip, that rely on DeferredDelete
events to function properly. An alternative would be to call sendPostedEvents()
from within that local loop.
Calling this function processes events only for the calling thread, and returns after all available events have been processed. Available events are events queued before the function call. This means that events that are posted while the function runs will be queued until a later round of event processing.
See also
- static PySide6.QtCore.QCoreApplication.processEvents(flags, maxtime)
- Parameters:
flags – Combination of
QEventLoop.ProcessEventsFlag
maxtime – int
This function overloads processEvents()
.
Processes pending events for the calling thread for ms
milliseconds or until there are no more events to process, whichever is shorter.
Use of this function is discouraged. Instead, prefer to move long operations out of the GUI thread into an auxiliary one and to completely avoid nested event loop processing. If event processing is really necessary, consider using QEventLoop
instead.
Calling this function processes events only for the calling thread.
Note
Unlike the processEvents()
overload, this function also processes events that are posted while the function runs.
Note
All events that were queued before the timeout will be processed, however long it takes.
See also
- static PySide6.QtCore.QCoreApplication.quit()#
Warning
This section contains snippets that were automatically translated from C++ to Python and may contain errors.
Asks the application to quit.
The request may be ignored if the application prevents the quit, for example if one of its windows can’t be closed. The application can affect this by handling the Quit
event on the application level, or Close
events for the individual windows.
If the quit is not interrupted the application will exit with return code 0 (success).
To exit the application without a chance of being interrupted, call exit()
directly. Note that method is not thread-safe.
It’s good practice to always connect signals to this slot using a QueuedConnection
. If a signal connected (non-queued) to this slot is emitted before control enters the main event loop (such as before “int main” calls exec()
), the slot has no effect and the application never exits. Using a queued connection ensures that the slot will not be invoked until after control enters the main event loop.
Example:
quitButton = QPushButton("Quit") quitButton.clicked.connect(app.quit, Qt::QueuedConnection)
Thread-safety note: this function may be called from any thread to thread-safely cause the currently-running main application loop to exit. However, thread-safety is not guaranteed if the QCoreApplication
object is being destroyed at the same time.
See also
- static PySide6.QtCore.QCoreApplication.removeLibraryPath(arg__1)#
- Parameters:
arg__1 – str
Removes path
from the library path list. If path
is empty or not in the path list, the list is not changed.
The library paths are reset to the default when an instance of QCoreApplication
is destructed.
- PySide6.QtCore.QCoreApplication.removeNativeEventFilter(filterObj)#
- Parameters:
filterObj –
PySide6.QtCore.QAbstractNativeEventFilter
Removes an event filterObject
from this object. The request is ignored if such an event filter has not been installed.
All event filters for this object are automatically removed when this object is destroyed.
It is always safe to remove an event filter, even during event filter activation (i.e. from the nativeEventFilter() function).
See also
- static PySide6.QtCore.QCoreApplication.removePostedEvents(receiver[, eventType=0])#
- Parameters:
receiver –
PySide6.QtCore.QObject
eventType – int
Removes all events of the given eventType
that were posted using postEvent()
for receiver
.
The events are not dispatched, instead they are removed from the queue. You should never need to call this function. If you do call it, be aware that killing events may cause receiver
to break one or more invariants.
If receiver
is None
, the events of eventType
are removed for all objects. If eventType
is 0, all the events are removed for receiver
. You should never call this function with eventType
of 0.
- static PySide6.QtCore.QCoreApplication.removeTranslator(messageFile)#
- Parameters:
messageFile –
PySide6.QtCore.QTranslator
- Return type:
bool
Removes the translation file translationFile
from the list of translation files used by this application. (It does not delete the translation file from the file system.)
The function returns true
on success and false on failure.
See also
- PySide6.QtCore.QCoreApplication.requestPermission(permission, context, functor)#
- Parameters:
permission –
PySide6.QtCore.QBluetoothPermission
context –
PySide6.QtCore.QObject
functor –
PyCallable
- PySide6.QtCore.QCoreApplication.requestPermission(permission, context, functor)
- Parameters:
permission –
PySide6.QtCore.QCalendarPermission
context –
PySide6.QtCore.QObject
functor –
PyCallable
- PySide6.QtCore.QCoreApplication.requestPermission(permission, context, functor)
- Parameters:
permission –
PySide6.QtCore.QCameraPermission
context –
PySide6.QtCore.QObject
functor –
PyCallable
- PySide6.QtCore.QCoreApplication.requestPermission(permission, context, functor)
- Parameters:
permission –
PySide6.QtCore.QContactsPermission
context –
PySide6.QtCore.QObject
functor –
PyCallable
- PySide6.QtCore.QCoreApplication.requestPermission(permission, context, functor)
- Parameters:
permission –
PySide6.QtCore.QLocationPermission
context –
PySide6.QtCore.QObject
functor –
PyCallable
- PySide6.QtCore.QCoreApplication.requestPermission(permission, context, functor)
- Parameters:
permission –
PySide6.QtCore.QMicrophonePermission
context –
PySide6.QtCore.QObject
functor –
PyCallable
- PySide6.QtCore.QCoreApplication.resolveInterface(name, revision)#
- Parameters:
name – str
revision – int
- Return type:
void
- static PySide6.QtCore.QCoreApplication.sendEvent(receiver, event)#
- Parameters:
receiver –
PySide6.QtCore.QObject
event –
PySide6.QtCore.QEvent
- Return type:
bool
Warning
This section contains snippets that were automatically translated from C++ to Python and may contain errors.
Sends event event
directly to receiver receiver
, using the notify()
function. Returns the value that was returned from the event handler.
The event is not deleted when the event has been sent. The normal approach is to create the event on the stack, for example:
event = QMouseEvent(QEvent.MouseButtonPress, pos, 0, 0, 0) QApplication.sendEvent(mainWindow, event)See also
- static PySide6.QtCore.QCoreApplication.sendPostedEvents([receiver=None[, event_type=0]])#
- Parameters:
receiver –
PySide6.QtCore.QObject
event_type – int
Immediately dispatches all events which have been previously queued with postEvent()
and which are for the object receiver
and have the event type event_type
.
Events from the window system are not dispatched by this function, but by processEvents()
.
If receiver
is None
, the events of event_type
are sent for all objects. If event_type
is 0, all the events are sent for receiver
.
Note
This method must be called from the thread in which its QObject
parameter, receiver
, lives.
See also
- static PySide6.QtCore.QCoreApplication.setApplicationName(application)#
- Parameters:
application – str
See also
Setter of property applicationName
.
- static PySide6.QtCore.QCoreApplication.setApplicationVersion(version)#
- Parameters:
version – str
See also
Setter of property applicationVersion
.
- static PySide6.QtCore.QCoreApplication.setAttribute(attribute[, on=true])#
- Parameters:
attribute –
ApplicationAttribute
on – bool
- static PySide6.QtCore.QCoreApplication.setEventDispatcher(eventDispatcher)#
- Parameters:
eventDispatcher –
PySide6.QtCore.QAbstractEventDispatcher
Sets the event dispatcher for the main thread to eventDispatcher
. This is only possible as long as there is no event dispatcher installed yet. That is, before QCoreApplication
has been instantiated. This method takes ownership of the object.
See also
- static PySide6.QtCore.QCoreApplication.setLibraryPaths(arg__1)#
- Parameters:
arg__1 – list of strings
Sets the list of directories to search when loading plugins with QLibrary
to paths
. All existing paths will be deleted and the path list will consist of the paths given in paths
and the path to the application.
The library paths are reset to the default when an instance of QCoreApplication
is destructed.
- static PySide6.QtCore.QCoreApplication.setOrganizationDomain(orgDomain)#
- Parameters:
orgDomain – str
See also
Setter of property organizationDomain
.
- static PySide6.QtCore.QCoreApplication.setOrganizationName(orgName)#
- Parameters:
orgName – str
See also
Setter of property organizationName
.
- static PySide6.QtCore.QCoreApplication.setQuitLockEnabled(enabled)#
- Parameters:
enabled – bool
See also
Setter of property quitLockEnabled
.
- static PySide6.QtCore.QCoreApplication.setSetuidAllowed(allow)#
- Parameters:
allow – bool
- PySide6.QtCore.QCoreApplication.shutdown()#
- static PySide6.QtCore.QCoreApplication.startingUp()#
- Return type:
bool
Returns true
if an application object has not been created yet; otherwise returns false
.
See also
- static PySide6.QtCore.QCoreApplication.testAttribute(attribute)#
- Parameters:
attribute –
ApplicationAttribute
- Return type:
bool
- static PySide6.QtCore.QCoreApplication.translate(context, key[, disambiguation=None[, n=-1]])#
- Parameters:
context – str
key – str
disambiguation – str
n – int
- Return type:
str
Returns the translation text for sourceText
, by querying the installed translation files. The translation files are searched from the most recently installed file back to the first installed file.
tr()
provides this functionality more conveniently.
context
is typically a class name (e.g., “MyDialog”) and sourceText
is either English text or a short identifying text.
disambiguation
is an identifying string, for when the same sourceText
is used in different roles within the same context. By default, it is None
.
See the QTranslator
and tr()
documentation for more information about contexts, disambiguations and comments.
n
is used in conjunction with %n
to support plural forms. See tr()
for details.
If none of the translation files contain a translation for sourceText
in context
, this function returns a QString
equivalent of sourceText
.
This function is not virtual. You can use alternative translation techniques by subclassing QTranslator
.
See also
tr()
installTranslator()
removeTranslator()
Internationalization and Translations
- class QCoreApplication(args)#
Constructs a Qt kernel application. Kernel applications are applications without a graphical user interface. These type of applications are used at the console or as server processes.
The args argument is processed by the application, and made available in a more convenient form by the
arguments()
method.