wxPrintPreview

wxPrintPreview

このクラスのオブジェクトは、印刷プレビュー処理を管理する。このオブジェクトは、wxPrintoutオブジェクトに渡され、wxPrintPreviewオブジェクト自身は、wxPreviewFrameオブジェクトに渡される。プレビューは、プレビューフレームの初期化と表示から始まる。wxPrinter::Printとは異なり、制御の流れは、フレームが表示された後すぐ、アプリケーションに戻る。

基本クラス

wxObject

インクルードファイル

<wx/print.h>

参考

印刷の概要, wxPrinterDC, wxPrintDialog, wxPrintout, wxPrinter, wxPreviewCanvas, wxPreviewControlBar, wxPreviewFrame.

メンバ

wxPrintPreview::wxPrintPreview
wxPrintPreview::~wxPrintPreview
wxPrintPreview::GetCanvas
wxPrintPreview::GetCurrentPage
wxPrintPreview::GetFrame
wxPrintPreview::GetMaxPage
wxPrintPreview::GetMinPage
wxPrintPreview::GetPrintout
wxPrintPreview::GetPrintoutForPrinting
wxPrintPreview::Ok
wxPrintPreview::PaintPage
wxPrintPreview::Print
wxPrintPreview::RenderPage
wxPrintPreview::SetCanvas
wxPrintPreview::SetCurrentPage
wxPrintPreview::SetFrame
wxPrintPreview::SetPrintout
wxPrintPreview::SetZoom

wxPrintPreview::wxPrintPreview

wxPrintPreview(wxPrintout* printout, wxPrintout* printoutForPrinting, wxPrintData* data=NULL)

コンストラクタ。printoutオブジェクトと、オプションで実際の印刷の際に使用されるprintoutオブジェクト、オプションで印刷データのアドレス（印刷プレビューオブジェクトの印刷データにコピーされる）を渡す。

printoutForPrintingがNULLでなければ、ユーザがプレビューインタフェースから直接印刷できるよう、印刷...ボタンがプレビューフレームに表示される。

このデストラクタが呼ばれてすぐに、printoutオブジェクトをdeleteしてはならない。なぜなら、prinoutオブジェクトは、wxPrintPreviewコンストラクタでdeleteされるからである。同じことは、data引数には適用されない。

wxPrintPreviewオブジェクトが正しく作られたかどうかは、Okメンバで調べることができる。プリンタデバイスコンテキストの初期化に問題があれば（例えば、プリンタが設定されていない）、Okはfalseを返す。

wxPrintPreview::~wxPrintPreview

~wxPrinter()

デストラクタ。両方の印刷プレビューオブジェクトをdeleteするため、アプリケーションの中でこれらのオブジェクトを破棄してはならない。

wxPrintPreview::GetCanvas

wxPreviewCanvas* GetCanvas()

印刷プレビューイメージを表示するために使用されるプレビューウィンドウを取得する。

wxPrintPreview::GetCurrentPage

int GetCurrentPage()

現在プレビューされているページを取得する。

wxPrintPreview::GetFrame

wxFrame * GetFrame()

印刷プレビューキャンバスとコントロールバーを表示するのに使用されるフレームを取得する。

wxPrintPreview::GetMaxPage

int GetMaxPage()

最大ページ数を返す。

wxPrintPreview::GetMinPage

int GetMinPage()

最小ページ数を返す。

wxPrintPreview::GetPrintout

wxPrintout * GetPrintout()

wxPrintPreviewオブジェクトに関連付けられたプレビューprintoutオブジェクトを取得する。

wxPrintPreview::GetPrintoutForPrinting

wxPrintout * GetPrintoutForPrinting()

プレビューインタフェースの内部から印刷するときに使用されるprintoutオブジェクトを取得する。なければ、NULLを返す。

wxPrintPreview::Ok

bool Ok()

wxPrintPreviewが有効であればtrueを返し、そうでなければfalseを返す。プリンタデバイスコンテキストの初期化に問題があれば（例えば、プリンタが設定されていない）、falseを返す。

wxPrintPreview::PaintPage

bool PaintPage(wxPreviewCanvas *canvas, wxDC&dc)

プレビューイメージでプレビューウィンドウをリフレッシュする。プレビューウィンドウのOnPaintメンバから呼ばれなければならない。

その実装は単に、プレビュービットマップをcanvas上にblitし(?)、プレビュービットマップがなければ新しく作成する。

wxPrintPreview::Print

bool Print(bool prompt)

wxPrintPreviewコンストラクタで提供された２個目のwxPrintoutオブジェクトを使用して印刷処理を実行する。通常、プレビューフレームのコントロールバー上にある、印刷...パネルアイテムによって呼ばれる。

エラーの場合には、falseを返す。エラーの種類について、詳細な情報を取得するためには、wxPrinter::GetLastErrorを呼べばよい。

wxPrintPreview::RenderPage

bool RenderPage(int pageNum)

ページをwxMemoryDC上にレンダリングする。wxPrintPreviewによって、内部的に使用される。

wxPrintPreview::SetCanvas

void SetCanvas(wxPreviewCanvas* window)

印刷プレビューイメージを表示するために使用されるウィンドウを設定する。

wxPrintPreview::SetCurrentPage

void SetCurrentPage(int pageNum)

プレビューすべき現在のページを設定する。

wxPrintPreview::SetFrame

void SetFrame(wxFrame *frame)

印刷プレビューキャンバスやコントロールバーを表示するために使用されるフレームを設定する。

wxPrintPreview::SetPrintout

void SetPrintout(wxPrintout *printout)

printoutオブジェクトをwxPrintPreviewオブジェクトに関連付ける。

wxPrintPreview::SetZoom

void SetZoom(int percent)

プレビューズームの比率を設定し、結果的にプレビューキャンバスをリフレッシュする。