Added the trayicon kvs class

git-svn-id: https://svn.kvirc.de/svn/trunk/kvirc@4936 17fca916-40b9-46aa-a4ea-0a15b648b75c

4 files changed, 306 insertions, 1 deletions

diff --git a/src/modules/objects/CMakeLists.txt b/src/modules/objects/CMakeLists.txt
index 43d89f567..694cde24c 100644
--- a/src/modules/objects/CMakeLists.txt
+++ b/src/modules/objects/CMakeLists.txt
@@ -28,6 +28,7 @@ SET(kviobjects_MOC_HDRS
 	class_spinbox.h
 	class_tabwidget.h
 	class_tablewidget.h
+	class_trayicon.h
 	class_tbrowser.h
 	class_toolbutton.h
 	class_treewidget.h
@@ -72,6 +73,7 @@ SET(kviobjects_SRCS
 	class_sql.cpp
 	class_tabwidget.cpp
 	class_tablewidget.cpp
+	class_trayicon.cpp
 	class_tbrowser.cpp
 	class_toolbar.cpp
 	class_toolbutton.cpp
diff --git a/src/modules/objects/class_trayicon.cpp b/src/modules/objects/class_trayicon.cpp
new file mode 100644
index 000000000..f95251776
--- /dev/null
+++ b/src/modules/objects/class_trayicon.cpp
@@ -0,0 +1,243 @@
+//=============================================================================
+//
+//   File : class_trayicon.cpp
+//   Creation date : Wed Ago 25 17:28:45 2010 GMT by Carbone Alesssandro
+//
+//   This file is part of the KVirc irc client distribution
+//   Copyright (C) 2009 Alessandro Carbone (elfonol at gmail dot 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 opinion) 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.
+//
+//=============================================================================
+
+#include "class_trayicon.h"
+#include "class_popupmenu.h"
+#include "kvi_iconmanager.h"
+#include "kvi_debug.h"
+#include "kvi_error.h"
+#include "kvi_locale.h"
+
+#include <QSystemTrayIcon>
+
+
+
+
+/*
+	@doc: trayicon
+	@keyterms:
+		trayicon object class
+	@title:
+		trayicon class
+	@type:
+		class
+	@short:
+		An implementation of the the system tray icon.
+	@inherits:
+		[class]object[/class]
+	@description:
+		This class provides a standard trayicon functionality.[br]
+	@functions:
+                !fn: setIcon(<image_id>).
+                Sets the tray icon.
+                See the [doc:image_id]image identifier[/doc] documentation for the explaination of the <image_id> parameter.
+                !fn: setTooltip(<tooltip:string>).
+                Sets the tray icon tooltip.
+                !fn: show()
+                Shows the tray icon.
+                !fn: hide()
+                Hides the tray icon.
+                !fn: isVisible()
+                Returns '1' if the tray icon is currently visible.
+                !fn: showMessage(<title:string>,<message:string>,<message_icon:string>,<timeout:integer>)
+                Shows a balloon message for the entry with the given title, message and message_icon for the time specified in millisecondsTimeoutHint. title and message must be plain text strings.
+                Message can be clicked by the user; the messageClickedEvent() will be triggered when this occurs.
+                Valid values for message_icon are:
+                - NoIcon : No icon is shown.
+                - Information : An information icon is shown.
+                - Warning : A standard warning icon is shown.
+                - Critical : A critical warning icon is shown.
+                !fn: setContextMenu(<popupmenu:hobject>).
+                Associates the given <popupmenu> with the tray icon.
+                !fn: activatedEvent(<reason:string>)
+                This event is triggered when the user click the tray icon.
+                If you reimplement this function the reason parameter will be passed as $0.
+                Values for reason are:
+                - Unknown : Unknown reason.
+                - Context : The context menu for the tray icon was requested.
+                - DoubleClick : The tray icon was double clicked.
+                - Trigger : The tray icon was clicked.
+                - MiddleClick : The tray icon was clicked with the middle mouse button.
+                The default implementation emits the [classfnc]$activated[/classfnc]() signal.
+                !fn: messageClickedEvent()
+                This event is triggered when the message displayed using [classfnc]$showMessage[/classfnc]() was clicked by the user.
+                The default implementation emits the [classfnc]$messageClicked[/classfnc]() signal.
+
+
+	@signals:
+		!sg: $activated()
+                This signal is emitted by the default implementation of [classfnc]$activatedEvent[/classfnc].
+                !sg: $messageClicked()
+                This signal is emitted by the default implementation of [classfnc]$messageClickedEvent[/classfnc].
+*/
+
+KVSO_BEGIN_REGISTERCLASS(KviKvsObject_trayicon,"trayicon","object")
+        KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,show)
+        KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,hide)
+        KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,isVisible)
+	KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,setIcon)
+	KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,setTooltip)
+	KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,showMessage)
+	KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,setContextMenu)
+	// events
+        KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,activatedEvent)
+        KVSO_REGISTER_HANDLER_BY_NAME(KviKvsObject_trayicon,messageClickedEvent)
+KVSO_END_REGISTERCLASS(KviKvsObject_trayicon)
+
+
+KVSO_BEGIN_CONSTRUCTOR(KviKvsObject_trayicon,KviKvsObject)
+        m_pTrayIcon = new QSystemTrayIcon(0);
+	connect(m_pTrayIcon,SIGNAL(activated(QSystemTrayIcon::ActivationReason)),this,SLOT(slotActivated(QSystemTrayIcon::ActivationReason)));
+        connect(m_pTrayIcon,SIGNAL(messageClicked()),this,SLOT(slotMessageClicked()));
+
+KVSO_END_CONSTRUCTOR(KviKvsObject_trayicon)
+
+KVSO_BEGIN_DESTRUCTOR(KviKvsObject_trayicon)
+	delete m_pTrayIcon;
+KVSO_END_DESTRUCTOR(KviKvsObject_trayicon)
+
+
+KVSO_CLASS_FUNCTION(trayicon,setIcon)
+{
+        CHECK_INTERNAL_POINTER(m_pTrayIcon)
+        QString szIcon;
+        KVSO_PARAMETERS_BEGIN(c)
+            KVSO_PARAMETER("icon",KVS_PT_STRING,0,szIcon)
+        KVSO_PARAMETERS_END(c)
+        QPixmap * pix = g_pIconManager->getImage(szIcon);
+        if(pix) m_pTrayIcon->setIcon(*pix);
+        return true;
+}
+KVSO_CLASS_FUNCTION(trayicon,setTooltip)
+{
+	CHECK_INTERNAL_POINTER(m_pTrayIcon)
+        QString szTooltip;
+        KVSO_PARAMETERS_BEGIN(c)
+            KVSO_PARAMETER("icon",KVS_PT_STRING,0,szTooltip)
+        KVSO_PARAMETERS_END(c)
+        m_pTrayIcon->setToolTip(szTooltip);
+	return true;
+}
+KVSO_CLASS_FUNCTION(trayicon,show)
+{
+        CHECK_INTERNAL_POINTER(m_pTrayIcon)
+        m_pTrayIcon->show();
+        return true;
+}
+KVSO_CLASS_FUNCTION(trayicon,hide)
+{
+        CHECK_INTERNAL_POINTER(m_pTrayIcon)
+        m_pTrayIcon->show();
+        return true;
+}
+KVSO_CLASS_FUNCTION(trayicon,isVisible)
+{
+        CHECK_INTERNAL_POINTER(m_pTrayIcon)
+        c->returnValue()->setBoolean(m_pTrayIcon->isVisible());
+        return true;
+}
+
+KVSO_CLASS_FUNCTION(trayicon,showMessage)
+{
+	CHECK_INTERNAL_POINTER(m_pTrayIcon)
+        QString szMessage,szTitle,szMessageIcon;
+        kvs_uint_t uTimeout;
+        KVSO_PARAMETERS_BEGIN(c)
+            KVSO_PARAMETER("title",KVS_PT_STRING,0,szTitle)
+            KVSO_PARAMETER("message",KVS_PT_STRING,0,szMessage)
+            KVSO_PARAMETER("icon",KVS_PT_STRING,0,szMessageIcon)
+            KVSO_PARAMETER("timeout",KVS_PT_UINT,0,uTimeout)
+        KVSO_PARAMETERS_END(c)
+        QSystemTrayIcon::MessageIcon message=QSystemTrayIcon::NoIcon;
+        if(KviQString::equalCI(szMessageIcon,"NoIcon")) message= QSystemTrayIcon::NoIcon;
+        else if(KviQString::equalCI(szMessageIcon,"Information"))message= QSystemTrayIcon::Information;
+        else if(KviQString::equalCI(szMessageIcon,"Warning")) message= QSystemTrayIcon::Warning;
+        else if(KviQString::equalCI(szMessageIcon,"Critical")) message= QSystemTrayIcon::Critical;
+        else c->warning(__tr2qs_ctx("Invalid message Icon: switch to default NoIcon '%Q'","objects"),&szMessageIcon);
+        m_pTrayIcon->showMessage(szTitle,szMessage,message,uTimeout);
+        return true;
+}
+
+KVSO_CLASS_FUNCTION(trayicon,setContextMenu)
+{
+	CHECK_INTERNAL_POINTER(m_pTrayIcon)
+        KviKvsObject *ob;
+        kvs_hobject_t hObject;
+        KVSO_PARAMETERS_BEGIN(c)
+                KVSO_PARAMETER("widget",KVS_PT_HOBJECT,0,hObject)
+        KVSO_PARAMETERS_END(c)
+        ob=KviKvsKernel::instance()->objectController()->lookupObject(hObject);
+        if (!ob)
+        {
+                c->warning(__tr2qs_ctx("Widget parameter is not an object","objects"));
+                return true;
+        }
+        if (!ob->object())
+        {
+                c->warning(__tr2qs_ctx("Widget parameter is not a valid object","objects"));
+                return true;
+        }
+        if(!ob->inheritsClass("popupmenu"))
+        {
+                c->warning(__tr2qs_ctx("Can't add a non-popupmenu object","objects"));
+                return true;
+        }
+         m_pTrayIcon->setContextMenu(((QMenu  *)(ob->object())));
+        return true;
+}
+KVSO_CLASS_FUNCTION(trayicon,activatedEvent)
+{
+	emitSignal("activated",c,c->params());
+	return true;
+}
+KVSO_CLASS_FUNCTION(trayicon,messageClickedEvent)
+{
+        emitSignal("messageClicked",c,c->params());
+        return true;
+}
+void KviKvsObject_trayicon::slotMessageClicked()
+{
+    KviKvsVariantList *lParams=0;
+    callFunction(this,"messageClickedEvent",0,lParams);
+}
+
+void KviKvsObject_trayicon::slotActivated(QSystemTrayIcon::ActivationReason reason)
+{
+        QString szReason;
+        if (reason==QSystemTrayIcon::Unknown)
+            szReason="Unknown";
+        else if(reason==QSystemTrayIcon::Context)
+            szReason="Context";
+        else if(reason==QSystemTrayIcon::DoubleClick)
+            szReason="DoubleClick";
+        else if(reason==QSystemTrayIcon::Trigger)
+            szReason="Trigger";
+        else szReason="MiddleClick";
+        KviKvsVariantList lParams;
+        lParams.append(new KviKvsVariant(szReason));
+        callFunction(this,"activatedEvent",0,&lParams);
+}
+#ifndef COMPILE_USE_STANDALONE_MOC_SOURCES
+#include "m_class_trayicon.moc"
+#endif //!COMPILE_USE_STANDALONE_MOC_SOURCES
diff --git a/src/modules/objects/class_trayicon.h b/src/modules/objects/class_trayicon.h
new file mode 100644
index 000000000..b257152b2
--- /dev/null
+++ b/src/modules/objects/class_trayicon.h
@@ -0,0 +1,58 @@
+#ifndef _CLASS_TRAYICON_H_
+#define _CLASS_TRAYICON_H_
+//=============================================================================
+//
+//   File : class_trayicon.h
+//   Creation date : Wed Ago 25 17:28:45 2010 GMT by Carbone Alesssandro
+//
+//   This file is part of the KVirc irc client distribution
+//   Copyright (C) 2008 Alessandro Carbone (elfonol at gmail dot 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 opinion) 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.
+//
+//=============================================================================
+
+
+
+
+//===============================================================
+#include "object_macros.h"
+#include <QSystemTrayIcon>
+#include <QMenu>
+
+class KviKvsObject_trayicon : public KviKvsObject
+{
+	Q_OBJECT
+public:
+	KVSO_DECLARE_OBJECT(KviKvsObject_trayicon)
+protected:
+        QSystemTrayIcon *m_pTrayIcon;
+protected:
+        bool setIcon(KviKvsObjectFunctionCall *c);
+        bool show(KviKvsObjectFunctionCall *c);
+        bool hide(KviKvsObjectFunctionCall *c);
+        bool isVisible(KviKvsObjectFunctionCall *c);
+        bool setTooltip(KviKvsObjectFunctionCall *c);
+        bool showMessage(KviKvsObjectFunctionCall *c);
+        bool setContextMenu(KviKvsObjectFunctionCall *c);
+        bool activatedEvent(KviKvsObjectFunctionCall *c);
+        bool messageClickedEvent(KviKvsObjectFunctionCall *c);
+	
+
+protected slots:
+	void slotActivated(QSystemTrayIcon::ActivationReason);
+        void slotMessageClicked();
+};
+#endif //_CLASS_TRAYICON_H_
diff --git a/src/modules/objects/libkviobjects.cpp b/src/modules/objects/libkviobjects.cpp
index ca4b7a2c4..987b5e600 100644
--- a/src/modules/objects/libkviobjects.cpp
+++ b/src/modules/objects/libkviobjects.cpp
@@ -57,6 +57,7 @@
 #include "class_tbrowser.h"
 #include "class_toolbar.h"
 #include "class_toolbutton.h"
+#include "class_trayicon.h"
 #include "class_treewidget.h"
 #include "class_treewidgetitem.h"
 #include "class_vbox.h"
@@ -96,6 +97,7 @@ static bool objects_module_cleanup(KviModule *)
 
         KviKvsObject_memorybuffer::unregisterSelf();
 	KviKvsObject_process::unregisterSelf();
+        KviKvsObject_trayicon::unregisterSelf();
 	KviKvsObject_ftp::unregisterSelf();
 	KviKvsObject_http::unregisterSelf();
 	KviKvsObject_socket::unregisterSelf();
@@ -795,7 +797,7 @@ static bool objects_module_init(KviModule * m)
 	KviKvsObject_socket::registerSelf();
 	KviKvsObject_http::registerSelf();
 	KviKvsObject_ftp::registerSelf();
-
+        KviKvsObject_trayicon::registerSelf();
 	KviKvsObject_process::registerSelf();
 	KviKvsObject_memorybuffer::registerSelf();