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

印刷される部数を返します。デフォルト値は 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

印刷対象のページ範囲の最初のページ番号（「開始ページ」の設定）を返します。文書内のページは、最初のページを1ページとする慣例に従ってページ番号が振られます。

デフォルトでは、この関数は特別な値である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)) {// ファイルを開くことに失敗しました
        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

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

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

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

この関数は、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 のサブクラスによって、カスタムなprintエンジンおよびpaintエンジン（それぞれ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 が true の場合、ページ全体への描画をサポートします。そうでない場合は、デバイスが報告する印刷可能領域に描画を制限します。

デフォルトでは、全ページ印刷は無効になっています。この場合、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のクロスプラットフォームPDF印刷エンジンを使用します。この形式をネイティブで生成できる場合（例えば、macOSでは印刷エンジンからPDFを生成できます）、出力形式をNativeFormat に戻してください。

outputFileName() およびsetOutputFormat()も参照してください 。

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

このプリンタの出力形式を「format 」に設定します。

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

format がNativeFormat の場合、printerName はデフォルトのプリンタに設定されます。有効なプリンタが設定されていない場合は、変更は行われません。NativeFormat を特定のprinterName で設定したい場合は、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)

印刷範囲オプションを `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 列挙型の項目に一致する値、またはドライバ固有の値のいずれかになります。ドライバ固有の値は、wingdi.hで宣言されている定数DMBIN_USERよりも大きい値となります。

QList<int> QPrinter::supportedResolutions() const

プリンタがサポートしていると報告する解像度（ドット/インチ単位の整数のリスト）を返します。

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

bool QPrinter::supportsMultipleCopies() const

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

ほとんどのシステムでは、この関数は true を返します。ただし、CUPS をサポートしていない X11 システムでは、この関数は false を返します。つまり、アプリケーション側で、必要な回数だけ同じ文書を印刷することで、部数を処理する必要があります。

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

int QPrinter::toPage() const

印刷対象のページ範囲の最終ページ番号（「終了ページ」設定）を返します。文書内のページ番号は、最初のページを1ページとする規則に従って付けられます。

デフォルトでは、この関数は 0 という特別な値を返します。これは、「to page」設定が設定されていないことを意味します。

この設定を読み取り、それに応じて印刷を行うのはプログラマーの責任です。

setFromTo()、fromPage()、およびpageRanges()も参照してください 。