~ubuntu-branches/ubuntu/lucid/perl-tk/lucid

« back to all changes in this revision

Viewing changes to pod/Canvas.pod

  • Committer: Bazaar Package Importer
  • Author(s): Colin Tuckley
  • Date: 2008-02-15 13:56:59 UTC
  • mfrom: (1.1.3 upstream) (4.1.1 hardy)
  • Revision ID: james.westby@ubuntu.com-20080215135659-ru2oqlykuju20fav
Tags: 1:804.028-1
* New Upstream Release (Closes: #463080).
* Update to Debhelper v5.
* Build with XFT=1 (Closes: #411129).

Show diffs side-by-side

added added

removed removed

Lines of Context:
346
346
The first possible syntax is a list of integers. Each element
347
347
represents the number of pixels of a line segment. Only the odd
348
348
segments are drawn using the "outline" color. The other segments
349
 
are drawn transparant.
 
349
are drawn transparent.
350
350
 
351
351
The second possible syntax is a character list containing only
352
 
5 possible characters B<[.,-_ ]>. The space can be used
353
 
to enlarge the space between other line elements, and can not
354
 
occur as the first position in the string. Some examples:
 
352
5 possible characters B<[.,-_ ]>,  with the first 4 characters
 
353
producing a segment of length 1 to 4, respectively, followed
 
354
by a transparent segment of length 2. The space can be used
 
355
repeatedly to enlarge the space between other line elements
 
356
by 1, and can not occur as the first position in the string.
 
357
The main difference of this syntax with the previous one is 
 
358
that it it shape-conserving. This means that all values in the dash
 
359
list will be multiplied by the line width before display. This
 
360
assures that "." will always be displayed as a dot and "-"
 
361
always as a dash regardless of the line width.
 
362
 
 
363
Some examples, for a line width of 2:
355
364
 
356
365
 -dash .     = -dash [2,4]
357
366
 -dash -     = -dash [6,4]
358
367
 -dash -.    = -dash [6,4,2,4]
359
368
 -dash -..   = -dash [6,4,2,4,2,4]
360
 
 -dash '. '  = -dash [2,8]
 
369
 -dash '.  ' = -dash [2,8]
361
370
 -dash ','   = -dash [4,4]
362
371
 
363
 
The main difference of this syntax with the previous is that it
364
 
it shape-conserving. This means that all values in the dash
365
 
list will be multiplied by the line width before display. This
366
 
assures that "." will always be displayed as a dot and "-"
367
 
always as a dash regardless of the line width.
368
 
 
369
 
On systems where only a limited set of dash patterns, the dash
370
 
pattern will be displayed as the most close dash pattern that
371
 
is available. For example, on Windows only the first 4 of the
 
372
On systems where only a limited set of dash patterns is available,
 
373
the dash pattern will be displayed as the closest available dash 
 
374
pattern. For example, on Windows only the first 4 of the
372
375
above examples are available. The last 2 examples will be
373
376
displayed identically as the first one.
374
377
 
1355
1358
=item B<-disabledbitmap> =E<gt> I<bitmap>
1356
1359
 
1357
1360
Specifies the bitmaps to display in the item in its normal, active and
1358
 
disabled states.
 
1361
disabled states. All bitmaps must have the same width and height.
1359
1362
I<Bitmap> may have any of the forms accepted by B<Tk_GetBitmap>.
1360
1363
 
1361
1364
=item B<-foreground> =E<gt> I<color>
1362
1365
 
1363
 
=item B<-activeforeground> =E<gt> I<bitmap>
 
1366
=item B<-activeforeground> =E<gt> I<color>
1364
1367
 
1365
 
=item B<-disabledforeground> =E<gt> I<bitmap>
 
1368
=item B<-disabledforeground> =E<gt> I<color>
1366
1369
 
1367
1370
Specifies the color to use for each of the bitmap's '1' valued pixels
1368
1371
in its normal, active and disabled states.
1530
1533
=item B<-disabledimage> =E<gt> I<name>
1531
1534
 
1532
1535
Specifies the name of the images to display in the item in is normal,
1533
 
active and disabled states.
1534
 
This image must have been created previously with the
1535
 
B<imageCreate> method.
 
1536
active and disabled states. This image must have been created
 
1537
previously, see L<Tk::Image>.
1536
1538
 
1537
1539
=item B<-state> =E<gt> I<state>
1538
1540