Okular::DocumentObserver Class Reference

#include <observer.h>

Inherited by ExecuteNextActionsHelper [private].

Public Types
enum	ChangedFlags {   Pixmap = 1, Bookmark = 2, Highlights = 4, TextSelection = 8,   Annotations = 16, BoundingBox = 32, NeedSaveAs = 64 }
enum	SetupFlags { DocumentChanged = 1, NewLayoutForPages = 2, UrlChanged = 4 }

Public Member Functions
	DocumentObserver (const DocumentObserver &)=delete
virtual	~DocumentObserver ()
virtual bool	canUnloadPixmap (int page) const
virtual void	notifyContentsCleared (int flags)
virtual void	notifyCurrentPageChanged (int previous, int current)
virtual void	notifyPageChanged (int page, int flags)
virtual void	notifySetup (const QVector< Okular::Page * > &pages, int setupFlags)
virtual void	notifyViewportChanged (bool smoothMove)
virtual void	notifyVisibleRectsChanged ()
virtual void	notifyZoom (int factor)
DocumentObserver &	operator= (const DocumentObserver &)=delete

Detailed Description

Base class for objects being notified when something changes.

Inherit this class and call Document->addObserver( yourClass ) to get notified of asynchronous events (new pixmap generated, or changed, etc..).

Definition at line 28 of file observer.h.

Member Enumeration Documentation

ChangedFlags

enum Okular::DocumentObserver::ChangedFlags

Flags that can be sent from the document to all observers to inform them about the type of object that has been changed.

Enumerator
Pixmap	Pixmaps has been changed.
Bookmark	Bookmarks has been changed.
Highlights	Highlighting information has been changed.
TextSelection	Text selection has been changed.
Annotations	Annotations have been changed.
BoundingBox	Bounding boxes have been changed.
NeedSaveAs	Set when "Save" is needed or annotation/form changes will be lost. Since 0.15 (KDE 4.9) Deprecated:

Definition at line 44 of file observer.h.

SetupFlags

enum Okular::DocumentObserver::SetupFlags

...

Enumerator
DocumentChanged	The document is a new document.
NewLayoutForPages	All the pages have.
UrlChanged	The URL has changed. Since 1.3

Definition at line 57 of file observer.h.

Constructor & Destructor Documentation

~DocumentObserver()

DocumentObserver::~DocumentObserver ( )

virtual

Destroys the document observer.

Definition at line 16 of file observer.cpp.

Member Function Documentation

canUnloadPixmap()

bool DocumentObserver::canUnloadPixmap ( int  page ) const

virtual

Returns whether the observer agrees that all pixmaps for the given page can be unloaded to improve memory usage.

Returns true per default.

Definition at line 44 of file observer.cpp.

notifyContentsCleared()

void DocumentObserver::notifyContentsCleared ( int  flags )

virtual

This method is called whenever the content described by the passed flags has been cleared.

Definition at line 32 of file observer.cpp.

notifyCurrentPageChanged()

void DocumentObserver::notifyCurrentPageChanged ( int  previous, int  current  )

virtual

This method is called after the current page of the document has been entered.

Parameters

previous	The number of the previous page (is -1 for the initial page change).
current	The number of the current page.

Since

0.16 (KDE 4.10)

Definition at line 49 of file observer.cpp.

notifyPageChanged()

void DocumentObserver::notifyPageChanged ( int  page, int  flags  )

virtual

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

Definition at line 28 of file observer.cpp.

notifySetup()

void DocumentObserver::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

Definition at line 20 of file observer.cpp.

notifyViewportChanged()

void DocumentObserver::notifyViewportChanged ( bool  smoothMove )

virtual

This method is called whenever the viewport has been changed.

Parameters

smoothMove

If true, the move shall be animated.

Definition at line 24 of file observer.cpp.

notifyVisibleRectsChanged()

void DocumentObserver::notifyVisibleRectsChanged ( )

virtual

This method is called whenever the visible rects have been changed.

Definition at line 36 of file observer.cpp.

notifyZoom()

void DocumentObserver::notifyZoom ( int  factor )

virtual

This method is called whenever the zoom of the document has been changed.

Definition at line 40 of file observer.cpp.

---

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

• observer.h
• observer.cpp