
KC8 slideShow API
=================


Functions:
==========

setSlides ( slides [, loopSlide [, callouts & clicks [, textformat ]]] )
-----------------------------------------------------------------------
- slides is an array of slides that make up the slideshow.
- loopSlide is the zero based slide to loop to when the end is reached; -1 means no loop
- callouts & clicks is an array of callouts and clickable areas.
- textformat is the base textformat to be used for callouts.


Each slide is an array containing the parameters for that particular slide. 

slide = [ transition id, transition time, image / symbol library link name,
          image time, scale mode, slide bg color, effects, sound link name,
          callouts & clicks indices, callouts transition ]

transition id :
defines the transition to be used for a slide.
for possible values see the transition_id_table_splitted.txt file

transition time :
the time in seconds a transition takes

image / symbol library link name :
the filename of the image or link name in case an image embedded in the symbol library is used.
Link names are not allowed to contain a dot (.) because the dot is used to determine if a filename
or link name is specified.

image time :
the time an image stays fully visible (after the transition has been completed)

scale mode :
0 = scale to fit
1 = scale and crop
2 = crop

slide bg color :
the background color of a slide in case the image doesn't cover the whole slide

effects :
1 = lined (cpu intensive)
2 = sepia
4 = b/w
8 = channel build
effects can be combined by adding values together except sepia and b/w but be careful with combining because of the increase in cpu load.

sound link name :
the link name of the sound in the symbol library used for the transition. External sound files are not supported.
Link names are not allowed to contain a dot (.) because it is reserved to specify a sound loop. For example
'mySound.3' will use the sound with link name 'mySound' and play it three times.
A sound stops playing when a transition ends.

callouts & clicks indices :
array containing the array index numbers of the callouts and clickable area array to be used.
[0,2] will use callout / clicks nr 0 and 2 of the callouts & clicks array.

callouts transition :
0 = fade in/out
1 = from/to top
2 = from/to right
3 = from/to bottom
4 = from/to left
all callouts on a slide come in at the same time just after a transition and go out just before the next one.


Each callout or clickable area is an object containing the parameters for that particular callout or clickable area. 

callout / click = { x:x, y:y, w:width, h:height, text:text, link:link, cradius:corner radius,
                    line:line color, fill:base fill color }

x: horizontal position of callout or clickable area
y: vertical position of callout or clickable area
w: width of the callout or clickable area
h: height of the callout or clickable area
text [optional]: text of the callout.
link [optional]: link to go to when callout or clickable area is clicked. can be a slide, e-mail address or external website.
cradius [optional]: radius of the corners of a callout; 0 means squared, 6 (default) results in rounded corners
line [optional]: line color of the callout
fill [optional]: base fill color of the callout



gotoSlide( slide )
------------------
Slide can be a slide number, 'first','last','previous' or 'next'.


setMode( mode )
---------------
Mode can be
0 = auto play
1 = manual navigation



Properties:
===========

_currentslide
-------------
_currentslide [read-only] returns the zero based number of the slide currently displayed.


_totalslides
------------
_totalslides [read-only] returns the total amount of slides set for the slideshow.



Events:
=======

onEnd
-----
Event occuring when the end of the slideshow is reached and loop is set to 'no loop'.


onLoop
------
Event occuring when the end of the slideshow is reached and loop is set to a specific slide.


onTransitStart
--------------
Event occuring just before a slide transition takes place.


onTransitComplete
-----------------
Event occuring just after a slide transition takes place.



Remarks & known limitations :
=============================

- The minimum size of the component is 50 x 50 pixels (navigation control turned off) or 125 x 50 pixels (navigation control turned on).
- Borders are two pixels on each side, navigation is 19 pixels in height.
