QPrinter Class

メンバ関数ドキュメント

[explicit] QPrinter::QPrinter(QPrinter::PrinterMode mode = ScreenResolution)

与えられたmode で新しいプリンタオブジェクトを作成します。

[explicit] QPrinter::QPrinter(const QPrinterInfo &printer, QPrinter::PrinterMode mode = ScreenResolution)

与えられたprinter とmode で新しいプリンタオブジェクトを作成します。

[virtual noexcept] QPrinter::~QPrinter()

プリンタオブジェクトを破棄し、割り当てられたリソースを解放します。印刷ジョブの実行中にプリンターが破壊された場合、印刷ジョブに影響を与える場合もあれば、与えない場合もあります。

bool QPrinter::abort()

現在の印刷実行を中止します。印刷が正常に中止された場合はtrue を返し、printerState() はQPrinter::Aborted を返します ; それ以外の場合はfalse を返します。

印刷ジョブを中止できるとは限りません。たとえば、すべてのデータがプリンタに送信されたが、プリンタがジョブをキャンセルするように要求してもできない、またはキャンセルしない場合などである。

bool QPrinter::collateCopies() const

複数部数を選択したときに照合順序がオンになっている場合は、true を返す。複数部数を選択したときに照合がオフになっている場合は、false を返す。丁合がオフの場合、各ページの印刷は、次のページを開始する前に numCopies()分だけ繰り返される。丁合をオンにすると、次のページのコピーが開始される前に、すべてのページが印刷されます。

setCollateCopies()も参照 。

QPrinter::ColorMode QPrinter::colorMode() const

現在のカラーモードを返します。

setColorMode() も参照 。

int QPrinter::copyCount() const

copy関数は、印刷部数を返します。デフォルト値は 1 です。

setCopyCount() およびsupportsMultipleCopies() も参照 。

QString QPrinter::creator() const

アプリケーション名 ドキュメントを作成したアプリケーションの名前を返します。

setCreator() も参照 。

QString QPrinter::docName() const

ドキュメント名を返します。

setDocName() およびQPrintEngine::PrintEnginePropertyKey も参照 。

QPrinter::DuplexMode QPrinter::duplex() const

現在の二重モードを返します。

setDuplex() も参照して ください。

bool QPrinter::fontEmbeddingEnabled() const

フォント埋め込みが有効な場合はtrue を返します。

setFontEmbeddingEnabled()も参照 。

int QPrinter::fromPage() const

fromページ番号： 印刷するページの範囲における最初のページの番号を返します (「fromページ」設定)。文書内のページは、最初のページが 1 ページであるという慣例に従って番号付けされます。

デフォルトでは、この関数は "from page "設定が未設定であることを意味する特別な値0を返します。

setFromTo()、toPage()、pageRanges()も参照 。

bool QPrinter::fullPage() const

プリンタの座標系の原点がページの隅にある場合はtrue を返し、 印刷可能領域の端にある場合は false を返す。

詳細と注意点についてはsetFullPage() を参照。

setFullPage() およびQPagedPaintDevice::pageLayout()も参照 。

bool QPrinter::isValid() const

現在選択 さ れてい る プ リ ン タ がシ ス テ ム内で有効なプ リ ン タ であ る か、 ま たは純粋な PDF プ リ ン タ であ る な らtrue を返し、 そ う でないな らfalse を返します。

それ以外の失敗を検出するには、QPainter::begin() またはQPrinter::newPage() の出力をチェックしてください。

    QPrinter printer;
    printer.setOutputFormat(QPrinter::PdfFormat);
    printer.setOutputFileName("/foobar/nonwritable.pdf");
    QPainter painter;
    if (! painter.begin(&printer)) { // failed to open file
        qWarning("failed to open file, is it writable?");
        return 1;
    }
    painter.drawText(10, 10, "Test");
    if (! printer.newPage()) {
        qWarning("failed in flushing page to disk, disk full?");
        return 1;
    }
    painter.drawText(10, 10, "Test 2");
    painter.end();

setPrinterName()も参照 。

[override virtual] bool QPrinter::newPage()

再インプリメント：QPagedPaintDevice::newPage().

プ リ ン タ に、 カ レ ン ト ページ を排出 し て新 し いページで印刷を続行す る よ う 指示 し ます。成功した場合はtrue を返し、失敗した場合はfalse を返す。

アクティブでないQPrinter オブジェクトに対して newPage() を呼び出すと、常に失敗します。

QString QPrinter::outputFileName() const

出力ファイル名を返す。デフォルトでは、これは空文字列です（プリンタがファイルに印刷すべきでないことを示します）。

setOutputFileName() およびQPrintEngine::PrintEnginePropertyKeyも参照のこと 。

QPrinter::OutputFormat QPrinter::outputFormat() const

このプリンタの出力フォーマットを返します。

setOutputFormat()も参照 。

QPrinter::PageOrder QPrinter::pageOrder() const

現在のページ順序を返します。

デフォルトのページ順はFirstPageFirst です。

setPageOrder()も参照 。

QRectF QPrinter::pageRect(QPrinter::Unit unit) const

ページの矩形をunit で返す。通常、ページの境界と用紙の間には余白があるため、 この矩形はpaperRect() よりも小さくなる。

QPagedPaintDevice::pageLayout()も参照 。

[override virtual] QPaintEngine *QPrinter::paintEngine() const

再インプリメント：QPaintDevice::paintEngine() const.

プリンタが使用しているペイントエンジンを返します。

QRectF QPrinter::paperRect(QPrinter::Unit unit) const

用紙の矩形をunit で返す。これは通常pageRect() よりも大きい。

pageRect()も参照してください 。

QPrinter::PaperSource QPrinter::paperSource() const

プリンタの用紙ソースを返します。これはManual またはプリンタトレイか用紙カセットである。

setPaperSource()も参照 。

QPagedPaintDevice::PdfVersion QPrinter::pdfVersion() const

このプリンタのPDFバージョンを返します。デフォルトはPdfVersion_1_4 です。

setPdfVersion()も参照して ください。

QPrintEngine *QPrinter::printEngine() const

印刷エンジン プリンタが使用する印刷エンジンを返します。

QString QPrinter::printProgram() const

印刷出力をプリンタに送信するプログラムの名前を返します。

デフォルトは空文字列を返す。つまり、QPrinter はシステム依存の方法で賢くなろうとする。X11のみでは、特定の印刷プログラムを使用するために、別のものに設定することができます。他のプラットフォームでは、これは空文字列を返す。

setPrintProgram() およびsetPrinterSelectionOption()も参照のこと 。

QPrinter::PrintRange QPrinter::printRange() const

QPrinter のページ範囲を返す。 印刷設定ダイアログが開かれた後、この関数は、ユーザが選択した値を返す。

setPrintRange()も参照して ください。

QString QPrinter::printerName() const

プリンタ名を返します。この値は、デフォルト・プリンタの名前に初期設定されます。

setPrinterName()も参照 。

QString QPrinter::printerSelectionOption() const

プリンタ・オプション選択文字列を返します。これは、印刷コマンドが明示的に設定されている場合にのみ有用です。

デフォルト値（空文字列）は、プリンタがシステム依存の方法で選択されることを意味する。

それ以外の値は、指定された値を使用することを意味します。

この関数は、WindowsとMacでは常に空文字列を返す。

setPrinterSelectionOption() およびsetPrintProgram()も参照のこと 。

QPrinter::PrinterState QPrinter::printerState() const

プリンタの現在の状態を返します。これは必ずしも正確とは限らない（例えば、プリンタがオペレーティングシステムに状態を報告する機能を持っていない場合など）。

int QPrinter::resolution() const

setResolution() またはプリンタ・ドライバで設定されている、プリンタの現在の想定解像度を返す。

setResolution()も参照 。

void QPrinter::setCollateCopies(bool collate)

印刷ダイアログが表示されたときの照合順序チェックボックスのデフォルト値を設定します。collate が true の場合、setCollateCopiesEnabled() が有効になります。デフォルト値は false です。この値は、ユーザーが印刷ダイアログで何を押したかによって変更されます。

collateCopies()も参照 。

void QPrinter::setColorMode(QPrinter::ColorMode newColorMode)

プリンタのカラーモードをnewColorMode に設定します。Color またはGrayScale のいずれかを指定します。

colorMode() も参照 。

void QPrinter::setCopyCount(int count)

印刷部数をcount に設定します。

プリンタドライバはこの設定を読み取り、指定された部数を印刷します。

copyCount() およびsupportsMultipleCopies() も参照して ください。

void QPrinter::setCreator(const QString &creator)

文書を作成したアプリケーション名をcreator に設定します。

この関数は X11 バージョンの Qt にのみ適用されます。作成者名が指定されない場合、作成者には "Qt" とバージョン番号が設定されます。

creator()も参照してください 。

void QPrinter::setDocName(const QString &name)

ドキュメント名をname に設定します。

X11 では、ドキュメント名は、例えばQPrintDialog のデフォルトの出力ファイル名として使用されます。文書名は、プリンタがファイルに印刷する場合のファイル名には影響しないことに注意。これにはsetOutputFile()関数を使用する。

docName() およびQPrintEngine::PrintEnginePropertyKeyも参照のこと 。

void QPrinter::setDuplex(QPrinter::DuplexMode duplex)

duplex モードに基づいて両面印刷を有効にする。

duplex() も参照 。

[protected] void QPrinter::setEngines(QPrintEngine *printEngine, QPaintEngine *paintEngine)

この関数は、QPrinter のサブクラスが、カスタム印刷エンジンとカスタムペイント・エンジン ( それぞれprintEngine とpaintEngine) を指定するために使用します。

QPrinter はエンジンの所有権を持たないので、 これらのエンジン・インスタンスは自分で管理する必要があります。

エンジンを変更すると、プリンタの状態とそのすべてのプロパティがリセットされることに注意してください。

printEngine() ・paintEngine() ・setOutputFormat()も参照 。

void QPrinter::setFontEmbeddingEnabled(bool enable)

enable に従っ て フ ォ ン ト 埋め込みを有効に し た り 無効に し た り し ます。

fontEmbeddingEnabled() も参照して ください。

void QPrinter::setFromTo(int from, int to)

from とto で指定 し た番号のページ を網羅す る よ う 、 印字す る ページ範囲を設定 し ます。 こ こ でfrom は範囲内の最初のページ、to は最後のページに対応 し ます。

この関数は主に、setup()を呼び出したときに印刷ダイアログでユーザーが上書きできるデフォルト値を設定するために使用されます。

fromPage()、toPage()、pageRanges()も参照 。

void QPrinter::setFullPage(bool fp)

fp が真の場合、ページ全体への描画のサポートを有効にします。そうでない場合、描画はデバイスによって報告された印刷可能領域に制限されます。

デフォルトでは、全ページ印刷は無効です。この場合、QPrinter の座標系の原点は、印刷可能領域の左上隅と一致する。

全ページ印刷が有効な場合、QPrinter の座標系の原点は、用紙自体の左上隅と一致する。この場合、device metrics は {QPageSize} で示される寸法と全く同じ寸法を報告する。プリンタの余白のために、物理的なページ全体に印刷することができない場合があります。

fullPage （）、QPagedPaintDevice::pageLayout （）、QPagedPaintDevice::setPageSize （）も参照 。

void QPrinter::setOutputFileName(const QString &fileName)

出力ファイル名をfileName に設定する。

NULLまたは空の名前（0または""）を設定すると、ファイルへの印刷は無効になる。空でない名前を設定すると、ファイルへの印刷が可能になる。

これはoutputFormat() の値を変更することができる。ファイル名の接尾辞が".pdf "の場合、PDFが生成される。ファイル名の接尾辞が ".pdf" 以外の場合、setOutputFormat() で設定された出力形式が使用されます。

QPrinter はそれぞれ Qt のクロスプラットフォーム PDF 印刷エンジンを使用します。このフォーマットをネイティブに生成できる場合、例えば macOS がそのプリントエンジンから PDF を生成できる場合、出力フォーマットを に戻してください。NativeFormat

outputFileName() およびsetOutputFormat()も参照 。

void QPrinter::setOutputFormat(QPrinter::OutputFormat format)

このプリンタの出力フォーマットをformat に設定します。

format が現在設定されている値と同じ場合は、変更は行われません。

format がNativeFormat の場合、printerName がデフォルト・プリンタに設定される。有効なプリンタが設定されていない場合、変更は行われません。特定のprinterName でNativeFormat を設定したい場合は、setPrinterName （）を使用する。

outputFormat() およびsetPrinterName()も参照 。

void QPrinter::setPageOrder(QPrinter::PageOrder pageOrder)

ページ順序をpageOrder に設定します。

ページ・オーダーはQPrinter::FirstPageFirst またはQPrinter::LastPageFirst にすることができる。 アプリケーションがページ・オーダーを読み取り、それに従って印刷する。

この関数は主に、ユーザが印刷ダイアログで上書きできるデフォルト値を設定するのに便利です。

この関数はX11でのみサポートされています。

pageOrder()も参照のこと 。

void QPrinter::setPaperSource(QPrinter::PaperSource source)

ペーパーソース設定をsource に設定する。

Windowsのみ：このオプションは印刷中に変更でき、次にnewPage() を呼び出したときから有効になります。

paperSource()も参照して ください。

void QPrinter::setPdfVersion(QPagedPaintDevice::PdfVersion version)

このプリンタの PDF バージョンをversion に設定します。

version が現在設定されている値と同じ場合、変更は行われません。

pdfVersion()も参照して ください。

void QPrinter::setPrintProgram(const QString &printProg)

印刷ジョブを実行するプログラムの名前をprintProg に設定します。

X11 では、この関数は PDF 出力で呼び出すプログラムを設定します。他のプラットフォームでは、何の効果もありません。

printProgram()も参照 。

void QPrinter::setPrintRange(QPrinter::PrintRange range)

印刷範囲オプション in をrange に設定します。

printRange() も参照して ください。

void QPrinter::setPrinterName(const QString &name)

プリンタ名をname に設定します。

name が空の場合、出力形式はPdfFormat に設定されます。

name が有効なプリンタでない場合、変更は行われない。

name が有効なプリンタである場合、出力形式はNativeFormat に設定される。

printerName （）、isValid （）、setOutputFormat （）も参照 。

void QPrinter::setPrinterSelectionOption(const QString &option)

option を使ってプリンタを選択するように設定します。option はデフォルトでは NULL ですが（これは Qt が十分に賢いので正しく推測できるはずだという意味です）、 特定のプリンタ選択オプションを使うために他の値を設定することもできます。

プリンタがアクティブな状態でプリンタ選択オプションが変更された場合、現在の印刷ジョブは影響を受けるかもしれませんし、受けないかもしれません。

この機能はWindowsまたはMacには影響しない。

printerSelectionOption() およびsetPrintProgram()も参照の こと。

void QPrinter::setResolution(int dpi)

dpi またはできるだけdpi に近い位置で印刷するようプリンタに要求する。

この設定は、例えばQPainter::viewport() が返す座標系に影響する。

この関数は、QPainter::begin() の前に呼び出さなければならない。

resolution() およびQPagedPaintDevice::setPageSize()も参照 。

QList<QPrinter::PaperSource> QPrinter::supportedPaperSources() const

このプリンタでサポートされている用紙サイズを返します。

値は、QPrinter::PaperSource enumのエントリと一致する値か、ドライバ固有の値となる。ドライバ固有の値は、wingdi.hで宣言されている定数DMBIN_USERより大きい。

QList<int> QPrinter::supportedResolutions() const

プリンターがサポートしている解像度のリスト(ドット/インチの整数のリスト)を返す。

すべての印刷が PDF に直接行われる X11 では、この関数は常に PDF の解像度、すなわち 72 (72 dpi - ただしPrinterMode を参照) だけを含む 1 項目のリストを返します。

bool QPrinter::supportsMultipleCopies() const

プ リ ン タ が同一文書の複数部数を 1 つのジョ ブで印刷す る こ と をサポー ト し てい る と き はtrue を返し、 そ う でない と き は false を返 し ます。

そうでない場合はfalseが返される。しかし、CUPSをサポートしていないX11システムでは、この関数はfalseを返す。つまり、アプリケーションは、同じドキュメントを必要な回数印刷することで、部数を処理しなければならない。

setCopyCount() およびcopyCount()も参照のこと 。

int QPrinter::toPage() const

印刷するページの範囲（"to page "設定）の最後のページの番号を返します。ドキュメントのページ番号は、最初のページを 1 ページ目とする慣例に従って付けられます。

デフォルトでは、この関数は特別な値0を返し、これは "to page "設定が未設定であることを意味する。

プログラマは、この設定を読み取り、それに従って印刷する責任を負う。

setFromTo(),fromPage(),pageRanges()も参照してください 。