KActivities 5.109.0
|
This class is used to notify the system that a file, web page or some other resource has been accessed. More...
#include <resourceinstance.h>
Properties | |
QString | mimetype |
QString | title |
QUrl | uri |
quintptr | winId |
Signals | |
void | requestsFocus () |
Emitted when the system wants to show the resource represented by this ResourceInstance. | |
Public Slots | |
void | notifyFocusedIn () |
Call this method to notify the system that the resource has the focus in your application. | |
void | notifyFocusedOut () |
Call this method to notify the system that the resource lost the focus in your application. | |
void | notifyModified () |
Call this method to notify the system that you modified (the contents of) the resource. | |
void | setMimetype (const QString &mimetype) |
Sets the mimetype for this resource. | |
void | setTitle (const QString &title) |
Sets the title for this resource. | |
void | setUri (const QUrl &newUri) |
This is a convenience method that sets the new URI. | |
Public Member Functions | |
ResourceInstance (quintptr wid, const QString &application, QObject *parent=nullptr) | |
Creates a new resource instance. | |
ResourceInstance (quintptr wid, QObject *parent=nullptr) | |
Creates a new resource instance. | |
ResourceInstance (quintptr wid, QUrl resourceUri, const QString &mimetype=QString(), const QString &title=QString(), const QString &application=QString(), QObject *parent=nullptr) | |
Creates a new resource instance and automatically notifies the system that it was opened. | |
~ResourceInstance () override | |
Destroys the ResourceInstance and notifies the system that the resource has been closed. | |
QString | mimetype () const |
QString | title () const |
virtual QUrl | uri () const |
quintptr | winId () const |
Static Public Member Functions | |
static void | notifyAccessed (const QUrl &uri, const QString &application=QString()) |
If there's no way to tell for how long an application is keeping the resource open, you can just call this static method - it will notify the system that the application has accessed the resource. | |
This class is used to notify the system that a file, web page or some other resource has been accessed.
It provides methods to notify the system when the resource was opened, modified and closed, along with in what window the resource is shown.
You should create an instance of this class for every resource you open.
"The system" in this case can be the backend for tracking and automatically scoring files that are being accessed, the system to show the open files per window in the taskbar, the share-like-connect, etc.
The user of this class shouldn't care about the backend systems - everything is done under-the-hood automatically.
|
explicit |
Creates a new resource instance.
wid | id of the window that will show the resource |
parent | pointer to the parent object |
|
explicit |
Creates a new resource instance.
wid | id of the window that will show the resource |
application | application's name (the name used for the .desktop file). If not specified, QCoreApplication::applicationName is used |
parent | pointer to the parent object |
KActivities::ResourceInstance::ResourceInstance | ( | quintptr | wid, |
QUrl | resourceUri, | ||
const QString & | mimetype = QString() , |
||
const QString & | title = QString() , |
||
const QString & | application = QString() , |
||
QObject * | parent = nullptr |
||
) |
Creates a new resource instance and automatically notifies the system that it was opened.
In some special cases, where the URI of the resource is being constantly changed (for example, in the world globe, street map applications) you have two options:
wid | window id in which the resource is shown |
resourceUri | URI of the resource that is shown |
mimetype | the mime type of the resource |
title | the title of the resource |
application | application's name (the name used for the .desktop file). If not specified, QCoreApplication::applicationName is used |
parent | pointer to the parent object |
|
override |
Destroys the ResourceInstance and notifies the system that the resource has been closed.
QString KActivities::ResourceInstance::mimetype | ( | ) | const |
|
static |
If there's no way to tell for how long an application is keeping the resource open, you can just call this static method - it will notify the system that the application has accessed the resource.
uri | URI of the resource |
application | application's name (the name used for the .desktop file). If not specified, QCoreApplication::applicationName is used |
|
slot |
Call this method to notify the system that the resource has the focus in your application.
|
slot |
Call this method to notify the system that the resource lost the focus in your application.
|
slot |
Call this method to notify the system that you modified (the contents of) the resource.
|
signal |
Emitted when the system wants to show the resource represented by this ResourceInstance.
You should listen to this signal if you have multiple resources shown in one window (MDI). On catching it, show the resource and give it focus.
|
slot |
Sets the mimetype for this resource.
|
slot |
Sets the title for this resource.
|
slot |
This is a convenience method that sets the new URI.
This is usually handled by sending the close event for the previous URI, and an open event for the new one.
QString KActivities::ResourceInstance::title | ( | ) | const |
|
virtual |
quintptr KActivities::ResourceInstance::winId | ( | ) | const |