action.h

/***************************************************************************
 *   Copyright (C) 2004 by Enrico Ros <[email protected]>                  *
 *                                                                         *
 *   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_ACTION_H_
#define _OKULAR_ACTION_H_

#include "global.h"
#include "okularcore_export.h"

#include <QString>
#include <QVariant>

namespace Okular
{
class ActionPrivate;
class GotoActionPrivate;
class ExecuteActionPrivate;
class BrowseActionPrivate;
class DocumentActionPrivate;
class SoundActionPrivate;
class ScriptActionPrivate;
class MovieActionPrivate;
class RenditionActionPrivate;
class MovieAnnotation;
class ScreenAnnotation;
class Movie;
class Sound;
class DocumentViewport;

class OKULARCORE_EXPORT Action
{
public:
    enum ActionType {
        Goto,         
        Execute,      
        Browse,       
        DocAction,    
        Sound,        
        Movie,        
        Script,       
        Rendition,    
        BackendOpaque 
    };

    virtual ~Action();

    virtual ActionType actionType() const = 0;

    virtual QString actionTip() const;

    void setNativeId(const QVariant &id);

    QVariant nativeId() const;

    QVector<Action *> nextActions() const;

    void setNextActions(const QVector<Action *> &actions);

protected:
    Action(ActionPrivate &dd);
    Q_DECLARE_PRIVATE(Action)
    ActionPrivate *d_ptr;

private:
    Q_DISABLE_COPY(Action)
};

class OKULARCORE_EXPORT GotoAction : public Action
{
public:
    GotoAction(const QString &fileName, const DocumentViewport &viewport);

    GotoAction(const QString &fileName, const QString &namedDestination);

    ~GotoAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    bool isExternal() const;

    QString fileName() const;

    DocumentViewport destViewport() const;

    QString destinationName() const;

private:
    Q_DECLARE_PRIVATE(GotoAction)
    Q_DISABLE_COPY(GotoAction)
};

class OKULARCORE_EXPORT ExecuteAction : public Action
{
public:
    ExecuteAction(const QString &fileName, const QString &parameters);

    ~ExecuteAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    QString fileName() const;

    QString parameters() const;

private:
    Q_DECLARE_PRIVATE(ExecuteAction)
    Q_DISABLE_COPY(ExecuteAction)
};

class OKULARCORE_EXPORT BrowseAction : public Action
{
public:
    explicit BrowseAction(const QUrl &url);

    ~BrowseAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    QUrl url() const;

private:
    Q_DECLARE_PRIVATE(BrowseAction)
    Q_DISABLE_COPY(BrowseAction)
};

class OKULARCORE_EXPORT DocumentAction : public Action
{
public:
    enum DocumentActionType {
        PageFirst = 1,       
        PagePrev = 2,        
        PageNext = 3,        
        PageLast = 4,        
        HistoryBack = 5,     
        HistoryForward = 6,  
        Quit = 7,            
        Presentation = 8,    
        EndPresentation = 9, 
        Find = 10,           
        GoToPage = 11,       
        Close = 12           
    };

    explicit DocumentAction(enum DocumentActionType documentActionType);

    ~DocumentAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    DocumentActionType documentActionType() const;

private:
    Q_DECLARE_PRIVATE(DocumentAction)
    Q_DISABLE_COPY(DocumentAction)
};

class OKULARCORE_EXPORT SoundAction : public Action
{
public:
    SoundAction(double volume, bool synchronous, bool repeat, bool mix, Okular::Sound *sound);

    ~SoundAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    double volume() const;

    bool synchronous() const;

    bool repeat() const;

    bool mix() const;

    Okular::Sound *sound() const;

private:
    Q_DECLARE_PRIVATE(SoundAction)
    Q_DISABLE_COPY(SoundAction)
};

class OKULARCORE_EXPORT ScriptAction : public Action
{
public:
    ScriptAction(enum ScriptType type, const QString &script);

    ~ScriptAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    ScriptType scriptType() const;

    QString script() const;

private:
    Q_DECLARE_PRIVATE(ScriptAction)
    Q_DISABLE_COPY(ScriptAction)
};

class OKULARCORE_EXPORT MovieAction : public Action
{
public:
    enum OperationType { Play, Stop, Pause, Resume };

    explicit MovieAction(OperationType operation);

    ~MovieAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    OperationType operation() const;

    void setAnnotation(MovieAnnotation *annotation);

    MovieAnnotation *annotation() const;

private:
    Q_DECLARE_PRIVATE(MovieAction)
    Q_DISABLE_COPY(MovieAction)
};

class OKULARCORE_EXPORT RenditionAction : public Action
{
public:
    enum OperationType {
        None,  
        Play,  
        Stop,  
        Pause, 
        Resume 
    };

    RenditionAction(OperationType operation, Okular::Movie *movie, enum ScriptType scriptType, const QString &script);

    ~RenditionAction() override;

    ActionType actionType() const override;

    QString actionTip() const override;

    OperationType operation() const;

    Okular::Movie *movie() const;

    ScriptType scriptType() const;

    QString script() const;

    void setAnnotation(ScreenAnnotation *annotation);

    ScreenAnnotation *annotation() const;

private:
    Q_DECLARE_PRIVATE(RenditionAction)
    Q_DISABLE_COPY(RenditionAction)
};

class OKULARCORE_EXPORT BackendOpaqueAction : public Action
{
public:
    BackendOpaqueAction();

    ActionType actionType() const override;

private:
    Q_DISABLE_COPY(BackendOpaqueAction)
};

}

#endif