summaryrefslogtreecommitdiffstats
path: root/koffice-i18n-sv/docs/koffice/chalk/developers-scripting.docbook
blob: 0dd76de1d5b6cdad9870607f9466902441d49af2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
<sect1 id="developers-scripting">
<title
>Använda skript</title>

<para
>I &chalk; kan du skriva skript med Ruby eller Python (tillgängligheten för tolkarna kan bero på vad din distribution eller administratören av din dator installerade). Här hittar du en beskrivning av programmeringsgränssnittet för skript. </para
><para
>Vissa exempel levereras med &chalk;, och du kan hitta dem i <filename
>/usr/share/apps/chalk/scripts</filename
> (eller <filename
>/opt/kde/share/apps/chalk/scripts</filename
>). </para>

<sect2 id="developers-scripting-variables">
<title
>Variabler i modulen <classname
>Krosschalkcore</classname
></title>

<itemizedlist>
<listitem
><para
><varname
>ChalkDocument</varname
> returnerar ett <classname
>Document</classname
>-objekt</para
></listitem>
<listitem
><para
><varname
>ChalkScript</varname
> returnerar ett <classname
>ScriptProgress</classname
>-objekt</para
></listitem>
</itemizedlist>

<para
>Du kan hämta ett objekt med funktionen <function
>get</function
> i modulen <classname
>Krosschalkcore</classname
>. I Ruby måste du skriva något som liknar det här: <programlisting
>doc = Krosschalkcore::get("ChalkDocument")
script = Krosschalkcore::get("ChalkScript")
</programlisting>
</para>

</sect2>

<sect2 id="developers-scripting-functions">
<title
>Funktioner i modulen <classname
>Krosschalkcore</classname
></title>

<itemizedlist>
<listitem
><para
>Funktion: <function
>getBrush</function
></para
><para
>Funktionen returnerar en pensel (<classname
>Brush</classname
>) som tas från listan med &chalk;s resurser. Den har ett argument: penselns namn. Till exempel (i Ruby): <programlisting
>Krosschalkcore::getBrush("Circle (05)")
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>getFilter</function
></para
><para
>Funktionen returnerar ett filter (<classname
>Filter</classname
>) som tas från listan med &chalk;s resurser. Den har ett argument: filtrets namn. Till exempel (i Ruby): <programlisting
>Krosschalkcore::getFilter("invert")
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>getPattern</function
></para
><para
>Funktionen returnerar ett mönster (<classname
>Pattern</classname
>) som tas från listan med &chalk;s resurser. Den har ett argument: mönstrets namn. Till exempel (i Ruby): <programlisting
>Krosschalkcore::getPattern("Bricks")
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>loadBrush</function
></para
><para
>Funktionen laddar en pensel (<classname
>Brush</classname
>) och returnerar den därefter. Den har ett argument: penselns filnamn.</para
></listitem>

<listitem
><para
>Funktion: <function
>loadPattern</function
></para
><para
>Funktionen laddar ett mönster (<classname
>Pattern</classname
>) och returnerar det därefter. Den har ett argument: mönstrets filnamn.</para
></listitem>

<listitem
><para
>Funktion: <function
>newCircleBrush</function
></para
><para
>Funktionen returnerar en pensel (<classname
>Brush</classname
>) med en cirkulär form. Den har minst två argument: bredd och höjd. Den kan också ha två ytterligare argument: skuggans bredd och höjd. Om skuggan inte anges, används ingen. Till exempel (i Ruby): <programlisting
>Krosschalkcore::newCircleBrush(10,20) # skapa en enkel cirkel
Krosschalkcore::newCircleBrush(10,20,5,10) # skapa en toning
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>newHSVColor</function
></para
><para
>Funktionen returnerar en ny färg (<classname
>Color</classname
>) med den angivna HSV-trippeln. Den har tre argument: färgtonskomponenten (0 till 255), färgmättnadskomponenten (0 till 255), och värdekomponenten (0 till 255). Till exempel (i Ruby): <programlisting
>Krosschalkcore::newHSVColor(255,125,0)
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>newImage</function
></para
><para
>Funktionen returnerar en ny bild (<classname
>Image</classname
>). Den har fyra argument: bredd, höjd, färgrymdsidentifikation, bildens namn. Den returnerar objektet <classname
>Image</classname
>. Till exempel (i Ruby): <programlisting
>Krosschalkcore::newImage(10,20, "RGBA", "kikoo")
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>newRectBrush</function
></para
><para
>Funktionen returnerar en pensel (<classname
>Brush</classname
>) med en rektangulär form. Den har minst två argument: bredd och höjd. Den kan också ha två ytterligare argument: skuggans bredd och höjd. Om skuggan inte anges, används ingen. Till exempel (i Ruby): <programlisting
>Krosschalkcore::newRectBrush(10,20) # skapa en enkel rektangel
 Krosschalkcore::newRectBrush(10,20,5,10) # skapa en toning
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>newRGBColor</function
></para
><para
>Funktionen returnerar en ny färg (<classname
>Color</classname
>) med den angivna RGB-trippeln. Den har tre argument: den röda komponenten (0 till 255), den blåa komponenten (0 till 255), och den gröna komponenten (0 till 255). Till exempel (i Ruby): <programlisting
>Krosschalkcore::newRGBColor(255,0,0) # skapa en röd färg
Krosschalkcore::newRGBColor(255,255,255) # skapa en vit färg
</programlisting
></para
></listitem>
</itemizedlist>
</sect2>

<sect2 id="developers-scripting-objects">
<title
>Beskrivningar och funktionslista för diverse objekt i <classname
>Krosschalkcore</classname
></title>

<itemizedlist>
<listitem
><para
>Objekt: PaintLayer</para>

<itemizedlist>
<listitem
><para
>Funktion: <function
>beginPainting</function
></para
></listitem>

<listitem
><para
>Funktion: <function
>convertToColorspace</function
></para
><para
>Konvertera bilden till en färgrymd. Funktionen har ett argument: namnet på den resulterande färgrymden. Till exempel (i Ruby): <programlisting
>image.convertToColorspace("CMYK")
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>createHistogram</function
></para
><para
>Funktionen skapar ett histogram för lagret. Den har två argument: histogramtypen ("RGB8HISTO"), och 0 om histogrammet är linjärt eller 1 om det är logatimiskt.</para
></listitem>

<listitem
><para
>Funktion: <function
>createHLineIterator</function
></para
><para
>Skapa en iterator för ett lager, som går igenom en rad. Funktionen har tre argument: <varname
>x</varname
> (start i raden), <varname
>y</varname
> (radens vertikala position), radens bredd.</para
></listitem>

<listitem
><para
>Funktion: <function
>createPainter</function
></para
><para
>Funktionen skapar ett målningsobjekt (<classname
>Painter</classname
>) som låter dig måla på lagret. </para
></listitem>

<listitem
><para
>Funktion: <function
>createRectIterator</function
></para
><para
>Skapa en iterator för ett lager, som går igenom ett rektangulärt område. Funktionen har fyra argument: <varname
>x</varname
>, <varname
>y</varname
>, rektangelns bredd, rektangelns höjd.</para
></listitem>

<listitem
><para
>Funktion: <function
>createVLineIterator</function
></para
><para
>Skapa en iterator för ett lager, som går igenom en kolumn. Funktionen har tre argument: <varname
>x</varname
> (kolumnens horisontella position), <varname
>y</varname
> (start i kolumnen), kolumnens höjd.</para
></listitem>

<listitem
><para
>Funktion: <function
>endPainting</function
></para
><para
>Funktionen stänger aktuell ångringspost och lägger till den i historiken.</para
></listitem>

<listitem
><para
>Funktion: <function
>fastWaveletTransformation</function
></para
><para
>Returnerar lagrets snabba wavelet-transform.</para
></listitem>

<listitem
><para
>Funktion: <function
>fastWaveletUntransformation</function
></para
><para
>Gör omvänd transform av en snabb wavelet till lagret. Den har ett argument: ett wavelet-objekt. Till exempel (i Ruby): <programlisting
>wavelet = layer.fastWaveletTransformation()
layer.fastWaveletUntransformation(wavelet)
</programlisting
></para
></listitem>

<listitem
><para
>Funktion: <function
>getHeight</function
></para
><para
>Returnera lagrets höjd.</para
></listitem>

<listitem
><para
>Funktion: <function
>getWidth</function
></para
><para
>Returnera lagrets bredd.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objekt: <classname
>Filter</classname
></para>
<itemizedlist>

<listitem
><para
>Funktion: <function
>getFilterConfiguration</function
></para
><para
>Funktionen returnerar filterinställningen (<classname
>FilterConfiguration</classname
>) som hör ihop med filtret.</para
></listitem>

<listitem
><para
>Funktion: <function
>process</function
></para
><para
>Funktionen utför filtret. Den har minst ett argument: lagret som är källan. Du kan också använda fyra följande argument: <varname
>x</varname
>, <varname
>y</varname
>, <varname
>bredd</varname
>, <varname
>höjd</varname
>. (<varname
>x</varname
>, <varname
>y</varname
>, <varname
>bredd</varname
>,<varname
>höjd</varname
>) definierar den rektangulära område där filtret beräknas. Om rektangeln inte är definierad, används filtret på hela lagret. Till exempel (i Ruby) <programlisting
>doc = Krosschalkcore::get("ChalkDocument")
image = doc.getImage()
layer = image.getActivePaintLayer()
width = layer.getWidth()
height = layer.getHeight()
filter = Krosschalkcore::getFilter("invert")
filter.process(layer, layer)
filter.process(layer, layer, 10, 10, 20, 20 )
</programlisting
></para
></listitem>
</itemizedlist
></listitem>

<listitem
><para
>Objekt: <classname
>FilterConfiguration</classname
></para>
<itemizedlist>

<listitem
><para
>Funktion: <function
>getProperty</function
></para
><para
>Funktionen returnerar en parameters värde för tillhörande filter (<classname
>Filter</classname
>). Den har ett argument: parameterns namn.</para
></listitem>

<listitem
><para
>Funktion: <function
>setProperty</function
></para
><para
>Funktionen definierar en parameter för tillhörande filter (<classname
>Filter</classname
>). Den har två argument: parameterns namn och värde, vars typ beror på filtret.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objekt: <classname
>Histogram</classname
></para>

<para
>Klassen låter dig komma åt histogrammet för ett målningslager (<classname
>PaintLayer</classname
>). Exempel (i Ruby): <programlisting
>doc = krosschalkcore::get("ChalkDocument")
 image = doc.getImage()
 layer = image.getActiveLayer()
 histo = layer.createHistogram("RGB8HISTO",0)
 min = layer.getMin() * 255
 max = layer.getMax() * 255
 for i in min..max
   print layer.getValue(i)
   print "\n"
 end
</programlisting>
</para>

<itemizedlist>
<listitem
><para
>Funktion: <function
>getChannel</function
></para
><para
>Returnera den valda kanalen.</para
></listitem>

<listitem
><para
>Funktion: <function
>getCount</function
></para
><para
>Funktionen returnerar antal bildpunkter som används av histogrammet.</para
></listitem>

<listitem
><para
>Funktion: <function
>getHighest</function
></para
><para
>Funktionen returnerar histogrammets största värde.</para
></listitem>

<listitem
><para
>Funktion: <function
>getLowest</function
></para
><para
>Funktionen returnerar histogrammets minsta värde.</para
></listitem>

<listitem
><para
>Funktion: <function
>getMax</function
></para
><para
>Funktionen returnerar histogrammets maximala gränsvärde (värden på större avstånd än maximala värdet är noll). Värdet är i intervallet 0.0 &ndash; 1.0.</para
></listitem>

<listitem
><para
>Funktion: <function
>getMean</function
></para
><para
>Den här funktionen returnerar histogrammets medelvärde.</para
></listitem>

<listitem
><para
>Funktion: <function
>getMin</function
></para
><para
>Funktionen returnerar histogrammets minimala gränsvärde (värden på mindre avstånd än minimala värdet är noll). Värdet är i intervallet 0.0 &ndash; 1.0.</para
></listitem>

<listitem
><para
>Funktion: <function
>getNumberOfBins</function
></para
><para
>Returnerar antal staplar i histogrammet. </para
></listitem>

<listitem
><para
>Funktion: <function
>getTotal</function
></para
><para
>Den här funktionen returnerar summan av alla värden i histogrammet.</para
></listitem>

<listitem
><para
>Funktion: <function
>getValue</function
></para
><para
>Returnerar värdet för en stapel i histogrammet. Funktionen har ett argument: indexet i intervallet [0..255].</para
></listitem>

<listitem
><para
>Funktion: <function
>setChannel</function
></para
><para
>Välj kanal i lagret som resultatet i histogrammet ska hämtas från. Funktionen har ett argument: kanalnumret.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objekt: <classname
>ScriptProgress</classname
></para>
<para
><classname
>ScriptProgress</classname
> används för att hantera förloppsraden i &chalk;s statusrad. Till exempel (i Ruby): <programlisting
>script = Krosschalkcore::get("ChalkScript")
script.setProgressTotalSteps(1000)
script.setProgressStage("progressive", 0)
for i in 1..900
  script.incProgress()
end
script.setProgressStage("brutal", 1000)
</programlisting
></para>

<itemizedlist>
<listitem
><para
>Funktion: <function
>incProgress</function
></para
><para
>Den här funktionen ökar förloppsindikeringen med ett steg.</para
></listitem>

<listitem
><para
>Funktion: <function
>setProgress</function
></para
><para
>Den här funktionen ställer in förloppsindikeringens värde. Den har ett argument: förloppsindikeringens värde.</para
></listitem>

<listitem
><para
>Funktion: <function
>setProgressStage</function
></para
><para
>Den här funktionen ställer in förloppsindikeringens värde och visar texten.</para
></listitem>

<listitem
><para
>Funktion: <function
>setProgressTotalSteps</function
></para
><para
>Funktionen ställer in antal steg som skriptet kommer att behöva. Den har ett argument: det maximala värdet hos förloppsindikeringen</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objekt: <classname
>Wavelet</classname
></para
><para
>Objektet innehåller koefficienterna för en wavelet-transform av ett målningslager (<classname
>PaintLayer</classname
>).</para>
<itemizedlist>

<listitem
><para
>Funktion: <function
>getDepth</function
></para
><para
>Returnerar lagrets djup.</para
></listitem>

<listitem
><para
>Funktion: <function
>getNCoeff</function
></para
><para
>Returnerar värdet på den N:e koefficienten. Funktionen har ett argument: koefficientens index.</para
></listitem>

<listitem
><para
>Funktion: <function
>getNumCoeffs</function
></para
><para
>Returnerar antal koefficienter i denna wavelet-transform (= storlek * storlek * djup).</para
></listitem>

<listitem
><para
>Funktion: <function
>getSize</function
></para
><para
>Returnerar wavelet-transformens storlek (storlek = bredd * höjd).</para
></listitem>

<listitem
><para
>Funktion: <function
>getXYCoeff</function
></para
><para
>Returnerar en koefficients värde. Funktionen har två argument: <varname
>x</varname
> och <varname
>y</varname
>.</para
></listitem>

<listitem
><para
>Funktion: <function
>setNCoeff</function
></para
><para
>Ställer in värdet för den N:e koefficienten. Funktionen har två argument: koefficientens index och koefficientens nya värde.</para
></listitem>

<listitem
><para
>Funktion: <function
>setXYCoeff</function
></para
><para
>Ställer in värdet för en koefficient. Funktionen har tre argument: <varname
>x</varname
>, <varname
>y</varname
> ochkoefficientens nya värde.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objekt: <classname
>Painter</classname
></para>
<itemizedlist>

<listitem
><para
>Funktion: <function
>convolve</function
></para
><para
>Funktionen använder en faltningskärna på en bild. Den har minst tre argument: en lista av listor med kärnan (alla listor måste ha samma storlek), faktor och förskjutning. </para
><para
>Värdet av en bildpunkt anges av följande funktion: K * P / faktor + förskjutning, där K är kärnan och P är grannskapet. </para
><para
>Den kan ha följande valfria argument: <varname
>kantoperation</varname
> (styr hur bildpunkterna i kanten på en bild ska faltas: 0 = använd förvald färg, 1 = använd bildpunkten på bildens motsatta sida, 2 = använd kantens bildpunkt, 3 = undvik bildpunkter vid kanten), <varname
>kanal</varname
> (1 för färg, 2 för alfa, 3 för båda), <varname
>x</varname
>, <varname
>y</varname
>, <varname
>bredd</varname
>, <varname
>höjd</varname
>.</para
></listitem>

<listitem
><para
>Funktion: <function
>setFillThreshold</function
></para
><para
>Ställer in fylltröskeln. Den har ett argument: tröskeln.</para
></listitem>

<listitem
><para
>Funktion: <function
>fillColor</function
></para
><para
>Börja fylla med en färg. Den har två argument: <varname
>x</varname
> och <varname
>y</varname
>.</para
></listitem>

<listitem
><para
>Funktion: <function
>fillPattern</function
></para
><para
>Börja fylla med ett mönster. Den har två argument: <varname
>x</varname
> och <varname
>y</varname
>.</para
></listitem>

<listitem
><para
>Funktion: <function
>paintPolyline</function
></para
><para
>Funktionen ritar en flerlinje. Den har två argument: en lista med x-positioner och en lista med y-positioner.</para
></listitem>

<listitem
><para
>Funktion: <function
>paintLine</function
></para
><para
>Funktionen ritar en linje. Den har fem argument: <varname
>x1</varname
>, <varname
>y1</varname
>, <varname
>x2</varname
>, <varname
>y2</varname
>, and <varname
>tryck</varname
>. </para
></listitem>

<listitem
><para
>Funktion: <function
>paintBezierCurve</function
></para
><para
>Funktion ritar en Bezier-kurva. Den har tio argument: <varname
>x1</varname
>, <varname
>y1</varname
>, <varname
>p1</varname
>, <varname
>cx1</varname
>, <varname
>cy1</varname
>, <varname
>cx2</varname
>, <varname
>cx2</varname
>, <varname
>x2</varname
>, <varname
>y2</varname
>, <varname
>p2</varname
>, där (<varname
>x1</varname
>,<varname
>y1</varname
>) är startpositionen, <varname
>p1</varname
> är trycket vid start, (<varname
>x2</varname
>,<varname
>y2</varname
>) är slutpositionen, <varname
>p2</varname
> är trycket vid slutet. (<varname
>cx1</varname
>,<varname
>cy1</varname
>) och (<varname
>cx2</varname
>,<varname
>cy2</varname
>) är positionerna för styrpunkterna.</para
></listitem>

<listitem
><para
>Funktion: <function
>paintEllipse</function
></para
><para
>Funktion ritar en ellips. Den har fem argument: <varname
>x1</varname
>, <varname
>y1</varname
>, <varname
>x2</varname
>, <varname
>y2</varname
>, <varname
>tryck</varname
>, där (<varname
>x1</varname
>,<varname
>y1</varname
>) och (<varname
>x2</varname
>,<varname
>y2</varname
>) är positionerna för de två centra.</para
></listitem>

<listitem
><para
>Funktion: <function
>paintPolygon</function
></para
><para
>Funktionen ritar en polygon. Den har två argument: en lista med x-positioner och en lista med y-positioner.</para
></listitem>

<listitem
><para
>Funktion: <function
>paintRect</function
></para
><para
>Funktionen ritar en rektangel. Den har fem argument: <varname
>x</varname
>, <varname
>y</varname
>, <varname
>bredd</varname
> <varname
>höjd</varname
>, <varname
>tryck</varname
>.</para
></listitem>

<listitem
><para
>Funktion: <function
>paintAt</function
></para
><para
>Funktionen målar en given position. Den har tre argument: <varname
>x</varname
>, <varname
>y</varname
>, <varname
>tryck</varname
>.</para
></listitem>

<listitem
><para
>Funktion: <function
>setPaintColor</function
></para
><para
>Funktionen ställer in målarfärgen (också kallad förgrundsfärgen). Den har ett argument: en färg (<classname
>Color</classname
>).</para
></listitem>

<listitem
><para
>Funktion: <function
>setBackgroundColor</function
></para
><para
>Funktionen ställer in bakgrundsfärgen. Den har ett argument: en färg (<classname
>Color</classname
>).</para
></listitem>

<listitem
><para
>Funktion: <function
>setPattern</function
></para
><para
>Funktionen ställer in mönstret som används att fylla med. Den har ett argument: ett mönsterobjekt (<classname
>Pattern</classname
>).</para
></listitem>

<listitem
><para
>Funktion: <function
>setBrush</function
></para
><para
>Funktionen ställer in penseln som används att måla med. Den har ett argument: ett penselobjekt (<classname
>Brush</classname
>).</para
></listitem>

<listitem
><para
>Funktion: <function
>setPaintOp</function
></para
><para
>Funktionen definierar en målningsoperation. Den har ett argument: målningsoperationens namn.</para
></listitem>

<listitem
><para
>Funktion: <function
>setDuplicateOffset</function
></para
><para
>Funktionen definierar duplikatets förskjutning. Den har två argument: horisontell förskjutning och vertikal förskjutning.</para
></listitem>

<listitem
><para
>Funktion: <function
>setOpacity</function
></para
><para
>Funktionen ställer in målningens ogenomskinlighet. Den har ett argument: ogenomskinligheten i intervallet 0 till 255.</para
></listitem>

<listitem
><para
>Funktion: <function
>setStrokeStyle</function
></para
><para
>Funktionen ställer in streckets stil. Den har ett argument: 0 för inget, eller 1 för pensel.</para
></listitem>

<listitem
><para
>Funktion: <function
>setFillStyle</function
></para
><para
>Funktionen ställer in fyllstilen för målningsobjektet (<classname
>Painter</classname
>). Den har ett argument: 0 för ingen, 1 för fyll med förgrundsfärg, 2 för fyll med bakgrundsfärg, 3 för fyll med mönster.</para
></listitem>
</itemizedlist>
</listitem>

<listitem
><para
>Objekt: <classname
>Iterator</classname
></para
><para
>Objektet låter dig ändra bildpunktsvärden ett i taget. Namnet på vissa funktioner beror på färgrymden, om lagrets färgrymd till exempel är RGB, finns <function
>setR</function
>, <function
>setG</function
> och <function
>setB</function
>, och för CMYK, <function
>setC</function
>, <function
>setM</function
>, <function
>setY</function
> och <function
>setK</function
>. I dokumentationen antar vi att färgrymden kallas ABC, med tre kanaler: A, B, C.</para>

<itemizedlist>
<listitem
><para
>Funktioner: <function
>setA</function
>, <function
>setB</function
>, <function
>setC</function
></para
><para
>Dessa funktioner har ett argument: det nya värdet för en av bildpunktens kanaler.</para
></listitem>

<listitem
><para
>Funktion: <function
>setABC</function
></para
><para
>Ställer in alla kanalers värde. Funktionen har ett argument: ett fält med de nya värdena för alla kanaler.</para
></listitem>

<listitem
><para
>Funktioner: <function
>getA</function
>, <function
>getB</function
>, <function
>getC</function
></para
><para
>Returnera värdet för en av kanalerna i den här bildpunkten.</para
></listitem>

<listitem
><para
>Funktion: <function
>getABC</function
></para
><para
>Returnera ett fält med alla kanalers värden.</para
></listitem>

<listitem
><para
>Funktion: <function
>darken</function
></para
><para
>Gör en bildpunkt mörkare. Funktionen har minst ett argument: <varname
>skugga</varname
> (värdet som används för att göra alla färgkanaler mörkare). Funktionen kan ha följande valfria argument: <varname
>kompensation</varname
> (för att begränsa mörknandet).</para
></listitem>

<listitem
><para
>Funktion: <function
>invertColor</function
></para
><para
>Invertera färgen för en bildpunkt.</para
></listitem>

<listitem
><para
>Funktion: <function
>next</function
></para
><para
>Öka positionen, och gå till nästa bildpunkt.</para
></listitem>

<listitem
><para
>Funktion: <function
>isDone</function
></para
><para
>Returnera sant om iteratorn är i slutet (inga fler bildpunkter är tillgängliga).</para
></listitem>
</itemizedlist>
</listitem>
</itemizedlist>

</sect2>

<sect2 id="developers-scripting-resources">
<title
>Resurser</title>

<para
>Här är tips eller partiella listor med resurser för &chalk;. </para
><para
>För pensel (<classname
>Brush</classname
>) och mönster (<classname
>Pattern</classname
>): Du kan hämta namn och tillhörande pensel eller mönster från markeringsverktyget i &chalk;s verktygsrad. </para
><para
>En lista med identifierare av färgrymder i &chalk;: LABA, RGBA, RGBA16, RGBAF32, RGBAF16HALF, LMSAF32, GRAYA, GRAYA16, CMYK, CMYKA16. </para>
</sect2>

</sect1>