/*******************************************************************************
 * gui/common/UserNotify.h                                                     *
 *                                                                             *
 * Copyright (c) 2012, RetroShare Team <retroshare.project@gmail.com>          *
 *                                                                             *
 * This program is free software: you can redistribute it and/or modify        *
 * it under the terms of the GNU Affero General Public License as              *
 * published by the Free Software Foundation, either version 3 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 Affero General Public License for more details.                         *
 *                                                                             *
 * You should have received a copy of the GNU Affero General Public License    *
 * along with this program. If not, see <https://www.gnu.org/licenses/>.       *
 *                                                                             *
 *******************************************************************************/

#ifndef USERNOTIFY_H
#define USERNOTIFY_H

#include <QObject>
#include <QSystemTrayIcon>
#include <QListWidgetItem>

class QToolBar;
class QToolButton;
class QAction;

class UserNotify : public QObject
{
	Q_OBJECT

public:
	UserNotify(QObject *parent = 0);
	virtual ~UserNotify();

	void initialize(QToolBar *mainToolBar, QAction *mainAction, QListWidgetItem *listItem,const QString& subtext);
	void createIcons(QMenu *notifyMenu);
	QSystemTrayIcon* getTrayIcon(){ return mTrayIcon;}
	QAction* getNotifyIcon(){ return mNotifyIcon;}

	virtual bool hasSetting(QString */*name*/, QString */*group*/) { return false; }

    // UserNotify is used to display tooltips when some services have no messages and so on, in the format of "Name (43242 new messages)"
    // This method is used to pass the string that comes after the number.
    virtual QString textInfo() const { return QString() ; }

	bool notifyEnabled();
	bool notifyCombined();
	bool notifyBlink();
	void setNotifyEnabled(bool enabled, bool combined, bool blink);

signals:
	void countChanged();

public slots:
	void updateIcon();

private slots:
	void trayIconClicked(QSystemTrayIcon::ActivationReason e = QSystemTrayIcon::Trigger);
	void trayIconHovered();
	void blink(bool on);

protected:
	virtual void startUpdate();
	void update();

private:
	virtual QIcon getIcon() { return QIcon(); }
	virtual QIcon getMainIcon(bool /*hasNew*/) { return QIcon(); }
	virtual unsigned int getNewCount() { return 0; }

	virtual QString getTrayMessage(bool plural);
	virtual QString getNotifyMessage(bool plural);

	virtual void iconClicked() {}
	virtual void iconHovered() {}

private:
	QToolButton *mMainToolButton;
	QAction *mMainAction;
	QListWidgetItem *mListItem;
	QSystemTrayIcon *mTrayIcon;
	QAction *mNotifyIcon;
	unsigned int mNewCount;
	QString mButtonText;
	QString mButtonText2;
	bool mLastBlinking;
};

#endif // USERNOTIFY_H