From d756ef2c1ee17e867dac0b16d717b7cd4fbc7424 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Gr=C3=A9gory=20Soutad=C3=A9?= <soutade@gmail.com>
Date: Wed, 18 Nov 2020 16:20:12 +0100
Subject: [PATCH] Update README

---
 README.md | 90 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 77 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 3ea91bb..bcc46d0 100644
--- a/README.md
+++ b/README.md
@@ -23,18 +23,14 @@ All functions read JSON formatted parameters
   notify():
   {
       "group": "groupname",
-      // item can have text and/or icon, other are optional
-      // click action can be : "signal" or "delete"
-      // box property can be : "left", "center" or "right"
       "items": [
           {
-	      "name":"",
-              "text":"",
-              "style":"",
-              "icon-style":"",
-	      "icon":"",
-	      "on-click":"",
-	      "box":"",
+	      "name"  : "",
+	      "box"   : "",             // Optional : left, right or center
+	      "text"  : <text_object>,  // Optional
+	      "icon"  : <icon_object>,  // Optional
+	      "popup" : <popup_object>, // Optional
+	      <signals_description>,    // Optional
           }, ...
       ]
       }
@@ -50,9 +46,75 @@ All functions read JSON formatted parameters
      "groups": ["<groupName>", ...]
   }
 
+  openPopup():
+  {
+     "item": "<itemName>@<groupName>"
+  }
 
-When text/icon is clicked and on-click parameter is set to "signal", 
-extension emit one of the following signals :
+  closePopup():
+  {
+     "item": "<itemName>@<groupName>"
+  }
+
+  togglePopup():
+  {
+     "item": "<itemName>@<groupName>"
+  }
+
+
+DBUS object
+===========
+
+<text_object> is defined as :
+  {
+    "text"  : "Text to be displayed",
+    "style" : "CSS style to be applied", // Optional
+  }
+
+<icon_object> is defined as :
+  {
+    "path"  : "Icon path",
+    "style" : "CSS style to be applied", // Optional
+  }
+
+<picture_object> is defined as :
+  {
+    "path"   : "Icon path",
+    "width"  : XXX, // Optional : Force width in pixels, can be -1 for defaut value
+    "height" : XXX, // Optional : Force height in pixels, can be -1 for defaut value
+  }
+
+<popup_object is defuned as :
+  {
+     "items": [<text_objects> and/or <picture_objects>]
+  }
+  
+
+Signals description
+===================
+
+Signals can be :
+
+  "on-click"          : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+  "on-dblclick"       : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+  "on-rightclick"     : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+  "on-rightdblclick"  : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+  "on-enter"  : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+  "on-leave"  : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+  "on-scroll" : ["signal"|"delete"|"open-popup"|"close-popup"|"toggle-popup"]
+
+<!!> WARNING <!!> : It seems that GNOME 3.38.0 had some troubles managing on-enter/on-leave signal
+
+Targets :
+
+  * signal : emit a signal to desktop application
+  * delete : Delete item
+  * open-popup : Open the popup if there is one
+  * close-popup : Close the popup if there is one
+  * toggle-popup : Toggle (open/close) the popup if there is one
+  
+
+Signal names emit when action "signal" is specified :
 
   * onClick
   * onRightClick
@@ -63,6 +125,8 @@ extension emit one of the following signals :
   * onScrollUp
   * onScrollDown
 
+Each signal is sent with one parameter : "<itemName>@<groupName>"
+
 Other signals are available when extension is activated/deactivated :
 
   * onActivate
@@ -74,7 +138,7 @@ Example
 
 You can test it with command line :
 
-  gdbus call --session --dest org.gnome.Shell --object-path /com/soutade/GenericMonitor --method com.soutade.GenericMonitor.notify '{"group":"new","items":[{"name":"first","on-enter":"open-popup","on-leave":"close-popup","text":"Hello","style":"color:green","popup":{"items":[{"picture":{"path":"/tmp/cat2.jpg"}}]}}]}'
+  gdbus call --session --dest org.gnome.Shell --object-path /com/soutade/GenericMonitor --method com.soutade.GenericMonitor.notify '{"group":"new","items":[{"name":"first","on-click":"toggle-popup","text":"Hello","style":"color:green","popup":{"items":[{"picture":{"path":"/tmp/cat2.jpg"}}]}}]}'
 
   gdbus call --session --dest org.gnome.Shell --object-path /com/soutade/GenericMonitor --method com.soutade.GenericMonitor.deleteGroups '{"groups":["new"]}'