IJobHolder Class Reference

Interface for plugins holding jobs or persistent notifications. More...

#include "ijobholder.h"

Public Member Functions
virtual IJobHolderRepresentationHandler_ptr	CreateRepresentationHandler ()=0

Protected Member Functions
virtual	~IJobHolder ()=default

Detailed Description

Interface for plugins holding jobs or persistent notifications.

If a plugin can have some long-performing jobs (like a BitTorrent download, or file transfer in an IM client, or mail checking status) or persistent notifications (like unread messages in an IM client, unread news in an RSS feed reader or weather forecast), it may want to implement this interface to display itself in plugins like Summary.

The model with jobs and state info is obtained via GetRepresentation(), and various roles are used to retrieve controls and information pane of the plugin from that model, as well as some metadata like job progress (see JobHolderRole and JobHolderProcessRole enumerations, and RowInfo for an example).

Controls and additional information pane are only visible when a job handled by the plugin is selected.

See also

IDownloader

CustomDataRoles

JobHolderRole

JobHolderProcessRole

RowInfo

Definition at line 198 of file ijobholder.h.

Constructor & Destructor Documentation

~IJobHolder()

virtual IJobHolder::~IJobHolder ( )

protectedvirtualdefault

Member Function Documentation

CreateRepresentationHandler()

virtual IJobHolderRepresentationHandler_ptr IJobHolder::CreateRepresentationHandler ( )

pure virtual

---

The documentation for this class was generated from the following file:

• /home/abuild/rpmbuild/BUILD/leechcraft-doc-0.6.70+git.18450.gabe19ee3b0-build/leechcraft-0.6.70-18450-gabe19ee3b0/src/interfaces/ijobholder.h