1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
|
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>
<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>
canvasprintbox - Create and manipulate a canvas print box
widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>canvasprintbox</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Widget <- Canvasprintbox
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>activeBackground</B> <DD> <B>background</B> <B>borderWidthcursor</B>
<B>foreground</B> <B>highlightBackground</B> <B>highlightColorhighlightThickness</B>
</DD>
</DL>
<DL>
<DT><B>insertBackground</B> <DD> <B>insertBorderWidthinsertOffTimeinsertOnTime</B>
<B>insertWidth</B> <B>relief</B> <B>repeatDelay</B> <B>repeatInterval</B>
</DD>
</DL>
<DL>
<DT><B>selectBackground</B> <DD> <B>selectBorderWidthselectForeground</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>filename</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>FileName</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-filename</B>
<P>
</DD>
</DL>
The file to write the postscript output to (Only when
output is set to "file"). If posterizing is turned on
and <B>hpagecnt</B> and/or <B>vpagecnt</B> is more than 1, x.y is
appended to the filename where x is the horizontal page
number and y the vertical page number.
<P>
<DL>
<DT>Name: <DD> <B>hpagecnt</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>PageCnt</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-hpagecnt</B>
<P>
</DD>
</DL>
Is used in combination with <B>posterize</B> to determine over
how many pages the output should be distributed. This
attribute specifies how many pages should be used horizontaly.
Any change to this attribute will automatically
update the "stamp". Defaults to 1.
<P>
<DL>
<DT>Name: <DD> <B>orient</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Orient</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-orient</B>
<P>
</DD>
</DL>
Determines the orientation of the output to the printer
(or file). It can take the value "portrait" or
"landscape" (default). Changes to this attribute will
be reflected immediately in the "stamp". Defaults to
"landscape" but will be changed automaticaly to the
value deemed appropiate for the current canvas. Setting
this attribute when the canvasprintbox is first constructed
(instead of using the "configure" method) will
turn off the auto adjustment of this attribute.
<P>
<DL>
<DT>Name: <DD> <B>output</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Output</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-output</B>
<P>
</DD>
</DL>
Specifies where the postscript output should go: to the
printer or to a file. Can take on the values "printer"
or "file". The corresponding entry-widget will reflect
the contents of either the <B>printcmd</B> attribute or the
<B>filename</B> attribute. Defaults to "printer".
<P>
<DL>
<DT>Name: <DD> <B>pageSize</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>PageSize</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-pagesize</B>
<P>
</DD>
</DL>
The pagesize the printer supports. Changes to this
attribute will be reflected immediately in the "stamp".
Defaults to "a4".
<P>
<DL>
<DT>Name: <DD> <B>posterize</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Posterize</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-posterize</B>
<P>
</DD>
</DL>
Indicates if posterizing is turned on or not. Posterizing
the output means that it is possible to distribute
the output over more than one page. This way it is possible
to print a canvas/region which is larger than the
specified pagesize without stretching. If used in combination
with stretching it can be used to "blow up"
the contents of a canvas to as large as size as you
want (See attributes: hpagecnt and vpagecnt). Any
change to this attribute will automatically update the
"stamp". Defaults to 0.
<P>
<DL>
<DT>Name: <DD> <B>printCmd</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>PrintCmd</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-printcmd</B>
<P>
</DD>
</DL>
The command to execute when printing the postscript
output. The command will get the postscript directed
to its standard input (Only when output is set to
"printer"). Defaults to "lpr".
<P>
<DL>
<DT>Name: <DD> <B>printRegion</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>PrintRegion</B>
<P>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-printregion</B>
<P>
</DD>
</DL>
A list of four coordinates specifying which part of the
canvas to print. An empty list means that the canvas'
entire <B>scrollregion</B> should be printed. Any change to
this attribute will automatically update the "stamp".
Defaults to an empty list.
<P>
<DL>
<DT>Name: <DD> <B>stretch</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Stretch</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-stretch</B>
<P>
</DD>
</DL>
Determines if the output should be stretched to fill
the page (as defined by the attribute pagesize) as
large as possible. The aspect-ratio of the output will
be retained and the output will never fall outside of
the boundaries of the page. Defaults to 0 but will be
changed automaticaly to the value deemed appropiate for
the current canvas. Setting this attribute when the
canvasprintbox is first constructed (instead of using
the "configure" method) will turn off the auto adjustment
of this attribute.
<P>
<DL>
<DT>Name: <DD> <B>vPageCnt</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>PageCnt</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-vpagecnt</B>
<P>
</DD>
</DL>
Is used in combination with "posterize" to determine
over how many pages the output should be distributed.
This attribute specifies how many pages should be used
verticaly. Any change to this attribute will automatically
update the "stamp". Defaults to 1.
<P>
_________________________________________________________________
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>
Implements a print box for printing the contents of a canvas
widget to a printer or a file. It is possible to specify
page orientation, the number of pages to print the image on
and if the output should be stretched to fit the page.
Options exist to control the appearance and actions of the
widget.
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>METHODS</B></A></H2>
The <B>canvasprintbox</B> command creates a new Tcl command whose
name is <I>pathName</I>. This command may be used to invoke various
operations on the widget. It has the following general
form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for canvasprintbox
widgets:
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>cget</B> <I>option</I><BR>
Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>canvasprintbox</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>canvasprintbox</B> command.
<P>
<I>pathName</I> <B>getoutput</B><BR>
Returns the value of the <B>printercmd</B> or <B>filename</B> option
depending on the current setting of <B>output</B>.
<P>
<I>pathName</I> <B>print</B><BR>
Perfrom the actual printing of the canvas using the
current settings of all the attributes. Returns a
boolean indicating wether the printing was successful
or not.
<P>
<I>pathName</I> <B>refresh</B><BR>
Retrieves the current value for all edit fields and
updates the stamp accordingly. Is useful for Applybuttons.
<P>
<I>pathName</I> <B>setcanvas</B> <I>canvas</I><BR>
This is used to set the <I>canvas</I> that has to be printed.
A stamp-sized copy will automatically be drawn to show
how the output would look with the current settings.
<P>
<I>pathName</I> <B>stop</B><BR>
Stops the drawing of the "stamp". I'm currently unable
to detect when a Canvasprintbox gets destroyed or withdrawn.
It's therefore advised that you perform a stop
before you do something like that.
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>prtflentry</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Entry</B>
<P>
</DD>
</DL>
The prtflentry component is the entry field for user
input of the <B>filename</B> or <B>printer</B> command (depending on
the value of <B>output</B>).
<P>
<DL>
<DT>Name: <DD> <B>hpcnt</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Entry</B>
<P>
</DD>
</DL>
The hpcnt component is the entry field for user input
of the number of pages to use horizontaly when <B>posterize</B>
is turned on.<BR>
<DL>
<DT>Name: <DD> <B>vpcnt</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Entry</B>
<P>
</DD>
</DL>
The vpcnt component is the entry field for user input
of the number of pages to use verticaly when <B>posterize</B>
is turned on.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>EXAMPLE</B></A></H2>
canvasprintbox .fsb -orient landscape -stretch 1
pack .fsb -padx 10 -pady 10 -fill both -expand yes
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>AUTHOR</B></A></H2>
Tako Schotanus
<P>
Tako.Schotanus@bouw.tno.nl
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>KEYWORDS</B></A></H2>
canvasprintbox, widget
<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">DESCRIPTION</A></LI>
<LI><A NAME="toc8" HREF="#sect8">METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">COMPONENTS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">EXAMPLE</A></LI>
<LI><A NAME="toc12" HREF="#sect12">AUTHOR</A></LI>
<LI><A NAME="toc13" HREF="#sect13">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
