/*********
*
* This file is part of BibleTime's source code, http://www.bibletime.info/.
*
* Copyright 1999-2008 by the BibleTime developers.
* The BibleTime source code is licensed under the GNU General Public License version 2.0.
*
**********/

#ifndef CBOOKMARKINDEX_H
#define CBOOKMARKINDEX_H

//BibleTime includes
#include "btbookmarkitembase.h"

class CSwordModuleInfo;
#include "frontend/displaywindow/cdisplaywindow.h"

#include "util/cpointers.h"

//Qt includes
#include <QTimer>
#include <QToolTip>
#include <QList>
#include <QTreeWidget>
#include <QTreeWidgetItem>

class CSearchDialog;
class CMainIndex;
class QWidget;
class QDropEvent;
class QDragMoveEvent;
class QDragLeaveEvent;
class BTMimeData;
class QMenu;
class QAction;
class QPaintEvent;

class QMouseEvent;

/**
* The widget which manages all bookmarks.
* @author The BibleTime team
*/
class CBookmarkIndex : public QTreeWidget {
	Q_OBJECT

public:
	CBookmarkIndex(QWidget *parent);
	virtual ~CBookmarkIndex();

	void initTree();

	/**
	* Saves the bookmarks to disk
	*/
	void saveBookmarks();

signals:
	/**
	* Is emitted when a module should be opened,
	*/
	void createReadDisplayWindow( QList<CSwordModuleInfo*>, const QString& );

protected: // Protected methods

	/** A hack to get the modifiers. */
	virtual void mouseReleaseEvent(QMouseEvent* event);

	/** Needed to paint an drag pointer arrow. */
	virtual void paintEvent(QPaintEvent* event);

	/** Initialize the SIGNAL<->SLOT connections. */
	void initConnections();

	/** Returns the drag object for the current selection. */
	virtual QMimeData* dragObject();

	/**
	* D'n'd methods are reimplementations from QTreeWidget or its ancestors.
	* In these we handle creating, moving and copying bookmarks with d'n'd.
	*/
	virtual void dragEnterEvent( QDragEnterEvent* event );
	virtual void dragMoveEvent( QDragMoveEvent* event );
	virtual void dropEvent( QDropEvent* event );
	virtual void dragLeaveEvent( QDragLeaveEvent* event );

	/** Returns the correct action object for the given type of action. */
	QAction* action( BtBookmarkItemBase::MenuAction type ) const;

	/** Reimplementation from QAbstractItemView. Takes care of movable items. */
	virtual void startDrag(Qt::DropActions supportedActions);


	/** Handle mouse moving (mag updates) */
	virtual void mouseMoveEvent(QMouseEvent* event);


protected slots:

	/** Prevents annoying folder collapsing while dropping. */
	void expandAutoCollapsedItem(QTreeWidgetItem* i) {expandItem(i);}

	/** Is called when an item was clicked or activated. */
	void slotExecuted( QTreeWidgetItem* );

	/** Shows the context menu at the given position. */
	void contextMenu(const QPoint&);

	/** Adds a new subfolder to the current item. */
	void createNewFolder();

	/** Opens a dialog to change the current folder. */
	void changeFolder();

	/** Exports the bookmarks from the selected folder. */
	void exportBookmarks();

	/** Changes the current bookmark. */
	void changeBookmark();

	/** Helps with the extra item. */
	void slotItemEntered(QTreeWidgetItem*, int);

	/** Import bookmarks from a file and add them to the selected folder. */
	void importBookmarks();

	/** Deletes the selected entries. */
	void deleteEntries(bool confirm=true);

	/** Prints the selected bookmarks. */
	void printBookmarks();

	/** Slot for the mag update timer. */
	void magTimeout();

private:

	/** Initializes the view. */
	void initView();

	/** Convenience function for creating a new action. */
	QAction* newQAction(const QString& text, const QString& pix, int shortcut, const QObject* receiver, const char* slot, QObject* parent);

	/**
	* Returns true if more than one entry is supported by this action type.
	* Returns false for actions which support only one entry.
	*/
	bool isMultiAction( const BtBookmarkItemBase::MenuAction type ) const;

	/** A helper function for d'n'd which creates a new bookmark item when drop happens. */
	void createBookmarkFromDrop(QDropEvent* event, QTreeWidgetItem* parentItem, int indexInParent);

	/**
	* Returns a list of new items created from the selection.
	* Sets flags which indicate whether the selection was legal for dropping.
	*/
	QList<QTreeWidgetItem*> addItemsToDropTree(QTreeWidgetItem* target, bool& bookmarksOnly, bool& targetIncluded, bool& moreThanOneFolder);

	struct Actions {
		QAction* newFolder;
		QAction* changeFolder;

		QAction* changeBookmark;
		QAction* importBookmarks;
		QAction* exportBookmarks;
		QAction* printBookmarks;

		QAction* deleteEntries;
	}
	m_actions;

	QMenu* m_popup;
	QTimer m_magTimer;
	int m_mouseReleaseEventModifiers;
	QTreeWidgetItem* m_previousEventItem;
	QPoint m_dragMovementPosition;
	QPoint m_dragStartPosition;
	QTreeWidgetItem* m_extraItem;
};

#endif