• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdegraphics API Reference
  • KDE Home
  • Contact Us
 

okular

  • sources
  • kde-4.12
  • kdegraphics
  • okular
  • interfaces
viewerinterface.h
Go to the documentation of this file.
1 /***************************************************************************
2  * Copyright (C) 2011 by Michel Ludwig <michel.ludwig@kdemail.net> *
3  * *
4  * This program is free software; you can redistribute it and/or modify *
5  * it under the terms of the GNU General Public License as published by *
6  * the Free Software Foundation; either version 2 of the License, or *
7  * (at your option) any later version. *
8  ***************************************************************************/
9 
10 #ifndef _OKULAR_VIEWERINTERFACE_H_
11 #define _OKULAR_VIEWERINTERFACE_H_
12 
13 #include "../core/okular_export.h"
14 
15 #include <QtCore/QObject>
16 #include <QtCore/QString>
17 
18 namespace Okular {
19 
26 class ViewerInterface
27 {
28  public:
29  virtual ~ViewerInterface() {}
30 
40  virtual void showSourceLocation(const QString& fileName, int line, int column, bool showGraphically = true) = 0;
41 
45  virtual void clearLastShownSourceLocation() = 0;
46 
50  virtual bool areSourceLocationsShownGraphically() const = 0;
51 
55  virtual void setShowSourceLocationsGraphically(bool b) = 0;
56 
60  virtual bool isWatchFileModeEnabled() const = 0;
61 
65  virtual void setWatchFileModeEnabled(bool b) = 0;
66 
67 
68  // SIGNALS
73  void openSourceReference(const QString& absFileName, int line, int column);
74 
79  void viewerMenuStateChange(bool enabled);
80 };
81 
82 }
83 
84 Q_DECLARE_INTERFACE( Okular::ViewerInterface, "org.kde.okular.ViewerInterface/0.1" )
85 
86 #endif
Okular::ViewerInterface::showSourceLocation
virtual void showSourceLocation(const QString &fileName, int line, int column, bool showGraphically=true)=0
Show the specified source location centrally in the viewer.
Okular::ViewerInterface::openSourceReference
void openSourceReference(const QString &absFileName, int line, int column)
The signal 'openSourceReference' is emitted whenever the user has triggered a source reference in the...
Okular::ViewerInterface::viewerMenuStateChange
void viewerMenuStateChange(bool enabled)
The signal 'viewerMenuStateChange' is emitted whenever the state of the menu 'menu_okular_part_viewer...
Okular::ViewerInterface::clearLastShownSourceLocation
virtual void clearLastShownSourceLocation()=0
Clear the source location that was set last in the viewer.
Okular::ViewerInterface::isWatchFileModeEnabled
virtual bool isWatchFileModeEnabled() const =0
Returns true iff the watch file mode is enabled.
Okular::ViewerInterface::setWatchFileModeEnabled
virtual void setWatchFileModeEnabled(bool b)=0
Allows to enable or disable the watch file mode.
Okular::ViewerInterface::areSourceLocationsShownGraphically
virtual bool areSourceLocationsShownGraphically() const =0
Returns true iff source locations are shown graphically.
Okular::ViewerInterface::setShowSourceLocationsGraphically
virtual void setShowSourceLocationsGraphically(bool b)=0
Allows to control whether source locations are shown graphically, or not.
Okular::ViewerInterface
Abstract interface for controlling advanced features of a document viewer.
Definition: viewerinterface.h:26
Okular::ViewerInterface::~ViewerInterface
virtual ~ViewerInterface()
Definition: viewerinterface.h:29
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:45:03 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

okular

Skip menu "okular"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdegraphics API Reference

Skip menu "kdegraphics API Reference"
  •     libkdcraw
  •     libkexiv2
  •     libkipi
  •     libksane
  • okular

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal