okular
#include <generator.h>
Public Types | |
enum | PixmapRequestFeature { NoFeature = 0, Asynchronous = 1, Preload = 2 } |
Public Member Functions | |
PixmapRequest (DocumentObserver *observer, int pageNumber, int width, int height, int priority, PixmapRequestFeatures features) | |
~PixmapRequest () | |
bool | asynchronous () const |
int | height () const |
bool | isTile () const |
const NormalizedRect & | normalizedRect () const |
DocumentObserver * | observer () const |
Page * | page () const |
int | pageNumber () const |
bool | preload () const |
int | priority () const |
void | setNormalizedRect (const NormalizedRect &rect) |
void | setTile (bool tile) |
int | width () const |
Detailed Description
Describes a pixmap type request.
Definition at line 575 of file generator.h.
Member Enumeration Documentation
Enumerator | |
---|---|
NoFeature | |
Asynchronous | |
Preload |
Definition at line 581 of file generator.h.
Constructor & Destructor Documentation
PixmapRequest::PixmapRequest | ( | DocumentObserver * | observer, |
int | pageNumber, | ||
int | width, | ||
int | height, | ||
int | priority, | ||
PixmapRequestFeatures | features | ||
) |
Creates a new pixmap request.
- Parameters
-
observer The observer. pageNumber The page number. width The width of the page. height The height of the page. priority The priority of the request. features The features of generation.
Definition at line 462 of file generator.cpp.
PixmapRequest::~PixmapRequest | ( | ) |
Destroys the pixmap request.
Definition at line 476 of file generator.cpp.
Member Function Documentation
bool PixmapRequest::asynchronous | ( | ) | const |
Returns whether the generation should be done synchronous or asynchronous.
If asynchronous, the pixmap is created in a thread and the observer is notified when the job is done.
Definition at line 506 of file generator.cpp.
int PixmapRequest::height | ( | ) | const |
Returns the page height of the requested pixmap.
Definition at line 496 of file generator.cpp.
bool PixmapRequest::isTile | ( | ) | const |
Returns whether the generator should render just the region given by normalizedRect() or the entire page.
- Since
- 0.16 (KDE 4.10)
Definition at line 526 of file generator.cpp.
const NormalizedRect & PixmapRequest::normalizedRect | ( | ) | const |
Returns the normalized region of the page to request.
- Since
- 0.16 (KDE 4.10)
Definition at line 539 of file generator.cpp.
DocumentObserver * PixmapRequest::observer | ( | ) | const |
Returns the observer of the request.
Definition at line 481 of file generator.cpp.
Page * PixmapRequest::page | ( | ) | const |
Returns a pointer to the page where the pixmap shall be generated for.
Definition at line 516 of file generator.cpp.
int PixmapRequest::pageNumber | ( | ) | const |
Returns the page number of the request.
Definition at line 486 of file generator.cpp.
bool PixmapRequest::preload | ( | ) | const |
Returns whether the generation request is for a page that is not important i.e.
it's just for speeding up future rendering
Definition at line 511 of file generator.cpp.
int PixmapRequest::priority | ( | ) | const |
Returns the priority (less it better, 0 is maximum) of the request.
Definition at line 501 of file generator.cpp.
void PixmapRequest::setNormalizedRect | ( | const NormalizedRect & | rect | ) |
Sets the region of the page to request.
- Since
- 0.16 (KDE 4.10)
Definition at line 531 of file generator.cpp.
void PixmapRequest::setTile | ( | bool | tile | ) |
Sets whether the generator should render only the given normalized rect or the entire page.
- Since
- 0.16 (KDE 4.10)
Definition at line 521 of file generator.cpp.
int PixmapRequest::width | ( | ) | const |
Returns the page width of the requested pixmap.
Definition at line 491 of file generator.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:19:26 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.