QPdfPageRenderer Class
QPdfPageRenderer クラスは、PDF ドキュメントのページのレンダリングをカプセル化します。詳細...
Header: | #include <QPdfPageRenderer> |
Inherits: | QObject |
パブリックな型
enum class | RenderMode { MultiThreaded, SingleThreaded } |
プロパティ
- document : QPdfDocument*
- renderMode : RenderMode
パブリック関数
QPdfPageRenderer(QObject *parent) | |
virtual | ~QPdfPageRenderer() override |
QPdfDocument * | document() const |
QPdfPageRenderer::RenderMode | renderMode() const |
quint64 | requestPage(int pageNumber, QSize imageSize, QPdfDocumentRenderOptions options = QPdfDocumentRenderOptions()) |
void | setDocument(QPdfDocument *document) |
void | setRenderMode(QPdfPageRenderer::RenderMode mode) |
シグナル
void | documentChanged(QPdfDocument *document) |
void | renderModeChanged(QPdfPageRenderer::RenderMode renderMode) |
詳細な説明
QPdfPageRenderer には、requestPage() を通して呼び出されたすべてのレンダリング要求を収集するキューがあります。設定されているRenderMode に応じて、QPdfPageRenderer はこのキューを次のイベントループの呼び出し時にメイン UI スレッド (RenderMode::SingleThreaded
) あるいは別のワーカースレッド (RenderMode::MultiThreaded
) で処理し、レンダリングが完了すると各リクエストの pageRendered() シグナルで結果を返します。
QPdfDocumentも参照してください 。
メンバ型ドキュメント
enum class QPdfPageRenderer::RenderMode
この列挙型は、ページがどのようにレンダリングされるかを記述します。
定数 | 値 | 説明 |
---|---|---|
QPdfPageRenderer::RenderMode::MultiThreaded | 0 | すべてのページは別のワーカースレッドでレンダリングされます。 |
QPdfPageRenderer::RenderMode::SingleThreaded | 1 | すべてのページはメイン UI スレッドでレンダリングされます (デフォルト)。 |
renderMode() およびsetRenderMode()も参照してください 。
プロパティ Documentation
document : QPdfDocument*
このプロパティは、このオブジェクトがページをレンダリングするドキュメントインスタンスを保持します。
デフォルトでは、このプロパティはnullptr
です。
アクセス関数:
QPdfDocument * | document() const |
void | setDocument(QPdfDocument *document) |
Notifier シグナル:
void | documentChanged(QPdfDocument *document) |
document()、setDocument()、QPdfDocumentも参照 。
renderMode : RenderMode
このプロパティは、レンダラーがページのレンダリングに使用するモードを保持する。
デフォルトでは、このプロパティはRenderMode::SingleThreaded
です。
アクセス関数:
QPdfPageRenderer::RenderMode | renderMode() const |
void | setRenderMode(QPdfPageRenderer::RenderMode mode) |
通知シグナル:
void | renderModeChanged(QPdfPageRenderer::RenderMode renderMode) |
setRenderMode() およびRenderModeも参照 。
メンバ関数ドキュメント
[explicit]
QPdfPageRenderer::QPdfPageRenderer(QObject *parent)
親オブジェクトparent を持つページレンダラオブジェクトを構築します。
[override virtual noexcept]
QPdfPageRenderer::~QPdfPageRenderer()
ページレンダラオブジェクトを破棄します。
QPdfDocument *QPdfPageRenderer::document() const
このオブジェクトがページをレンダリングするドキュメントを返すか、または以前に何も設定されていない場合はnullptr
を返します。
注意: プロパティ document のゲッター関数です。
setDocument() およびQPdfDocumentも参照してください 。
QPdfPageRenderer::RenderMode QPdfPageRenderer::renderMode() const
ページがどのようにレンダリングされるかのモードを返します。
注: プロパティ renderMode のゲッター関数。
setRenderMode() およびRenderMode も参照 。
quint64 QPdfPageRenderer::requestPage(int pageNumber, QSize imageSize, QPdfDocumentRenderOptions options = QPdfDocumentRenderOptions())
指定されたoptions に従って、ページpageNumber をサイズimageSize のQImage にレンダリングするようレンダラーに要求します。
レンダリングが完了すると、結果をパラメータとして pageRendered() シグナルが発行される。
戻り値は、レンダーリクエストを一意に識別するIDである。同じパラメータを持つリクエストがまだキューに残っている場合、そのキューに入れられたリクエストのIDが返される。
void QPdfPageRenderer::setDocument(QPdfDocument *document)
このオブジェクトがページをレンダリングするdocument を設定します。
注: プロパティdocument のセッター関数です。
document() およびQPdfDocumentも参照してください 。
void QPdfPageRenderer::setRenderMode(QPdfPageRenderer::RenderMode mode)
ページのレンダリング方法のモードをmode に設定する。
備考: プロパティrenderMode に対するセッター関数。
renderMode() およびRenderModeも参照して ください。
本ドキュメントに含まれる文書の著作権は、それぞれの所有者に帰属します。 本書で提供されるドキュメントは、Free Software Foundation が発行したGNU Free Documentation License version 1.3に基づいてライセンスされています。 Qtおよびそれぞれのロゴは、フィンランドおよびその他の国におけるThe Qt Company Ltd.の 商標です。その他すべての商標は、それぞれの所有者に帰属します。