Documentation

PresentationProperties
in package

Table of Contents

Constants

SLIDESHOW_TYPE_BROWSE  = 'browse'
SLIDESHOW_TYPE_KIOSK  = 'kiosk'
SLIDESHOW_TYPE_PRESENT  = 'present'
THUMBNAIL_DATA  = 'data'
THUMBNAIL_FILE  = 'file'
VIEW_HANDOUT  = 'handoutView'
VIEW_NOTES  = 'notesView'
VIEW_NOTES_MASTER  = 'notesMasterView'
VIEW_OUTLINE  = 'outlineView'
VIEW_SLIDE  = 'sldView'
VIEW_SLIDE_MASTER  = 'sldMasterView'
VIEW_SLIDE_SORTER  = 'sldSorterView'
VIEW_SLIDE_THUMBNAIL  = 'sldThumbnailView'

Properties

$arraySlideshowTypes  : array<int, string>
$arrayView  : array<int, string>
$isCommentVisible  : bool
$isLoopUntilEsc  : bool
$lastView  : string
$markAsFinal  : bool
Mark as final.
$slideshowType  : string
$thumbnail  : null|string
$thumbnailPath  : null|string
$thumbnailType  : string
$zoom  : float
Zoom.

Methods

getLastView()  : string
getSlideshowType()  : string
getThumbnail()  : string|null
Return the content of thumbnail.
getThumbnailPath()  : string|null
Return the thumbnail file path.
getThumbnailType()  : string
Return the thumbnail type.
getZoom()  : float
Return the zoom (in percentage).
isCommentVisible()  : bool
isLoopContinuouslyUntilEsc()  : bool
isMarkedAsFinal()  : bool
Return if this document is marked as final.
markAsFinal()  : self
Mark a document as final.
setCommentVisible()  : self
setLastView()  : self
setLoopContinuouslyUntilEsc()  : self
setSlideshowType()  : self
setThumbnailPath()  : self
Define the path for the thumbnail file / preview picture.
setZoom()  : self
Set the zoom of the document (in percentage).

Constants

Properties

$arraySlideshowTypes

protected array<int, string> $arraySlideshowTypes = [self::SLIDESHOW_TYPE_PRESENT, self::SLIDESHOW_TYPE_BROWSE, self::SLIDESHOW_TYPE_KIOSK]

$arrayView

protected array<int, string> $arrayView = [self::VIEW_HANDOUT, self::VIEW_NOTES, self::VIEW_NOTES_MASTER, self::VIEW_OUTLINE, self::VIEW_SLIDE, self::VIEW_SLIDE_MASTER, self::VIEW_SLIDE_SORTER, self::VIEW_SLIDE_THUMBNAIL]

$thumbnail

protected null|string $thumbnail

Define the thumbnail content (if content into zip file)

$thumbnailType

protected string $thumbnailType = self::THUMBNAIL_FILE

Define if thumbnail is out of PPT or previouly store into PPT

Methods

getThumbnail()

Return the content of thumbnail.

public getThumbnail() : string|null
Return values
string|null

getThumbnailPath()

Return the thumbnail file path.

public getThumbnailPath() : string|null
Return values
string|null

getThumbnailType()

Return the thumbnail type.

public getThumbnailType() : string
Return values
string

isMarkedAsFinal()

Return if this document is marked as final.

public isMarkedAsFinal() : bool
Return values
bool

markAsFinal()

Mark a document as final.

public markAsFinal([bool $state = true ]) : self
Parameters
$state : bool = true
Return values
self

setCommentVisible()

public setCommentVisible([bool $value = false ]) : self
Parameters
$value : bool = false
Return values
self

setLastView()

public setLastView([string $value = self::VIEW_SLIDE ]) : self
Parameters
$value : string = self::VIEW_SLIDE
Return values
self

setLoopContinuouslyUntilEsc()

public setLoopContinuouslyUntilEsc([bool $value = false ]) : self
Parameters
$value : bool = false
Return values
self

setSlideshowType()

public setSlideshowType([string $value = self::SLIDESHOW_TYPE_PRESENT ]) : self
Parameters
$value : string = self::SLIDESHOW_TYPE_PRESENT
Return values
self

setThumbnailPath()

Define the path for the thumbnail file / preview picture.

public setThumbnailPath([string $path = '' ][, string $type = self::THUMBNAIL_FILE ][, string|null $content = null ]) : self
Parameters
$path : string = ''
$type : string = self::THUMBNAIL_FILE
$content : string|null = null
Return values
self

setZoom()

Set the zoom of the document (in percentage).

public setZoom([float $zoom = 1.0 ]) : self
Parameters
$zoom : float = 1.0
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results