pagetransition.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Tobias Koenig <tokoe@kde.org>                   *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 ***************************************************************************/

#ifndef _OKULAR_PAGETRANSITION_H_
#define _OKULAR_PAGETRANSITION_H_

#include "okular_export.h"

namespace Okular {

class OKULAR_EXPORT PageTransition
{
    public:
        enum Type {
            Replace,
            Split,
            Blinds,
            Box,
            Wipe,
            Dissolve,
            Glitter,
            Fly,
            Push,
            Cover,
            Uncover,
            Fade
        };

        enum Alignment {
            Horizontal,
            Vertical
        };

        enum Direction {
            Inward,
            Outward
        };

        PageTransition( Type type = Replace );

        PageTransition( const PageTransition &other );
        PageTransition& operator=( const PageTransition &other );

        ~PageTransition();

        Type type() const;

        int duration() const;

        Alignment alignment() const;

        Direction direction() const;

        int angle() const;

        double scale() const;

        bool isRectangular() const;

        void setType( Type type );

        void setDuration( int duration );

        void setAlignment( Alignment alignment );

        void setDirection( Direction direction );

        void setAngle( int angle );

        void setScale( double scale );

        void setIsRectangular( bool rectangular );

    private:
        class Private;
        Private* const d;
};

}

#endif