!!! wxPrintout

このクラスは、アプリケーションドキュメントを印刷するための機能を隠蔽している。このクラス派生して新しいクラスを作成し、OnPrintPageやHasPageなどの呼び出しに応じるために、メンバをオーバーライドしなければならない。このクラスのインスタンスは、印刷やプレビューを初期化するために、wxPrinter::PrintやwxPrintPreviewオブジェクトに渡される。

<<基本クラス>>

wxObject

<<インクルードファイル>>

<wx/print.h>

<<参考>>

印刷の概要, wxPrinterDC, wxPrintDialog, wxPrinter, wxPrintPreview

<<メンバ>>

wxPrintout::wxPrintout
wxPrintout::~wxPrintout
wxPrintout::GetDC
wxPrintout::GetPageInfo
wxPrintout::GetPageSizeMM
wxPrintout::GetPageSizePixels
wxPrintout::GetPPIPrinter
wxPrintout::GetPPIScreen
wxPrintout::GetTitle
wxPrintout::HasPage
wxPrintout::IsPreview
wxPrintout::OnBeginDocument
wxPrintout::OnEndDocument
wxPrintout::OnBeginPrinting
wxPrintout::OnEndPrinting
wxPrintout::OnPreparePrinting
wxPrintout::OnPrintPage

!! wxPrintout::wxPrintout

wxPrintout(const wxString& title = "Printout")

コンストラクタ。オプションでtitle引数を渡す（現在のファイル名を渡すのは良いアイディアである）。これは印刷リスト（少なくともMSWでは）に現れる。

!! wxPrintout::~wxPrintout

~wxPrintout()

デストラクタ。

!! wxPrintout::GetDC

wxDC * GetDC()

印刷に関連付けられた（印刷やプレビューの始めに与えられた）デバイスコンテキストを返す。これは、Windows環境下での印刷であればwxPrinterDCであり、他のプラットフォームであればwxPostScriptDCでり、プレビューであればwxMemoryDCである。

!! wxPrintout::GetPageInfo

void GetPageInfo(int *minPage, int *maxPage, int *pageFrom, int *pageTo)

ユーザが指定可能な最小ページと最大ページの値と、印刷するように要求されたページの幅に関する情報を得るために、アプリケーションからフレームワークによって呼ばれる。デフォルトでは、ページの最小値と最大値として1と32000を、要求されたページ幅として1と1を返す。

minPageがゼロの場合、ページ番号コントロールは印刷ダイアログ内で無効化される。

<<wxPython note>>: When this method is implemented in a derived Python class, it should be designed to take no parameters (other than the self reference) and to return a tuple of four integers.

<<wxPerl note>>: When this method is overridden in a derived class, it must not take any parameters, and returns a 4-element list.

!! wxPrintout::GetPageSizeMM

void GetPageSizeMM(int *w, int *h)

印刷ページのサイズをミリメートル単位で返す。

<<wxPython note>>: This method returns the output-only parameters as a tuple.

<<wxPerl note>>: In wxPerl this method takes no arguments and returns a 2-element list ( w, h )

!! wxPrintout::GetPageSizePixels

void GetPageSizePixels(int *w, int *h)

印刷ページのサイズをピクセル単位で返す。印刷出力がプレビューに対して使用される場合には、wxDC::GetSizeが返す値と異なる場合がある。なぜなら、この場合、メモリデバイスコンテキストが使用され、現在のプレビューズームを繁栄したビットマップサイズが使用されるためである。プレビューがサポートされる場合には、アプリケーションは、この不一致を考慮しなければならない。

<<wxPython note>>: This method returns the output-only parameters as a tuple.

<<wxPerl note>>: In wxPerl this method takes no arguments and returns a 2-element list ( w, h )

!! wxPrintout::GetPPIPrinter

void GetPPIPrinter(int *w, int *h)

プリンタデバイスコンテキストの、論理インチあたりのピクセル(ppi)を返す。プリンタPPIをスクリーンPPIで割ると、プリンタ上に文字を表示するための適切なスケール係数が求められる。プレビューDCのサイズを考慮するために、この値にスケール係数を掛けることを忘れてはならない。

<<wxPython note>>: This method returns the output-only parameters as a tuple.

<<wxPerl note>>: In wxPerl this method takes no arguments and returns a 2-element list ( w, h )

!! wxPrintout::GetPPIScreen

void GetPPIScreen(int *w, int *h)

スクリーンデバイスコンテキストの、論理インチあたりのピクセル(ppi)を返す。プリンタPPIをスクリーンPPIで割ると、プリンタ上に文字を表示するための適切なスケール係数が求められる。プレビューDCのサイズを考慮するために、この値にスケール係数を掛けることを忘れてはならない。

!! wxPrintout::GetTitle

wxString GetTitle()

印刷出力のタイトルを返す。

<<wxPython note>>: This method returns the output-only parameters as a tuple.

<<wxPerl note>>: In wxPerl this method takes no arguments and returns a 2-element list ( w, h )

!! wxPrintout::HasPage

bool HasPage(int pageNum)

ドキュメントがページを持っている場合には、trueを返すように、そうでなければ、falseを返すようにオーバーライドしなければならない。falseを返すのは、ドキュメントの終わりを意味する。デフォルトでは、HasPageは、ドキュメントが１ページだけ持っているかのように振舞う。

!! wxPrintout::IsPreview

bool IsPreview()

現在の印刷出力がプレビューのために使用されている場合には、trueを返す。

!! wxPrintout::OnBeginDocument

bool OnBeginDocument(int startPage, int endPage)

ドキュメントの印刷を始めるときにフレームワークから呼ばれる。印刷ジョブをキャンセルすると、この関数はfalseを返す。OnBeginDocumentは、印刷される部数ごと、１回ずつ呼ばれる。

基本クラスのwxPrintout::OnBeginDocumentは、オーバーライドされた関数の中から呼ばれなくてはならない（そして、戻り値がチェックされなければならない）。なぜなら、wxPrintout::OnBeginDocumentは、wxDC::StartDocを呼ぶからである。

<<wxPython note>>: If this method is overridden in a Python class then the base class version can be called by using the method base_OnBeginDocument(startPage, endPage).

!! wxPrintout::OnEndDocument

void OnEndDocument()

ドキュメントを印刷する最後に、フレームワークから呼ばれる。OnEndDocumentは、印刷される部数ごとに、１回ずつ呼ばれる。

基本クラスのwxPrintout::OnEndDocumentは、オーバーライドされた関数の中から呼ばれなくてはならない。なぜなら、wxPrintout::OnEndDocumentは、wxDC::EndDocを呼ぶからである。

!! wxPrintout::OnBeginPrinting

void OnBeginPrinting()

印刷を開始するときに、フレームワークから呼ばれる。OnBeginPrintingは、（何部印刷されるかに関わらず）印刷ジョブごとに１回ずつ呼ばれる。

!! wxPrintout::OnEndPrinting

void OnEndPrinting()

印刷を終了するときに、フレームワークから呼ばれる。OnEndPrintingは、（何部印刷されるに関わらず）印刷ジョブごとに１回ずつ呼ばれる。

!! wxPrintout::OnPreparePrinting

void OnPreparePrinting()

wxPrintoutオブジェクトで発生するどの要求よりも前に、フレームワークから１回だけ呼ばれる。オブジェクトに対して、例えば、ドキュメント内のページ数を計算するための機会を与える。

!! wxPrintout::OnPrintPage

bool OnPrintPage(int pageNum)

１つのページが印刷されるときに、フレームワークから呼ばれる。印刷ジョブをキャンセルすると、falseを返す。アプリケーションは、利用するデバイスコンテキストを得るために、wxPrintout::GetDCを使用することができる。