/***************************************************************************
 *   Copyright (C) 2009 by Joris Guisson                                   *
 *   joris.guisson@gmail.com                                               *
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.          *
 ***************************************************************************/

#ifndef ACTIVITY_H
#define ACTIVITY_H

#include <QWidget>
#include <ksharedconfig.h>
#include <ktcore_export.h>
#include <kparts/part.h>

class KMenu;

namespace kt
{
	class Activity;
	
	/**
		Part of an Activity
	*/
	class KTCORE_EXPORT ActivityPart : public KParts::Part
	{
		Q_OBJECT
	public:
		ActivityPart(Activity* parent);
		virtual ~ActivityPart();
		
		/// Set the XML GUI file of the part
		void setXMLGUIFile(const QString & xml_gui);
		
		/// Get a menu described in the XML of the part
		KMenu* menu(const QString & name);
	};
	
	/**
	 * Base class for all activities.
	 */
	class KTCORE_EXPORT Activity : public QWidget
	{
		Q_OBJECT
	public:
		Activity(const QString & name,const QString & icon,int weight,QWidget* parent);
		virtual ~Activity();
		
		/// Get the name of the activity
		const QString & name() const {return activity_name;}
		
		/// Get the icon name
		const QString & icon() const {return activity_icon;}
		
		/// Get the part
		ActivityPart* part() const {return activity_part;}
		
		/// Set the name
		void setName(const QString & name);
		
		/// Set the icon
		void setIcon(const QString & icon);
		
		/// Get the weight
		int weight() const {return activity_weight;}
		
		static bool lessThan(Activity* l,Activity* r);
		
	protected:
		/**
			Activities wishing to provide toolbar and menu entries, should
			call this function to set the XML GUI description.
			@param xml_file The XMLGUI file
		*/
		void setXMLGUIFile(const QString & xml_file);
		
	signals:
		void nameChanged(Activity* a,const QString & name);
		void iconChanged(Activity* a,const QString & icon);
		
	private:
		QString activity_name;
		QString activity_icon;
		int activity_weight;
		ActivityPart* activity_part;
	};
}

#endif // ACTIVITY_H
