JobActionFactory Class Reference

#include <molequeue/jobactionfactory.h>

Inheritance diagram for JobActionFactory:

Public Types
enum	Flag { ContextItem = 0x1 }

Public Member Functions
	JobActionFactory (const JobActionFactory &other)
JobActionFactory &	operator= (const JobActionFactory &other)
virtual void	readSettings (QSettings &settings)
virtual void	writeSettings (QSettings &settings) const
void	setServer (Server *s)
Server *	server () 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
Server *	m_server
QList< Job >	m_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

Flag

enum Flag

Flags defining properties of the created QActions.

Enumerator
ContextItem	Actions may be used as a context menu item.

Member Function Documentation

readSettings()

virtual void readSettings ( QSettings & settings )

virtual

Reimplemented in OpenWithActionFactory.

writeSettings()

virtual void writeSettings ( QSettings & settings ) const

virtual

Reimplemented in OpenWithActionFactory.

setServer()

void setServer

(

Server *

s

)

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

server()

Server * server

(

)

const

Return the Server instance.

name()

virtual QString name ( ) const

pure virtual

A name that uniquely identifies this factory.

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

clearJobs()

virtual void clearJobs ( )

virtual

Clear m_jobs and reset m_attemptedJobAdditions

Reimplemented in OpenWithActionFactory.

isMultiJob()

virtual bool isMultiJob ( ) const

virtual

Returns

true if the product QActions operate on multiple jobs.

addJobIfValid()

virtual bool addJobIfValid ( const Job & job )

virtual

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

See also

isValidForJob

isValidForJob()

virtual bool isValidForJob ( const Job & job ) const

pure virtual

Returns

true if the factory's actions are appropriate for job.

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

useMenu()

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.

menuText()

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.

hasValidActions()

virtual bool hasValidActions ( ) const

virtual

Returns

true if addJobIfValid has been called with any appropriate jobs since the last call to clearJobs().

createActions()

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 KillJobActionFactory, OpenDirectoryActionFactory, OpenWithActionFactory, RemoveJobActionFactory, and ViewJobLogActionFactory.

usefulness()

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 KillJobActionFactory, OpenDirectoryActionFactory, OpenWithActionFactory, RemoveJobActionFactory, and ViewJobLogActionFactory.

flags()

virtual Flags flags ( ) const

virtual

Returns

A set of JobActionFactory::Flags describe the actions produced by this factory.

setFlags()

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:

• jobactionfactory.h