pdftron::PDF::Annots::Movie Class Reference

A movie annotation contains animated graphics and sound to be presented on the computer screen and through the speakers. More...

#include <Movie.h>

Inheritance diagram for pdftron::PDF::Annots::Movie:

Inheritance graph
[legend]
Collaboration diagram for pdftron::PDF::Annots::Movie:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 Movie (SDF::Obj d=0)
 Creates a Movie annotation and initializes it using given Cos/SDF object.
 Movie (const Annot &ann)
 Creates a Movie annotation and initializes it using given annotation object.
UString GetTitle () const
 Returns the title of the Movie Annotation.
void SetTitle (const UString &title)
 Sets the title of the Movie Annotation.
bool IsToBePlayed () const
 Returns the option of whether the Movie is to be played.
void SetToBePlayed (bool isplay=true)
 Sets the option of whether the Movie is to be played.

Static Public Member Functions

static Movie Create (SDF::SDFDoc &doc, const Rect &pos)
 Creates a new Movie annotation in the specified document.


Detailed Description

A movie annotation contains animated graphics and sound to be presented on the computer screen and through the speakers.

When the annotation is activated, the movie is played.


Constructor & Destructor Documentation

pdftron::PDF::Annots::Movie::Movie ( SDF::Obj  d = 0  ) 

Creates a Movie annotation and initializes it using given Cos/SDF object.

Note:
The constructor does not copy any data, but is instead the logical equivalent of a type cast.

pdftron::PDF::Annots::Movie::Movie ( const Annot ann  )  [inline]

Creates a Movie annotation and initializes it using given annotation object.

Note:
The constructor does not copy any data, but is instead the logical equivalent of a type cast.


Member Function Documentation

static Movie pdftron::PDF::Annots::Movie::Create ( SDF::SDFDoc doc,
const Rect pos 
) [static]

Creates a new Movie annotation in the specified document.

Parameters:
doc A document to which the Movie annotation is added.
pos A rectangle specifying the Movie annotation's bounds in default user space units.
Returns:
A newly created blank Movie annotation.

UString pdftron::PDF::Annots::Movie::GetTitle (  )  const

Returns the title of the Movie Annotation.

Returns:
A string representing the title of the Movie Annotation.
Note:
Movie actions may use this title to reference the movie annotation.

void pdftron::PDF::Annots::Movie::SetTitle ( const UString title  ) 

Sets the title of the Movie Annotation.

(Optional)

Parameters:
title A string representing the title of the Movie Annotation.
Note:
Movie actions may use this title to reference the movie annotation.

bool pdftron::PDF::Annots::Movie::IsToBePlayed (  )  const

Returns the option of whether the Movie is to be played.

Returns:
a boolean value indicating if the movie is to be played.
Note:
IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.

void pdftron::PDF::Annots::Movie::SetToBePlayed ( bool  isplay = true  ) 

Sets the option of whether the Movie is to be played.

(Optional)

Parameters:
isplay A boolean value telling if the movie is to be played. Default value: true.
Note:
IsToBePlayed is a flag specifying whether to play the movie when the annotation is activated. The movie shall be played using default activation parameters. If the value is false, the movie shall not be played. Default value: true.


© 2002-2010 PDFTron Systems Inc.