API reference - Class QDesktopServices

ApplicationsLocation

Signature: [static,const] QDesktopServices_StandardLocation ApplicationsLocation

Description: Enum constant QDesktopServices::ApplicationsLocation

Python specific notes:
The object exposes a readable attribute 'ApplicationsLocation'. This is the getter.

CacheLocation

Signature: [static,const] QDesktopServices_StandardLocation CacheLocation

Description: Enum constant QDesktopServices::CacheLocation

Python specific notes:
The object exposes a readable attribute 'CacheLocation'. This is the getter.

DataLocation

Signature: [static,const] QDesktopServices_StandardLocation DataLocation

Description: Enum constant QDesktopServices::DataLocation

Python specific notes:
The object exposes a readable attribute 'DataLocation'. This is the getter.

DesktopLocation

Signature: [static,const] QDesktopServices_StandardLocation DesktopLocation

Description: Enum constant QDesktopServices::DesktopLocation

Python specific notes:
The object exposes a readable attribute 'DesktopLocation'. This is the getter.

DocumentsLocation

Signature: [static,const] QDesktopServices_StandardLocation DocumentsLocation

Description: Enum constant QDesktopServices::DocumentsLocation

Python specific notes:
The object exposes a readable attribute 'DocumentsLocation'. This is the getter.

FontsLocation

Signature: [static,const] QDesktopServices_StandardLocation FontsLocation

Description: Enum constant QDesktopServices::FontsLocation

Python specific notes:
The object exposes a readable attribute 'FontsLocation'. This is the getter.

HomeLocation

Signature: [static,const] QDesktopServices_StandardLocation HomeLocation

Description: Enum constant QDesktopServices::HomeLocation

Python specific notes:
The object exposes a readable attribute 'HomeLocation'. This is the getter.

MoviesLocation

Signature: [static,const] QDesktopServices_StandardLocation MoviesLocation

Description: Enum constant QDesktopServices::MoviesLocation

Python specific notes:
The object exposes a readable attribute 'MoviesLocation'. This is the getter.

MusicLocation

Signature: [static,const] QDesktopServices_StandardLocation MusicLocation

Description: Enum constant QDesktopServices::MusicLocation

Python specific notes:
The object exposes a readable attribute 'MusicLocation'. This is the getter.

PicturesLocation

Signature: [static,const] QDesktopServices_StandardLocation PicturesLocation

Description: Enum constant QDesktopServices::PicturesLocation

Python specific notes:
The object exposes a readable attribute 'PicturesLocation'. This is the getter.

TempLocation

Signature: [static,const] QDesktopServices_StandardLocation TempLocation

Description: Enum constant QDesktopServices::TempLocation

Python specific notes:
The object exposes a readable attribute 'TempLocation'. This is the getter.

_const_cast

Signature: [const] QDesktopServices ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

assign

Signature: void assign (const QDesktopServices other)

Description: Assigns another object to self

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

displayName

Signature: [static] string displayName (const QDesktopServices_StandardLocation type)

Description: Static method QString QDesktopServices::displayName(QDesktopServices::StandardLocation type)

This method is static and can be called without an instance.

dup

Signature: [const] new QDesktopServices ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

new

Signature: [static] new QDesktopServices new

Description: Constructor QDesktopServices::QDesktopServices()

This method creates an object of class QDesktopServices.

Python specific notes:
This method is the default initializer of the object.

openUrl

Signature: [static] bool openUrl (const QUrl url)

Description: Static method bool QDesktopServices::openUrl(const QUrl &url)

This method is static and can be called without an instance.

setUrlHandler

Signature: [static] void setUrlHandler (string scheme, QObject ptr receiver, string method)

Description: Static method void QDesktopServices::setUrlHandler(const QString &scheme, QObject *receiver, const char *method)

This method is static and can be called without an instance.

storageLocation

Signature: [static] string storageLocation (const QDesktopServices_StandardLocation type)

Description: Static method QString QDesktopServices::storageLocation(QDesktopServices::StandardLocation type)

This method is static and can be called without an instance.

unsetUrlHandler

Signature: [static] void unsetUrlHandler (string scheme)

Description: Static method void QDesktopServices::unsetUrlHandler(const QString &scheme)

This method is static and can be called without an instance.