Initial commit of OpenSPARC T2 design and verification files.

[OpenSPARC-T2-DV] / tools / perl-5.8.0 / man / man3 / SVG::Element.3

.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SVG::Element 3"
.TH SVG::Element 3 "2003-11-02" "perl v5.8.0" "User Contributed Perl Documentation"
.SH "NAME"
SVG::Element \- Generate the element bits for SVG.pm
.SH "AUTHOR"
.IX Header "AUTHOR"
Ronan Oger, ronan@roasp.com
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1),\s-1SVG\s0,\s-1SVG::XML\s0,SVG::Element,SVG::Parser, SVG::Manual
http://www.roasp.com/
http://www.perlsvg.com/
http://www.roitsystems.com/
http://www.w3c.org/Graphics/SVG/
.Sh "tag (alias: element)"
.IX Subsection "tag (alias: element)"
$tag = \f(CW$SVG\fR\->tag($name, \f(CW%attributes\fR)
.PP
Generic element generator. Creates the element named \f(CW$name\fR with the attributes
specified in \f(CW%attributes\fR. This method is the basis of most of the explicit
element generators.
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $tag = $SVG->tag('g', transform=>'rotate(-45)');
.Ve
.Sh "anchor"
.IX Subsection "anchor"
$tag = \f(CW$SVG\fR\->anchor(%attributes)
.PP
Generate an anchor element. Anchors are put around objects to make them
\&'live' (i.e. clickable). It therefore requires a drawn object or group element
as a child.
.PP
\&\fBExample:\fR
.PP
.Vb 6
\&    # generate an anchor    
\&    $tag = $SVG->anchor(
\&        -href=>'http://here.com/some/simpler/SVG.SVG'
\&    );
\&    # add a circle to the anchor. The circle can be clicked on.
\&    $tag->circle(cx=>10,cy=>10,r=>1);
.Ve
.PP
.Vb 5
\&    # more complex anchor with both URL and target
\&    $tag = $SVG->anchor(
\&          -href   => 'http://somewhere.org/some/other/page.html',
\&          -target => 'new_window'
\&    );
.Ve
.Sh "circle"
.IX Subsection "circle"
$tag = \f(CW$SVG\fR\->circle(%attributes)
.PP
Draw a circle at (cx,cy) with radius r.
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $tag = $SVG->circlecx=>4, cy=>2, r=>1);
.Ve
.Sh "ellipse"
.IX Subsection "ellipse"
$tag = \f(CW$SVG\fR\->ellipse(%attributes)
.PP
Draw an ellipse at (cx,cy) with radii rx,ry.
.PP
\&\fBExample:\fR
.PP
.Vb 12
\&    my $tag = $SVG->ellipse(
\&        cx=>10, cy=>10,
\&        rx=>5, ry=>7,
\&        id=>'ellipse',
\&        style=>{
\&            'stroke'=>'red',
\&            'fill'=>'green',
\&            'stroke-width'=>'4',
\&            'stroke-opacity'=>'0.5',
\&            'fill-opacity'=>'0.2'
\&        }
\&    );
.Ve
.Sh "rectangle (alias: rect)"
.IX Subsection "rectangle (alias: rect)"
$tag = \f(CW$SVG\fR\->rectangle(%attributes)
.PP
Draw a rectangle at (x,y) with width 'width' and height 'height' and side radii
\&'rx' and 'ry'.
.PP
\&\fBExample:\fR
.PP
.Vb 6
\&    $tag = $SVG->rectangle(
\&        x=>10, y=>20,
\&        width=>4, height=>5,
\&        rx=>5.2, ry=>2.4,
\&        id=>'rect_1'
\&    );
.Ve
.Sh "image"
.IX Subsection "image"
.Vb 1
\& $tag = $SVG->image(%attributes)
.Ve
.PP
Draw an image at (x,y) with width 'width' and height 'height' linked to image
resource '\-href'. See also \*(L"use\*(R".
.PP
\&\fBExample:\fR
.PP
.Vb 6
\&    $tag = $SVG->image(
\&        x=>100, y=>100,
\&        width=>300, height=>200,
\&        '-href'=>"image.png", #may also embed SVG, e.g. "image.SVG"
\&        id=>'image_1'
\&    );
.Ve
.PP
\&\fBOutput:\fR
.PP
.Vb 1
\&    <image xlink:href="image.png" x="100" y="100" width="300" height="200"/>
.Ve
.Sh "use"
.IX Subsection "use"
$tag = \f(CW$SVG\fR\->use(%attributes)
.PP
Retrieve the content from an entity within an \s-1SVG\s0 document and apply it at
(x,y) with width 'width' and height 'height' linked to image resource '\-href'.
.PP
\&\fBExample:\fR
.PP
.Vb 6
\&    $tag = $SVG->use(
\&        x=>100, y=>100,
\&        width=>300, height=>200,
\&        '-href'=>"pic.SVG#image_1",
\&        id=>'image_1'
\&    );
.Ve
.PP
\&\fBOutput:\fR
.PP
.Vb 1
\&    <use xlink:href="pic.SVG#image_1" x="100" y="100" width="300" height="200"/>
.Ve
.PP
According to the \s-1SVG\s0 specification, the 'use' element in \s-1SVG\s0 can point to a
single element within an external \s-1SVG\s0 file.
.Sh "polygon"
.IX Subsection "polygon"
$tag = \f(CW$SVG\fR\->polygon(%attributes)
.PP
Draw an n\-sided polygon with vertices at points defined by a string of the form
\&'x1,y1,x2,y2,x3,y3,... xy,yn'. The \*(L"get_path\*(R" method is provided as a
convenience to generate a suitable string from coordinate data.
.PP
\&\fBExample:\fR
.PP
.Vb 3
\&    # a five-sided polygon
\&    my $xv = [0,2,4,5,1];
\&    my $yv = [0,0,2,7,5];
.Ve
.PP
.Vb 4
\&    $points = $a->get_path(
\&        x=>$xv, y=>$yv,
\&        -type=>'polygon'
\&    );
.Ve
.PP
.Vb 5
\&    $c = $a->polygon(
\&        %$points,
\&        id=>'pgon1',
\&        style=>\e%polygon_style
\&    );
.Ve
.PP
\&\s-1SEE\s0 \s-1ALSO:\s0
.PP
\&\*(L"polyline\*(R", \*(L"path\*(R", \*(L"get_path\*(R".
.Sh "polyline"
.IX Subsection "polyline"
$tag = \f(CW$SVG\fR\->polyline(%attributes)
.PP
Draw an n\-point polyline with points defined by a string of the form
\&'x1,y1,x2,y2,x3,y3,... xy,yn'. The \*(L"get_path\*(R" method is provided as a
convenience to generate a suitable string from coordinate data.
.PP
\&\fBExample:\fR
.PP
.Vb 3
\&    # a 10-pointsaw-tooth pattern
\&    my $xv = [0,1,2,3,4,5,6,7,8,9];
\&    my $yv = [0,1,0,1,0,1,0,1,0,1];
.Ve
.PP
.Vb 5
\&    $points = $a->get_path(
\&        x=>$xv, y=>$yv,
\&        -type=>'polyline',
\&        -closed=>'true' #specify that the polyline is closed.
\&    );
.Ve
.PP
.Vb 8
\&    my $tag = $a->polyline (
\&        %$points,
\&        id=>'pline_1',
\&        style=>{
\&            'fill-opacity'=>0,
\&            'stroke-color'=>'rgb(250,123,23)'
\&        }
\&    );
.Ve
.Sh "line"
.IX Subsection "line"
$tag = \f(CW$SVG\fR\->line(%attributes)
.PP
Draw a straight line between two points (x1,y1) and (x2,y2).
.PP
\&\fBExample:\fR
.PP
.Vb 5
\&    my $tag = $SVG->line(
\&        id=>'l1',
\&        x1=>0, y1=>10,
\&        x2=>10, y2=>0
\&    );
.Ve
.PP
To draw multiple connected lines, use \*(L"polyline\*(R".
.Sh "text"
.IX Subsection "text"
$text = \f(CW$SVG\fR\->text(%attributes)\->\fIcdata()\fR;
.PP
$text_path = \f(CW$SVG\fR\->text(\-type=>'path');
\&\f(CW$text_span\fR = \f(CW$text_path\fR\->text(\-type=>'span')\->cdata('A');
\&\f(CW$text_span\fR = \f(CW$text_path\fR\->text(\-type=>'span')\->cdata('B');
\&\f(CW$text_span\fR = \f(CW$text_path\fR\->text(\-type=>'span')\->cdata('C');
.PP
define the container for a text string to be drawn in the image.
.PP
\&\fBInput:\fR 
    \-type     = path type (path | polyline | polygon)
    \-type     = text element type  (path | span | normal [default])
.PP
\&\fBExample:\fR
.PP
.Vb 3
\&    my $text1 = $SVG->text(
\&        id=>'l1', x=>10, y=>10
\&    )->cdata('hello, world');
.Ve
.PP
.Vb 2
\&    my $text2 = $SVG->text(
\&        id=>'l1', x=>10, y=>10, -cdata=>'hello, world');
.Ve
.PP
.Vb 4
\&    my $text = $SVG->text(
\&        id=>'tp', x=>10, y=>10 -type=>path)
\&        ->text(id=>'ts' -type=>'span')
\&        ->cdata('hello, world');
.Ve
.PP
\&\s-1SEE\s0 \s-1ALSO:\s0
.PP
.Vb 1
\&    L<"desc">, L<"cdata">.
.Ve
.Sh "title"
.IX Subsection "title"
$tag = \f(CW$SVG\fR\->title(%attributes)
.PP
Generate the title of the image.
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $tag = $SVG->title(id=>'document-title')->cdata('This is the title');
.Ve
.Sh "desc"
.IX Subsection "desc"
$tag = \f(CW$SVG\fR\->desc(%attributes)
.PP
Generate the description of the image.
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $tag = $SVG->desc(id=>'document-desc')->cdata('This is a description');
.Ve
.Sh "comment"
.IX Subsection "comment"
$tag = \f(CW$SVG\fR\->comment(@comments)
.PP
Generate the description of the image.
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $tag = $SVG->comment('comment 1','comment 2','comment 3');
.Ve
.PP
$tag = \f(CW$SVG\fR\->pi(@pi)
.PP
Generate a set of processing instructions
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $tag = $SVG->pi('instruction one','instruction two','instruction three');
.Ve
.PP
.Vb 4
\&    returns: 
\&      <lt>?instruction one?<gt>
\&      <lt>?instruction two?<gt>
\&      <lt>?instruction three?<gt>
.Ve
.Sh "script"
.IX Subsection "script"
$tag = \f(CW$SVG\fR\->script(%attributes)
.PP
Generate a script container for dynamic (client\-side) scripting using
ECMAscript, Javascript or other compatible scripting language.
.PP
\&\fBExample:\fR
.PP
.Vb 1
\&    my $tag = $SVG->script(-type=>"text/ecmascript");
.Ve
.PP
.Vb 4
\&    # populate the script tag with cdata
\&    # be careful to manage the javascript line ends.