MoleQueue  0.8.0
 All Classes Functions Variables Enumerations Enumerator Pages
Public Types | Public Member Functions | Protected Attributes | List of all members
JobActionFactory Class Referenceabstract

#include <molequeue/jobactionfactory.h>

Inheritance diagram for JobActionFactory:
KillJobActionFactory OpenDirectoryActionFactory OpenWithActionFactory RemoveJobActionFactory ViewJobLogActionFactory

Public Types

enum  Flag { ContextItem = 0x1 }
 

Public Member Functions

 JobActionFactory (const JobActionFactory &other)
 
JobActionFactoryoperator= (const JobActionFactory &other)
 
virtual void readSettings (QSettings &settings)
 
virtual void writeSettings (QSettings &settings) const
 
void setServer (Server *s)
 
Serverserver () const
 
virtual QString name () const =0
 
virtual void clearJobs ()
 
virtual bool isMultiJob () const
 
virtual bool addJobIfValid (const Job &job)
 
virtual bool isValidForJob (const Job &job) const =0
 
virtual bool useMenu () const
 
virtual QString menuText () const
 
virtual bool hasValidActions () const
 
virtual QList< QAction * > createActions ()=0
 
virtual unsigned int usefulness () const =0
 
virtual Flags flags () const
 
virtual void setFlags (Flags f)
 

Protected Attributes

unsigned int m_attemptedJobAdditions
 
bool m_isMultiJob
 
Serverm_server
 
QList< Jobm_jobs
 
Flags m_flags
 

Detailed Description

Base class for implementing a factory which creates QActions that operate on Job instances.

Author
David C. Lonie

Member Enumeration Documentation

enum Flag

Flags defining properties of the created QActions.

Enumerator
ContextItem 

Actions may be used as a context menu item.

Member Function Documentation

void setServer ( Server s)

Set the Server instance. Called in ActionFactoryManager::addFactory().

Server* server ( ) const

Return the Server instance.

virtual QString name ( ) const
pure virtual

A name that uniquely identifies this factory.

Implemented in OpenWithActionFactory, RemoveJobActionFactory, ViewJobLogActionFactory, KillJobActionFactory, and OpenDirectoryActionFactory.

virtual void clearJobs ( )
virtual

Clear m_jobs and reset m_attemptedJobAdditions

Reimplemented in OpenWithActionFactory.

virtual bool isMultiJob ( ) const
virtual
Returns
true if the product QActions operate on multiple jobs.
virtual bool addJobIfValid ( const Job job)
virtual

Increment m_attemptedJobAdditions and check if the factory's actions are appropriate for the Job by calling isValidForJob. If so, job is added to m_jobs.

See Also
isValidForJob
virtual bool isValidForJob ( const Job job) const
pure virtual
Returns
true if the factory's actions are appropriate for job.

Implemented in OpenWithActionFactory, RemoveJobActionFactory, ViewJobLogActionFactory, KillJobActionFactory, and OpenDirectoryActionFactory.

virtual bool useMenu ( ) const
virtual
Returns
true if this factory's actions should be placed in a submenu. Use menuText() to get the menu name.

Reimplemented in OpenWithActionFactory.

virtual QString menuText ( ) const
virtual
Returns
The text to be used for a submenu containing this factory's items. Call useMenu() to see if this is required.

Reimplemented in OpenWithActionFactory.

virtual bool hasValidActions ( ) const
virtual
Returns
true if addJobIfValid has been called with any appropriate jobs since the last call to clearJobs().
virtual QList<QAction *> createActions ( )
pure virtual

Create actions that operate on the Job objects in m_jobs. The caller is responsible for managing the lifetime of the actions (passing them to a QMenu or similar is usually sufficient).

See Also
hasValidActions()
addJobIfValid
clearJobs

Implemented in OpenWithActionFactory, RemoveJobActionFactory, ViewJobLogActionFactory, KillJobActionFactory, and OpenDirectoryActionFactory.

virtual unsigned int usefulness ( ) const
pure virtual

The "usefulness" of the actions produced by this factory, used to order actions in generated menus, etc. Lower value means higher usefulness.

Implemented in OpenWithActionFactory, RemoveJobActionFactory, ViewJobLogActionFactory, KillJobActionFactory, and OpenDirectoryActionFactory.

virtual Flags flags ( ) const
virtual
Returns
A set of JobActionFactory::Flags describe the actions produced by this factory.
virtual void setFlags ( Flags  f)
virtual
Returns
Set JobActionFactory::Flags describing the actions produced by this factory.

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