Okular::Movie Class Reference

#include <movie.h>

Public Types
enum	PlayMode { PlayOnce, PlayOpen, PlayRepeat, PlayPalindrome }

Public Member Functions
	Movie (const QString &fileName)
	Movie (const QString &fileName, const QByteArray &data)
	~Movie ()
bool	autoPlay () const
PlayMode	playMode () const
QImage	posterImage () const
Rotation	rotation () const
void	setAutoPlay (bool autoPlay)
void	setPlayMode (PlayMode mode)
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 28 of file movie.h.

Member Enumeration Documentation

enum Okular::Movie::PlayMode

The play mode for playing the movie.

Enumerator
PlayOnce	Play the movie once, closing the movie controls at the end.
PlayOpen	Like PlayOnce, 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 34 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 50 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 55 of file movie.cpp.

Movie::~Movie

(

)

Destroys the movie object.

Definition at line 73 of file movie.cpp.

Member Function Documentation

bool Movie::autoPlay

(

)

const

Whether to play the movie automatically.

Definition at line 132 of file movie.cpp.

Movie::PlayMode Movie::playMode

(

)

const

How to play the movie.

Definition at line 122 of file movie.cpp.

QImage Movie::posterImage

(

)

const

Returns the poster image.

Since

4.10

Definition at line 152 of file movie.cpp.

Rotation Movie::rotation

(

)

const

Returns the rotation of the movie.

Definition at line 102 of file movie.cpp.

void Movie::setAutoPlay

(

bool

autoPlay

)

Sets whether to play the movie automatically.

Definition at line 127 of file movie.cpp.

void Movie::setPlayMode

(

Movie::PlayMode

mode

)

Sets the way the movie should be played.

Definition at line 117 of file movie.cpp.

void Movie::setPosterImage

(

const QImage &

image

)

Sets the poster image.

Since

4.10

Definition at line 147 of file movie.cpp.

void Movie::setRotation

(

Rotation

rotation

)

Sets the rotation of the movie.

Definition at line 97 of file movie.cpp.

void Movie::setShowControls

(

bool

show

)

Sets whether show a bar with movie controls.

Definition at line 107 of file movie.cpp.

void Movie::setShowPosterImage

(

bool

show

)

Sets whether to show a poster image.

Since

4.10

Definition at line 137 of file movie.cpp.

void Movie::setSize

(

const QSize &

aspect

)

Sets the size for the movie.

Definition at line 87 of file movie.cpp.

bool Movie::showControls

(

)

const

Whether show a bar with movie controls.

Definition at line 112 of file movie.cpp.

bool Movie::showPosterImage

(

)

const

Whether to show a poster image.

Since

4.10

Definition at line 142 of file movie.cpp.

QSize Movie::size

(

)

const

Returns the size of the movie.

Definition at line 92 of file movie.cpp.

QString Movie::url

(

)

const

Returns the url of the movie.

Definition at line 79 of file movie.cpp.

---

The documentation for this class was generated from the following files:

• movie.h
• movie.cpp