Okular::DocumentObserver

Search for usage in LXR

Okular::DocumentObserver Class Reference

#include <observer.h>

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)
 
DocumentObserveroperator= (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 31 of file observer.h.

Member Enumeration Documentation

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 47 of file observer.h.

...

Enumerator
DocumentChanged 

The document is a new document.

NewLayoutForPages 

All the pages have.

UrlChanged 

The URL has changed.

Since
1.3

Definition at line 60 of file observer.h.

Constructor & Destructor Documentation

DocumentObserver::~DocumentObserver ( )
virtual

Destroys the document observer.

Definition at line 19 of file observer.cpp.

Member Function Documentation

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 47 of file observer.cpp.

void DocumentObserver::notifyContentsCleared ( int  flags)
virtual

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

Definition at line 35 of file observer.cpp.

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

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

Parameters
previousThe number of the previous page (is -1 for the initial page change).
currentThe number of the current page.
Since
0.16 (KDE 4.10)

Definition at line 52 of file observer.cpp.

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 31 of file observer.cpp.

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

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

Parameters
pagesThe vector of pages of the document.
setupFlagsthe flags with the information about the setup

Definition at line 23 of file observer.cpp.

void DocumentObserver::notifyViewportChanged ( bool  smoothMove)
virtual

This method is called whenever the viewport has been changed.

Parameters
smoothMoveIf true, the move shall be animated.

Definition at line 27 of file observer.cpp.

void DocumentObserver::notifyVisibleRectsChanged ( )
virtual

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

Definition at line 39 of file observer.cpp.

void DocumentObserver::notifyZoom ( int  factor)
virtual

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

Definition at line 43 of file observer.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed May 12 2021 22:35:30 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.