Okular::PixmapRequest

Search for usage in LXR

Okular::PixmapRequest Class Reference

#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, qreal dpr, int priority, PixmapRequestFeatures features)
 
 ~PixmapRequest ()
 
bool asynchronous () const
 
int height () const
 
bool isTile () const
 
const NormalizedRectnormalizedRect () const
 
DocumentObserverobserver () const
 
Pagepage () 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.

Member Typedef Documentation

◆ PixmapRequestFeatures

typedef QFlags< PixmapRequestFeature > Okular::PixmapRequest::PixmapRequestFeatures

Definition at line 617 of file generator.h.

Member Enumeration Documentation

◆ PixmapRequestFeature

enum Okular::PixmapRequest::PixmapRequestFeature

Definition at line 616 of file generator.h.

Constructor & Destructor Documentation

◆ PixmapRequest()

PixmapRequest::PixmapRequest ( DocumentObserver * observer,
int pageNumber,
int width,
int height,
qreal dpr,
int priority,
PixmapRequestFeatures features )

Creates a new pixmap request.

Parameters
observerThe observer.
pageNumberThe page number.
widthThe width of the page in logical pixels.
heightThe height of the page in logical pixels.
dprDevice pixel ratio of the screen that the pixmap is intended for.
priorityThe priority of the request.
featuresThe features of generation.

Definition at line 564 of file generator.cpp.

◆ ~PixmapRequest()

PixmapRequest::~PixmapRequest ( )

Destroys the pixmap request.

Definition at line 580 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 610 of file generator.cpp.

◆ height()

int PixmapRequest::height ( ) const

Returns the page height of the requested pixmap.

Definition at line 600 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 630 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 644 of file generator.cpp.

◆ observer()

DocumentObserver * PixmapRequest::observer ( ) const

Returns the observer of the request.

Definition at line 585 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 620 of file generator.cpp.

◆ pageNumber()

int PixmapRequest::pageNumber ( ) const

Returns the page number of the request.

Definition at line 590 of file generator.cpp.

◆ partialUpdatesWanted()

bool PixmapRequest::partialUpdatesWanted ( ) const

Should the request report back updates if possible?

Since
1.3

Definition at line 654 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 615 of file generator.cpp.

◆ priority()

int PixmapRequest::priority ( ) const

Returns the priority (less it better, 0 is maximum) of the request.

Definition at line 605 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 635 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 649 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 625 of file generator.cpp.

◆ shouldAbortRender()

bool PixmapRequest::shouldAbortRender ( ) const

Should the request be aborted if possible?

Since
1.4

Definition at line 659 of file generator.cpp.

◆ width()

int PixmapRequest::width ( ) const

Returns the page width of the requested pixmap.

Definition at line 595 of file generator.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sun Feb 25 2024 18:44:05 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.