okular/interfaces/viewerinterface.h

49 lines
1.6 KiB
C++

/***************************************************************************
* Copyright (C) 2011 by Michel Ludwig <michel.ludwig@kdemail.net> *
* *
* 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 _VIEWERINTERFACE_H_
#define _VIEWERINTERFACE_H_
#include <QString>
/**
* @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
{
public:
virtual ~ViewerInterface() {}
/**
* Show the specified source location centrally in the viewer.
*/
virtual void showSourceLocation(const QString& fileName, int line, int column) = 0;
/**
* Allows to enable or disable the watch file mode
*/
virtual void setWatchFileModeEnabled(bool b) = 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);
};
Q_DECLARE_INTERFACE( ViewerInterface, "org.kde.viewerinterface/0.1" )
#endif