mirror of
https://invent.kde.org/graphics/okular
synced 2024-09-29 20:54:45 +00:00
2fbab13e1f
With this MR, the sidebar can now be (if not locked): * docked to the left or right side * undocked and floated as an independent window * closed with the close button in the header BUG: 455013
108 lines
2.9 KiB
C++
108 lines
2.9 KiB
C++
/*
|
|
SPDX-FileCopyrightText: 2011 Michel Ludwig <michel.ludwig@kdemail.net>
|
|
|
|
SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#ifndef _OKULAR_VIEWERINTERFACE_H_
|
|
#define _OKULAR_VIEWERINTERFACE_H_
|
|
|
|
#include "../core/okularcore_export.h"
|
|
#ifdef Q_OS_WIN
|
|
#define VIEWERINTERFACE_EXPORT __declspec(dllexport)
|
|
#else
|
|
#define VIEWERINTERFACE_EXPORT OKULARCORE_EXPORT
|
|
#endif
|
|
|
|
#include <QObject>
|
|
#include <QString>
|
|
|
|
namespace Okular
|
|
{
|
|
/**
|
|
* @short Abstract interface for controlling advanced features of a document viewer
|
|
*
|
|
* This interface can be used to control some more or less advanced features of a document
|
|
* viewer.
|
|
*/
|
|
class VIEWERINTERFACE_EXPORT ViewerInterface
|
|
{
|
|
public:
|
|
ViewerInterface()
|
|
{
|
|
}
|
|
virtual ~ViewerInterface()
|
|
{
|
|
}
|
|
|
|
ViewerInterface(const ViewerInterface &) = delete;
|
|
ViewerInterface &operator=(const ViewerInterface &) = delete;
|
|
|
|
/**
|
|
* Show the specified source location centrally in the viewer.
|
|
*
|
|
* @param fileName source file name
|
|
* @param line in the source file, starts from 0
|
|
* @param column in the source file, starts from 0
|
|
* @param showGraphically controls whether the given source location will be
|
|
* shown graphically in the viewer (if that feature is globally activated)
|
|
*/
|
|
virtual void showSourceLocation(const QString &fileName, int line, int column, bool showGraphically = true) = 0;
|
|
|
|
/**
|
|
* Clear the source location that was set last in the viewer.
|
|
*/
|
|
virtual void clearLastShownSourceLocation() = 0;
|
|
|
|
/**
|
|
* Returns true iff source locations are shown graphically.
|
|
*/
|
|
virtual bool areSourceLocationsShownGraphically() const = 0;
|
|
|
|
/**
|
|
* Allows to control whether source locations are shown graphically, or not.
|
|
*/
|
|
virtual void setShowSourceLocationsGraphically(bool b) = 0;
|
|
|
|
/**
|
|
* Returns true iff the watch file mode is enabled.
|
|
*/
|
|
virtual bool isWatchFileModeEnabled() const = 0;
|
|
|
|
/**
|
|
* Allows to enable or disable the watch file mode
|
|
*/
|
|
virtual void setWatchFileModeEnabled(bool b) = 0;
|
|
|
|
/**
|
|
* Should the shell that supports tabs open new files in tabs?
|
|
*/
|
|
virtual bool openNewFilesInTabs() const = 0;
|
|
|
|
/**
|
|
* Returns the sidebar container.
|
|
*
|
|
* @since 23.04
|
|
*/
|
|
virtual QWidget *getSideContainer() const = 0;
|
|
|
|
// SIGNALS
|
|
/**
|
|
* The signal 'openSourceReference' is emitted whenever the user has triggered a source
|
|
* reference in the currently displayed document.
|
|
*/
|
|
void openSourceReference(const QString &absFileName, int line, int column);
|
|
|
|
/**
|
|
* The signal 'viewerMenuStateChange' is emitted whenever the state of the menu
|
|
* 'menu_okular_part_viewer' defined in 'part-viewermode.rc' has changed.
|
|
*/
|
|
void viewerMenuStateChange(bool enabled);
|
|
};
|
|
|
|
}
|
|
|
|
Q_DECLARE_INTERFACE(Okular::ViewerInterface, "org.kde.okular.ViewerInterface/0.1")
|
|
|
|
#endif
|