add new features in homescreen-service and homescreen

[src/libqthomescreen.git] / src / qlibhomescreen.cpp

diff --git a/src/qlibhomescreen.cpp b/src/qlibhomescreen.cpp
index b9298f1..f769469 100644 (file)
--- a/src/qlibhomescreen.cpp
+++ b/src/qlibhomescreen.cpp
@@ -17,36 +17,71 @@
 #include "qlibhomescreen.h"
 #include <QJsonDocument>
 #include <QJsonObject>
+#include "hmi-debug.h"
 using namespace std;
 
 #define _POPUPREPLY "on_screen_reply"
 #define _REQ_POPUP_MESSAGE "on_screen_message"
 #define _TAPSHORTCUT "tap_shortcut"
 #define _KEY_DATA "data"
-#define _KEY_APPLICATION_DATA "application_name"
+#define _KEY_APPLICATION_DATA "application_id"
 #define _KEY_REPLY_MESSAGE "reply_message"
 #define _KEY_REQUEST_MESSAGE "display_message"
 
 static QLibHomeScreen* myThis;
 
 // Note: qlibhomescreen will be integrated to libqtappfw
-
+/**
+ * QLibHomeScreen construction function
+ *
+ * #### Parameters
+ * - parent [in] : object parent.
+ *
+ * #### Return
+ * - None
+ *
+ */
 QLibHomeScreen::QLibHomeScreen(QObject *parent) :
     QObject(parent),
     mp_hs(NULL)
 {
-
+    HMI_DEBUG("qlibhomescreen", "called.");
 }
 
+/**
+ * QLibHomeScreen destruction function
+ *
+ * #### Parameters
+ * - None
+ *
+ * #### Return
+ * - None
+ *
+ */
 QLibHomeScreen::~QLibHomeScreen()
 {
+    HMI_DEBUG("qlibhomescreen", "called.");
     if (mp_hs != NULL) {
         delete mp_hs;
     }
 }
 
+/**
+ * init function
+ *
+ * call libhomescreen init function to connect to binder by websocket
+ *
+ * #### Parameters
+ * - prot  : port from application
+ * - token : token from application
+ *
+ * #### Return
+ * - None
+ *
+ */
 void QLibHomeScreen::init(int port, const QString &token)
 {
+    HMI_DEBUG("qlibhomescreen", "called.");
     string ctoken = token.toStdString();
     mp_hs = new LibHomeScreen();
     mp_hs->init(port, ctoken.c_str());
@@ -54,26 +89,223 @@ void QLibHomeScreen::init(int port, const QString &token)
     myThis = this;
 }
 
+
+/**
+ * call on screen message
+ *
+ * use libhomescreen api to call onscreen message
+ *
+ * #### Parameters
+ * - message : message contents
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
 int QLibHomeScreen::onScreenMessage(const QString &message)
 {
+    HMI_DEBUG("qlibhomescreen", "called.");
     string str = message.toStdString();
     return mp_hs->onScreenMessage(str.c_str());
 }
 
+/**
+ * subscribe event
+ *
+ * use libhomescreen api to subscribe homescreen event
+ *
+ * #### Parameters
+ * - evetNave : homescreen event name
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
 int QLibHomeScreen::subscribe(const QString &evetName)
 {
+    HMI_DEBUG("qlibhomescreen", "called.");
     string str = evetName.toStdString();
     return mp_hs->subscribe(str);
 }
 
+/**
+ * unsubscribe event
+ *
+ * use libhomescreen api to unsubscribe homescreen event
+ *
+ * #### Parameters
+ * - evetNave : homescreen event name
+ *
+ * #### Return
+ * - Returns 0 on success or -1 in case of error.
+ *
+ */
 int QLibHomeScreen::unsubscribe(const QString &evetName)
 {
+    HMI_DEBUG("qlibhomescreen", "called.");
     string str = evetName.toStdString();
     return mp_hs->unsubscribe(str);
 }
 
+/**
+ * set homescreen event handler function
+ *
+ * #### Parameters
+ * - et : homescreen event name
+ * - f  : event handler function
+ *
+ * #### Return
+ * - None.
+ *
+ */
 void QLibHomeScreen::set_event_handler(enum QEventType et, handler_fun f)
 {
+    HMI_DEBUG("qlibhomescreen", "called.");
     LibHomeScreen::EventType hs_et = (LibHomeScreen::EventType)et;
     return this->mp_hs->set_event_handler(hs_et, std::move(f));
-}
\ No newline at end of file
+}
+
+/**
+ * tapShortcut function
+ *
+ * #### Parameters
+ * - application_id : tapped application id
+  *
+ * #### Return
+ * - None.
+ *
+ */
+void QLibHomeScreen::tapShortcut(QString application_id)
+{
+    HMI_DEBUG("qlibhomescreen","tapShortcut %s", application_id.toStdString().c_str());
+    mp_hs->showWindow(application_id.toStdString().c_str(), nullptr);
+}
+
+/**
+ * show application by application id
+ *
+ * #### Parameters
+ * - application_id  : application id
+ * - json  : json parameters
+ *
+ * #### Return
+ * - None.
+ *
+ */
+void QLibHomeScreen::showWindow(QString application_id, json_object* json)
+{
+    mp_hs->showWindow(application_id.toStdString().c_str(), json);
+}
+
+/**
+ * show application by application id, json string
+ *
+ * #### Parameters
+ * - application_id  : application id
+ * - json  : json parameters
+ *
+ * #### Return
+ * - None.
+ *
+ */
+void QLibHomeScreen::showWindow(QString application_id, QString json)
+{
+    if(json.isNull())
+        mp_hs->showWindow(application_id.toStdString().c_str(), nullptr);
+    else
+        mp_hs->showWindow(application_id.toStdString().c_str(), json_tokener_parse(json.toStdString().c_str()));
+}
+
+/**
+ * hide application by application id
+ *
+ * #### Parameters
+ * - application_id  : application id
+ *
+ * #### Return
+ * - None.
+ *
+ */
+void QLibHomeScreen::hideWindow(QString application_id)
+{
+    mp_hs->hideWindow(application_id.toStdString().c_str());
+}
+
+/**
+ * send onscreen or software keyboard message to application
+ *
+ * #### Parameters
+ * - application_id  : application id
+ * - json  : json parameters
+ *
+ * #### Return
+ * - None.
+ *
+ */
+void QLibHomeScreen::replyShowWindow(QString application_id, json_object* json)
+{
+    mp_hs->replyShowWindow(application_id.toStdString().c_str(), json);
+}
+
+/**
+ * send onscreen or software keyboard message to application
+ *
+ * #### Parameters
+ * - application_id  : application id
+ * - json  : json parameters
+ *
+ * #### Return
+ * - None.
+ *
+ */
+void QLibHomeScreen::replyShowWindow(QString application_id, QString json)
+{
+    if(json.isNull())
+        mp_hs->replyShowWindow(application_id.toStdString().c_str(), nullptr);
+    else
+        mp_hs->replyShowWindow(application_id.toStdString().c_str(), json_tokener_parse(json.toStdString().c_str()));
+}
+
+/**
+ * show information
+ *
+ * use libhomescreen api to push information to menubarApp
+ *
+ * #### Parameters
+ * - params : json parameters
+ *
+ * #### Return
+ * - None.
+ *
+ */
+void QLibHomeScreen::showInformation(QString info)
+{
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val = json_object_new_string(info.toStdString().c_str());
+       json_object_object_add(j_obj, "info", val);
+
+    mp_hs->showInformation(j_obj);
+}
+
+/**
+ * show notification
+ *
+ * use libhomescreen api to push notification to menubarApp
+ *
+ * #### Parameters
+ * - params : json parameters
+ *
+ * #### Resturn
+ * - None.
+ *
+ */
+void QLibHomeScreen::showNotification(QString icon, QString text)
+{
+       struct json_object* j_obj = json_object_new_object();
+       struct json_object* val_icon = json_object_new_string(icon.toStdString().c_str());
+       struct json_object* val_text = json_object_new_string(text.toStdString().c_str());
+       json_object_object_add(j_obj, "icon", val_icon);
+       json_object_object_add(j_obj, "text", val_text);
+
+    mp_hs->showNotification(j_obj);
+}