Ipelib: ipe::Effect Class Reference

Ipelib

Public Types | Public Member Functions | Public Attributes | List of all members
ipe::Effect Class Reference
Ipe Attributes

`#include <ipeattributes.h>`

## Public Types
enum | TEffect { ENormal , ESplitHI , ESplitHO , ESplitVI , ESplitVO , EBlindsH , EBlindsV , EBoxI , EBoxO , EWipeLR , EWipeBT , EWipeRL , EWipeTB , EDissolve , EGlitterLR , EGlitterTB , EGlitterD }

## Public Member Functions
| Effect ()
void | pageDictionary (Stream &stream) const

## Public Attributes
TEffect | iEffect
int | iTransitionTime
int | iDuration

## Detailed Description

Effect that Acrobat Reader will show on page change.

Acrobat Reader and other PDF viewers can show a special effect when a new page of the document is shown. This class describes such an effect.

## Member Enumeration Documentation

## ◆ TEffect

enum ipe::Effect::TEffect

The various fancy effects that Acrobat Reader will show.

Enumerator
ENormal |
ESplitHI |
ESplitHO |
ESplitVI |
ESplitVO |
EBlindsH |
EBlindsV |
EBoxI |
EBoxO |
EWipeLR |
EWipeBT |
EWipeRL |
EWipeTB |
EDissolve |
EGlitterLR |
EGlitterTB |
EGlitterD |

## Constructor & Destructor Documentation

## ◆ Effect()

Effect::Effect | ( |  | ) |

Construct default effect.

References ENormal, iDuration, iEffect, and iTransitionTime.

## Member Function Documentation

## ◆ pageDictionary()

void Effect::pageDictionary | ( | Stream & | stream | ) | const

Write part of page dictionary.

Write part of page dictionary indicating effect, including the two keys /Dur and /Trans.

References EBlindsH, EBlindsV, EBoxI, EBoxO, EDissolve, EGlitterD, EGlitterLR, EGlitterTB, ENormal, ESplitHI, ESplitHO, ESplitVI, ESplitVO, EWipeBT, EWipeLR, EWipeRL, EWipeTB, iDuration, iEffect, and iTransitionTime.

Referenced by ipe::PdfWriter::createPageView().

## Member Data Documentation

## ◆ iEffect

TEffect ipe::Effect::iEffect

Referenced by Effect(), pageDictionary(), ipe::ImlParser::parseStyle(), and ipe::StyleSheet::saveAsXml().

## ◆ iTransitionTime

int ipe::Effect::iTransitionTime

Referenced by Effect(), pageDictionary(), ipe::ImlParser::parseStyle(), and ipe::StyleSheet::saveAsXml().

## ◆ iDuration

int ipe::Effect::iDuration

Referenced by Effect(), pageDictionary(), ipe::ImlParser::parseStyle(), and ipe::StyleSheet::saveAsXml().

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

- ipeattributes.h
- ipeattributes.cpp