Class
RBRhythmDBImportJob
Description [src]
class RB.RhythmDBImportJob : GObject.Object
implements RB.TaskProgress {
priv: RhythmDBImportJobPrivate*
}Tracks the addition to the database of files under a set of directories, providing status information.
The entry types to use for the database entries added by the import job are specified on creation.
Constructors
rhythmdb_import_job_new
Creates a new import job with the specified entry types. Before starting the job, the caller must add one or more paths to import.
Instance methods
rhythmdb_import_job_add_uri
Adds a URI to import. All files under the specified URI will be imported.
rhythmdb_import_job_cancel
Cancels the import job. The job will cease as soon as possible. More directories may be scanned and more files may be imported before the job actually ceases.
rhythmdb_import_job_get_imported
Returns the number of files successfully imported by the import job so far.
rhythmdb_import_job_get_total
Returns the total number of files that will be processed by this import job. This increases as the import directories are scanned.
rhythmdb_import_job_scan_complete
Returns whether the directory scan phase of the import job is complete.
rhythmdb_import_job_start
Starts the import job. After this method has been called, no more URIs may be added to the import job. May only be called once for a given import job.
Methods inherited from RBTaskProgress (1)
Properties
Properties inherited from RBTaskProgress (6)
RBTaskProgress:task-cancellable
RBTaskProgress:task-detail
RBTaskProgress:task-label
RBTaskProgress:task-notify
RBTaskProgress:task-outcome
RBTaskProgress:task-progress
Signals
RB.RhythmDBImportJob::entry-added
Emitted when an entry has been added to the database by the import job.
RB.RhythmDBImportJob::scan-complete
Emitted when the directory scan is complete. Once the scan is complete, the total number of files to be processed will not change.
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct RBRhythmDBImportJobClass {
GObjectClass parent_class;
void (* entry_added) (
RhythmDBImportJob* job,
RhythmDBEntry* entry
);
void (* status_changed) (
RhythmDBImportJob* job,
int total,
int imported
);
void (* scan_complete) (
RhythmDBImportJob* job,
int total
);
void (* complete) (
RhythmDBImportJob* job,
int total
);
}No description available.
Class members
parent_class: GObjectClassNo description available.
entry_added: void (* entry_added) ( RhythmDBImportJob* job, RhythmDBEntry* entry )No description available.
status_changed: void (* status_changed) ( RhythmDBImportJob* job, int total, int imported )No description available.
scan_complete: void (* scan_complete) ( RhythmDBImportJob* job, int total )No description available.
complete: void (* complete) ( RhythmDBImportJob* job, int total )No description available.