[ class tree: plugins ] [ index: plugins ] [ all elements ]

Procedural File: slideshow.php

Source Location: /plugins/slideshow.php

Page Details

slideshow -- Supports showing slideshows of images in an album.

Plugin Option 'slideshow_size' -- Size of the images Plugin Option 'slideshow_mode' -- The player to be used Plugin Option 'slideshow_effect' -- The cycle effect Plugin Option 'slideshow_speed' -- How fast it runs Plugin Option 'slideshow_timeout' -- Transition time Plugin Option 'slideshow_showdesc' -- Allows the show to display image descriptons

The theme files 'slideshow.php', 'slideshow.css', and 'slideshow-controls.png' must reside in the theme folder. If you are creating a custom theme, copy these files form the "default" theme of the Zenphoto distribution.

NOTE: The jQuery mode does not support movie and audio files anymore. If you need to show them please use the Flash mode.

Author:  Malte Müller (acrylian), Stephen Billard (sbillard), Don Peterson (dpeterson)
Version:  1.0.6.4
Classes
Class Description
slideshowOptions Plugin option handling class
Functions
printSlideShow  [line 146]

Prints the slideshow using the jQuery plugin Cycle (http://http://www.malsup.com/jquery/cycle/) or Flash based using Flowplayer http://flowplayer.org if installed 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.

Image size is taken from the calling link or if not specified there the sized image size from the options

NOTE: The jQuery mode does not support movie and audio files anymore. If you need to show them please use the Flash mode.

Parameters:
bool   $heading:  set to true (default) to emit the slideshow breadcrumbs in flash mode
bool   $speedctl:  controls whether an option box for controlling transition speed is displayed


void printSlideShow( [bool $heading = true], [bool $speedctl = false]  )

[ Top ]
printSlideShowJS  [line 471]

Prints the path to the slideshow JS and CSS (printed because some values need to be changed dynamically).

CSS can be adjusted To be used on slideshow.php


void printSlideShowJS( )

[ Top ]
printSlideShowLink  [line 93]

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.

Parameters:
string   $linktext:  Text for the link


void printSlideShowLink( [string $linktext = '']  )

[ Top ]


Documentation generated on Tue, 30 Sep 2008 20:23:29 +0200 by phpDocumentor 1.4.1