Okular::Movie

Search for usage in LXR

Okular::Movie Class Reference

#include <movie.h>

Public Types

enum  PlayMode { PlayLimited, PlayOpen, PlayRepeat, PlayPalindrome }
 

Public Member Functions

 Movie (const QString &fileName)
 
 Movie (const QString &fileName, const QByteArray &data)
 
 ~Movie ()
 
bool autoPlay () const
 
PlayMode playMode () const
 
double playRepetitions () const
 
QImage posterImage () const
 
Rotation rotation () const
 
void setAutoPlay (bool autoPlay)
 
void setPlayMode (PlayMode mode)
 
void setPlayRepetitions (double repetitions)
 
void setPosterImage (const QImage &image)
 
void setRotation (Rotation rotation)
 
void setShowControls (bool show)
 
void setShowPosterImage (bool show)
 
void setSize (const QSize &aspect)
 
bool showControls () const
 
bool showPosterImage () const
 
QSize size () const
 
QString url () const
 

Detailed Description

Contains information about a movie object.

Since
0.8 (KDE 4.2)

Definition at line 25 of file movie.h.

Member Enumeration Documentation

The play mode for playing the movie.

Enumerator
PlayLimited 

Play a fixed amount of times, closing the movie controls at the end.

Since
0.24
PlayOpen 

Like PlayLimited, but leaving the controls open.

PlayRepeat 

Play continuously until stopped.

PlayPalindrome 

Play forward, then backward, then again forward and so on until stopped.

Definition at line 31 of file movie.h.

Constructor & Destructor Documentation

Movie::Movie ( const QString fileName)
explicit

Creates a new movie object with the given external fileName.

Definition at line 49 of file movie.cpp.

Movie::Movie ( const QString fileName,
const QByteArray data 
)
explicit

Creates a new movie object with the given movie data.

Definition at line 54 of file movie.cpp.

Movie::~Movie ( )

Destroys the movie object.

Definition at line 72 of file movie.cpp.

Member Function Documentation

bool Movie::autoPlay ( ) const

Whether to play the movie automatically.

Definition at line 141 of file movie.cpp.

Movie::PlayMode Movie::playMode ( ) const

How to play the movie.

Definition at line 121 of file movie.cpp.

double Movie::playRepetitions ( ) const

How many times to play the movie.

Since
0.24

Definition at line 131 of file movie.cpp.

QImage Movie::posterImage ( ) const

Returns the poster image.

Since
4.10

Definition at line 161 of file movie.cpp.

Rotation Movie::rotation ( ) const

Returns the rotation of the movie.

Definition at line 101 of file movie.cpp.

void Movie::setAutoPlay ( bool  autoPlay)

Sets whether to play the movie automatically.

Definition at line 136 of file movie.cpp.

void Movie::setPlayMode ( Movie::PlayMode  mode)

Sets the way the movie should be played.

Definition at line 116 of file movie.cpp.

void Movie::setPlayRepetitions ( double  repetitions)

Sets how many times the movie should be played.

Since
0.24

Definition at line 126 of file movie.cpp.

void Movie::setPosterImage ( const QImage image)

Sets the poster image.

Since
4.10

Definition at line 156 of file movie.cpp.

void Movie::setRotation ( Rotation  rotation)

Sets the rotation of the movie.

Definition at line 96 of file movie.cpp.

void Movie::setShowControls ( bool  show)

Sets whether show a bar with movie controls.

Definition at line 106 of file movie.cpp.

void Movie::setShowPosterImage ( bool  show)

Sets whether to show a poster image.

Since
4.10

Definition at line 146 of file movie.cpp.

void Movie::setSize ( const QSize aspect)

Sets the size for the movie.

Definition at line 86 of file movie.cpp.

bool Movie::showControls ( ) const

Whether show a bar with movie controls.

Definition at line 111 of file movie.cpp.

bool Movie::showPosterImage ( ) const

Whether to show a poster image.

Since
4.10

Definition at line 151 of file movie.cpp.

QSize Movie::size ( ) const

Returns the size of the movie.

Definition at line 91 of file movie.cpp.

QString Movie::url ( ) const

Returns the url of the movie.

Definition at line 78 of file movie.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Sat Oct 23 2021 22:36:42 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.