Printer (クラス)
public abstract sealed shared Printer {inherits Drawable}
パッケージ： CURL.GRAPHICS.PRINTER

Drawable プリンタに相当するオブジェクト。

説明

たいていのアプリケーションでは、Printer を直接使用せずに print-graphic や PrintRootFrame を使用して印刷します。

プロパティ
bottom-margin:ページコンテンツの印刷エリアの下から、ページの下の端までのオフセットです。
アクセサ public abstract Printer.bottom-margin:Distance
copies:部数を取得します。
アクセサ public Printer.copies:int
left-margin:ページコンテンツの印刷エリアの左から、ページの左の端までのオフセットです。
アクセサ public abstract Printer.left-margin:Distance
name:プリンタ名。
アクセサ public abstract Printer.name:String
orientation:ページの印刷方向。
アクセサ public abstract Printer.orientation:PageOrientation
page-height:ページの高さ。
アクセサ public abstract Printer.page-height:Distance
page-offset:ページの top/left 角から、印刷するコンテンツエリアの top/left 角までのオフセットです。
アクセサ deprecated public Printer.page-offset:Distance2d
page-width:ページの幅。
アクセサ public abstract Printer.page-width:Distance
printable-height:印刷可能領域の高さ。
アクセサ public abstract Printer.printable-height:Distance
printable-offset:印刷するコンテンツエリアの top/left 角から、印刷可能なエリアの top/left 角までのオフセットです。
アクセサ public abstract Printer.printable-offset:Distance2d
printable-width:印刷可能領域の幅。
アクセサ public abstract Printer.printable-width:Distance
right-margin:ページコンテンツの印刷エリアの右から、ページの右の端までのオフセットです。
アクセサ public abstract Printer.right-margin:Distance
top-margin:ページコンテンツの印刷エリアの上から、ページの上の端までのオフセットです。
アクセサ public abstract Printer.top-margin:Distance
プロパティ 継承 Drawable: destroy-handled?, destroy-observed?, destroy-requested?, forced-redraw-handler, height, resolution, width

クラス プロシージャ
get-collate?:指定のプリンタが部単位での印刷をサポートしているかを返します。
public {Printer.get-collate?
name:String
}:(success?:bool, supported?:bool)
get-color?:指定のプリンタがカラー印刷をサポートしているかを返します。
public {Printer.get-color?
name:String
}:(success?:bool, supported?:bool)
get-current-printer:プリンタ名を返します。Printer.open を呼び出す時にプリンタ名を指定しなかった場合、既定の印刷のターゲットとなるプリンタ名を返します。
public {Printer.get-current-printer}:#String
get-default-printer:システム全体における既定のプリンタがあればその名前を返します。
public {Printer.get-default-printer}:#String
get-duplex?:指定のプリンタが両面印刷をサポートしているかを返します。
public {Printer.get-duplex?
name:String
}:(success?:bool, supported?:bool)
get-media-source:指定されたプリンタがサポートしている給紙方法(用紙トレイ)のリストを返します。
public {Printer.get-media-source
name:String
}:#{Array-of PrintMediaSource}
get-page-description:設定されたプリンタでサポートされている用紙のリストを返します。
public {Printer.get-page-description
name:String
}:#{Array-of PrintPageDescription}
get-page-setup-margin:ページを構成するマージンです。
public {Printer.get-page-setup-margin}:PrintMargin
get-printers:現在、利用可能なプリンタのリストを返します。
public {Printer.get-printers}:#StringArray
open:[印刷] ダイアログ ボックスを開いて、選択した Printer を返します。
public {Printer.open
margin:#PrintMargin = null,
enable-print-selection?:bool = false,
print-range:PrintRange = {PrintRange 0, 0},
show-dialog?:bool = true,
orientation:PageOrientation = PageOrientation.default,
owner:HostWindowID = HostWindowID.none,
printer-name:#String = null,
page-description:#PrintPageDescription = null,
media-source:#PrintMediaSource = null,
color:PrintSettingBool = PrintSettingBool.default,
collate:PrintSettingBool = PrintSettingBool.default,
duplex:PrintDuplex = PrintDuplex.default,
copies:int = 0
}:(printer:#Printer, range:PrintRangeSelection)

メソッド
end:印刷を終了します。
public abstract {Printer.end}:void
end-page:ページを終了します。
public abstract {Printer.end-page}:void
メソッド 継承 Drawable: destroy, to-Pixmap
メソッド 継承 Object: object-describe, object-describe-for-debugging, object-serialize




プロパティ詳細
bottom-margin (アクセサ)
アクセサ public abstract Printer.bottom-margin:Distance

ページコンテンツの印刷エリアの下から、ページの下の端までのオフセットです。

説明

下のマージンは PrintMargin.top-offset になります。PrintMargin オブジェクトを Printer.open に渡すことができます。渡さない場合は、既定の PrintMargin オブジェクトが使用されます。 既定の PrintMargin オブジェクトは、page-setup-dialog を呼び出すことで変更することが可能です。 使用される PrintMargin オブジェクトに関わらず、この値は印刷用に指定されたページにおける印刷されない下のオフセットより小さくなることはありません。
導入: バージョン 6.0

copies (アクセサ)
アクセサ public Printer.copies:int

部数を取得します。

導入: バージョン 7.0

left-margin (アクセサ)
アクセサ public abstract Printer.left-margin:Distance

ページコンテンツの印刷エリアの左から、ページの左の端までのオフセットです。

説明

左のマージンは、PrintMargin.left-offset になります。PrintMargin オブジェクトを Printer.open に渡すことができます。渡さない場合は、既定の PrintMargin オブジェクトが使用されます。 既定の PrintMargin オブジェクトは、page-setup-dialog を呼び出すことで変更することが可能です。 使用される PrintMargin オブジェクトに関わらず、この値は印刷用に指定されたページにおける印刷されない左のオフセットより小さくなることはありません。
導入: バージョン 6.0

name (アクセサ)
アクセサ public abstract Printer.name:String

プリンタ名。


orientation (アクセサ)
アクセサ public abstract Printer.orientation:PageOrientation

ページの印刷方向。


page-height (アクセサ)
アクセサ public abstract Printer.page-height:Distance

ページの高さ。

注意事項

これは、ページの実際の高さになります。ページの印刷可能な高さを取得するためには、Printer.printable-height を呼び出してください。

page-offset (アクセサ)
アクセサ deprecated public Printer.page-offset:Distance2d

ページの top/left 角から、印刷するコンテンツエリアの top/left 角までのオフセットです。

非推奨

代わりに、Printer.left-margin や Printer.top-margin の負数を使用してください。

page-width (アクセサ)
アクセサ public abstract Printer.page-width:Distance

ページの幅。

注意事項

これは、ページの実際の幅になります。ページの印刷可能な幅を取得するためには、Printer.printable-width を呼び出してください。

printable-height (アクセサ)
アクセサ public abstract Printer.printable-height:Distance

印刷可能領域の高さ。

注意事項

この Drawable の高さは、このゲッターによって返される値と等しくなります。 Printer.printable-offset も参照してください。

printable-offset (アクセサ)
アクセサ public abstract Printer.printable-offset:Distance2d

印刷するコンテンツエリアの top/left 角から、印刷可能なエリアの top/left 角までのオフセットです。

説明

選択されているページのサイズで、選択されているプリンタが実際に印刷可能なエリアが印刷可能なエリアとなります。印刷可能なエリアの幅と高さを取得するためには、Printer.printable-width と Printer.printable-height を使用してください。

printable-width (アクセサ)
アクセサ public abstract Printer.printable-width:Distance

印刷可能領域の幅。

注意事項

この Drawable の幅は、このゲッターによって返される値と等しくなります。 Printer.printable-offset も参照してください。

right-margin (アクセサ)
アクセサ public abstract Printer.right-margin:Distance

ページコンテンツの印刷エリアの右から、ページの右の端までのオフセットです。

説明

右のマージンは、PrintMargin.right-offset になります。PrintMargin オブジェクトを Printer.open に渡すことができます。渡さない場合は、既定の PrintMargin オブジェクトが使用されます。 既定の PrintMargin オブジェクトは、page-setup-dialog を呼び出すことで変更することが可能です。 使用される PrintMargin オブジェクトに関わらず、この値は印刷用に指定されたページにおける印刷されない右のオフセットより小さくなることはありません。
導入: バージョン 6.0

top-margin (アクセサ)
アクセサ public abstract Printer.top-margin:Distance

ページコンテンツの印刷エリアの上から、ページの上の端までのオフセットです。

説明

上のマージンは、PrintMargin.top-offset になります。PrintMargin オブジェクトを Printer.open に渡すことができます。渡さない場合は、既定の PrintMargin オブジェクトが使用されます。 既定の PrintMargin オブジェクトは、page-setup-dialog を呼び出すことで変更することが可能です。 使用される PrintMargin オブジェクトに関わらず、この値は印刷用に指定されたページにおける印刷されない上のオフセットより小さくなることはありません。
導入: バージョン 6.0



クラス プロシージャ詳細
get-collate? (クラスプロシージャ)
public {Printer.get-collate?
name:String
}:(success?:bool, supported?:bool)

指定のプリンタが部単位での印刷をサポートしているかを返します。

name: クエリするプリンタ名。

戻り値

2つのブール値、1つ目はクエリが成功したか、2つ目は部単位での印刷をサポートしているかを返します。1つめの値が false の場合は、2つ目の値は意味を持ちません。
導入: バージョン 8.0

get-color? (クラスプロシージャ)
public {Printer.get-color?
name:String
}:(success?:bool, supported?:bool)

指定のプリンタがカラー印刷をサポートしているかを返します。

name: クエリするプリンタ名。

戻り値

2つのブール値、1つ目はクエリが成功したか、2つ目はカラー印刷がサポートされているかを返します。1つめの値が false の場合は、2つ目の値は意味を持ちません。
導入: バージョン 8.0

get-current-printer (クラスプロシージャ)
public {Printer.get-current-printer}:#String

プリンタ名を返します。Printer.open を呼び出す時にプリンタ名を指定しなかった場合、既定の印刷のターゲットとなるプリンタ名を返します。

注意事項

ほとんどのプラットフォームで、これは現在のプロセスから最後に印刷したプリンタになります。 Mac では、既定のプリンタと現在のプリンタが常に同じプリンタになります。ユーザーがシステムの既定のプリンタを選択していない限り、これは最近で使用されたプリンタになります。その場合、ユーザーによって選択されるプリンタになります。
導入: バージョン 6.0

get-default-printer (クラスプロシージャ)
public {Printer.get-default-printer}:#String

システム全体における既定のプリンタがあればその名前を返します。

注意事項

Mac では、既定のプリンタと現在のプリンタが常に同じプリンタになります。ユーザーがシステムの既定のプリンタを選択していない限り、これは最近で使用されたプリンタになります。その場合、ユーザーによって選択されるプリンタになります。 一般的に、アプリケーションは既定のプリンタより現在のプリンタと関係します。詳細情報に関しては、Printer.get-current-printer を参照してください。
導入: バージョン 6.0

get-duplex? (クラスプロシージャ)
public {Printer.get-duplex?
name:String
}:(success?:bool, supported?:bool)

指定のプリンタが両面印刷をサポートしているかを返します。

name: クエリするプリンタ名。

戻り値

2つのブール値、1つ目はクエリが成功したか、2つ目は両面印刷がサポートされているかを返します。1つめの値が false の場合は、2つ目の値は意味を持ちません。
導入: バージョン 8.0

get-media-source (クラスプロシージャ)
public {Printer.get-media-source
name:String
}:#{Array-of PrintMediaSource}

指定されたプリンタがサポートしている給紙方法(用紙トレイ)のリストを返します。

name: クエリするプリンタ名。

戻り値

サポートしている用紙トレイのリスト、クエリが成功しない場合は null になります。 PrintMediaSource を参照してください。
導入: バージョン 8.0

get-page-description (クラスプロシージャ)
public {Printer.get-page-description
name:String
}:#{Array-of PrintPageDescription}

設定されたプリンタでサポートされている用紙のリストを返します。

name: クエリするプリンタ名。

戻り値

プリンタでサポートされている用紙のリストです。 name は、Printer.get-printers で返されるプリンタ名のリストになければならないことに注意してください。リストにない場合、戻り値は null になります。 サポートされている用紙サイズに関するプリンタへのクエリに失敗した場合も、null を返します。
導入: バージョン 6.0

get-page-setup-margin (クラスプロシージャ)
public {Printer.get-page-setup-margin}:PrintMargin

ページを構成するマージンです。

注意事項

これは、page-setup-dialog プロシージャによって変更されます。既定値はページの 4 方向それぞれ 36pt になります。
導入: バージョン 6.0

get-printers (クラスプロシージャ)
public {Printer.get-printers}:#StringArray

現在、利用可能なプリンタのリストを返します。

戻り値

現在利用できるプリンタ名のリストです。プリンタが見つからない場合は、null を返します。
導入: バージョン 6.0

open (クラスプロシージャ)
public {Printer.open
margin:#PrintMargin = null,
enable-print-selection?:bool = false,
print-range:PrintRange = {PrintRange 0, 0},
show-dialog?:bool = true,
orientation:PageOrientation = PageOrientation.default,
owner:HostWindowID = HostWindowID.none,
printer-name:#String = null,
page-description:#PrintPageDescription = null,
media-source:#PrintMediaSource = null,
color:PrintSettingBool = PrintSettingBool.default,
collate:PrintSettingBool = PrintSettingBool.default,
duplex:PrintDuplex = PrintDuplex.default,
copies:int = 0
}:(printer:#Printer, range:PrintRangeSelection)

[印刷] ダイアログ ボックスを開いて、選択した Printer を返します。

margin: ユーザーに示された初期設定のマージンです。 margin に、プリンタで定義された印刷可能なエリアより広いエリアが指定された場合、印刷可能なエリアに等しくなるよう調整されます。 margin が null の場合、既定のマージンが使用されます。 Printer オブジェクトを作成する前に page-setup-dialog を呼び出すことで、既定のマージンを変更することができます。
enable-print-selection?: true に設定されている場合、[選択範囲の印刷] チェックボックスがオンになってます。それ以外の場合はオフです。
print-range: 印刷されるページの初期範囲。範囲の定義方法の詳細は、アプリケーションによって異なります。

print-range が指定されていない場合、または最小値と最大値が等しい場合、[印刷範囲] チェックボックスは無効になります。
show-dialog?: true（既定）に指定されている場合、印刷ダイアログを表示します。そうでなければ、ダイアログは表示されず、Printer.get-current-printer によって定義されている現在のプリンタの既定値が使用されます。
owner: このパラメータは、ユーザー設定できません。
printer-name: 非 null の場合、印刷するためのプリンタ名を規定します。Printer.get-printers プロシージャで返される値のひとつである必要があります。 非 null で、ターゲットとなるプリンタが見つからない場合、show-dialog? が false であればエラーがスローされます。そうでなければ printer-name は無視されます。 デフォルトは、nullです。
page-description:
非 null の場合、印刷に使用されるページのサイズを規定します。印刷ジョブが送られるプリンタに関する Printer.get-page-description プロシージャによって返される値の一つでなければなりません。
ターゲットとなるプリンタがサポートしていない場合、このパラメータは無視されます。
media-source:
非 null の場合、印刷に使用するプリンタトレイを指定します。それは、印刷ジョブが送られるプリンタの Printer.get-media-source プロシージャによって返される値の一つでなければなりません。
対象となるプリンタがサポートしていない場合、このパラメータは無視されます。
color:
指定された場合、プリンタ出力をカラー (yes) か、モノクロ (no) か指定することが出来ます。
このパラメータは、対象のプリンタがこの機能をサポートしない場合、無視されます。
collate:
指定された場合、複数部印刷する時プリンタが部単位で印刷するかを指定することが出来ます。
このパラメータは、対象のプリンタがこの機能をサポートしない場合、無視されます。
duplex:
指定された場合、両面印刷の方法を指定することが出来ます。
このパラメータは、対象のプリンタがこの機能をサポートしない場合、無視されます。
copies: 正の数が指定された場合、部数を指定します。そうでない場合、以前印刷された部数が規定値として使用されます。規定値は 1 です。

戻り値

ユーザー選択の Printer、およびユーザー選択の印刷範囲を示す PrintRangeSelection の値を参照するポインタ。

ユーザーが PrintRangeSelection.range を選択した場合、この値が反映して print-range パラメータが変更されます。

ユーザーがダイアログをキャンセルした場合、返される Printer はnull です。

注意事項

特権アプレットのみがこのプロシージャを呼び出すことができます。 この API は、低レベルの目的のために存在します。グラフィカル オブジェクトを印刷する必要があるアプリケーション コードでは、通常 print-graphic を使用します。


メソッド詳細
end (メソッド)
public abstract {Printer.end}:void

印刷を終了します。

注意事項

ページが開いている場合、印刷が終了する前に終了します。

end-page (メソッド)
public abstract {Printer.end-page}:void

ページを終了します。

注意事項

ページのレンダリング呼び出しによりページが開きます。

注意事項

ページを開かないで終了ページを呼び出すと、空白のページが印刷されます。