From 1b46022c538762537b4e1b8ee63362aeb993024a Mon Sep 17 00:00:00 2001 From: "Carsten Haitzler (Rasterman)" Date: Thu, 6 Jun 2013 12:13:26 +0900 Subject: [PATCH] document edje object inlining and message/signal etc. comms. --- README | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) diff --git a/README b/README index 0d4c619d..f4ff2d17 100644 --- a/README +++ b/README @@ -211,6 +211,78 @@ it[CW;H;LINK\nFULL-PATH-OR-URL] LINK is a path (or url) to open WHEN the thumb is clicked on by the user. +ij[CW;H;FULL-PATH\nGROUP][\n][cmd1][\r\n][cmd2]... + = insert EDJE object with file path given, and the group name given. + the command list (and the \n whitespace delimiter before the list) + is optional, but is executed/parsed before display of the actual + object to do things like initialize its initial state. see "iC" + command for more details on the command list. + + be aware that once you have an object with an assigned channel id, + it can send back signals and messages via escapes on stdin. these + escapes will follow terminology extended escape format + (ESC + } ... \000), and the content will be one of: + + ;CHID\ndrag\nPART NAME\nVAL1\nVAL2 + ;CHID\ndrag,start\nPART NAME\nVAL1\nVAL2 + ;CHID\ndrag,stop\nPART NAME\nVAL1\nVAL2 + ;CHID\ndrag,step\nPART NAME\nVAL1\nVAL2 + ;CHID\drag,set\nPART NAME\nVAL1\nVAL2 + signal;CHID\nSIGNAL STRING\nSOURCE STRING + message;CHID\nOPCODE ID\nstring\nSTRING1 + message;CHID\nOPCODE ID\nint\nINT1 + message;CHID\nOPCODE ID\nfloat\nFLOAT1 + message;CHID\nOPCODE ID\nstring_set\nSTRING1\nSTRING2\nSTRING3... + message;CHID\nOPCODE ID\nint_set\nINT1\nINT2\nINT3... + message;CHID\nOPCODE ID\nfloat_set\nFLOAT1\nFLOAT2\nFLOAT3... + message;CHID\nOPCODE ID\nstring_int\nSTRING1\nINT1 + message;CHID\nOPCODE ID\nstring_float\nSTRING1\nFLOAT1 + message;CHID\nOPCODE ID\nstring_int_set\nSTRING1\nINT1\nINT2\nINT3... + message;CHID\nOPCODE ID\nstring_float_set\nSTRING1\nFLOAT1\nFLOAT2\nFLOAT3... + +iC[CHID]\n[cmd1][\r\n][cmd2][\r\n][cmd3]... + = send a "command" (cmd1, cmd2, cmd3 etc.) to an existing named + channel id "CHID". this can be a list of 1 or more command strings, + with each string broken by a continuous sequence of 1 or more \r + and/or \n characters. e.g. "\n", "\r", "\r\n", "\n\r", + "\n\r\n\n\n", etc. + + commands understood are: + + text\nPART NAME\nTEXT STRING + set the text of "PART NAME" to string "TEXT STRING" + + emit\nSIGNAL STRING\nSOURCE STRING + emit signal "SIGNAL STRING" "SOURCE STRING" + + drag\nPART NAME\n[value|size|step|page]\nVAL1\nVAL2 + manipulate dragable of name "PART NAME" and either set "value", + "size", "step" or "page" properties to "VAL1" and "VAL2" for x + and y, where VAL1 and VAL2 are floating point values + + chid\nCHANNEL ID + set the channel id of a given edje object (only valid in setup + commands for the inline edje object) to "CHANNEL ID" so it can + be addressed later. + + message\nOPCODE ID\n[string|int|float|string_set|int_set|... + float_set|string|int|string_float|string_int_set|... + string_float_set]\n[message data] + send a message with opcode (integer) id "OPCODE ID" og one of + the given types supported ("string", "int", "float", etc.) and + then with the given "message data" at the end. message data + format depends on message type: + string: STRING1 + int: INT1 + float: FLOAT1 + string_set: STRING1\nSTRING2\nSTRING3... + int_set: INT1\nINT2\nINT3... + float_set: FLOAT1\nFLOAT2\nFLOAT3... + string_int: STRING1\nINT1 + string_float: STRING1\nFLOAT1 + string_int_set: STRING1\nINT1\nINT2\nINT3... + string_float_set: STRING1\nFLOAT1\nFLOAT2\nFLOAT3... + ib = begin media replace sequence run