Okular::PixmapRequest
#include <generator.h>
Public Types | |
enum | PixmapRequestFeature { NoFeature = 0, Asynchronous = 1, Preload = 2 } |
typedef QFlags< PixmapRequestFeature > | PixmapRequestFeatures |
Public Member Functions | |
PixmapRequest (DocumentObserver *observer, int pageNumber, int width, int height, int priority, PixmapRequestFeatures features) | |
PixmapRequest (DocumentObserver *observer, int pageNumber, int width, int height, qreal dpr, 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 | partialUpdatesWanted () const |
bool | preload () const |
int | priority () const |
void | setNormalizedRect (const NormalizedRect &rect) |
void | setPartialUpdatesWanted (bool partialUpdatesWanted) |
void | setTile (bool tile) |
bool | shouldAbortRender () const |
int | width () const |
Detailed Description
Describes a pixmap type request.
Definition at line 610 of file generator.h.
Constructor & Destructor Documentation
◆ PixmapRequest() [1/2]
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 in logical pixels. height The height of the page in logical pixels. priority The priority of the request. features The features of generation.
Definition at line 562 of file generator.cpp.
◆ PixmapRequest() [2/2]
PixmapRequest::PixmapRequest | ( | DocumentObserver * | observer, |
int | pageNumber, | ||
int | width, | ||
int | height, | ||
qreal | dpr, | ||
int | priority, | ||
PixmapRequestFeatures | features | ||
) |
Creates a new pixmap request.
- Parameters
-
observer The observer. pageNumber The page number. width The width of the page in logical pixels. height The height of the page in logical pixels. dpr Device pixel ratio of the screen that the pixmap is intended for. priority The priority of the request. features The features of generation.
Definition at line 567 of file generator.cpp.
◆ ~PixmapRequest()
PixmapRequest::~PixmapRequest | ( | ) |
Destroys the pixmap request.
Definition at line 583 of file generator.cpp.
Member Function Documentation
◆ asynchronous()
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 613 of file generator.cpp.
◆ height()
int PixmapRequest::height | ( | ) | const |
Returns the page height of the requested pixmap.
Definition at line 603 of file generator.cpp.
◆ isTile()
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 633 of file generator.cpp.
◆ normalizedRect()
const NormalizedRect & PixmapRequest::normalizedRect | ( | ) | const |
Returns the normalized region of the page to request.
- Since
- 0.16 (KDE 4.10)
Definition at line 647 of file generator.cpp.
◆ observer()
DocumentObserver * PixmapRequest::observer | ( | ) | const |
Returns the observer of the request.
Definition at line 588 of file generator.cpp.
◆ page()
Page * PixmapRequest::page | ( | ) | const |
Returns a pointer to the page where the pixmap shall be generated for.
Definition at line 623 of file generator.cpp.
◆ pageNumber()
int PixmapRequest::pageNumber | ( | ) | const |
Returns the page number of the request.
Definition at line 593 of file generator.cpp.
◆ partialUpdatesWanted()
bool PixmapRequest::partialUpdatesWanted | ( | ) | const |
Should the request report back updates if possible?
- Since
- 1.3
Definition at line 657 of file generator.cpp.
◆ preload()
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 618 of file generator.cpp.
◆ priority()
int PixmapRequest::priority | ( | ) | const |
Returns the priority (less it better, 0 is maximum) of the request.
Definition at line 608 of file generator.cpp.
◆ setNormalizedRect()
void PixmapRequest::setNormalizedRect | ( | const NormalizedRect & | rect | ) |
Sets the region of the page to request.
- Since
- 0.16 (KDE 4.10)
Definition at line 638 of file generator.cpp.
◆ setPartialUpdatesWanted()
void PixmapRequest::setPartialUpdatesWanted | ( | bool | partialUpdatesWanted | ) |
Sets whether the request should report back updates if possible.
- Since
- 1.3
Definition at line 652 of file generator.cpp.
◆ setTile()
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 628 of file generator.cpp.
◆ shouldAbortRender()
bool PixmapRequest::shouldAbortRender | ( | ) | const |
◆ width()
int PixmapRequest::width | ( | ) | const |
Returns the page width of the requested pixmap.
Definition at line 598 of file generator.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 04:08:33 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.