slideshow2
Table of Contents
Classes
- cycle
- Plugin option handling class
Functions
- printSlideShowLink() : mixed
- Prints a link to call the slideshow (not shown if there are no images in the album) To be used on album.php and image.php A CSS id names 'slideshowlink' is attached to the link so it can be directly styled.
- printSlideShow() : mixed
- Prints the slideshow using the {@link http://http://www.malsup.com/jquery/cycle2/ jQuery plugin Cycle2 }
Functions
printSlideShowLink()
Prints a link to call the slideshow (not shown if there are no images in the album) To be used on album.php and image.php A CSS id names 'slideshowlink' is attached to the link so it can be directly styled.
printSlideShowLink([string $linktext = NULL ][, string $linkstyle = Null ]) : mixed
If the mode is set to "jQuery Colorbox" and the Colorbox plugin is enabled this link starts a Colorbox slideshow from a hidden HTML list of all images in the album. On album.php it starts with the first always, on image.php with the current image.
Parameters
- $linktext : string = NULL
-
Text for the link
- $linkstyle : string = Null
-
Style of Text for the link
Tags
printSlideShow()
Prints the slideshow using the {@link http://http://www.malsup.com/jquery/cycle2/ jQuery plugin Cycle2 }
printSlideShow([bool $heading = true ][, bool $speedctl = false ][, obj $albumobj = NULL ][, obj $imageobj = NULL ][, int $width = NULL ][, int $height = NULL ][, bool $crop = false ][, bool $shuffle = false ][, bool $linkslides = false ][, bool $controls = true ]) : mixed
Two ways to use: a) Use on your theme's slideshow.php page and called via printSlideShowLink(): If called from image.php it starts with that image, called from album.php it starts with the first image (jQuery only) To be used on slideshow.php only and called from album.php or image.php.
b) Calling directly via printSlideShow() function (jQuery mode) Place the printSlideShow() function where you want the slideshow to appear and set create an album object for $albumobj and if needed an image object for $imageobj. The controls are disabled automatically.
NOTE: The jQuery mode does not support movie and audio files anymore. If you need to show them please use the Flash mode. Also note that this function is not used for the Colorbox mode!
Parameters
- $heading : bool = true
-
set to true (default) to emit the slideshow breadcrumbs in flash mode
- $speedctl : bool = false
-
controls whether an option box for controlling transition speed is displayed
- $albumobj : obj = NULL
-
The object of the album to show the slideshow of. If set this overrides the POST data of the printSlideShowLink()
- $imageobj : obj = NULL
-
The object of the image to start the slideshow with. If set this overrides the POST data of the printSlideShowLink(). If not set the slideshow starts with the first image of the album.
- $width : int = NULL
-
The width of the images (jQuery mode). If set this overrides the size the slideshow_width plugin option that otherwise is used.
- $height : int = NULL
-
The heigth of the images (jQuery mode). If set this overrides the size the slideshow_height plugin option that otherwise is used.
- $crop : bool = false
-
Set to true if you want images cropped width x height (jQuery mode only)
- $shuffle : bool = false
-
Set to true if you want random (shuffled) order
- $linkslides : bool = false
-
Set to true if you want the slides to be linked to their image pages (jQuery mode only)
- $controls : bool = true
-
Set to true (default) if you want the slideshow controls to be shown (might require theme CSS changes if calling outside the slideshow.php page) (jQuery mode only)