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" : , // Optional + "icon" : , // Optional + "popup" : , // Optional + , // Optional }, ... ] } @@ -50,9 +46,75 @@ All functions read JSON formatted parameters "groups": ["", ...] } + openPopup(): + { + "item": "@" + } -When text/icon is clicked and on-click parameter is set to "signal", -extension emit one of the following signals : + closePopup(): + { + "item": "@" + } + + togglePopup(): + { + "item": "@" + } + + +DBUS object +=========== + + is defined as : + { + "text" : "Text to be displayed", + "style" : "CSS style to be applied", // Optional + } + + is defined as : + { + "path" : "Icon path", + "style" : "CSS style to be applied", // Optional + } + + 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 + } + + and/or ] + } + + +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 : "@" + 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"]}'