summaryrefslogtreecommitdiffstats
path: root/libk3b/core/k3bthread.h
diff options
context:
space:
mode:
Diffstat (limited to 'libk3b/core/k3bthread.h')
-rw-r--r--libk3b/core/k3bthread.h95
1 files changed, 95 insertions, 0 deletions
diff --git a/libk3b/core/k3bthread.h b/libk3b/core/k3bthread.h
new file mode 100644
index 0000000..f7e68fc
--- /dev/null
+++ b/libk3b/core/k3bthread.h
@@ -0,0 +1,95 @@
+/*
+ *
+ * $Id: k3bthread.h 619556 2007-01-03 17:38:12Z trueg $
+ * Copyright (C) 2003 Sebastian Trueg <trueg@k3b.org>
+ *
+ * This file is part of the K3b project.
+ * Copyright (C) 1998-2007 Sebastian Trueg <trueg@k3b.org>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ * See the file "COPYING" for the exact licensing terms.
+ */
+
+
+#ifndef _K3B_THREAD_H_
+#define _K3B_THREAD_H_
+
+#include <qthread.h>
+#include "k3b_export.h"
+
+class QObject;
+
+/**
+ * The threaded couterpart to K3bJob
+ * instead of emitting the information signals
+ * one has to use the emitXXX methods which will post
+ * K3bProgressInfoEvents to the eventhandler.
+ *
+ * K3bThreadJob can be used to automatically wrap the thread in a K3bJob.
+ *
+ * As in K3bJob it is important to call emitStarted and emitFinished.
+ *
+ * See K3bThreadJob for more information.
+ */
+class LIBK3B_EXPORT K3bThread : public QThread
+{
+ public:
+ K3bThread( QObject* eventHandler = 0 );
+ K3bThread( unsigned int stackSize, QObject* eventHandler = 0 );
+ virtual ~K3bThread();
+
+ void setProgressInfoEventHandler( QObject* eventHandler );
+
+ /**
+ * Initialize the thread before starting it in the GUi thread.
+ * K3bThreadJob automatically calls this.
+ *
+ * The default implementation does nothing.
+ */
+ virtual void init();
+
+ /**
+ * to provide the same api like K3bJob
+ * the default implementation calls terminate and
+ * emitCancled() and emitFinished(false)
+ */
+ virtual void cancel();
+
+ virtual QString jobDescription() const;
+ virtual QString jobDetails() const;
+
+ /**
+ * waits until all running K3bThread have finished.
+ * This is used by K3bApplication.
+ */
+ static void waitUntilFinished();
+
+ protected:
+ virtual void run() = 0;
+
+ /**
+ * uses the K3bJob::MessageType enum
+ */
+ void emitInfoMessage( const QString& msg, int type );
+ void emitPercent( int p );
+ void emitSubPercent( int p );
+ void emitStarted();
+ void emitCanceled();
+ void emitFinished( bool success );
+ void emitProcessedSize( int processed, int size );
+ void emitProcessedSubSize( int processed, int size );
+ void emitNewTask( const QString& job );
+ void emitNewSubTask( const QString& job );
+ void emitDebuggingOutput(const QString&, const QString&);
+ void emitData( const char* data, int len );
+ void emitNextTrack( int track, int trackNum );
+
+ private:
+ class Private;
+ Private* d;
+};
+
+#endif