#include <part.h>

Inheritance diagram for Okular::Part:

Public Slots
Q_SCRIPTABLE QString	currentDocument ()

Q_SCRIPTABLE uint	currentPage ()

Q_SCRIPTABLE QString	documentMetaData (const QString &metaData) const

Q_SCRIPTABLE Q_NOREPLY void	enableStartWithPrint ()

Q_SCRIPTABLE Q_NOREPLY void	goToPage (uint page)

Q_SCRIPTABLE Q_NOREPLY void	openDocument (const QString &doc)

Q_SCRIPTABLE uint	pages ()

void	psTransformEnded (int, QProcess::ExitStatus)

Q_SCRIPTABLE Q_NOREPLY void	reload ()

void	restoreDocument (const KConfigGroup &group)

void	saveDocumentRestoreInfo (KConfigGroup &group)

void	slotDoFileDirty ()

void	slotFileDirty (const QString &)

Q_SCRIPTABLE void	slotFind ()

KConfigDialog *	slotGeneratorPreferences ()

Q_SCRIPTABLE void	slotGotoFirst ()

Q_SCRIPTABLE void	slotGotoLast ()

Q_SCRIPTABLE void	slotNextPage ()

Q_SCRIPTABLE void	slotPreferences ()

Q_SCRIPTABLE void	slotPreviousPage ()

void	slotPrint ()

Q_SCRIPTABLE void	slotPrintPreview ()

Q_SCRIPTABLE void	slotTogglePresentation ()

Signals
void	enableCloseAction (bool enable)

void	enablePrintAction (bool enable)

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

void	viewerMenuStateChange (bool enabled)

Public Member Functions
	Part (QWidget parentWidget, QObject parent, const QVariantList &args, KComponentData componentData)

	~Part ()

bool	areSourceLocationsShownGraphically () const

void	clearLastShownSourceLocation ()

bool	closeUrl ()

bool	closeUrl (bool promptToSave)

bool	isWatchFileModeEnabled () const

void	notifyPageChanged (int page, int flags)

void	notifySetup (const QVector< Okular::Page * > &pages, int setupFlags)

void	notifyViewportChanged (bool smoothMove)

bool	openDocument (const KUrl &url, uint page)

bool	queryClose ()

KUrl	realUrl () const

bool	saveAs (const KUrl &saveUrl)

bool	saveFile ()

void	setReadWrite (bool readwrite)

void	setShowSourceLocationsGraphically (bool show)

void	setWatchFileModeEnabled (bool enable)

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

void	startPresentation ()

QStringList	supportedMimeTypes () const

Public Member Functions inherited from Okular::DocumentObserver
	DocumentObserver ()

virtual	~DocumentObserver ()

virtual bool	canUnloadPixmap (int page) const

virtual void	notifyContentsCleared (int flags)

virtual void	notifyCurrentPageChanged (int previous, int current)

virtual void	notifyVisibleRectsChanged ()

virtual void	notifyZoom (int factor)

Public Member Functions inherited from KDocumentViewer
virtual	~KDocumentViewer ()

virtual void	goToPage (uint page)=0

Public Member Functions inherited from Okular::ViewerInterface
virtual	~ViewerInterface ()

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

void	viewerMenuStateChange (bool enabled)

Protected Slots
void	cannotQuit ()

void	close ()

void	enableTOC (bool enable)

void	loadCancelled (const QString &reason)

void	openUrlFromBookmarks (const KUrl &url)

void	openUrlFromDocument (const KUrl &url)

void	setWindowTitleFromDocument ()

void	slotAboutBackend ()

void	slotAboutToShowContextMenu (KMenu menu, QAction action, QMenu *contextMenu)

void	slotAddBookmark ()

void	slotExportAs (QAction *)

void	slotFindNext ()

void	slotFindPrev ()

void	slotGetNewStuff ()

void	slotGoToPage ()

void	slotHideFindBar ()

void	slotHidePresentation ()

void	slotHistoryBack ()

void	slotHistoryNext ()

bool	slotImportPSFile ()

void	slotJobFinished (KJob *job)

void	slotJobStarted (KIO::Job *job)

void	slotNewConfig ()

void	slotNextBookmark ()

void	slotPreviousBookmark ()

void	slotRebuildBookmarkMenu ()

void	slotReload ()

void	slotRenameBookmarkFromMenu ()

void	slotRenameCurrentViewportBookmark ()

void	slotSaveCopyAs ()

void	slotSaveFileAs ()

void	slotShowBottomBar ()

void	slotShowEmbeddedFiles ()

void	slotShowFindBar ()

void	slotShowLeftPanel ()

void	slotShowMenu (const Okular::Page *page, const QPoint &point)

void	slotShowPresentation ()

void	slotShowProperties ()

void	updateBookmarksActions ()

void	updateViewActions ()

Protected Member Functions
void	guiActivateEvent (KParts::GUIActivateEvent *event)

bool	openFile ()

bool	openUrl (const KUrl &url)

Additional Inherited Members
Public Types inherited from Okular::DocumentObserver
enum	ChangedFlags { Pixmap = 1, Bookmark = 2, Highlights = 4, TextSelection = 8, Annotations = 16, BoundingBox = 32, NeedSaveAs = 64 }

enum	SetupFlags { DocumentChanged = 1, NewLayoutForPages = 2 }

Detailed Description

This is a "Part".

It that does all the real work in a KPart application.

Main Part

Author: Wilco Greven greve.nosp@m.n@kd.nosp@m.e.org

Version: 0.2

Definition at line 96 of file part.h.

Constructor & Destructor Documentation

Okular::Part::Part	(	QWidget *	parentWidget,
		QObject *	parent,
		const QVariantList &	args,
		KComponentData	componentData
	)

If one element of 'args' contains one of the strings "Print/Preview" or "ViewerWidget", the part will be set up in the corresponding mode.

Additionally, it is possible to specify which config file should be used by adding a string containing "ConfigFileName=<file name>" to 'args'.

Definition at line 300 of file part.cpp.

Okular::Part::~Part ( )

Definition at line 830 of file part.cpp.

Member Function Documentation

bool Okular::Part::areSourceLocationsShownGraphically ( ) const

virtual

Returns true iff source locations are shown graphically.

Implements Okular::ViewerInterface.

Definition at line 935 of file part.cpp.

void Okular::Part::cannotQuit ( )

protectedslot

Definition at line 1506 of file part.cpp.

void Okular::Part::clearLastShownSourceLocation ( )

virtual

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

Implements Okular::ViewerInterface.

Definition at line 912 of file part.cpp.

void Okular::Part::close ( )

protectedslot

Definition at line 1496 of file part.cpp.

bool Okular::Part::closeUrl ( )

Definition at line 1484 of file part.cpp.

bool Okular::Part::closeUrl ( bool promptToSave )

Definition at line 1412 of file part.cpp.

QString Okular::Part::currentDocument ( )

slot

Definition at line 1119 of file part.cpp.

uint Okular::Part::currentPage ( )

slot

Definition at line 1113 of file part.cpp.

QString Okular::Part::documentMetaData ( const QString & metaData ) const

slot

Definition at line 1125 of file part.cpp.

void Okular::Part::enableCloseAction ( bool enable )

signal

void Okular::Part::enablePrintAction ( bool enable )

signal

void Okular::Part::enableStartWithPrint ( )

slot

Definition at line 2413 of file part.cpp.

void Okular::Part::enableTOC ( bool enable )

protectedslot

Definition at line 1773 of file part.cpp.

void Okular::Part::goToPage ( uint page )

slot

Definition at line 1094 of file part.cpp.

void Okular::Part::guiActivateEvent ( KParts::GUIActivateEvent * event )

protected

Definition at line 1489 of file part.cpp.

bool Okular::Part::isWatchFileModeEnabled ( ) const

virtual

Returns true iff the watch file mode is enabled.

Implements Okular::ViewerInterface.

Definition at line 917 of file part.cpp.

void Okular::Part::loadCancelled ( const QString & reason )

protectedslot

Definition at line 1004 of file part.cpp.

void Okular::Part::notifyPageChanged	(	int	page,
		int	flags
	)

virtual

This method is called whenever the content on page described by the passed flags has been changed.

Reimplemented from Okular::DocumentObserver.

Definition at line 1080 of file part.cpp.

void Okular::Part::notifySetup	(	const QVector< Okular::Page * > &	pages,
		int	setupFlags
	)

virtual

This method is called whenever the document is initialized or reconstructed.

Parameters

pages	The vector of pages of the document.
setupFlags	the flags with the information about the setup

Reimplemented from Okular::DocumentObserver.

Definition at line 1064 of file part.cpp.

void Okular::Part::notifyViewportChanged ( bool smoothMove )

virtual

This method is called whenever the viewport has been changed.

Parameters

smoothMove If true, the move shall be animated.

Reimplemented from Okular::DocumentObserver.

Definition at line 1075 of file part.cpp.

bool Okular::Part::openDocument	(	const KUrl &	url,
		uint	page
	)

virtual

Open the document at the specified url at page page.

Implements KDocumentViewer.

Definition at line 866 of file part.cpp.

void Okular::Part::openDocument ( const QString & doc )

slot

Definition at line 1101 of file part.cpp.

bool Okular::Part::openFile ( )

protected

Definition at line 1186 of file part.cpp.

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

signal

bool Okular::Part::openUrl ( const KUrl & url )

protected

Definition at line 1343 of file part.cpp.

void Okular::Part::openUrlFromBookmarks ( const KUrl & url )

protectedslot

Definition at line 969 of file part.cpp.

void Okular::Part::openUrlFromDocument ( const KUrl & url )

protectedslot

Definition at line 954 of file part.cpp.

uint Okular::Part::pages ( )

slot

Definition at line 1107 of file part.cpp.

void Okular::Part::psTransformEnded	(	int	exit,
		QProcess::ExitStatus	status
	)

slot

Definition at line 2621 of file part.cpp.

bool Okular::Part::queryClose ( )

Definition at line 1389 of file part.cpp.

KUrl Okular::Part::realUrl ( ) const

Definition at line 891 of file part.cpp.

void Okular::Part::reload ( )

slot

Definition at line 2405 of file part.cpp.

void Okular::Part::restoreDocument ( const KConfigGroup & group )

slot

Definition at line 2602 of file part.cpp.

bool Okular::Part::saveAs ( const KUrl & saveUrl )

Definition at line 2075 of file part.cpp.

void Okular::Part::saveDocumentRestoreInfo ( KConfigGroup & group )

slot

Definition at line 2614 of file part.cpp.

bool Okular::Part::saveFile ( )

Definition at line 2023 of file part.cpp.

void Okular::Part::setReadWrite ( bool readwrite )

Definition at line 2802 of file part.cpp.

void Okular::Part::setShowSourceLocationsGraphically ( bool b )

virtual

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

Implements Okular::ViewerInterface.

Definition at line 940 of file part.cpp.

void Okular::Part::setWatchFileModeEnabled ( bool b )

virtual

Allows to enable or disable the watch file mode.

Implements Okular::ViewerInterface.

Definition at line 922 of file part.cpp.

void Okular::Part::setWindowTitleFromDocument ( )

protectedslot

Definition at line 1021 of file part.cpp.

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

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)

Implements Okular::ViewerInterface.

Definition at line 901 of file part.cpp.

void Okular::Part::slotAboutBackend ( )

protectedslot

Definition at line 2418 of file part.cpp.

void Okular::Part::slotAboutToShowContextMenu	(	KMenu *	menu,
		QAction *	action,
		QMenu *	contextMenu
	)

protectedslot

Definition at line 1947 of file part.cpp.

void Okular::Part::slotAddBookmark ( )

protectedslot

Definition at line 1904 of file part.cpp.

void Okular::Part::slotDoFileDirty ( )

slot

Definition at line 1574 of file part.cpp.

void Okular::Part::slotExportAs ( QAction * act )

protectedslot

Definition at line 2444 of file part.cpp.

void Okular::Part::slotFileDirty ( const QString & path )

slot

Definition at line 1530 of file part.cpp.

void Okular::Part::slotFind ( )

slot

Definition at line 1991 of file part.cpp.

void Okular::Part::slotFindNext ( )

protectedslot

Definition at line 2006 of file part.cpp.

void Okular::Part::slotFindPrev ( )

protectedslot

Definition at line 2015 of file part.cpp.

KConfigDialog * Okular::Part::slotGeneratorPreferences ( )

slot

Definition at line 1039 of file part.cpp.

void Okular::Part::slotGetNewStuff ( )

protectedslot

Definition at line 2166 of file part.cpp.

void Okular::Part::slotGotoFirst ( )

slot

Definition at line 1868 of file part.cpp.

void Okular::Part::slotGotoLast ( )

slot

Definition at line 1877 of file part.cpp.

void Okular::Part::slotGoToPage ( )

protectedslot

Definition at line 1846 of file part.cpp.

void Okular::Part::slotHideFindBar ( )

protectedslot

Definition at line 1796 of file part.cpp.

void Okular::Part::slotHidePresentation ( )

protectedslot

Definition at line 2387 of file part.cpp.

void Okular::Part::slotHistoryBack ( )

protectedslot

Definition at line 1892 of file part.cpp.

void Okular::Part::slotHistoryNext ( )

protectedslot

Definition at line 1898 of file part.cpp.

bool Okular::Part::slotImportPSFile ( )

protectedslot

Definition at line 1143 of file part.cpp.

void Okular::Part::slotJobFinished ( KJob * job )

protectedslot

Definition at line 996 of file part.cpp.

void Okular::Part::slotJobStarted ( KIO::Job * job )

protectedslot

Definition at line 985 of file part.cpp.

void Okular::Part::slotNewConfig ( )

protectedslot

Definition at line 2201 of file part.cpp.

void Okular::Part::slotNextBookmark ( )

protectedslot

Definition at line 1979 of file part.cpp.

void Okular::Part::slotNextPage ( )

slot

Definition at line 1861 of file part.cpp.

void Okular::Part::slotPreferences ( )

slot

Definition at line 2178 of file part.cpp.

void Okular::Part::slotPreviousBookmark ( )

protectedslot

Definition at line 1967 of file part.cpp.

void Okular::Part::slotPreviousPage ( )

slot

Definition at line 1854 of file part.cpp.

void Okular::Part::slotPrint ( )

slot

Definition at line 2498 of file part.cpp.

void Okular::Part::slotPrintPreview ( )

slot

Definition at line 2231 of file part.cpp.

void Okular::Part::slotRebuildBookmarkMenu ( )

protectedslot

Definition at line 1784 of file part.cpp.

void Okular::Part::slotReload ( )

protectedslot

Definition at line 2488 of file part.cpp.

void Okular::Part::slotRenameBookmarkFromMenu ( )

protectedslot

Definition at line 1931 of file part.cpp.

void Okular::Part::slotRenameCurrentViewportBookmark ( )

protectedslot

Definition at line 1942 of file part.cpp.

void Okular::Part::slotSaveCopyAs ( )

protectedslot

Definition at line 2120 of file part.cpp.

void Okular::Part::slotSaveFileAs ( )

protectedslot

Definition at line 2029 of file part.cpp.

void Okular::Part::slotShowBottomBar ( )

protectedslot

Definition at line 1521 of file part.cpp.

void Okular::Part::slotShowEmbeddedFiles ( )

protectedslot

Definition at line 2370 of file part.cpp.

void Okular::Part::slotShowFindBar ( )

protectedslot

Definition at line 1789 of file part.cpp.

void Okular::Part::slotShowLeftPanel ( )

protectedslot

Definition at line 1512 of file part.cpp.

void Okular::Part::slotShowMenu	(	const Okular::Page *	page,
		const QPoint &	point
	)

protectedslot

Definition at line 2265 of file part.cpp.

void Okular::Part::slotShowPresentation ( )

protectedslot

Definition at line 2378 of file part.cpp.

void Okular::Part::slotShowProperties ( )

protectedslot

Definition at line 2362 of file part.cpp.

void Okular::Part::slotTogglePresentation ( )

slot

Definition at line 2394 of file part.cpp.

void Okular::Part::startPresentation ( )

virtual

Start the presentation mode.

Implements KDocumentViewer.

Definition at line 879 of file part.cpp.

QStringList Okular::Part::supportedMimeTypes ( ) const

virtual

Return a list with the supported mimetypes.

Implements KDocumentViewer.

Definition at line 885 of file part.cpp.

void Okular::Part::updateBookmarksActions ( )

protectedslot

Definition at line 1744 of file part.cpp.

void Okular::Part::updateViewActions ( )

protectedslot

Definition at line 1659 of file part.cpp.

void Okular::Part::viewerMenuStateChange ( bool enabled )

signal

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

okular

Public Slots

Signals

Public Member Functions

Protected Slots

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

okular

kdegraphics API Reference

Search