summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--ecore-animator.wiki204
-rw-r--r--ecore-event.wiki138
-rw-r--r--ecore-file.wiki1373
-rw-r--r--ecore-intro.wiki25
-rw-r--r--ecore-job.wiki75
-rw-r--r--ecore-poller.wiki95
-rw-r--r--ecore-timer.wiki43
-rw-r--r--eina-containers.wiki319
-rw-r--r--eina-intro.wiki21
-rw-r--r--eina-value.wiki51
-rw-r--r--intro.wiki23
11 files changed, 2367 insertions, 0 deletions
diff --git a/ecore-animator.wiki b/ecore-animator.wiki
new file mode 100644
index 0000000..e663df1
--- /dev/null
+++ b/ecore-animator.wiki
@@ -0,0 +1,204 @@
1===== Javascript binding API - Ecore Animator =====
2
3[[api:javascript:ecore|Back to the JS Ecore page]]
4
5WORKINPROGRESS
6
7==== Constants ====
8
9=== Position mapping ===
10
11 * ''efl.Ecore.Animator.POS_MAP_ACCELERATE''
12 * ''efl.Ecore.Animator.POS_MAP_ACCELERATE_FACTOR''
13 * ''efl.Ecore.Animator.POS_MAP_BOUNCE''
14 * ''efl.Ecore.Animator.POS_MAP_CUBIC_BEZIER''
15 * ''efl.Ecore.Animator.POS_MAP_DECELERATE''
16 * ''efl.Ecore.Animator.POS_MAP_DECELERATE_FACTOR''
17 * ''efl.Ecore.Animator.POS_MAP_DIVISOR_INTERP''
18 * ''efl.Ecore.Animator.POS_MAP_LINEAR''
19 * ''efl.Ecore.Animator.POS_MAP_SINUSOIDAL''
20 * ''efl.Ecore.Animator.POS_MAP_SINUSOIDAL_FACTOR''
21 * ''efl.Ecore.Animator.POS_MAP_SPRING''
22
23=== Sources ===
24
25 * ''efl.Ecore.Animator.SOURCE_CUSTOM''
26 * ''efl.Ecore.Animator.SOURCE_TIMER''
27
28==== Functions ====
29
30=== add() ===
31
32Syntax
33
34<code javascript>
35</code>
36
37Parameters
38
39 *
40
41Return value
42
43 *
44
45=== addTimeline() ===
46
47Syntax
48
49<code javascript>
50 code
51</code>
52
53Parameters
54
55 * parameters
56
57Return value
58
59 * return
60
61=== customTick(args) ===
62
63Syntax
64
65<code javascript>
66 code
67</code>
68
69Parameters
70
71 * parameters
72
73Return value
74
75 * return
76
77=== getFrametime(args) ===
78
79Syntax
80
81<code javascript>
82 code
83</code>
84
85Parameters
86
87 * parameters
88
89Return value
90
91 * return
92
93=== getSource(args) ===
94
95Syntax
96
97<code javascript>
98 code
99</code>
100
101Parameters
102
103 * parameters
104
105Return value
106
107 * return
108
109=== posMap(args) ===
110
111Syntax
112
113<code javascript>
114 code
115</code>
116
117Parameters
118
119 * parameters
120
121Return value
122
123 * return
124
125=== posMapN(args) ===
126
127Syntax
128
129<code javascript>
130 code
131</code>
132
133Parameters
134
135 * parameters
136
137Return value
138
139 * return
140
141=== setCustomSourceTickBeginCallback(args) ===
142
143Syntax
144
145<code javascript>
146 code
147</code>
148
149Parameters
150
151 * parameters
152
153Return value
154
155 * return
156
157=== setCustomSourceTickEndCallback(args) ===
158
159Syntax
160
161<code javascript>
162 code
163</code>
164
165Parameters
166
167 * parameters
168
169Return value
170
171 * return
172
173=== setFrametime(args) ===
174
175Syntax
176
177<code javascript>
178 code
179</code>
180
181Parameters
182
183 * parameters
184
185Return value
186
187 * return
188
189=== setSource(args) ===
190
191Syntax
192
193<code javascript>
194 code
195</code>
196
197Parameters
198
199 * parameters
200
201Return value
202
203 * return
204 \ No newline at end of file
diff --git a/ecore-event.wiki b/ecore-event.wiki
new file mode 100644
index 0000000..c39f3bc
--- /dev/null
+++ b/ecore-event.wiki
@@ -0,0 +1,138 @@
1===== Javascript binding API - Ecore Events =====
2
3[[api:javascript:ecore|Back to the JS Ecore page]]
4
5WORKINPROGRESS
6
7==== Constants ====
8
9=== Signal type ===
10
11 * ''efl.Ecore.Event.NONE''
12 * ''efl.Ecore.Event.SIGNAL_USER''
13 * ''efl.Ecore.Event.SIGNAL_HUP''
14 * ''efl.Ecore.Event.SIGNAL_EXIT''
15 * ''efl.Ecore.Event.SIGNAL_POWER''
16 * ''efl.Ecore.Event.SIGNAL_REALTIME''
17
18=== Hardware state ===
19
20 * ''efl.Ecore.Event.MEMORY_STATE''
21 * ''efl.Ecore.Event.POWER_STATE''
22
23 * ''efl.Ecore.Event.MEMORY_STATE_NORMAL''
24 * ''efl.Ecore.Event.MEMORY_STATE_LOW''
25
26 * ''efl.Ecore.Event.POWER_STATE_MAINS''
27 * ''efl.Ecore.Event.POWER_STATE_BATTERY''
28 * ''efl.Ecore.Event.POWER_STATE_LOW''
29
30=== Changes ===
31
32 * ''efl.Ecore.Event.LOCALE_CHANGED''
33 * ''efl.Ecore.Event.HOSTNAME_CHANGED''
34 * ''efl.Ecore.Event.SYSTEM_TIMEDATE_CHANGED''
35
36==== Functions ====
37
38=== add() ===
39
40Syntax
41
42<code javascript>
43</code>
44
45Parameters
46
47 * parameter
48
49Return type
50
51 * return type
52
53Lorem ipsum...
54
55=== addHandler() ===
56
57Syntax
58
59<code javascript>
60</code>
61
62Parameters
63
64 * parameter
65
66Return type
67
68 * return type
69
70Lorem ipsum...
71
72=== getCurrentType() ===
73
74Syntax
75
76<code javascript>
77</code>
78
79Parameters
80
81 * parameter
82
83Return type
84
85 * return type
86
87Lorem ipsum...
88
89=== addSignalUserHandler() ===
90
91Syntax
92
93<code javascript>
94</code>
95
96Parameters
97
98 * parameter
99
100Return type
101
102 * return type
103
104Lorem ipsum...
105
106=== addSignalExitHandler() ===
107
108Syntax
109
110<code javascript>
111</code>
112
113Parameters
114
115 * parameter
116
117Return type
118
119 * return type
120
121Lorem ipsum...
122
123=== addSignalRealtimeHandler() ===
124
125Syntax
126
127<code javascript>
128</code>
129
130Parameters
131
132 * parameter
133
134Return type
135
136 * return type
137
138Lorem ipsum...
diff --git a/ecore-file.wiki b/ecore-file.wiki
new file mode 100644
index 0000000..ad2198b
--- /dev/null
+++ b/ecore-file.wiki
@@ -0,0 +1,1373 @@
1===== Javascript binding API - Ecore Files =====
2
3[[api:javascript:ecore|Back to the JS Ecore page]]
4
5WORKINPROGRESS
6
7==== Constants ====
8
9
10=== Events ===
11
12 * ''efl.Ecore.File.EVENT_NONE''
13 * ''efl.Ecore.File.EVENT_CREATED_FILE''
14 * ''efl.Ecore.File.EVENT_CREATED_DIRECTORY''
15 * ''efl.Ecore.File.EVENT_DELETED_FILE''
16 * ''efl.Ecore.File.EVENT_DELETED_DIRECTORY''
17 * ''efl.Ecore.File.EVENT_SELF''
18 * ''efl.Ecore.File.EVENT_MODIFIED''
19 * ''efl.Ecore.File.EVENT_CLOSED''
20 * ''efl.Ecore.File.PROGRESS_CONTINUE''
21 * ''efl.Ecore.File.PROCESS_ABORT''
22
23==== Functions ====
24
25=== abortAllDownloads() ===
26
27Syntax
28
29<code javascript>
30</code>
31
32Parameters
33
34 * parameter
35
36Return type
37
38 * return type
39
40Lorem ipsum...
41
42=== addMonitor() ===
43
44Syntax
45
46<code javascript>
47</code>
48
49Parameters
50
51 * parameter
52
53Return type
54
55 * return type
56
57Lorem ipsum...
58
59=== availableDownloadProtocol() ===
60
61Syntax
62
63<code javascript>
64</code>
65
66Parameters
67
68 * parameter
69
70Return type
71
72 * return type
73
74Lorem ipsum...
75
76=== canExec() ===
77
78Syntax
79
80<code javascript>
81</code>
82
83Parameters
84
85 * parameter
86
87Return type
88
89 * return type
90
91Lorem ipsum...
92
93=== canRead() ===
94
95Syntax
96
97<code javascript>
98</code>
99
100Parameters
101
102 * parameter
103
104Return type
105
106 * return type
107
108Lorem ipsum...
109
110=== canWrite() ===
111
112Syntax
113
114<code javascript>
115</code>
116
117Parameters
118
119 * parameter
120
121Return type
122
123 * return type
124
125Lorem ipsum...
126
127=== cp() ===
128
129Syntax
130
131<code javascript>
132</code>
133
134Parameters
135
136 * parameter
137
138Return type
139
140 * return type
141
142Lorem ipsum...
143
144=== download() ===
145
146Syntax
147
148<code javascript>
149</code>
150
151Parameters
152
153 * parameter
154
155Return type
156
157 * return type
158
159Lorem ipsum...
160
161=== environmentTmp() ===
162
163Syntax
164
165<code javascript>
166</code>
167
168Parameters
169
170 * parameter
171
172Return type
173
174 * return type
175
176Lorem ipsum...
177
178=== escapeName() ===
179
180Syntax
181
182<code javascript>
183</code>
184
185Parameters
186
187 * parameter
188
189Return type
190
191 * return type
192
193Lorem ipsum...
194
195=== exists() ===
196
197Syntax
198
199<code javascript>
200</code>
201
202Parameters
203
204 * parameter
205
206Return type
207
208 * return type
209
210Lorem ipsum...
211
212=== existsPathDir() ===
213
214Syntax
215
216<code javascript>
217</code>
218
219Parameters
220
221 * parameter
222
223Return type
224
225 * return type
226
227Lorem ipsum...
228
229=== getAppExe() ===
230
231Syntax
232
233<code javascript>
234</code>
235
236Parameters
237
238 * parameter
239
240Return type
241
242 * return type
243
244Lorem ipsum...
245
246=== getDir() ===
247
248Syntax
249
250<code javascript>
251</code>
252
253Parameters
254
255 * parameter
256
257Return type
258
259 * return type
260
261Lorem ipsum...
262
263=== getFile() ===
264
265Syntax
266
267<code javascript>
268</code>
269
270Parameters
271
272 * parameter
273
274Return type
275
276 * return type
277
278Lorem ipsum...
279
280=== init() ===
281
282Syntax
283
284<code javascript>
285</code>
286
287Parameters
288
289 * parameter
290
291Return type
292
293 * return type
294
295Lorem ipsum...
296
297=== installedApp() ===
298
299Syntax
300
301<code javascript>
302</code>
303
304Parameters
305
306 * parameter
307
308Return type
309
310 * return type
311
312Lorem ipsum...
313
314=== isDir() ===
315
316Syntax
317
318<code javascript>
319</code>
320
321Parameters
322
323 * parameter
324
325Return type
326
327 * return type
328
329Lorem ipsum...
330
331=== isEmptyDir() ===
332
333Syntax
334
335<code javascript>
336</code>
337
338Parameters
339
340 * parameter
341
342Return type
343
344 * return type
345
346Lorem ipsum...
347
348=== listApp() ===
349
350Syntax
351
352<code javascript>
353</code>
354
355Parameters
356
357 * parameter
358
359Return type
360
361 * return type
362
363Lorem ipsum...
364
365=== ls() ===
366
367Syntax
368
369<code javascript>
370</code>
371
372Parameters
373
374 * parameter
375
376Return type
377
378 * return type
379
380Lorem ipsum...
381
382=== mkdir() ===
383
384Syntax
385
386<code javascript>
387</code>
388
389Parameters
390
391 * parameter
392
393Return type
394
395 * return type
396
397Lorem ipsum...
398
399=== mkdirs() ===
400
401Syntax
402
403<code javascript>
404</code>
405
406Parameters
407
408 * parameter
409
410Return type
411
412 * return type
413
414Lorem ipsum...
415
416=== mkpath() ===
417
418Syntax
419
420<code javascript>
421</code>
422
423Parameters
424
425 * parameter
426
427Return type
428
429 * return type
430
431Lorem ipsum...
432
433=== mkpaths() ===
434
435Syntax
436
437<code javascript>
438</code>
439
440Parameters
441
442 * parameter
443
444Return type
445
446 * return type
447
448Lorem ipsum...
449
450=== mkstemp() ===
451
452Syntax
453
454<code javascript>
455</code>
456
457Parameters
458
459 * parameter
460
461Return type
462
463 * return type
464
465Lorem ipsum...
466
467=== mksubdirs() ===
468
469Syntax
470
471<code javascript>
472</code>
473
474Parameters
475
476 * parameter
477
478Return type
479
480 * return type
481
482Lorem ipsum...
483
484=== modTime() ===
485
486Syntax
487
488<code javascript>
489</code>
490
491Parameters
492
493 * parameter
494
495Return type
496
497 * return type
498
499Lorem ipsum...
500
501=== mv() ===
502
503Syntax
504
505<code javascript>
506</code>
507
508Parameters
509
510 * parameter
511
512Return type
513
514 * return type
515
516Lorem ipsum...
517
518=== readlink() ===
519
520Syntax
521
522<code javascript>
523</code>
524
525Parameters
526
527 * parameter
528
529Return type
530
531 * return type
532
533Lorem ipsum...
534
535=== realpath() ===
536
537Syntax
538
539<code javascript>
540</code>
541
542Parameters
543
544 * parameter
545
546Return type
547
548 * return type
549
550Lorem ipsum...
551
552=== remove() ===
553
554Syntax
555
556<code javascript>
557</code>
558
559Parameters
560
561 * parameter
562
563Return type
564
565 * return type
566
567Lorem ipsum...
568
569=== rmdir() ===
570
571Syntax
572
573<code javascript>
574</code>
575
576Parameters
577
578 * parameter
579
580Return type
581
582 * return type
583
584Lorem ipsum...
585
586=== rmRecursive() ===
587
588Syntax
589
590<code javascript>
591</code>
592
593Parameters
594
595 * parameter
596
597Return type
598
599 * return type
600
601Lorem ipsum...
602
603=== shutdown() ===
604
605Syntax
606
607<code javascript>
608</code>
609
610Parameters
611
612 * parameter
613
614Return type
615
616 * return type
617
618Lorem ipsum...
619
620=== size() ===
621
622Syntax
623
624<code javascript>
625</code>
626
627Parameters
628
629 * parameter
630
631Return type
632
633 * return type
634
635Lorem ipsum...
636
637=== stripExtension() ===
638
639Syntax
640
641<code javascript>
642</code>
643
644Parameters
645
646 * parameter
647
648Return type
649
650 * return type
651
652Lorem ipsum...
653
654=== symlink() ===
655
656Syntax
657
658<code javascript>
659</code>
660
661Parameters
662
663 * parameter
664
665Return type
666
667 * return type
668
669Lorem ipsum...
670
671=== unlink() ===
672
673Syntax
674
675<code javascript>
676</code>
677
678Parameters
679
680 * parameter
681
682Return type
683
684 * return type
685
686Lorem ipsum...
687===== Javascript binding API - Ecore Files =====
688
689[[api:javascript:ecore|Back to the JS Ecore page]]
690
691WORKINPROGRESS
692
693==== Constants ====
694
695
696=== Events ===
697
698 * ''efl.Ecore.File.EVENT_NONE''
699 * ''efl.Ecore.File.EVENT_CREATED_FILE''
700 * ''efl.Ecore.File.EVENT_CREATED_DIRECTORY''
701 * ''efl.Ecore.File.EVENT_DELETED_FILE''
702 * ''efl.Ecore.File.EVENT_DELETED_DIRECTORY''
703 * ''efl.Ecore.File.EVENT_SELF''
704 * ''efl.Ecore.File.EVENT_MODIFIED''
705 * ''efl.Ecore.File.EVENT_CLOSED''
706 * ''efl.Ecore.File.PROGRESS_CONTINUE''
707 * ''efl.Ecore.File.PROCESS_ABORT''
708
709==== Functions ====
710
711=== abortAllDownloads() ===
712
713Syntax
714
715<code javascript>
716</code>
717
718Parameters
719
720 * parameter
721
722Return type
723
724 * return type
725
726Lorem ipsum...
727
728=== addMonitor() ===
729
730Syntax
731
732<code javascript>
733</code>
734
735Parameters
736
737 * parameter
738
739Return type
740
741 * return type
742
743Lorem ipsum...
744
745=== availableDownloadProtocol() ===
746
747Syntax
748
749<code javascript>
750</code>
751
752Parameters
753
754 * parameter
755
756Return type
757
758 * return type
759
760Lorem ipsum...
761
762=== canExec() ===
763
764Syntax
765
766<code javascript>
767</code>
768
769Parameters
770
771 * parameter
772
773Return type
774
775 * return type
776
777Lorem ipsum...
778
779=== canRead() ===
780
781Syntax
782
783<code javascript>
784</code>
785
786Parameters
787
788 * parameter
789
790Return type
791
792 * return type
793
794Lorem ipsum...
795
796=== canWrite() ===
797
798Syntax
799
800<code javascript>
801</code>
802
803Parameters
804
805 * parameter
806
807Return type
808
809 * return type
810
811Lorem ipsum...
812
813=== cp() ===
814
815Syntax
816
817<code javascript>
818</code>
819
820Parameters
821
822 * parameter
823
824Return type
825
826 * return type
827
828Lorem ipsum...
829
830=== download() ===
831
832Syntax
833
834<code javascript>
835</code>
836
837Parameters
838
839 * parameter
840
841Return type
842
843 * return type
844
845Lorem ipsum...
846
847=== environmentTmp() ===
848
849Syntax
850
851<code javascript>
852</code>
853
854Parameters
855
856 * parameter
857
858Return type
859
860 * return type
861
862Lorem ipsum...
863
864=== escapeName() ===
865
866Syntax
867
868<code javascript>
869</code>
870
871Parameters
872
873 * parameter
874
875Return type
876
877 * return type
878
879Lorem ipsum...
880
881=== exists() ===
882
883Syntax
884
885<code javascript>
886</code>
887
888Parameters
889
890 * parameter
891
892Return type
893
894 * return type
895
896Lorem ipsum...
897
898=== existsPathDir() ===
899
900Syntax
901
902<code javascript>
903</code>
904
905Parameters
906
907 * parameter
908
909Return type
910
911 * return type
912
913Lorem ipsum...
914
915=== getAppExe() ===
916
917Syntax
918
919<code javascript>
920</code>
921
922Parameters
923
924 * parameter
925
926Return type
927
928 * return type
929
930Lorem ipsum...
931
932=== getDir() ===
933
934Syntax
935
936<code javascript>
937</code>
938
939Parameters
940
941 * parameter
942
943Return type
944
945 * return type
946
947Lorem ipsum...
948
949=== getFile() ===
950
951Syntax
952
953<code javascript>
954</code>
955
956Parameters
957
958 * parameter
959
960Return type
961
962 * return type
963
964Lorem ipsum...
965
966=== init() ===
967
968Syntax
969
970<code javascript>
971</code>
972
973Parameters
974
975 * parameter
976
977Return type
978
979 * return type
980
981Lorem ipsum...
982
983=== installedApp() ===
984
985Syntax
986
987<code javascript>
988</code>
989
990Parameters
991
992 * parameter
993
994Return type
995
996 * return type
997
998Lorem ipsum...
999
1000=== isDir() ===
1001
1002Syntax
1003
1004<code javascript>
1005</code>
1006
1007Parameters
1008
1009 * parameter
1010
1011Return type
1012
1013 * return type
1014
1015Lorem ipsum...
1016
1017=== isEmptyDir() ===
1018
1019Syntax
1020
1021<code javascript>
1022</code>
1023
1024Parameters
1025
1026 * parameter
1027
1028Return type
1029
1030 * return type
1031
1032Lorem ipsum...
1033
1034=== listApp() ===
1035
1036Syntax
1037
1038<code javascript>
1039</code>
1040
1041Parameters
1042
1043 * parameter
1044
1045Return type
1046
1047 * return type
1048
1049Lorem ipsum...
1050
1051=== ls() ===
1052
1053Syntax
1054
1055<code javascript>
1056</code>
1057
1058Parameters
1059
1060 * parameter
1061
1062Return type
1063
1064 * return type
1065
1066Lorem ipsum...
1067
1068=== mkdir() ===
1069
1070Syntax
1071
1072<code javascript>
1073</code>
1074
1075Parameters
1076
1077 * parameter
1078
1079Return type
1080
1081 * return type
1082
1083Lorem ipsum...
1084
1085=== mkdirs() ===
1086
1087Syntax
1088
1089<code javascript>
1090</code>
1091
1092Parameters
1093
1094 * parameter
1095
1096Return type
1097
1098 * return type
1099
1100Lorem ipsum...
1101
1102=== mkpath() ===
1103
1104Syntax
1105
1106<code javascript>
1107</code>
1108
1109Parameters
1110
1111 * parameter
1112
1113Return type
1114
1115 * return type
1116
1117Lorem ipsum...
1118
1119=== mkpaths() ===
1120
1121Syntax
1122
1123<code javascript>
1124</code>
1125
1126Parameters
1127
1128 * parameter
1129
1130Return type
1131
1132 * return type
1133
1134Lorem ipsum...
1135
1136=== mkstemp() ===
1137
1138Syntax
1139
1140<code javascript>
1141</code>
1142
1143Parameters
1144
1145 * parameter
1146
1147Return type
1148
1149 * return type
1150
1151Lorem ipsum...
1152
1153=== mksubdirs() ===
1154
1155Syntax
1156
1157<code javascript>
1158</code>
1159
1160Parameters
1161
1162 * parameter
1163
1164Return type
1165
1166 * return type
1167
1168Lorem ipsum...
1169
1170=== modTime() ===
1171
1172Syntax
1173
1174<code javascript>
1175</code>
1176
1177Parameters
1178
1179 * parameter
1180
1181Return type
1182
1183 * return type
1184
1185Lorem ipsum...
1186
1187=== mv() ===
1188
1189Syntax
1190
1191<code javascript>
1192</code>
1193
1194Parameters
1195
1196 * parameter
1197
1198Return type
1199
1200 * return type
1201
1202Lorem ipsum...
1203
1204=== readlink() ===
1205
1206Syntax
1207
1208<code javascript>
1209</code>
1210
1211Parameters
1212
1213 * parameter
1214
1215Return type
1216
1217 * return type
1218
1219Lorem ipsum...
1220
1221=== realpath() ===
1222
1223Syntax
1224
1225<code javascript>
1226</code>
1227
1228Parameters
1229
1230 * parameter
1231
1232Return type
1233
1234 * return type
1235
1236Lorem ipsum...
1237
1238=== remove() ===
1239
1240Syntax
1241
1242<code javascript>
1243</code>
1244
1245Parameters
1246
1247 * parameter
1248
1249Return type
1250
1251 * return type
1252
1253Lorem ipsum...
1254
1255=== rmdir() ===
1256
1257Syntax
1258
1259<code javascript>
1260</code>
1261
1262Parameters
1263
1264 * parameter
1265
1266Return type
1267
1268 * return type
1269
1270Lorem ipsum...
1271
1272=== rmRecursive() ===
1273
1274Syntax
1275
1276<code javascript>
1277</code>
1278
1279Parameters
1280
1281 * parameter
1282
1283Return type
1284
1285 * return type
1286
1287Lorem ipsum...
1288
1289=== shutdown() ===
1290
1291Syntax
1292
1293<code javascript>
1294</code>
1295
1296Parameters
1297
1298 * parameter
1299
1300Return type
1301
1302 * return type
1303
1304Lorem ipsum...
1305
1306=== size() ===
1307
1308Syntax
1309
1310<code javascript>
1311</code>
1312
1313Parameters
1314
1315 * parameter
1316
1317Return type
1318
1319 * return type
1320
1321Lorem ipsum...
1322
1323=== stripExtension() ===
1324
1325Syntax
1326
1327<code javascript>
1328</code>
1329
1330Parameters
1331
1332 * parameter
1333
1334Return type
1335
1336 * return type
1337
1338Lorem ipsum...
1339
1340=== symlink() ===
1341
1342Syntax
1343
1344<code javascript>
1345</code>
1346
1347Parameters
1348
1349 * parameter
1350
1351Return type
1352
1353 * return type
1354
1355Lorem ipsum...
1356
1357=== unlink() ===
1358
1359Syntax
1360
1361<code javascript>
1362</code>
1363
1364Parameters
1365
1366 * parameter
1367
1368Return type
1369
1370 * return type
1371
1372Lorem ipsum...
1373
diff --git a/ecore-intro.wiki b/ecore-intro.wiki
new file mode 100644
index 0000000..ca43fa5
--- /dev/null
+++ b/ecore-intro.wiki
@@ -0,0 +1,25 @@
1====== Javascript binding API - ECore - Operating system abstraction and integration ======
2
3[[api:javascript|Back to the JS EFL page]]
4
5The ECore library provides tools to enhance the integration between the application and the operating system.
6
7===== Components =====
8
9[[api/javascript/ecore/animator|Animator API reference]] - Simplify the creation of animations.
10
11[[api/javascript/ecore/event| Event API reference]] - Creation and notification of events.
12
13[[api/javascript/ecore/file| File API reference]] - File and directory handling.
14
15[[api/javascript/ecore/idle| Idle API reference]] - Creation of callbacks to be called when the application is not handling events, timers or file handlers.
16
17[[api/javascript/ecore/job| Job API reference]] - Queuing jobs for later execution.
18
19[[api/javascript/ecore/mainloop| Mainloop API reference]] - Integration with EFL main loop.
20
21[[api/javascript/ecore/poller| Poller API reference]] - Provides an infrastructure for creation of pollers.
22
23[[api/javascript/ecore/throttle| Throttle API reference]] - Sets the "voluntary throlling" by the EFL main loop.
24
25[[api/javascript/ecore/timer| Timer API reference]] - Handling of timer callbacks.
diff --git a/ecore-job.wiki b/ecore-job.wiki
new file mode 100644
index 0000000..8310da3
--- /dev/null
+++ b/ecore-job.wiki
@@ -0,0 +1,75 @@
1===== Javascript binding API - Ecore Idler =====
2
3[[api:javascript:ecore|Back to the JS Ecore page]]
4
5**DRAFT**
6
7==== Constants ====
8
9
10==== Functions ====
11
12=== add(args) ===
13
14Syntax
15
16<code javascript>
17 code
18</code>
19
20Parameters
21
22 * parameters
23
24Return value
25
26 * return
27
28=== addEnterer(args) ===
29
30Syntax
31
32<code javascript>
33 code
34</code>
35
36Parameters
37
38 * parameters
39
40Return value
41
42 * return
43
44=== addEntererBefore(args) ===
45
46Syntax
47
48<code javascript>
49 code
50</code>
51
52Parameters
53
54 * parameters
55
56Return value
57
58 * return
59
60=== addExiter(args) ===
61
62Syntax
63
64<code javascript>
65 code
66</code>
67
68Parameters
69
70 * parameters
71
72Return value
73
74 * return
75 \ No newline at end of file
diff --git a/ecore-poller.wiki b/ecore-poller.wiki
new file mode 100644
index 0000000..e828287
--- /dev/null
+++ b/ecore-poller.wiki
@@ -0,0 +1,95 @@
1===== Javascript binding API - Ecore Mainloop =====
2
3[[api:javascript:ecore|Back to the JS Ecore page]]
4
5**DRAFT**
6
7==== Constants ====
8
9 * ''efl.Ecore.Mainloop.CALLBACK_CANCEL''
10 * ''efl.Ecore.Mainloop.CALLBACK_DONE''
11 * ''efl.Ecore.Mainloop.CALLBACK_PASS_ON''
12 * ''efl.Ecore.Mainloop.CALLBACK_RENEW''
13
14==== Functions ====
15
16=== begin(args) ===
17
18Syntax
19
20<code javascript>
21 code
22</code>
23
24Parameters
25
26 * parameters
27
28Return value
29
30 * return
31
32=== getAnimatorTicked(args) ===
33
34Syntax
35
36<code javascript>
37 code
38</code>
39
40Parameters
41
42 * parameters
43
44Return value
45
46 * return
47
48=== getNested(args) ===
49
50Syntax
51
52<code javascript>
53 code
54</code>
55
56Parameters
57
58 * parameters
59
60Return value
61
62 * return
63
64=== iterate(args) ===
65
66Syntax
67
68<code javascript>
69 code
70</code>
71
72Parameters
73
74 * parameters
75
76Return value
77
78 * return
79
80=== quit(args) ===
81
82Syntax
83
84<code javascript>
85 code
86</code>
87
88Parameters
89
90 * parameters
91
92Return value
93
94 * return
95 \ No newline at end of file
diff --git a/ecore-timer.wiki b/ecore-timer.wiki
new file mode 100644
index 0000000..4c82ed4
--- /dev/null
+++ b/ecore-timer.wiki
@@ -0,0 +1,43 @@
1===== Javascript binding API - Ecore Throttle =====
2
3[[api:javascript:ecore|Back to the JS Ecore page]]
4
5**DRAFT**
6
7==== Constants ====
8
9
10==== Functions ====
11
12=== adjust(args) ===
13
14Syntax
15
16<code javascript>
17 code
18</code>
19
20Parameters
21
22 * parameters
23
24Return value
25
26 * return
27
28=== get(args) ===
29
30Syntax
31
32<code javascript>
33 code
34</code>
35
36Parameters
37
38 * parameters
39
40Return value
41
42 * return
43 \ No newline at end of file
diff --git a/eina-containers.wiki b/eina-containers.wiki
new file mode 100644
index 0000000..ddcb15e
--- /dev/null
+++ b/eina-containers.wiki
@@ -0,0 +1,319 @@
1====== Javascript binding API - Eina Containers ======
2
3[[api::javascript::eina|Back to the JS Eina page]]
4
5Currently, two data types are available: Lists and Arrays. Both represent a sequence of items and aim to have a similar interface to the native [[https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array|Javascript Arrays]] for the most common operations like push/pop and indexed get/set.
6
7One important limitation is that when you create an Eina collection you must pass the type of object that will be stored. This is required to allow the binding do the correct conversion between Javascript types and C/C++ types due to the former's static nature.
8
9Besides the constructor function, they differ in the way the items are stored underneath. ''efl.List'' are doubly-linked lists, with relatively fast insert/delete operations while ''efl.Array'' objects are contiguous memory regions, with fast data access (compared to Lists) but allowing to insert or delete items only at the extremities of the container.
10
11<note important>
12Apart from the constructors, both containers have the exact same API.
13</note>
14
15==== Constructors ====
16
17Syntax
18
19<code javascript>
20new efl.List(typename);
21new efl.Array(typename);
22</code>
23
24Parameters
25
26 * typename - A string with the type of the contained items for this container.
27
28Return type
29
30 * Array/List - A newly created container, empty.
31
32The constructor functions receive the name of the type that will be stored on the container. The following types are supported using the respective type name:
33
34 * Integers - "int"
35 * Floating point numbers - "float"
36 * Boolean values - "bool"
37 * Strings of characters - "string"
38
39==== Containers methods and operations ====
40
41The methods and operations below are supported for both types of sequences.
42
43=== concat(container) ===
44
45Syntax
46
47<code javascript>
48var new_container = objA.concat(objC);
49</code>
50
51Parameters
52
53 * container - A container of the same type of the callee container, including the contained type.
54
55Return type
56
57 * Array/List - A container of the same type of the callee.
58
59Concatenates two containers returning the result as a new container object.
60
61<note important>
62It performs a shallow copy of the container. Object **references** are copied (i.e. changes in the object will appear in both containers) and basic types are copied.
63</note>
64
65<note warning>
66The concatenation operation will work only on the same type of containers (e.g. lists of ints with lists of ints). Wrong arguments will raise TypeError.
67</note>
68
69=== getter: container[index] ===
70
71Syntax
72
73<code javascript>
74var myvar = obj[index];
75</code>
76
77Parameters
78
79 * index - An integer with the 0-based index desired.
80
81Return type
82
83 * T or ''undefined'' - When calling on a container wrapping items of type T. ''undefined'' if no object on that index.
84
85Works like Javascript Array ''[]'' operators. The items are 0-indexed, with the first element at index 0 and the last element with index equal to the number of elements of the sequence minus 1.
86
87Usage example:
88
89<code javascript>
90mylist[42] // Gets the 42nd element
91mylist[0] // Gets the first element.
92</code>
93
94<note important>
95Trying to access an element with an index out of bounds will return ''undefined''.
96</note>
97
98=== indexOf(target) ===
99
100Syntax
101
102<code javascript>
103var index = obj.indexOf(target);
104</code>
105
106Parameters
107
108 * target - An object/item to search for.
109
110Return type
111
112 * integer - The index of the item in the container. -1 if not found.
113
114Searches for ''target'' in the container and returns the index if found. If not found, return -1.
115
116Example usage:
117
118<code javascript>
119// obj = [100, 42, 55, 42]
120var idx = obj.indexOf(42); // idx = 1
121var idx2 = obj.indexOf(1000); // idx2 = -1
122</code>
123
124=== lastIndexOf(target) ===
125
126Syntax
127
128<code javascript>
129var index = obj.lastIndexOf(target);
130</code>
131
132Parameters
133
134 * target - An object/item to search for.
135
136Return type
137
138 * integer - The last index of the item in the container. -1 if not found.
139
140Searches backwards for ''target'', returning its index if found, or -1 otherwise.
141
142Example code:
143
144<code javascript>
145// obj = [100, 42, 55, 42]
146var idx = obj.lastIndexOf(42) // idx = 3
147var idx2 = obj.lastIndexOf(0) // idx2 = -1
148</code>
149
150=== length property ===
151
152Syntax
153
154<code javascript>
155obj.length
156</code>
157
158Return type
159
160 * integer - The number of elements on this container.
161
162Returns the number of elements on this container.
163
164<note important>
165In pure Javascript Arrays, assigning a number smaller than the size of the container to the length property will delete elements from the container. This behavior is **not** present on eina Arrays or Lists. Trying to assign a number to length will have no effect.
166</note>
167
168Example usage:
169
170<code javascript>
171var last = obj[obj.length - 1]
172</code>
173
174=== pop() ===
175
176Syntax
177
178<code javascript>
179var value = obj.pop();
180</code>
181
182Return type
183
184 * T or ''undefined'' - For containers wrapping items of type T. ''undefined'' if it was an empty space or the container was empty.
185
186Behaves like Javascript ''Array.pop()'', removing the last element of the list and returning it.
187
188Example code:
189<code javascript>
190// obj is [1,2,3,4,5]
191var value = obj.pop(); // value now is 5 and obj is [1,2,3,4]
192</code>
193
194<note important>
195Trying to pop an item from an empty list will return undefined and leave the list empty.
196</note>
197
198=== push(value) ===
199
200Syntax
201
202<code javascript>
203var size = obj.push(item)
204</code>
205
206Parameters
207
208 * item - An object/item to append to the container.
209
210Return type
211
212 * integer - The size of the container after pushing.
213
214Works like the Javascript ''Array.push(item)'', appending the item to the end of the sequence. For lists, a new node is created at the end. For Arrays, the item is set to the end of the array, and it may grow as needed.
215
216The method returns the size of the container after adding the new element.
217
218Usage example:
219
220<code javascript>
221var mylist = new efl.List("int");
222mylist.push(3);
223var myarray = new efl.Array("string");
224var new_size = myarray.push("Foobar");
225</code>
226
227<note warning>
228Although Javascript is weak typed, the binding functions are rather strong typed, doing minimal type conversions, like int to floats. Trying to push an element of a different type from the one provided in the constructor will raise TypeError.
229<code javascript>
230var obj = new efl.List("float");
231obj.push("44"); // CRASH!!!!
232</code>
233</note>
234
235=== setter: container[index] = value ===
236
237Syntax
238
239<code javascript>
240obj[index] = value;
241var v = (obj[index] = value);
242</code>
243
244Parameters
245
246 * index - An integer with the target slot on the container.
247 * value - An object/item to be set to the target position.
248
249Return type
250
251 * object - The same object that was assigned (''value'').
252
253Works like Javascript indexed setter method. It sets the value at the given index to the given value, //generally// not changing the container size (see note below). On success, the operation returns the value recently set.
254
255<note important>
256Trying to set a value at an index equal or larger than the size of the container will extend the container up to that index and fill value up to the last one with ''undefined'', and setting the given value in the last position.
257<code javascript>
258var obj = new efl.List("int");
259obj[42] = 42; // Obj now has 42 undefined's leading up to 42 in the last position.
260</code>
261</note>
262
263Usage example:
264
265<code javascript>
266var obj = new efl.List("int");
267obj.push(3) // [3]
268obj.push(2) // [3,2]
269obj[0] = 42; // [42, 2]
270</code>
271
272<note warning>
273As with pushing elements, trying to push an element of a different type from the one given to the constructor will raise TypeError.
274</note>
275
276=== slice([begin,[end]]) ===
277
278Syntax
279
280<code javascript>
281var x = obj.slice();
282var y = obj.slice(startIndex);
283var z = obj.slice(startIndex, endIndex);
284</code>
285
286Parameters
287
288 * begin - An integer with the index of the start of the slice.
289 * end - An integer with the index of the end of the slice.
290
291Return type
292
293 * container - A container of the same type of the callee.
294
295The slice method retrieves portions of the container. The first argument is the index to start the slice operation (default is 0, beginning of the list) and the second argument indicates the index where the extraction should stop, not including it (defaults to the container size). In interval notation, it returns ''[begin, end)''.
296
297It also performs a shallow copy like concat().
298
299Example usage:
300
301<code javascript>
302var same = obj.slice() // All elements from obj are in the returned container.
303var other = obj.slice(1); // Everything but the first element.
304var another = obj.slice (4, 10); // From the fifth element to the tenth.
305</code>
306
307=== toString() ===
308
309Syntax
310
311<code javascript>
312obj.toString();
313</code>
314
315Return type
316
317 * string - A comma-separated list of the items in this container.
318
319Generates a comma-separated string with the representation of the items in this container.
diff --git a/eina-intro.wiki b/eina-intro.wiki
new file mode 100644
index 0000000..df95e1f
--- /dev/null
+++ b/eina-intro.wiki
@@ -0,0 +1,21 @@
1====== Javascript binding API - Eina - Data types and tools ======
2
3[[api:javascript|Back to the JS EFL page]]
4
5The Eina library provides a number of data types and tools targeted at working with the remainder of the EFL framework although they can be used on their own. For example, Lists and Arrays can be used both to send collections of objects to a native function or get the result of a native function. Or someone can use just the logging facilities.
6
7===== Data types =====
8
9[[api/javascript/eina/containers|Containers API reference]] - A [[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array|JS Array]]-like set of containers for interacting with EFL functions.
10
11===== Tools and utilities =====
12
13[[api/javascript/eina/logging|Logging API reference]] - The Logging framework allows setting up different log domains and levels.
14
15[[api/javascript/eina/error|Error handling API reference]] - EFL offers a C's errno-like way of handling error through error codes. These codes are translated to Javascript Exceptions.
16
17[[api/javascript/eina/iterator|Iterator functions API reference]] - Allows sequential item access to Eina containers using iterator functions.
18
19[[api/javascript/eina/accessor|Acessor functions API reference]] - Allows random item access to Eina containers using accessor functions.
20
21[[api/javascript/eina/value|Value wrapping API reference]] - Abstracts generic data storage and access.
diff --git a/eina-value.wiki b/eina-value.wiki
new file mode 100644
index 0000000..15b124e
--- /dev/null
+++ b/eina-value.wiki
@@ -0,0 +1,51 @@
1====== Javascript binding API - Generic value storage ======
2
3[[api::javascript::eina|Back to the JS Eina page]]
4
5Eina provides a way to abstract the storage of generic values in an extensible and efficient way, aimed at simple data types.
6
7==== Constructors and methods ====
8
9=== Constructor ===
10
11Syntax
12
13<code javascript>
14var obj = new efl.value(value);
15</code>
16
17Parameters
18
19 * value - The value to be wrapped. Currently, numerical and string types are supported.
20
21Return type
22
23 * Value instance - The newly created wrapper.
24
25Creates a new value wrapper. It can be passed to the native functions and back.
26
27Example usage
28
29<code javascript>
30var myvalue = new efl.value(42);
31</code>
32
33=== get() ===
34
35Syntax
36
37<code javascript>
38var unwrapped = valueobj.get();
39</code>
40
41Unwraps a value and retrieve its contents.
42
43=== set(value) ===
44
45Syntax
46
47<code javascript>
48valueobj.set(somevalue);
49</code>
50
51Replaces the wrapped value with the given value. You can set any of the supported values, there's no restriction on the value being of the type set on at the time of instantiation.
diff --git a/intro.wiki b/intro.wiki
new file mode 100644
index 0000000..d8f77da
--- /dev/null
+++ b/intro.wiki
@@ -0,0 +1,23 @@
1====== Javascript Bindings for the Enlightenment Foundation Libraries (EFL) ======
2
3The EFL is a framework providing a great deal of functionality, from operating system abstraction to UI drawing abstractions and many others. The Javascript bindings for EFL are available in two flavors: A node.js module and direct embedding with libv8. Both are built on top of the libv8 JS engine.
4
5Below follows a list of the EFL modules covered by the javascript bindings. For node.js users, all are available through the module **efl**.
6
7<code javascript>
8var efl = require('efl');
9</code>
10
11 * [[api/javascript/ecore|Ecore]] - Operating system abstraction and integration.
12 * [[api/javascript/eet|Eet]] - Binary data parser and serializer.
13 * [[api/javascript/eeze|Eeze]] - Hardware device manipulation and notification.
14 * [[api/javascript/eio|Eio]] - Async input/output.
15 * [[api/javascript/eina|Eina]] - Data types and basic abstractions.
16 * [[api/javascript/eldbus|Eldbus]] - Dbus-integration.
17 * [[api/javascript/ethumb|Ethumb]] - Generate thumbnail images of files.
18
19===== Under the hood =====
20
21The Javascript binding is split into two big parts. The first is a //manual// binding, wich is described in this documentation. The //automatic// binding covers the Eo-based classes, built with automatically-generated code and will be covered later.
22
23Due to the C++ being the native language of the libv8, it's was also used to write the bindings, with the help of the C++ bindings for EFL.