Okular::ViewerInterface Class Reference

#include <viewerinterface.h>

Inheritance diagram for Okular::ViewerInterface:

Public Member Functions
virtual	~ViewerInterface ()
virtual bool	areSourceLocationsShownGraphically () const =0
virtual void	clearLastShownSourceLocation ()=0
virtual bool	isWatchFileModeEnabled () const =0
void	openSourceReference (const QString &absFileName, int line, int column)
virtual void	setShowSourceLocationsGraphically (bool b)=0
virtual void	setWatchFileModeEnabled (bool b)=0
virtual void	showSourceLocation (const QString &fileName, int line, int column, bool showGraphically=true)=0
void	viewerMenuStateChange (bool enabled)

Detailed Description

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.

Definition at line 26 of file viewerinterface.h.

Constructor & Destructor Documentation

virtual Okular::ViewerInterface::~ViewerInterface ( )

inlinevirtual

Definition at line 29 of file viewerinterface.h.

Member Function Documentation

virtual bool Okular::ViewerInterface::areSourceLocationsShownGraphically ( ) const

pure virtual

Returns true iff source locations are shown graphically.

Implemented in Okular::Part.

virtual void Okular::ViewerInterface::clearLastShownSourceLocation ( )

pure virtual

Clear the source location that was set last in the viewer.

Implemented in Okular::Part.

virtual bool Okular::ViewerInterface::isWatchFileModeEnabled ( ) const

pure virtual

Returns true iff the watch file mode is enabled.

Implemented in Okular::Part.

void Okular::ViewerInterface::openSourceReference	(	const QString &	absFileName,
		int	line,
		int	column
	)

The signal 'openSourceReference' is emitted whenever the user has triggered a source reference in the currently displayed document.

virtual void Okular::ViewerInterface::setShowSourceLocationsGraphically ( bool  b )

pure virtual

Allows to control whether source locations are shown graphically, or not.

Implemented in Okular::Part.

virtual void Okular::ViewerInterface::setWatchFileModeEnabled ( bool  b )

pure virtual

Allows to enable or disable the watch file mode.

Implemented in Okular::Part.

virtual void Okular::ViewerInterface::showSourceLocation ( const QString &  fileName, int  line, int  column, bool  showGraphically = true  )

pure virtual

Show the specified source location centrally in the viewer.

Parameters

fileName	source file name
line	in the source file, starts from 0
column	in the source file, starts from 0
showGraphically	controls whether the given source location will be shown graphically in the viewer (if that feature is globally activated)

Implemented in Okular::Part.

void Okular::ViewerInterface::viewerMenuStateChange

(

bool

enabled

)

The signal 'viewerMenuStateChange' is emitted whenever the state of the menu 'menu_okular_part_viewer' defined in 'part-viewermode.rc' has changed.

---

The documentation for this class was generated from the following file:

• viewerinterface.h