File: kdocumentviewer.h

package info (click to toggle)
okular 4%3A25.04.2-1
  • links: PTS, VCS
  • area: main
  • in suites: trixie
  • size: 36,108 kB
  • sloc: cpp: 81,483; ansic: 7,822; xml: 3,446; javascript: 435; java: 59; sh: 33; makefile: 11
file content (57 lines) | stat: -rw-r--r-- 1,177 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
/*
    SPDX-FileCopyrightText: 2007 Pino Toscano <pino@kde.org>

    SPDX-License-Identifier: GPL-2.0-or-later
*/

#ifndef _KDOCUMENTVIEWER_H_
#define _KDOCUMENTVIEWER_H_

#include "okularpart_export.h"

#include <QStringList>

class QUrl;

/**
 * @short Abstract interface for a document viewer
 *
 * This interface describes the basic functions of a document viewer.
 */
class OKULARPART_EXPORT KDocumentViewer
{
public:
    KDocumentViewer()
    {
    }
    virtual ~KDocumentViewer()
    {
    }

    KDocumentViewer(const KDocumentViewer &) = delete;
    KDocumentViewer &operator=(const KDocumentViewer &) = delete;

    /**
     * Open the document at the specified @p url at page @p page.
     */
    virtual bool openDocument(const QUrl &url, uint page) = 0;

    /**
     * Change to @p page the currently shown page.
     */
    virtual void goToPage(uint page) = 0;

    /**
     * Start the presentation mode.
     */
    virtual void startPresentation() = 0;

    /**
     * Return a list with the supported mimetypes.
     */
    virtual QStringList supportedMimeTypes() const = 0;
};

Q_DECLARE_INTERFACE(KDocumentViewer, "org.kde.kdocumentviewer/0.1")

#endif