Package mdp :: Package utils :: Class HTMLSlideShow

Class HTMLSlideShow

Abstract slideshow base class.

It does not display anything, but can be adapted by overriding some of the templating attributes. See ImageHTMLSlideShow for an example.

Instance Methods

[hide private]

__init__(self, title=None, delay=100, delay_delta=20, loop=True, slideshow_id=None, shortcuts=True, **kwargs)
Return the complete HTML code for the slideshow.

_get_random_id(self)
Factory method for random slideshow id.

html_bottom_template(self, _TemplateMetaClass__dict=None, **kw)

html_box_template(self, _TemplateMetaClass__dict=None, **kw)

html_buttons_template(self, _TemplateMetaClass__dict=None, **kw)

html_controls_template(self, _TemplateMetaClass__dict=None, **kw)

html_delay_template(self, _TemplateMetaClass__dict=None, **kw)

html_top_template(self, _TemplateMetaClass__dict=None, **kw)

js_controls_template(self, _TemplateMetaClass__dict=None, **kw)

js_keyboard_shortcuts_template(self, _TemplateMetaClass__dict=None, **kw)

js_loadslide_template(self, _TemplateMetaClass__dict=None, **kw)

js_onload_template(self, _TemplateMetaClass__dict=None, **kw)

js_update_template(self, _TemplateMetaClass__dict=None, **kw)

template(self, _TemplateMetaClass__dict=None, **kw)

Inherited from unreachable.StringTemplate: __str__, write

Inherited from unreachable.newobject: __long__, __native__, __nonzero__, __unicode__, next

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, title=None, delay=100, delay_delta=20, loop=True, slideshow_id=None, shortcuts=True, **kwargs)
(Constructor)

Return the complete HTML code for the slideshow.

title -- Optional slideshow title (for defualt None not title is shown).
delay - Delay between slides in ms (default 100).
delay_delta - Step size for increasing or decreasing the delay.
loop -- If True continue with first slide when the last slide is
    reached during the automatic slideshow (default is False).
slideshow_id -- String with the id used for the JS closure, and this
    is also the id of the div with the slideshow (so it can be used
    by CSS) and it is used as a prefix for the HTML elements.
    If the value is None (default) then a random id is used.
shortcuts -- Bind keyboard shortcuts to this slideshow (default is
    True). Note that keyboard shortcuts only work for a single
    slideshow per page.

Overrides: object.__init__

_get_random_id(self)

Factory method for random slideshow id.

Class HTMLSlideShow

__init__(self, title=None, delay=100, delay_delta=20, loop=True, slideshow_id=None, shortcuts=True, **kwargs) (Constructor)

_get_random_id(self)

html_bottom_template(self, _TemplateMetaClass__dict=None, **kw)

html_box_template(self, _TemplateMetaClass__dict=None, **kw)

html_buttons_template(self, _TemplateMetaClass__dict=None, **kw)

html_controls_template(self, _TemplateMetaClass__dict=None, **kw)

html_delay_template(self, _TemplateMetaClass__dict=None, **kw)

html_top_template(self, _TemplateMetaClass__dict=None, **kw)

js_controls_template(self, _TemplateMetaClass__dict=None, **kw)

js_keyboard_shortcuts_template(self, _TemplateMetaClass__dict=None, **kw)

js_loadslide_template(self, _TemplateMetaClass__dict=None, **kw)

js_onload_template(self, _TemplateMetaClass__dict=None, **kw)

js_update_template(self, _TemplateMetaClass__dict=None, **kw)

template(self, _TemplateMetaClass__dict=None, **kw)

init(self, title=None, delay=100, delay_delta=20, loop=True, slideshow_id=None, shortcuts=True, **kwargs)
(Constructor)