summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-06-06 12:13:26 +0900
committerCarsten Haitzler (Rasterman) <raster@rasterman.com>2013-06-06 12:13:26 +0900
commit1b46022c538762537b4e1b8ee63362aeb993024a (patch)
tree146734c349be3e0e70ca52e1616ee325f23cc07c /README
parentd993158cc82b25d2d6c2a013c640724fc0a2fd96 (diff)
document edje object inlining and message/signal etc. comms.
Diffstat (limited to 'README')
-rw-r--r--README72
1 files changed, 72 insertions, 0 deletions
diff --git a/README b/README
index 0d4c619..f4ff2d1 100644
--- a/README
+++ b/README
@@ -211,6 +211,78 @@ it[CW;H;LINK\nFULL-PATH-OR-URL]
211 LINK is a path (or url) to open WHEN the thumb is clicked on by the 211 LINK is a path (or url) to open WHEN the thumb is clicked on by the
212 user. 212 user.
213 213
214ij[CW;H;FULL-PATH\nGROUP][\n][cmd1][\r\n][cmd2]...
215 = insert EDJE object with file path given, and the group name given.
216 the command list (and the \n whitespace delimiter before the list)
217 is optional, but is executed/parsed before display of the actual
218 object to do things like initialize its initial state. see "iC"
219 command for more details on the command list.
220
221 be aware that once you have an object with an assigned channel id,
222 it can send back signals and messages via escapes on stdin. these
223 escapes will follow terminology extended escape format
224 (ESC + } ... \000), and the content will be one of:
225
226 ;CHID\ndrag\nPART NAME\nVAL1\nVAL2
227 ;CHID\ndrag,start\nPART NAME\nVAL1\nVAL2
228 ;CHID\ndrag,stop\nPART NAME\nVAL1\nVAL2
229 ;CHID\ndrag,step\nPART NAME\nVAL1\nVAL2
230 ;CHID\drag,set\nPART NAME\nVAL1\nVAL2
231 signal;CHID\nSIGNAL STRING\nSOURCE STRING
232 message;CHID\nOPCODE ID\nstring\nSTRING1
233 message;CHID\nOPCODE ID\nint\nINT1
234 message;CHID\nOPCODE ID\nfloat\nFLOAT1
235 message;CHID\nOPCODE ID\nstring_set\nSTRING1\nSTRING2\nSTRING3...
236 message;CHID\nOPCODE ID\nint_set\nINT1\nINT2\nINT3...
237 message;CHID\nOPCODE ID\nfloat_set\nFLOAT1\nFLOAT2\nFLOAT3...
238 message;CHID\nOPCODE ID\nstring_int\nSTRING1\nINT1
239 message;CHID\nOPCODE ID\nstring_float\nSTRING1\nFLOAT1
240 message;CHID\nOPCODE ID\nstring_int_set\nSTRING1\nINT1\nINT2\nINT3...
241 message;CHID\nOPCODE ID\nstring_float_set\nSTRING1\nFLOAT1\nFLOAT2\nFLOAT3...
242
243iC[CHID]\n[cmd1][\r\n][cmd2][\r\n][cmd3]...
244 = send a "command" (cmd1, cmd2, cmd3 etc.) to an existing named
245 channel id "CHID". this can be a list of 1 or more command strings,
246 with each string broken by a continuous sequence of 1 or more \r
247 and/or \n characters. e.g. "\n", "\r", "\r\n", "\n\r",
248 "\n\r\n\n\n", etc.
249
250 commands understood are:
251
252 text\nPART NAME\nTEXT STRING
253 set the text of "PART NAME" to string "TEXT STRING"
254
255 emit\nSIGNAL STRING\nSOURCE STRING
256 emit signal "SIGNAL STRING" "SOURCE STRING"
257
258 drag\nPART NAME\n[value|size|step|page]\nVAL1\nVAL2
259 manipulate dragable of name "PART NAME" and either set "value",
260 "size", "step" or "page" properties to "VAL1" and "VAL2" for x
261 and y, where VAL1 and VAL2 are floating point values
262
263 chid\nCHANNEL ID
264 set the channel id of a given edje object (only valid in setup
265 commands for the inline edje object) to "CHANNEL ID" so it can
266 be addressed later.
267
268 message\nOPCODE ID\n[string|int|float|string_set|int_set|...
269 float_set|string|int|string_float|string_int_set|...
270 string_float_set]\n[message data]
271 send a message with opcode (integer) id "OPCODE ID" og one of
272 the given types supported ("string", "int", "float", etc.) and
273 then with the given "message data" at the end. message data
274 format depends on message type:
275 string: STRING1
276 int: INT1
277 float: FLOAT1
278 string_set: STRING1\nSTRING2\nSTRING3...
279 int_set: INT1\nINT2\nINT3...
280 float_set: FLOAT1\nFLOAT2\nFLOAT3...
281 string_int: STRING1\nINT1
282 string_float: STRING1\nFLOAT1
283 string_int_set: STRING1\nINT1\nINT2\nINT3...
284 string_float_set: STRING1\nFLOAT1\nFLOAT2\nFLOAT3...
285
214ib 286ib
215 = begin media replace sequence run 287 = begin media replace sequence run
216 288