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

okular

  • Okular
  • DocumentPrivate
Public Member Functions | Public Attributes | List of all members
Okular::DocumentPrivate Class Reference

#include <document_p.h>

Public Member Functions

 DocumentPrivate (Document *parent)
 
void _o_configChanged ()
 
void cacheExportFormats ()
 
void calculateMaxTextPages ()
 
qulonglong calculateMemoryToFree ()
 
bool canAddAnnotationsNatively () const
 
bool canModifyExternalAnnotations () const
 
bool canRemoveExternalAnnotations () const
 
void cleanupPixmapMemory ()
 
void cleanupPixmapMemory (qulonglong memoryToFree)
 
void doContinueAllDocumentSearch (void *pagesToNotifySet, void *pageMatchesMap, int currentPage, int searchID, const QString &text, int caseSensitivity, const QColor &color)
 
void doContinueDirectionMatchSearch (void *doContinueDirectionMatchSearchStruct)
 
void doContinueGooglesDocumentSearch (void *pagesToNotifySet, void *pageMatchesMap, int currentPage, int searchID, const QStringList &words, int caseSensitivity, const QColor &color, bool matchAll)
 
QVariant documentMetaData (const QString &key, const QVariant &option) const
 
void doProcessSearchMatch (RegularAreaRect *match, RunningSearch *search, QSet< int > *pagesToNotify, int currentPage, int searchID, bool moveViewport, const QColor &color)
 
void fontReadingGotFont (const Okular::FontInfo &font)
 
void fontReadingProgress (int page)
 
ConfigInterface * generatorConfig (GeneratorInfo &info)
 
SaveInterface * generatorSave (GeneratorInfo &info)
 
qulonglong getFreeMemory (qulonglong *freeSwap=0)
 
qulonglong getTotalMemory ()
 
QString giveAbsolutePath (const QString &fileName) const
 
void loadAllGeneratorLibraries ()
 
void loadDocumentInfo ()
 
void loadDocumentInfo (const QString &fileName)
 
Generator * loadGeneratorLibrary (const KService::Ptr &service)
 
void loadServiceList (const KService::List &offers)
 
void loadViewsInfo (View *view, const QDomElement &e)
 
QString localizedSize (const QSizeF &size) const
 
QString namePaperSize (double inchesWidth, double inchesHeight) const
 
DocumentViewport nextDocumentViewport () const
 
void notifyAnnotationChanges (int page)
 
bool openDocumentInternal (const KService::Ptr &offer, bool isstdin, const QString &docFile, const QByteArray &filedata)
 
bool openRelativeFile (const QString &fileName)
 
QString pagesSizeString () const
 
void performAddPageAnnotation (int page, Annotation *annotation)
 
void performModifyPageAnnotation (int page, Annotation *annotation, bool appearanceChanged)
 
void performRemovePageAnnotation (int page, Annotation *annotation)
 
void performSetAnnotationContents (const QString &newContents, Annotation *annot, int pageNumber)
 
void refreshPixmaps (int)
 
void requestDone (PixmapRequest *request)
 
void rotationFinished (int page, Okular::Page *okularPage)
 
void saveDocumentInfo () const
 
bool savePageDocumentInfo (KTemporaryFile *infoFile, int what) const
 
void saveViewsInfo (View *view, QDomElement &e) const
 
AllocatedPixmap * searchLowestPriorityPixmap (bool unloadableOnly=false, bool thenRemoveIt=false, DocumentObserver *observer=0)
 
void sendGeneratorPixmapRequest ()
 
void setPageBoundingBox (int page, const NormalizedRect &boundingBox)
 
void setRotationInternal (int r, bool notify)
 
void slotGeneratorConfigChanged (const QString &)
 
void slotTimedMemoryCheck ()
 
void textGenerationDone (Page *page)
 
void unloadGenerator (const GeneratorInfo &info)
 
void warnLimitedAnnotSupport ()
 

Public Attributes

QLinkedList< AllocatedPixmap * > m_allocatedPixmaps
 
qulonglong m_allocatedPixmapsTotalMemory
 
QList< int > m_allocatedTextPagesFifo
 
bool m_annotationBeingMoved
 
bool m_annotationEditingEnabled
 
bool m_annotationsNeedSaveAs
 
ArchiveData * m_archiveData
 
QString m_archivedFileName
 
BookmarkManager * m_bookmarkManager
 
QEventLoop * m_closingLoop
 
QString m_docFileName
 
qint64 m_docSize
 
DocumentInfo * m_documentInfo
 
QLinkedList< PixmapRequest * > m_executingPixmapRequests
 
bool m_exportCached
 
ExportFormat::List m_exportFormats
 
ExportFormat m_exportToText
 
FontInfo::List m_fontsCache
 
bool m_fontsCached
 
QPointer< FontExtractionThread > m_fontThread
 
Generator * m_generator
 
QString m_generatorName
 
bool m_generatorsLoaded
 
int m_lastSearchID
 
QHash< QString, GeneratorInfo > m_loadedGenerators
 
int m_maxAllocatedTextPages
 
QTimer * m_memCheckTimer
 
QString m_nextDocumentDestination
 
DocumentViewport m_nextDocumentViewport
 
QSet< DocumentObserver * > m_observers
 
PageController * m_pageController
 
QVector< VisiblePageRect * > m_pageRects
 
PageSize m_pageSize
 
PageSize::List m_pageSizes
 
QVector< Page * > m_pagesVector
 
Document * m_parent
 
QMutex m_pixmapRequestsMutex
 
QLinkedList< PixmapRequest * > m_pixmapRequestsStack
 
QDomNode m_prevPropsOfAnnotBeingModified
 
Rotation m_rotation
 
QTimer * m_saveBookmarksTimer
 
Scripter * m_scripter
 
bool m_searchCancelled
 
QMap< int, RunningSearch * > m_searches
 
bool m_showWarningLimitedAnnotSupport
 
QStringList m_supportedMimeTypes
 
KTemporaryFile * m_tempFile
 
DocumentObserver * m_tiledObserver
 
QUndoStack * m_undoStack
 
KUrl m_url
 
QLinkedList< DocumentViewport > m_viewportHistory
 
QLinkedList< DocumentViewport >
::iterator 
m_viewportIterator
 
QSet< View * > m_views
 
bool m_warnedOutOfMemory
 
QPointer< QWidget > m_widget
 
QString m_xmlFileName
 

Detailed Description

Definition at line 83 of file document_p.h.

Constructor & Destructor Documentation

Okular::DocumentPrivate::DocumentPrivate ( Document *  parent)
inline

Definition at line 86 of file document_p.h.

Member Function Documentation

void DocumentPrivate::_o_configChanged ( )

Definition at line 1599 of file document.cpp.

void DocumentPrivate::cacheExportFormats ( )

Definition at line 851 of file document.cpp.

void DocumentPrivate::calculateMaxTextPages ( )

Definition at line 4385 of file document.cpp.

qulonglong DocumentPrivate::calculateMemoryToFree ( )

Definition at line 283 of file document.cpp.

bool DocumentPrivate::canAddAnnotationsNatively ( ) const

Definition at line 3042 of file document.cpp.

bool DocumentPrivate::canModifyExternalAnnotations ( ) const

Definition at line 3053 of file document.cpp.

bool DocumentPrivate::canRemoveExternalAnnotations ( ) const

Definition at line 3064 of file document.cpp.

void DocumentPrivate::cleanupPixmapMemory ( )

Definition at line 326 of file document.cpp.

void DocumentPrivate::cleanupPixmapMemory ( qulonglong  memoryToFree)

Definition at line 331 of file document.cpp.

void DocumentPrivate::doContinueAllDocumentSearch ( void *  pagesToNotifySet,
void *  pageMatchesMap,
int  currentPage,
int  searchID,
const QString &  text,
int  caseSensitivity,
const QColor &  color 
)

Definition at line 1729 of file document.cpp.

void DocumentPrivate::doContinueDirectionMatchSearch ( void *  doContinueDirectionMatchSearchStruct)

Definition at line 1610 of file document.cpp.

void DocumentPrivate::doContinueGooglesDocumentSearch ( void *  pagesToNotifySet,
void *  pageMatchesMap,
int  currentPage,
int  searchID,
const QStringList &  words,
int  caseSensitivity,
const QColor &  color,
bool  matchAll 
)

Definition at line 1817 of file document.cpp.

QVariant DocumentPrivate::documentMetaData ( const QString &  key,
const QVariant &  option 
) const

Request a particular metadata of the Document itself (ie, not something depending on the document type/backend).

Definition at line 1938 of file document.cpp.

void DocumentPrivate::doProcessSearchMatch ( RegularAreaRect *  match,
RunningSearch *  search,
QSet< int > *  pagesToNotify,
int  currentPage,
int  searchID,
bool  moveViewport,
const QColor &  color 
)

Definition at line 1679 of file document.cpp.

void DocumentPrivate::fontReadingGotFont ( const Okular::FontInfo &  font)

Definition at line 1497 of file document.cpp.

void DocumentPrivate::fontReadingProgress ( int  page)

Definition at line 1485 of file document.cpp.

ConfigInterface * DocumentPrivate::generatorConfig ( GeneratorInfo &  info)

Definition at line 868 of file document.cpp.

SaveInterface * DocumentPrivate::generatorSave ( GeneratorInfo &  info)

Definition at line 878 of file document.cpp.

qulonglong DocumentPrivate::getFreeMemory ( qulonglong *  freeSwap = 0)

Definition at line 484 of file document.cpp.

qulonglong DocumentPrivate::getTotalMemory ( )

Definition at line 448 of file document.cpp.

QString DocumentPrivate::giveAbsolutePath ( const QString &  fileName) const

Definition at line 775 of file document.cpp.

void DocumentPrivate::loadAllGeneratorLibraries ( )

Definition at line 815 of file document.cpp.

void DocumentPrivate::loadDocumentInfo ( )

Definition at line 590 of file document.cpp.

void DocumentPrivate::loadDocumentInfo ( const QString &  fileName)

Definition at line 601 of file document.cpp.

Generator * DocumentPrivate::loadGeneratorLibrary ( const KService::Ptr &  service)

Definition at line 798 of file document.cpp.

void DocumentPrivate::loadServiceList ( const KService::List &  offers)

Definition at line 827 of file document.cpp.

void DocumentPrivate::loadViewsInfo ( View *  view,
const QDomElement &  e 
)

Definition at line 719 of file document.cpp.

QString DocumentPrivate::localizedSize ( const QSizeF &  size) const

Definition at line 260 of file document.cpp.

QString DocumentPrivate::namePaperSize ( double  inchesWidth,
double  inchesHeight 
) const

Ledger and Tabloid are the same, just rotated by 90 degrees

Definition at line 159 of file document.cpp.

DocumentViewport DocumentPrivate::nextDocumentViewport ( ) const

Definition at line 1002 of file document.cpp.

void DocumentPrivate::notifyAnnotationChanges ( int  page)

Definition at line 2909 of file document.cpp.

bool DocumentPrivate::openDocumentInternal ( const KService::Ptr &  offer,
bool  isstdin,
const QString &  docFile,
const QByteArray &  filedata 
)

Definition at line 888 of file document.cpp.

bool DocumentPrivate::openRelativeFile ( const QString &  fileName)

Definition at line 786 of file document.cpp.

QString DocumentPrivate::pagesSizeString ( ) const

Definition at line 144 of file document.cpp.

void DocumentPrivate::performAddPageAnnotation ( int  page,
Annotation *  annotation 
)

Definition at line 1035 of file document.cpp.

void DocumentPrivate::performModifyPageAnnotation ( int  page,
Annotation *  annotation,
bool  appearanceChanged 
)

Definition at line 1106 of file document.cpp.

void DocumentPrivate::performRemovePageAnnotation ( int  page,
Annotation *  annotation 
)

Definition at line 1068 of file document.cpp.

void DocumentPrivate::performSetAnnotationContents ( const QString &  newContents,
Annotation *  annot,
int  pageNumber 
)

Definition at line 1150 of file document.cpp.

void DocumentPrivate::refreshPixmaps ( int  pageNumber)

Definition at line 1546 of file document.cpp.

void DocumentPrivate::requestDone ( PixmapRequest *  request)

This method is used by the generators to signal the finish of the pixmap generation request.

Definition at line 4294 of file document.cpp.

void DocumentPrivate::rotationFinished ( int  page,
Okular::Page *  okularPage 
)

Definition at line 1475 of file document.cpp.

void DocumentPrivate::saveDocumentInfo ( ) const

Definition at line 1186 of file document.cpp.

bool DocumentPrivate::savePageDocumentInfo ( KTemporaryFile *  infoFile,
int  what 
) const

Definition at line 972 of file document.cpp.

void DocumentPrivate::saveViewsInfo ( View *  view,
QDomElement &  e 
) const

Definition at line 752 of file document.cpp.

AllocatedPixmap * DocumentPrivate::searchLowestPriorityPixmap ( bool  unloadableOnly = false,
bool  thenRemoveIt = false,
DocumentObserver *  observer = 0 
)

Definition at line 413 of file document.cpp.

void DocumentPrivate::sendGeneratorPixmapRequest ( )

Definition at line 1283 of file document.cpp.

void DocumentPrivate::setPageBoundingBox ( int  page,
const NormalizedRect &  boundingBox 
)

Sets the bounding box of the given page (in terms of upright orientation, i.e., Rotation0).

Definition at line 4365 of file document.cpp.

void DocumentPrivate::setRotationInternal ( int  r,
bool  notify 
)

Definition at line 4431 of file document.cpp.

void DocumentPrivate::slotGeneratorConfigChanged ( const QString &  )

Definition at line 1505 of file document.cpp.

void DocumentPrivate::slotTimedMemoryCheck ( )

Definition at line 1275 of file document.cpp.

void DocumentPrivate::textGenerationDone ( Page *  page)

Definition at line 4408 of file document.cpp.

void DocumentPrivate::unloadGenerator ( const GeneratorInfo &  info)

Definition at line 846 of file document.cpp.

void DocumentPrivate::warnLimitedAnnotSupport ( )

Definition at line 1016 of file document.cpp.

Member Data Documentation

QLinkedList< AllocatedPixmap * > Okular::DocumentPrivate::m_allocatedPixmaps

Definition at line 219 of file document_p.h.

qulonglong Okular::DocumentPrivate::m_allocatedPixmapsTotalMemory

Definition at line 220 of file document_p.h.

QList< int > Okular::DocumentPrivate::m_allocatedTextPagesFifo

Definition at line 221 of file document_p.h.

bool Okular::DocumentPrivate::m_annotationBeingMoved

Definition at line 272 of file document_p.h.

bool Okular::DocumentPrivate::m_annotationEditingEnabled

Definition at line 270 of file document_p.h.

bool Okular::DocumentPrivate::m_annotationsNeedSaveAs

Definition at line 271 of file document_p.h.

ArchiveData* Okular::DocumentPrivate::m_archiveData

Definition at line 260 of file document_p.h.

QString Okular::DocumentPrivate::m_archivedFileName

Definition at line 261 of file document_p.h.

BookmarkManager* Okular::DocumentPrivate::m_bookmarkManager

Definition at line 239 of file document_p.h.

QEventLoop* Okular::DocumentPrivate::m_closingLoop

Definition at line 256 of file document_p.h.

QString Okular::DocumentPrivate::m_docFileName

Definition at line 200 of file document_p.h.

qint64 Okular::DocumentPrivate::m_docSize

Definition at line 203 of file document_p.h.

DocumentInfo* Okular::DocumentPrivate::m_documentInfo

Definition at line 265 of file document_p.h.

QLinkedList< PixmapRequest * > Okular::DocumentPrivate::m_executingPixmapRequests

Definition at line 217 of file document_p.h.

bool Okular::DocumentPrivate::m_exportCached

Definition at line 234 of file document_p.h.

ExportFormat::List Okular::DocumentPrivate::m_exportFormats

Definition at line 235 of file document_p.h.

ExportFormat Okular::DocumentPrivate::m_exportToText

Definition at line 236 of file document_p.h.

FontInfo::List Okular::DocumentPrivate::m_fontsCache

Definition at line 266 of file document_p.h.

bool Okular::DocumentPrivate::m_fontsCached

Definition at line 264 of file document_p.h.

QPointer< FontExtractionThread > Okular::DocumentPrivate::m_fontThread

Definition at line 263 of file document_p.h.

Generator* Okular::DocumentPrivate::m_generator

Definition at line 246 of file document_p.h.

QString Okular::DocumentPrivate::m_generatorName

Definition at line 247 of file document_p.h.

bool Okular::DocumentPrivate::m_generatorsLoaded

Definition at line 248 of file document_p.h.

int Okular::DocumentPrivate::m_lastSearchID

Definition at line 192 of file document_p.h.

QHash<QString, GeneratorInfo> Okular::DocumentPrivate::m_loadedGenerators

Definition at line 245 of file document_p.h.

int Okular::DocumentPrivate::m_maxAllocatedTextPages

Definition at line 222 of file document_p.h.

QTimer* Okular::DocumentPrivate::m_memCheckTimer

Definition at line 242 of file document_p.h.

QString Okular::DocumentPrivate::m_nextDocumentDestination

Definition at line 209 of file document_p.h.

DocumentViewport Okular::DocumentPrivate::m_nextDocumentViewport

Definition at line 208 of file document_p.h.

QSet< DocumentObserver * > Okular::DocumentPrivate::m_observers

Definition at line 212 of file document_p.h.

PageController* Okular::DocumentPrivate::m_pageController

Definition at line 255 of file document_p.h.

QVector< VisiblePageRect * > Okular::DocumentPrivate::m_pageRects

Definition at line 250 of file document_p.h.

PageSize Okular::DocumentPrivate::m_pageSize

Definition at line 230 of file document_p.h.

PageSize::List Okular::DocumentPrivate::m_pageSizes

Definition at line 231 of file document_p.h.

QVector< Page * > Okular::DocumentPrivate::m_pagesVector

Definition at line 249 of file document_p.h.

Document* Okular::DocumentPrivate::m_parent

Definition at line 187 of file document_p.h.

QMutex Okular::DocumentPrivate::m_pixmapRequestsMutex

Definition at line 218 of file document_p.h.

QLinkedList< PixmapRequest * > Okular::DocumentPrivate::m_pixmapRequestsStack

Definition at line 216 of file document_p.h.

QDomNode Okular::DocumentPrivate::m_prevPropsOfAnnotBeingModified

Definition at line 276 of file document_p.h.

Rotation Okular::DocumentPrivate::m_rotation

Definition at line 226 of file document_p.h.

QTimer* Okular::DocumentPrivate::m_saveBookmarksTimer

Definition at line 243 of file document_p.h.

Scripter* Okular::DocumentPrivate::m_scripter

Definition at line 258 of file document_p.h.

bool Okular::DocumentPrivate::m_searchCancelled

Definition at line 193 of file document_p.h.

QMap< int, RunningSearch * > Okular::DocumentPrivate::m_searches

Definition at line 191 of file document_p.h.

bool Okular::DocumentPrivate::m_showWarningLimitedAnnotSupport

Definition at line 273 of file document_p.h.

QStringList Okular::DocumentPrivate::m_supportedMimeTypes

Definition at line 253 of file document_p.h.

KTemporaryFile* Okular::DocumentPrivate::m_tempFile

Definition at line 202 of file document_p.h.

DocumentObserver* Okular::DocumentPrivate::m_tiledObserver

Definition at line 215 of file document_p.h.

QUndoStack* Okular::DocumentPrivate::m_undoStack

Definition at line 275 of file document_p.h.

KUrl Okular::DocumentPrivate::m_url

Definition at line 197 of file document_p.h.

QLinkedList< DocumentViewport > Okular::DocumentPrivate::m_viewportHistory

Definition at line 206 of file document_p.h.

QLinkedList< DocumentViewport >::iterator Okular::DocumentPrivate::m_viewportIterator

Definition at line 207 of file document_p.h.

QSet< View * > Okular::DocumentPrivate::m_views

Definition at line 268 of file document_p.h.

bool Okular::DocumentPrivate::m_warnedOutOfMemory

Definition at line 223 of file document_p.h.

QPointer<QWidget> Okular::DocumentPrivate::m_widget

Definition at line 188 of file document_p.h.

QString Okular::DocumentPrivate::m_xmlFileName

Definition at line 201 of file document_p.h.


The documentation for this class was generated from the following files:
  • document_p.h
  • document.cpp
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