QDesktopServices

The QDesktopServices class provides methods for accessing common desktop services. More…

New in version 4.2.

Synopsis

Static functions

• def openUrl (url)

• def setUrlHandler (scheme, receiver, method)

• def unsetUrlHandler (scheme)

Detailed Description

Many desktop environments provide services that can be used by applications to perform common tasks, such as opening a web page, in a way that is both consistent and takes into account the user’s application preferences.

This class contains functions that provide simple interfaces to these services that indicate whether they succeeded or failed.

The openUrl() function is used to open files located at arbitrary URLs in external applications. For URLs that correspond to resources on the local filing system (where the URL scheme is “file”), a suitable application will be used to open the file; otherwise, a web browser will be used to fetch and display the file.

The user’s desktop settings control whether certain executable file types are opened for browsing, or if they are executed instead. Some desktop environments are configured to prevent users from executing files obtained from non-local URLs, or to ask the user’s permission before doing so.

URL Handlers

The behavior of the openUrl() function can be customized for individual URL schemes to allow applications to override the default handling behavior for certain types of URLs.

The dispatch mechanism allows only one custom handler to be used for each URL scheme; this is set using the setUrlHandler() function. Each handler is implemented as a slot which accepts only a single QUrl argument.

The existing handlers for each scheme can be removed with the unsetUrlHandler() function. This returns the handling behavior for the given scheme to the default behavior.

This system makes it easy to implement a help system, for example. Help could be provided in labels and text browsers using help://myapplication/mytopic URLs, and by registering a handler it becomes possible to display the help text inside the application:

def showHelp(url):
    # ...
    pass

QDesktopServices.setUrlHandler("help", showHelp);

If inside the handler you decide that you can’t open the requested URL, you can just call openUrl() again with the same argument, and it will try to open the URL using the appropriate mechanism for the user’s desktop environment.

Combined with platform specific settings, the schemes registered by the openUrl() function can also be exposed to other applications, opening up for application deep linking or a very basic URL-based IPC mechanism.

Note

Since Qt 5, storageLocation() and displayName() are replaced by functionality provided by the QStandardPaths class.

See also

QSystemTrayIcon QProcess QStandardPaths

class PySide2.QtGui.QDesktopServices

static PySide2.QtGui.QDesktopServices.openUrl(url)

Parameters:

url – PySide2.QtCore.QUrl

Return type:

bool

Opens the given url in the appropriate Web browser for the user’s desktop environment, and returns true if successful; otherwise returns false .

If the URL is a reference to a local file (i.e., the URL scheme is “file”) then it will be opened with a suitable application instead of a Web browser.

The following example opens a file on the Windows file system residing on a path that contains spaces:

QDesktopServices.openUrl(QUrl("file:///C:/Documents and Settings/All Users/Desktop", QUrl.TolerantMode))

If a mailto URL is specified, the user’s e-mail client will be used to open a composer window containing the options specified in the URL, similar to the way mailto links are handled by a Web browser.

For example, the following URL contains a recipient (user@foo.com ), a subject (Test ), and a message body (Just a test ):

mailto:user@foo.com?subject=Test&body=Just a test

Warning

Although many e-mail clients can send attachments and are Unicode-aware, the user may have configured their client without these features. Also, certain e-mail clients (e.g., Lotus Notes) have problems with long URLs.

Warning

A return value of true indicates that the application has successfully requested the operating system to open the URL in an external application. The external application may still fail to launch or fail to open the requested URL. This result will not be reported back to the application.

Warning

URLs passed to this function on iOS will not load unless their schemes are listed in the LSApplicationQueriesSchemes key of the application’s Info.plist file. For more information, see the Apple Developer Documentation for canOpenURL(_:) . For example, the following lines enable URLs with the HTTPS scheme:

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>https</string>
</array>

See also

setUrlHandler()

static PySide2.QtGui.QDesktopServices.setUrlHandler(scheme, receiver, method)

Parameters:

• scheme – str

• receiver – PySide2.QtCore.QObject

• method – str

Sets the handler for the given scheme to be the handler method provided by the receiver object.

This function provides a way to customize the behavior of openUrl() . If openUrl() is called with a URL with the specified scheme then the given method on the receiver object is called instead of QDesktopServices launching an external application.

The provided method must be implemented as a slot that only accepts a single QUrl argument.

def showHelp(url):
    # ...
    pass

QDesktopServices.setUrlHandler("help", showHelp);

To use this function for receiving data from other apps on iOS you also need to add the custom scheme to the CFBundleURLSchemes list in your Info.plist file:

<key>CFBundleURLTypes</key>
<array>
    <dict>
        <key>CFBundleURLSchemes</key>
        <array>
            <string>myapp</string>
        </array>
    </dict>
</array>

For more information, see the Apple Developer Documentation for Communicating with Other Apps Using Custom URLs .

Warning

It is not possible to claim support for some well known URL schemes, including http and https. This is only allowed for Universal Links.

To claim support for http and https the above entry in the Info.plist file is not allowed. This is only possible when you add your domain to the Entitlements file:

<key>com.apple.developer.associated-domains</key>
<array>
    <string>applinks:your.domain.com</string>
</array>

iOS will search for /.well-known/apple-app-site-association on your domain, when the application is installed. If you want to listen to https://your.domain.com/help?topic=ABCDEF you need to provide the following content there:

{
    "applinks": {
        "apps": [],
        "details": [{
            "appIDs" : [ "ABCDE12345.com.example.app" ],
            "components": [{
                "/": "/help",
                "?": { "topic": "?*"}
            }]
        }]
    }
}

For more information, see the Apple Developer Documentation for https://developer.apple.com/documentation/safariservices/supporting_associated_domains_in_your_app [Supporting Associated Domains}.

If is used to set a new handler for a scheme which already has a handler, the existing handler is simply replaced with the new one. Since QDesktopServices does not take ownership of handlers, no objects are deleted when a handler is replaced.

Note that the handler will always be called from within the same thread that calls openUrl() .

You must call unsetUrlHandler() before destroying the handler object, so the destruction of the handler object does not overlap with concurrent invocations of openUrl() using it.

See also

openUrl() unsetUrlHandler()

static PySide2.QtGui.QDesktopServices.unsetUrlHandler(scheme)

Parameters:

scheme – str

Removes a previously set URL handler for the specified scheme .

Call this function before the handler object that was registered for scheme is destroyed, to prevent concurrent openUrl() calls from continuing to call the destroyed handler object.

See also

setUrlHandler()