plasma-framework/animations/slide.h

/*
 *   Copyright 2009 Mehmet Ali Akmanalp <makmanalp@wpi.edu>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as
 *   published by the Free Software Foundation; either version 2, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */

/**
 * @file This file contains the definition for the Slide effect.
 */

#ifndef PLASMA_ANIMATIONS_SLIDE_H
#define PLASMA_ANIMATIONS_SLIDE_H

#include <plasma/animations/animation.h>
#include <plasma/plasma_export.h>

namespace Plasma
{

/**
 * @class Slide plasma/animations/slide.h
 * @short Slide effect
 *
 * Effect that moves the object a specific distance in a given direction. The
 * object is optionally made invisible at the beginning or at the end.
 */
class PLASMA_EXPORT SlideAnimation : public Animation
{
    Q_OBJECT

public:
    SlideAnimation(AnimationDirection direction, qreal distance);
    virtual ~SlideAnimation(){};
    /**
     * Set if the widget is visible at the end of the animation (default True).
     * @param visibility True for visible, False for not.
     */
    void setVisibleAtEnd(bool visibility);

protected:
    virtual QAbstractAnimation* render(QObject* parent = 0);

};

}

#endif