IJobHolderRepresentationHandler Class Reference

#include "ijobholder.h"

Public Member Functions
virtual	~IJobHolderRepresentationHandler ()=default
virtual QAbstractItemModel &	GetRepresentation ()=0
	Returns the item representation model.
virtual void	HandleCurrentChanged (const QModelIndex &)
virtual void	HandleCurrentColumnChanged (const QModelIndex &)
virtual void	HandleCurrentRowChanged (const QModelIndex &)
virtual void	HandleSelectedRowsChanged (const QList< QModelIndex > &)
virtual void	HandleActivated (const QModelIndex &)
virtual void	HandleClicked (const QModelIndex &)
virtual void	HandleDoubleClicked (const QModelIndex &)
virtual void	HandleEntered (const QModelIndex &)
virtual void	HandlePressed (const QModelIndex &)
virtual QWidget *	GetInfoWidget ()
virtual QToolBar *	GetControls ()
virtual QMenu *	GetContextMenu ()

Detailed Description

Definition at line 117 of file ijobholder.h.

Constructor & Destructor Documentation

~IJobHolderRepresentationHandler()

virtual IJobHolderRepresentationHandler::~IJobHolderRepresentationHandler ( )

virtualdefault

Member Function Documentation

GetContextMenu()

virtual QMenu * IJobHolderRepresentationHandler::GetContextMenu ( )

inlinevirtual

Definition at line 169 of file ijobholder.h.

GetControls()

virtual QToolBar * IJobHolderRepresentationHandler::GetControls ( )

inlinevirtual

Definition at line 168 of file ijobholder.h.

GetInfoWidget()

virtual QWidget * IJobHolderRepresentationHandler::GetInfoWidget ( )

inlinevirtual

Definition at line 167 of file ijobholder.h.

GetRepresentation()

virtual QAbstractItemModel & IJobHolderRepresentationHandler::GetRepresentation ( )

pure virtual

Returns the item representation model.

The returned model is role-based: each row should provide a RowInfo via JobHolderRole::RowInfo, and process rows should also provide JobHolderProcessRole values (Done, Total, State, StateCustomText). Inside of LeechCraft the model would be merged with other models from other plugins.

This model is also used to retrieve controls and additional info for a given index via the CustomDataRoles::RoleControls and CustomDataRoles::RoleAdditionalInfo respectively.

Returned controls widget would be placed above the view with the jobs, so usually it has some actions controlling the job, but in fact it can have anything you want. It is only visible when a job from your plugin is selected. If a job from other plugin is selected, then other plugin's controls would be placed, and if no jobs are selected at all then all controls are hidden.

Widget with the additional information is placed to the right of the view with the jobs, so usually it has additional information about the job like transfer log for FTP client, but in fact it can have anything you want. The same rules regarding its visibility apply as for controls widget.

Returns

Representation model.

See also

IJobHolder

LC::CustomDataRoles

LC::RowInfo

LC::JobHolderProcessRole

HandleActivated()

virtual void IJobHolderRepresentationHandler::HandleActivated ( const QModelIndex & )

inlinevirtual

Definition at line 161 of file ijobholder.h.

HandleClicked()

virtual void IJobHolderRepresentationHandler::HandleClicked ( const QModelIndex & )

inlinevirtual

Definition at line 162 of file ijobholder.h.

HandleCurrentChanged()

virtual void IJobHolderRepresentationHandler::HandleCurrentChanged ( const QModelIndex & )

inlinevirtual

Definition at line 156 of file ijobholder.h.

HandleCurrentColumnChanged()

virtual void IJobHolderRepresentationHandler::HandleCurrentColumnChanged ( const QModelIndex & )

inlinevirtual

Definition at line 157 of file ijobholder.h.

HandleCurrentRowChanged()

virtual void IJobHolderRepresentationHandler::HandleCurrentRowChanged ( const QModelIndex & )

inlinevirtual

Definition at line 158 of file ijobholder.h.

HandleDoubleClicked()

virtual void IJobHolderRepresentationHandler::HandleDoubleClicked ( const QModelIndex & )

inlinevirtual

Definition at line 163 of file ijobholder.h.

HandleEntered()

virtual void IJobHolderRepresentationHandler::HandleEntered ( const QModelIndex & )

inlinevirtual

Definition at line 164 of file ijobholder.h.

HandlePressed()

virtual void IJobHolderRepresentationHandler::HandlePressed ( const QModelIndex & )

inlinevirtual

Definition at line 165 of file ijobholder.h.

HandleSelectedRowsChanged()

virtual void IJobHolderRepresentationHandler::HandleSelectedRowsChanged ( const QList< QModelIndex > & )

inlinevirtual

Definition at line 159 of file ijobholder.h.

---

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