mediawiki-extensions-Multim.../resources/multilightbox/hooks.txt
theopolisme b770e02d48 Enable fullscreening with jquery.fullscreen
Depends on I58138afa05c43f5a24e74fa3a30a658428c39ce0
(core patch)

Change-Id: Ib972d453bdf8172439bf6195985fcf7e248b2b8a
2014-01-27 14:14:36 +01:00

86 lines
2.3 KiB
Plaintext

These are the available hook types. You can register functions to handle these
by calling lightboxHooks.register( 'typeOfHook', function () { ... } );
modifyInterface
Arguments: None
ThisArg: LightboxInterface
Called: From LightboxInterface constructor
modifyDefaultPreDiv
Arguments: None
ThisArg: LightboxInterface
Called: From LightboxInterface setupPreDiv method, if defaults are loaded
modifyDefaultPostDiv
Arguments: None
ThisArg: LightboxInterface
Called: From LightboxInterface setupPostDiv method, if defaults are loaded
addToPreDiv
Arguments:
* addToPre - Array - Add jQuery elements here to be added to the pre-image div
ThisArg: LightboxInterface
Called: From LightboxInterface constructor
addToPostDiv
Arguments:
* addToPost - Array - Add jQuery elements here to be added to the post-image div
ThisArg: LightboxInterface
Called: From LightboxInterface constructor
imageLoaded
Arguments: None
ThisArg: LightboxInterface
Called: From LightboxInterface-defined callback when image is done loading
modifyImageObject
Arguments: None
ThisArg: LightboxImage
Called: From LightboxImage constructor
modifyImageElement
Arguments: None
ThisArg: HTMLImageElement
Called: From LightboxImage getImageElement method
nextImage
Arguments: None
ThisArg: MultiLightbox
Called: From MultiLightbox next method
prevImage
Arguments: None
ThisArg: MultiLightbox
Called: From MultiLightbox prev method
noNextImage
Arguments: None
ThisArg: MultiLightbox
Called: From MultiLightbox next method when user tries to reach too-high index
noPrevImage
Arguments: None
ThisArg: MultiLightbox
Called: From MultiLightbox prev method when user tries to reach negative index
fullscreen
Arguments:
* fullscreen - Boolean - Represents the current fullscreen state
ThisArg: LightboxInterface
Called: From LightboxInterface fullscreen method when user is going to fullscreen interface or leaving it.
clearInterface
Arguments: None
ThisArg: LightboxInterface
Called: From LightboxInterface empty method when the interface is being cleared.
imageResize
Arguments: None
ThisArg: LightboxInterface
Called: From LightboxInterface resize listener. Return false to override default behaviour.
closeInterface
Arguments: None
ThisArg: LightboxInterface
Called: From LightboxInterface unattach method when the interface is being unattached.