# class KJobTrackerInterface

###

Module | kdecore
Namespace |
Class | KJobTrackerInterface
Inherits | QObject

The interface to implement to track the progresses of a job.

### methods

- KJobTrackerInterface (parent)

  returns ctor

  Argument | Type | Default
  --- | --- | ---
  parent | QObject | 0

  Creates a new KJobTrackerInterface

  parent - the parent object

- description (job, title, field1, field2)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |
  title | QString |
  field1 | QPair<QString,QString> |
  field2 | QPair<QString,QString> |

  Called to display general description of a job. A description has a title and two optional fields which can be used to complete the description.

  Examples of titles are "Copying", "Creating resource", etc. The fields of the description can be "Source" with an URL, and, "Destination" with an URL for a "Copying" description.

  job - the job that emitted this signal

  title - the general description of the job

  field1 - first field (localized name and value)

  field2 - second field (localized name and value)

- finished (job)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |

  Called when a job is finished, in any case. It is used to notify that the job is terminated and that progress UI (if any) can be hidden.

  job - the job that emitted this signal

- infoMessage (job, plain, rich)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |
  plain | QString |
  rich | QString |

  Called to display state information about a job. Examples of message are "Resolving host", "Connecting to host...", etc.

  job - the job that emitted this signal

  plain - the info message

  rich - the rich text version of the message, or QString() is none is available

- percent (job, percent)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |
  percent | unsigned long |

  Called to show the overall progress of the job. Note that this is not called for finished jobs.

  job - the job that emitted this signal

  percent - the percentage

- processedAmount (job, unit, amount)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |
  unit | KJob.Unit |
  amount | qulonglong |

  Regularly called to show the progress of a job by giving the current amount. The unit of this amount is provided too. It can be called several times for a given job if the job manages several different units.

  job - the job that emitted this signal

  unit - the unit of the processed amount

  amount - the processed amount

- registerJob (job)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |

  Register a new job in this tracker.

  job - the job to register

- resumed (job)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |

  Called when a job is resumed.

  job - the job that emitted this signal

- speed (job, value)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |
  value | unsigned long |

  Called to show the speed of the job.

  job - the job that emitted this signal

  value - the current speed of the job

- suspended (job)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |

  Called when a job is suspended.

  job - the job that emitted this signal

- totalAmount (job, unit, amount)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |
  unit | KJob.Unit |
  amount | qulonglong |

  Called when we know the amount a job will have to process. The unit of this amount is provided too. It can be called several times for a given job if the job manages several different units.

  job - the job that emitted this signal

  unit - the unit of the total amount

  amount - the total amount

- unregisterJob (job)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |

  Unregister a job from this tracker.

  job - the job to unregister

- warning (job, plain, rich)

  returns Nothing

  Argument | Type | Default
  --- | --- | ---
  job | KJob |
  plain | QString |
  rich | QString |

  Emitted to display a warning about a job.

  job - the job that emitted this signal

  plain - the warning message

  rich - the rich text version of the message, or QString() is none is available