vcs

KDevelop::VcsJob

KDevelop::VcsJob Class Reference

#include <vcsjob.h>

Inheritance diagram for KDevelop::VcsJob:

[legend]

List of all members.

Detailed Description

This class provides an extension of KJob to get various Vcs specific information about the job.

This includes the type, the state and the results provided by the job.

Definition at line 44 of file vcsjob.h.


Public Types
enum	JobStatus { JobRunning = 0, JobSucceeded = 1, JobCanceled = 2, JobFailed = 3, JobNotStarted = 4 }
enum	JobType { Add = 0, Remove = 1, Copy = 2, Move = 3, Diff = 4, Commit = 5, Update = 6, Merge = 7, Resolve = 8, Import = 9, Checkout = 10, Log = 11, Push = 12, Pull = 13, Annotate = 14, Clone = 15, Status = 16, Revert = 17, Cat = 18, UserType = 1000 }
Signals
void	resultsReady (KDevelop::VcsJob *)
Public Member Functions
virtual QVariant	fetchResults ()=0
virtual JobStatus	status () const =0
JobType	type ()
	VcsJob (QObject *parent=0)
virtual KDevelop::IPlugin *	vcsPlugin () const =0
Protected Member Functions
void	setType (JobType)

Member Enumeration Documentation

enum KDevelop::VcsJob::JobStatus

Simple enum to define how the job finished.

Enumerator:

JobRunning	The job is running.
JobSucceeded	The job succeeded.
JobCanceled	The job was cancelled.
JobFailed	The job failed.
JobNotStarted	The job is not yet started.

Definition at line 83 of file vcsjob.h.

enum KDevelop::VcsJob::JobType

To easily check which type of job this is.

: Check how this can be extended via plugins, maybe use QFlag? (not QFlags!)

Enumerator:

Add	An add job.
Remove	A remove job.
Copy	A copy job.
Move	A move job.
Diff	A diff job.
Commit	A commit job.
Update	An update job.
Merge	A merge job.
Resolve	A resolve job.
Import	An import job.
Checkout	A checkout job.
Log	A log job.
Push	A push job.
Pull	A pull job.
Annotate	An annotate job.
Clone	A clone job.
Status	A status job.
Revert	A revert job.
Cat	A cat job.
UserType	A custom job.

Definition at line 56 of file vcsjob.h.

Member Function Documentation

virtual QVariant KDevelop::VcsJob::fetchResults ( ) [pure virtual]

This method will return all new results of the job.

The actual data type that is wrapped in the QVariant depends on the type of job.

Note:: Results returned by a previous call to fetchResults are not returned.

Implemented in DVCSjob.

void KDevelop::VcsJob::resultsReady ( KDevelop::VcsJob * ) [signal]

This signal is emitted when new results are available.

Depending on the plugin and the operation, it may be emitted only once when all results are ready, or several times.

void KDevelop::VcsJob::setType ( VcsJob::JobType t ) [protected]

This can be used to set the type of the vcs job in subclasses.

Definition at line 46 of file vcsjob.cpp.

virtual JobStatus KDevelop::VcsJob::status ( ) const [pure virtual]

Find out in which state the job is, it can be running, cancelled failed or finished.

Returns:: the status of the job

See also:: JobStatus

Implemented in DVCSjob.

VcsJob::JobType KDevelop::VcsJob::type ( )

Used to find out about the type of job.

Returns:: the type of job

Definition at line 41 of file vcsjob.cpp.

virtual KDevelop::IPlugin* KDevelop::VcsJob::vcsPlugin ( ) const [pure virtual]

Used to get at the version control plugin.

The plugin can be used to get one of the interfaces to execute more vcs actions, depending on this jobs results (like getting a diff for an entry in a log)

Implemented in DVCSjob.

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

vcs

KDevelop::VcsJob Class Reference

Detailed Description

Public Types

Signals

Public Member Functions

Protected Member Functions

Member Enumeration Documentation

Member Function Documentation

vcs

KDevelop Platform Libraries