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)
 
void setStartPaused (bool startPaused)
 
bool showControls () const
 
bool showPosterImage () const
 
QSize size () const
 
bool startPaused () 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

◆ PlayMode

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() [1/2]

Movie::Movie ( const QString & fileName)
explicit

Creates a new movie object with the given external fileName.

Definition at line 51 of file movie.cpp.

◆ Movie() [2/2]

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

Creates a new movie object with the given movie data.

Definition at line 56 of file movie.cpp.

◆ ~Movie()

Movie::~Movie ( )

Destroys the movie object.

Definition at line 75 of file movie.cpp.

Member Function Documentation

◆ autoPlay()

bool Movie::autoPlay ( ) const

Whether to play the movie automatically.

Definition at line 145 of file movie.cpp.

◆ playMode()

Movie::PlayMode Movie::playMode ( ) const

How to play the movie.

Definition at line 125 of file movie.cpp.

◆ playRepetitions()

double Movie::playRepetitions ( ) const

How many times to play the movie.

Since
0.24

Definition at line 135 of file movie.cpp.

◆ posterImage()

QImage Movie::posterImage ( ) const

Returns the poster image.

Since
4.10

Definition at line 175 of file movie.cpp.

◆ rotation()

Rotation Movie::rotation ( ) const

Returns the rotation of the movie.

Definition at line 105 of file movie.cpp.

◆ setAutoPlay()

void Movie::setAutoPlay ( bool autoPlay)

Sets whether to play the movie automatically.

Definition at line 140 of file movie.cpp.

◆ setPlayMode()

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

Sets the way the movie should be played.

Definition at line 120 of file movie.cpp.

◆ setPlayRepetitions()

void Movie::setPlayRepetitions ( double repetitions)

Sets how many times the movie should be played.

Since
0.24

Definition at line 130 of file movie.cpp.

◆ setPosterImage()

void Movie::setPosterImage ( const QImage & image)

Sets the poster image.

Since
4.10

Definition at line 170 of file movie.cpp.

◆ setRotation()

void Movie::setRotation ( Rotation rotation)

Sets the rotation of the movie.

Definition at line 100 of file movie.cpp.

◆ setShowControls()

void Movie::setShowControls ( bool show)

Sets whether show a bar with movie controls.

Definition at line 110 of file movie.cpp.

◆ setShowPosterImage()

void Movie::setShowPosterImage ( bool show)

Sets whether to show a poster image.

Since
4.10

Definition at line 160 of file movie.cpp.

◆ setSize()

void Movie::setSize ( const QSize aspect)

Sets the size for the movie.

Definition at line 90 of file movie.cpp.

◆ setStartPaused()

void Movie::setStartPaused ( bool startPaused)

Sets whether to start the movie in paused mode.

Definition at line 150 of file movie.cpp.

◆ showControls()

bool Movie::showControls ( ) const

Whether show a bar with movie controls.

Definition at line 115 of file movie.cpp.

◆ showPosterImage()

bool Movie::showPosterImage ( ) const

Whether to show a poster image.

Since
4.10

Definition at line 165 of file movie.cpp.

◆ size()

QSize Movie::size ( ) const

Returns the size of the movie.

Definition at line 95 of file movie.cpp.

◆ startPaused()

bool Movie::startPaused ( ) const

Whether to start the movie in paused mode.

Definition at line 155 of file movie.cpp.

◆ url()

QString Movie::url ( ) const

Returns the url of the movie.

Definition at line 81 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-2024 The KDE developers.
Generated on Fri May 24 2024 11:57:54 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.