]> git.sven.stormbind.net Git - sven/vym.git/blob - tex/commands.tex
Import Upstream version 2.6.11
[sven/vym.git] / tex / commands.tex
1 \item addBranch\\
2 \begin{tabular}{rl}
3   Selection: & Branch\\
4    Parameter: &  0:\\
5         Comment: & Index of new branch\\
6            Type: & Int\\
7        Optional: &  yes\\
8 \end{tabular}
9
10 \item addBranchBefore\\
11 \begin{tabular}{rl}
12   Selection: & Branch\\
13 \end{tabular}
14
15 \item addMapCenter\\
16 \begin{tabular}{rl}
17   Selection: & Any\\
18    Parameter: &  0:\\
19         Comment: & Position x\\
20            Type: & Double\\
21        Optional: &  No\\
22    Parameter: &  1:\\
23         Comment: & Position y\\
24            Type: & Double\\
25        Optional: &  No\\
26 \end{tabular}
27
28 \item addMapInsert\\
29 \begin{tabular}{rl}
30   Selection: & Any\\
31    Parameter: &  0:\\
32         Comment: & Filename of map to load\\
33            Type: & String\\
34        Optional: &  No\\
35    Parameter: &  1:\\
36         Comment: & Index where map is inserted\\
37            Type: & Int\\
38        Optional: &  yes\\
39    Parameter: &  2:\\
40         Comment: & Content filter\\
41            Type: & Int\\
42        Optional: &  yes\\
43 \end{tabular}
44
45 \item addMapReplace\\
46 \begin{tabular}{rl}
47   Selection: & Branch\\
48    Parameter: &  0:\\
49         Comment: & Filename of map to load\\
50            Type: & String\\
51        Optional: &  No\\
52 \end{tabular}
53
54 \item addSlide\\
55 \begin{tabular}{rl}
56   Selection: & Branch\\
57 \end{tabular}
58
59 \item addXLink\\
60 \begin{tabular}{rl}
61   Selection: & BranchLike\\
62    Parameter: &  0:\\
63         Comment: & Begin of XLink\\
64            Type: & String\\
65        Optional: &  No\\
66    Parameter: &  1:\\
67         Comment: & End of XLink\\
68            Type: & String\\
69        Optional: &  No\\
70    Parameter: &  2:\\
71         Comment: & Width of XLink\\
72            Type: & Int\\
73        Optional: &  yes\\
74    Parameter: &  3:\\
75         Comment: & Color of XLink\\
76            Type: & Color\\
77        Optional: &  yes\\
78    Parameter: &  4:\\
79         Comment: & Penstyle of XLink\\
80            Type: & String\\
81        Optional: &  yes\\
82 \end{tabular}
83
84 \item branchCount\\
85 \begin{tabular}{rl}
86   Selection: & BranchLike\\
87 \end{tabular}
88
89 \item centerOnID\\
90 \begin{tabular}{rl}
91   Selection: & Any\\
92    Parameter: &  0:\\
93         Comment: & UUID of object to center on\\
94            Type: & String\\
95        Optional: &  No\\
96 \end{tabular}
97
98 \item clearFlags\\
99 \begin{tabular}{rl}
100   Selection: & BranchLike\\
101 \end{tabular}
102
103 \item colorBranch\\
104 \begin{tabular}{rl}
105   Selection: & Branch\\
106    Parameter: &  0:\\
107         Comment: & New color\\
108            Type: & Color\\
109        Optional: &  yes\\
110 \end{tabular}
111
112 \item colorSubtree\\
113 \begin{tabular}{rl}
114   Selection: & Branch\\
115    Parameter: &  0:\\
116         Comment: & New color\\
117            Type: & Color\\
118        Optional: &  yes\\
119 \end{tabular}
120
121 \item copy\\
122 \begin{tabular}{rl}
123   Selection: & BranchOrImage\\
124 \end{tabular}
125
126 \item cut\\
127 \begin{tabular}{rl}
128   Selection: & BranchOrImage\\
129 \end{tabular}
130
131 \item cycleTask\\
132 \begin{tabular}{rl}
133   Selection: & BranchOrImage\\
134    Parameter: &  0:\\
135         Comment: & True, if cycling in reverse order\\
136            Type: & Bool\\
137        Optional: &  yes\\
138 \end{tabular}
139
140 \item delete\\
141 \begin{tabular}{rl}
142   Selection: & TreeItem\\
143 \end{tabular}
144
145 \item deleteChildren\\
146 \begin{tabular}{rl}
147   Selection: & Branch\\
148 \end{tabular}
149
150 \item deleteKeepChildren\\
151 \begin{tabular}{rl}
152   Selection: & Branch\\
153 \end{tabular}
154
155 \item deleteSlide\\
156 \begin{tabular}{rl}
157   Selection: & Any\\
158    Parameter: &  0:\\
159         Comment: & Index of slide to delete\\
160            Type: & Int\\
161        Optional: &  No\\
162 \end{tabular}
163
164 \item exportAO\\
165 \begin{tabular}{rl}
166   Selection: & Any\\
167    Parameter: &  0:\\
168         Comment: & Filename for export\\
169            Type: & String\\
170        Optional: &  No\\
171 \end{tabular}
172
173 \item exportASCII\\
174 \begin{tabular}{rl}
175   Selection: & Any\\
176    Parameter: &  0:\\
177         Comment: & Filename for export\\
178            Type: & String\\
179        Optional: &  No\\
180 \end{tabular}
181
182 \item exportHTML\\
183 \begin{tabular}{rl}
184   Selection: & Any\\
185    Parameter: &  0:\\
186         Comment: & Filename for export\\
187            Type: & String\\
188        Optional: &  No\\
189 \end{tabular}
190
191 \item exportImage\\
192 \begin{tabular}{rl}
193   Selection: & Any\\
194    Parameter: &  0:\\
195         Comment: & Filename for export\\
196            Type: & String\\
197        Optional: &  No\\
198    Parameter: &  1:\\
199         Comment: & Image format\\
200            Type: & String\\
201        Optional: &  yes\\
202 \end{tabular}
203
204 \item exportLaTeX\\
205 \begin{tabular}{rl}
206   Selection: & Any\\
207    Parameter: &  0:\\
208         Comment: & Filename for export\\
209            Type: & String\\
210        Optional: &  No\\
211 \end{tabular}
212
213 \item exportImpress\\
214 \begin{tabular}{rl}
215   Selection: & Any\\
216    Parameter: &  0:\\
217         Comment: & Filename for export\\
218            Type: & String\\
219        Optional: &  No\\
220    Parameter: &  1:\\
221         Comment: & Configuration file for export\\
222            Type: & String\\
223        Optional: &  No\\
224 \end{tabular}
225
226 \item exportPDF\\
227 \begin{tabular}{rl}
228   Selection: & Any\\
229    Parameter: &  0:\\
230         Comment: & Filename for export\\
231            Type: & String\\
232        Optional: &  No\\
233 \end{tabular}
234
235 \item exportPDF\\
236 \begin{tabular}{rl}
237   Selection: & Any\\
238    Parameter: &  0:\\
239         Comment: & Filename for export\\
240            Type: & String\\
241        Optional: &  No\\
242 \end{tabular}
243
244 \item exportSVG\\
245 \begin{tabular}{rl}
246   Selection: & Any\\
247    Parameter: &  0:\\
248         Comment: & Filename for export\\
249            Type: & String\\
250        Optional: &  No\\
251 \end{tabular}
252
253 \item exportXML\\
254 \begin{tabular}{rl}
255   Selection: & Any\\
256    Parameter: &  0:\\
257         Comment: & Filename for export\\
258            Type: & String\\
259        Optional: &  No\\
260 \end{tabular}
261
262 \item getDestPath\\
263 \begin{tabular}{rl}
264   Selection: & Any\\
265 \end{tabular}
266
267 \item getFileDir\\
268 \begin{tabular}{rl}
269   Selection: & Any\\
270 \end{tabular}
271
272 \item getFrameType\\
273 \begin{tabular}{rl}
274   Selection: & Branch\\
275 \end{tabular}
276
277 \item getHeading\\
278 \begin{tabular}{rl}
279   Selection: & TreeItem\\
280 \end{tabular}
281
282 \item getSelectString\\
283 \begin{tabular}{rl}
284   Selection: & TreeItem\\
285 \end{tabular}
286
287 \item getURL\\
288 \begin{tabular}{rl}
289   Selection: & TreeItem\\
290 \end{tabular}
291
292 \item getVymLink\\
293 \begin{tabular}{rl}
294   Selection: & Branch\\
295 \end{tabular}
296
297 \item getXLinkColor\\
298 \begin{tabular}{rl}
299   Selection: & XLinkItem\\
300 \end{tabular}
301
302 \item getXLinkWidth\\
303 \begin{tabular}{rl}
304   Selection: & XLinkItem\\
305 \end{tabular}
306
307 \item getXLinkPenStyle\\
308 \begin{tabular}{rl}
309   Selection: & XLinkItem\\
310 \end{tabular}
311
312 \item hasActiveFlag\\
313 \begin{tabular}{rl}
314   Selection: & TreeItem\\
315    Parameter: &  0:\\
316         Comment: & Name of flag\\
317            Type: & String\\
318        Optional: &  No\\
319 \end{tabular}
320
321 \item importDir\\
322 \begin{tabular}{rl}
323   Selection: & Branch\\
324    Parameter: &  0:\\
325         Comment: & Directory name to import\\
326            Type: & String\\
327        Optional: &  No\\
328 \end{tabular}
329
330 \item isScrolled\\
331 \begin{tabular}{rl}
332   Selection: & Branch\\
333 \end{tabular}
334
335 \item loadImage\\
336 \begin{tabular}{rl}
337   Selection: & Branch\\
338    Parameter: &  0:\\
339         Comment: & Filename of image\\
340            Type: & String\\
341        Optional: &  No\\
342 \end{tabular}
343
344 \item loadNote\\
345 \begin{tabular}{rl}
346   Selection: & Branch\\
347    Parameter: &  0:\\
348         Comment: & Filename of note\\
349            Type: & String\\
350        Optional: &  No\\
351 \end{tabular}
352
353 \item moveDown\\
354 \begin{tabular}{rl}
355   Selection: & Branch\\
356 \end{tabular}
357
358 \item moveUp\\
359 \begin{tabular}{rl}
360   Selection: & Branch\\
361 \end{tabular}
362
363 \item moveSlideDown\\
364 \begin{tabular}{rl}
365   Selection: & Any\\
366 \end{tabular}
367
368 \item moveSlideUp\\
369 \begin{tabular}{rl}
370   Selection: & Any\\
371 \end{tabular}
372
373 \item move\\
374 \begin{tabular}{rl}
375   Selection: & BranchOrImage\\
376    Parameter: &  0:\\
377         Comment: & Position x\\
378            Type: & Double\\
379        Optional: &  No\\
380    Parameter: &  1:\\
381         Comment: & Position y\\
382            Type: & Double\\
383        Optional: &  No\\
384 \end{tabular}
385
386 \item moveRel\\
387 \begin{tabular}{rl}
388   Selection: & BranchOrImage\\
389    Parameter: &  0:\\
390         Comment: & Position x\\
391            Type: & Double\\
392        Optional: &  No\\
393    Parameter: &  1:\\
394         Comment: & Position y\\
395            Type: & Double\\
396        Optional: &  No\\
397 \end{tabular}
398
399 \item nop\\
400 \begin{tabular}{rl}
401   Selection: & Any\\
402 \end{tabular}
403
404 \item note2URLs\\
405 \begin{tabular}{rl}
406   Selection: & Branch\\
407 \end{tabular}
408
409 \item paste\\
410 \begin{tabular}{rl}
411   Selection: & Branch\\
412 \end{tabular}
413
414 \item redo\\
415 \begin{tabular}{rl}
416   Selection: & Any\\
417 \end{tabular}
418
419 \item relinkTo\\
420 \begin{tabular}{rl}
421   Selection: & TreeItem\\
422    Parameter: &  0:\\
423         Comment: & Selection string of parent\\
424            Type: & String\\
425        Optional: &  No\\
426    Parameter: &  1:\\
427         Comment: & Index position\\
428            Type: & Int\\
429        Optional: &  No\\
430    Parameter: &  2:\\
431         Comment: & Position x\\
432            Type: & Double\\
433        Optional: &  yes\\
434    Parameter: &  3:\\
435         Comment: & Position y\\
436            Type: & Double\\
437        Optional: &  yes\\
438 \end{tabular}
439
440 \item saveImage\\
441 \begin{tabular}{rl}
442   Selection: & Image\\
443    Parameter: &  0:\\
444         Comment: & Filename of image to save\\
445            Type: & String\\
446        Optional: &  No\\
447    Parameter: &  1:\\
448         Comment: & Format of image to save\\
449            Type: & String\\
450        Optional: &  No\\
451 \end{tabular}
452
453 \item saveNote\\
454 \begin{tabular}{rl}
455   Selection: & Branch\\
456    Parameter: &  0:\\
457         Comment: & Filename of note to save\\
458            Type: & String\\
459        Optional: &  No\\
460 \end{tabular}
461
462 \item scroll\\
463 \begin{tabular}{rl}
464   Selection: & Branch\\
465 \end{tabular}
466
467 \item select\\
468 \begin{tabular}{rl}
469   Selection: & Any\\
470    Parameter: &  0:\\
471         Comment: & Selection string\\
472            Type: & String\\
473        Optional: &  No\\
474 \end{tabular}
475
476 \item selectID\\
477 \begin{tabular}{rl}
478   Selection: & Any\\
479    Parameter: &  0:\\
480         Comment: & Unique ID\\
481            Type: & String\\
482        Optional: &  No\\
483 \end{tabular}
484
485 \item selectLastBranch\\
486 \begin{tabular}{rl}
487   Selection: & Branch\\
488 \end{tabular}
489
490 \item selectLastImage\\
491 \begin{tabular}{rl}
492   Selection: & Branch\\
493 \end{tabular}
494
495 \item selectLatestAdded\\
496 \begin{tabular}{rl}
497   Selection: & Any\\
498 \end{tabular}
499
500 \item setFlag\\
501 \begin{tabular}{rl}
502   Selection: & TreeItem\\
503    Parameter: &  0:\\
504         Comment: & Name of flag\\
505            Type: & String\\
506        Optional: &  No\\
507 \end{tabular}
508
509 \item setTaskSleep\\
510 \begin{tabular}{rl}
511   Selection: & Branch\\
512    Parameter: &  0:\\
513         Comment: & Days to sleep\\
514            Type: & Int\\
515        Optional: &  No\\
516 \end{tabular}
517
518 \item setFrameIncludeChildren\\
519 \begin{tabular}{rl}
520   Selection: & BranchOrImage\\
521    Parameter: &  0:\\
522         Comment: & Include or don't include children in frame\\
523            Type: & Bool\\
524        Optional: &  No\\
525 \end{tabular}
526
527 \item setFrameType\\
528 \begin{tabular}{rl}
529   Selection: & BranchOrImage\\
530    Parameter: &  0:\\
531         Comment: & Type of frame\\
532            Type: & String\\
533        Optional: &  No\\
534 \end{tabular}
535
536 \item setFramePenColor\\
537 \begin{tabular}{rl}
538   Selection: & BranchOrImage\\
539    Parameter: &  0:\\
540         Comment: & Color of frame border line\\
541            Type: & Color\\
542        Optional: &  No\\
543 \end{tabular}
544
545 \item setFrameBrushColor\\
546 \begin{tabular}{rl}
547   Selection: & BranchOrImage\\
548    Parameter: &  0:\\
549         Comment: & Color of frame background\\
550            Type: & Color\\
551        Optional: &  No\\
552 \end{tabular}
553
554 \item setFramePadding\\
555 \begin{tabular}{rl}
556   Selection: & BranchOrImage\\
557    Parameter: &  0:\\
558         Comment: & Padding around frame\\
559            Type: & Int\\
560        Optional: &  No\\
561 \end{tabular}
562
563 \item setFrameBorderWidth\\
564 \begin{tabular}{rl}
565   Selection: & BranchOrImage\\
566    Parameter: &  0:\\
567         Comment: & Width of frame borderline\\
568            Type: & Int\\
569        Optional: &  No\\
570 \end{tabular}
571
572 \item setHeading\\
573 \begin{tabular}{rl}
574   Selection: & TreeItem\\
575    Parameter: &  0:\\
576         Comment: & New heading\\
577            Type: & String\\
578        Optional: &  No\\
579 \end{tabular}
580
581 \item setHideExport\\
582 \begin{tabular}{rl}
583   Selection: & BranchOrImage\\
584    Parameter: &  0:\\
585         Comment: & Set if item should be visible in export\\
586            Type: & Bool\\
587        Optional: &  No\\
588 \end{tabular}
589
590 \item setIncludeImagesHorizontally\\
591 \begin{tabular}{rl}
592   Selection: & Branch\\
593    Parameter: &  0:\\
594         Comment: & Set if images should be included horizontally in parent branch\\
595            Type: & Bool\\
596        Optional: &  No\\
597 \end{tabular}
598
599 \item setIncludeImagesVertically\\
600 \begin{tabular}{rl}
601   Selection: & Branch\\
602    Parameter: &  0:\\
603         Comment: & Set if images should be included vertically in parent branch\\
604            Type: & Bool\\
605        Optional: &  No\\
606 \end{tabular}
607
608 \item setHideLinksUnselected\\
609 \begin{tabular}{rl}
610   Selection: & BranchOrImage\\
611    Parameter: &  0:\\
612         Comment: & Set if links of items should be visible for unselected items\\
613            Type: & Bool\\
614        Optional: &  No\\
615 \end{tabular}
616
617 \item setMapAnimCurve\\
618 \begin{tabular}{rl}
619   Selection: & Any\\
620    Parameter: &  0:\\
621         Comment: & EasingCurve used in animation in MapEditor\\
622            Type: & Int\\
623        Optional: &  No\\
624 \end{tabular}
625
626 \item setMapAuthor\\
627 \begin{tabular}{rl}
628   Selection: & Any\\
629    Parameter: &  0:\\
630         Comment: & \\
631            Type: & String\\
632        Optional: &  No\\
633 \end{tabular}
634
635 \item setMapAnimDuration\\
636 \begin{tabular}{rl}
637   Selection: & Any\\
638    Parameter: &  0:\\
639         Comment: & Duration of animation in MapEditor in milliseconds\\
640            Type: & Int\\
641        Optional: &  No\\
642 \end{tabular}
643
644 \item setMapComment\\
645 \begin{tabular}{rl}
646   Selection: & Any\\
647    Parameter: &  0:\\
648         Comment: & \\
649            Type: & String\\
650        Optional: &  No\\
651 \end{tabular}
652
653 \item setMapBackgroundColor\\
654 \begin{tabular}{rl}
655   Selection: & Any\\
656    Parameter: &  0:\\
657         Comment: & Color of map background\\
658            Type: & Color\\
659        Optional: &  No\\
660 \end{tabular}
661
662 \item setMapDefLinkColor\\
663 \begin{tabular}{rl}
664   Selection: & Any\\
665    Parameter: &  0:\\
666         Comment: & Default color of links\\
667            Type: & Color\\
668        Optional: &  No\\
669 \end{tabular}
670
671 \item setMapLinkStyle\\
672 \begin{tabular}{rl}
673   Selection: & Any\\
674    Parameter: &  0:\\
675         Comment: & Link style in map\\
676            Type: & String\\
677        Optional: &  No\\
678 \end{tabular}
679
680 \item setMapRotation\\
681 \begin{tabular}{rl}
682   Selection: & Any\\
683    Parameter: &  0:\\
684         Comment: & Rotation of map\\
685            Type: & Double\\
686        Optional: &  No\\
687 \end{tabular}
688
689 \item setMapZoom\\
690 \begin{tabular}{rl}
691   Selection: & Any\\
692    Parameter: &  0:\\
693         Comment: & Zoomfactor of map\\
694            Type: & Double\\
695        Optional: &  No\\
696 \end{tabular}
697
698 \item setNote\\
699 \begin{tabular}{rl}
700   Selection: & Branch\\
701    Parameter: &  0:\\
702         Comment: & Note of branch\\
703            Type: & String\\
704        Optional: &  No\\
705 \end{tabular}
706
707 \item setScale\\
708 \begin{tabular}{rl}
709   Selection: & Image\\
710    Parameter: &  0:\\
711         Comment: & Scale image x\\
712            Type: & Double\\
713        Optional: &  No\\
714    Parameter: &  1:\\
715         Comment: & Scale image y\\
716            Type: & Double\\
717        Optional: &  No\\
718 \end{tabular}
719
720 \item setSelectionColor\\
721 \begin{tabular}{rl}
722   Selection: & Any\\
723    Parameter: &  0:\\
724         Comment: & Color of selection box\\
725            Type: & Color\\
726        Optional: &  No\\
727 \end{tabular}
728
729 \item setURL\\
730 \begin{tabular}{rl}
731   Selection: & TreeItem\\
732    Parameter: &  0:\\
733         Comment: & URL of TreeItem\\
734            Type: & String\\
735        Optional: &  No\\
736 \end{tabular}
737
738 \item setVymLink\\
739 \begin{tabular}{rl}
740   Selection: & Branch\\
741    Parameter: &  0:\\
742         Comment: & Vymlink of branch\\
743            Type: & String\\
744        Optional: &  No\\
745 \end{tabular}
746
747 \item sleep\\
748 \begin{tabular}{rl}
749   Selection: & Any\\
750    Parameter: &  0:\\
751         Comment: & Sleep (seconds)\\
752            Type: & Int\\
753        Optional: &  No\\
754 \end{tabular}
755
756 \item sortChildren\\
757 \begin{tabular}{rl}
758   Selection: & Branch\\
759    Parameter: &  0:\\
760         Comment: & Sort children of branch in revers order if set\\
761            Type: & Bool\\
762        Optional: &  yes\\
763 \end{tabular}
764
765 \item toggleFlag\\
766 \begin{tabular}{rl}
767   Selection: & Branch\\
768    Parameter: &  0:\\
769         Comment: & Name of flag to toggle\\
770            Type: & String\\
771        Optional: &  No\\
772 \end{tabular}
773
774 \item toggleFrameIncludeChildren\\
775 \begin{tabular}{rl}
776   Selection: & Branch\\
777 \end{tabular}
778
779 \item toggleScroll\\
780 \begin{tabular}{rl}
781   Selection: & Branch\\
782 \end{tabular}
783
784 \item toggleTarget\\
785 \begin{tabular}{rl}
786   Selection: & Branch\\
787 \end{tabular}
788
789 \item toggleTask\\
790 \begin{tabular}{rl}
791   Selection: & Branch\\
792 \end{tabular}
793
794 \item undo\\
795 \begin{tabular}{rl}
796   Selection: & Any\\
797 \end{tabular}
798
799 \item unscroll\\
800 \begin{tabular}{rl}
801   Selection: & Branch\\
802 \end{tabular}
803
804 \item unscrollChildren\\
805 \begin{tabular}{rl}
806   Selection: & Branch\\
807 \end{tabular}
808
809 \item unsetFlag\\
810 \begin{tabular}{rl}
811   Selection: & Branch\\
812    Parameter: &  0:\\
813         Comment: & Name of flag to unset\\
814            Type: & String\\
815        Optional: &  No\\
816 \end{tabular}
817