[catagits/Gitalist.git] / local-lib5 / man / man3 / WWW::Mechanize::Link.3pm

.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
.\"
.\" Standard preamble:
.\" ========================================================================
.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.  \*(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-
.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\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" 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 "WWW::Mechanize::Link 3"
.TH WWW::Mechanize::Link 3 "2008-11-23" "perl v5.8.7" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
WWW::Mechanize::Link \- Link object for WWW::Mechanize
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
Link object to encapsulate all the stuff that Mech needs but nobody
wants to deal with as an array.
.SH "Constructor"
.IX Header "Constructor"
.SS "\fInew()\fP"
.IX Subsection "new()"
.Vb 8
\&    my $link = WWW::Mechanize::Link\->new( {
\&        url  => $url,
\&        text => $text,
\&        name => $name,
\&        tag  => $tag,
\&        base => $base,
\&        attr => $attr_href,
\&    } );
.Ve
.PP
For compatibility, this older interface is also supported:
.PP
.Vb 1
\& new( $url, $text, $name, $tag, $base, $attr_href )
.Ve
.PP
Creates and returns a new \f(CW\*(C`WWW::Mechanize::Link\*(C'\fR object.
.SH "Accessors"
.IX Header "Accessors"
.ie n .SS "$link\->\fIurl()\fP"
.el .SS "\f(CW$link\fP\->\fIurl()\fP"
.IX Subsection "$link->url()"
\&\s-1URL\s0 from the link
.ie n .SS "$link\->\fItext()\fP"
.el .SS "\f(CW$link\fP\->\fItext()\fP"
.IX Subsection "$link->text()"
Text of the link
.ie n .SS "$link\->\fIname()\fP"
.el .SS "\f(CW$link\fP\->\fIname()\fP"
.IX Subsection "$link->name()"
\&\s-1NAME\s0 attribute from the source tag, if any.
.ie n .SS "$link\->\fItag()\fP"
.el .SS "\f(CW$link\fP\->\fItag()\fP"
.IX Subsection "$link->tag()"
Tag name (one of: \*(L"a\*(R", \*(L"area\*(R", \*(L"frame\*(R", \*(L"iframe\*(R" or \*(L"meta\*(R").
.ie n .SS "$link\->\fIbase()\fP"
.el .SS "\f(CW$link\fP\->\fIbase()\fP"
.IX Subsection "$link->base()"
Base \s-1URL\s0 to which the links are relative.
.ie n .SS "$link\->\fIattrs()\fP"
.el .SS "\f(CW$link\fP\->\fIattrs()\fP"
.IX Subsection "$link->attrs()"
Returns hash ref of all the attributes and attribute values in the tag.
.ie n .SS "$link\->\s-1\fIURI\s0()\fP"
.el .SS "\f(CW$link\fP\->\s-1\fIURI\s0()\fP"
.IX Subsection "$link->URI()"
Returns the \s-1URL\s0 as a \s-1URI::URL\s0 object.
.ie n .SS "$link\->\fIurl_abs()\fP"
.el .SS "\f(CW$link\fP\->\fIurl_abs()\fP"
.IX Subsection "$link->url_abs()"
Returns a \s-1URI::URL\s0 object for the absolute form of the string.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2004\-2008 Andy Lester. All rights reserved. This program is
free software; you can redistribute it and/or modify it under the same
terms as Perl itself.
Commit	Line	Data
3fea05b9	1	.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.10)
	2	.\"
	3	.\" Standard preamble:
	4	.\" ========================================================================
	5	.de Sp \" Vertical space (when we can't use .PP)
	6	.if t .sp .5v
	7	.if n .sp
	8	..
	9	.de Vb \" Begin verbatim text
	10	.ft CW
	11	.nf
	12	.ne \\$1
	13	..
	14	.de Ve \" End verbatim text
	15	.ft R
	16	.fi
	17	..
	18	.\" Set up some character translations and predefined strings. \*(-- will
	19	.\" give an unbreakable dash, \(PI will give pi, \(L" will give a left
	20	.\" double quote, and \(R" will give a right double quote. \(C+ will
	21	.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
	22	.\" therefore won't be available. \(C` and \(C' expand to `' in nroff,
	23	.\" nothing in troff, for use with C<>.
	24	.tr \(*W-
	25	.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
	26	.ie n \{\
	27	. ds -- \(*W-
	28	. ds PI pi
	29	. if (\n(.H=4u)&(1m=24u) .ds -- \(W\h'-12u'\(W\h'-12u'-\" diablo 10 pitch
	30	. if (\n(.H=4u)&(1m=20u) .ds -- \(W\h'-12u'\(W\h'-8u'-\" diablo 12 pitch
	31	. ds L" ""
	32	. ds R" ""
	33	. ds C` ""
	34	. ds C' ""
	35	'br\}
	36	.el\{\
	37	. ds -- \\|\(em\\|
	38	. ds PI \(*p
	39	. ds L" ``
	40	. ds R" ''
	41	'br\}
	42	.\"
	43	.\" Escape single quotes in literal strings from groff's Unicode transform.
	44	.ie \n(.g .ds Aq \(aq
	45	.el .ds Aq '
	46	.\"
	47	.\" If the F register is turned on, we'll generate index entries on stderr for
	48	.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
	49	.\" entries marked with X<> in POD. Of course, you'll have to process the
	50	.\" output yourself in some meaningful fashion.
	51	.ie \nF \{\
	52	. de IX
	53	. tm Index:\\$1\t\\n%\t"\\$2"
	54	..
	55	. nr % 0
	56	. rr F
	57	.\}
	58	.el \{\
	59	. de IX
	60	..
	61	.\}
	62	.\"
	63	.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
	64	.\" Fear. Run. Save yourself. No user-serviceable parts.
65	. \" fudge factors for nroff and troff
66	.if n \{\
67	. ds #H 0
68	. ds #V .8m
69	. ds #F .3m
70	. ds #[ \f1
71	. ds #] \fP
72	.\}
73	.if t \{\
74	. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75	. ds #V .6m
76	. ds #F 0
77	. ds #[ \&
78	. ds #] \&
79	.\}
80	. \" simple accents for nroff and troff
81	.if n \{\
82	. ds ' \&
83	. ds ` \&
84	. ds ^ \&
85	. ds , \&
86	. ds ~ ~
87	. ds /
88	.\}
89	.if t \{\
90	. ds ' \\k:\h'-(\\n(.wu8/10-\(#H)'\'\h"\|\\n:u"
91	. ds ` \\k:\h'-(\\n(.wu8/10-\(#H)'\`\h'\|\\n:u'
92	. ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'^\h'\|\\n:u'
93	. ds , \\k:\h'-(\\n(.wu*8/10)',\h'\|\\n:u'
94	. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'\|\\n:u'
95	. ds / \\k:\h'-(\\n(.wu8/10-\(#H)'\z\(sl\h'\|\\n:u'
96	.\}
97	. \" troff and (daisy-wheel) nroff accents
98	.ds : \\k:\h'-(\\n(.wu8/10-\(#H+.1m+\(#F)'\v'-\(#V'\z.\h'.2m+\(#F'.\h'\|\\n:u'\v'\(#V'
99	.ds 8 \h'\(#H'\(b\h'-\*(#H'
100	.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\(#H)/2u'\v'-.3n'\(#[\z\(de\v'.3n'\h'\|\\n:u'\*(#]
101	.ds d- \h'\(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\(#H'
102	.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'\|\\n:u'
103	.ds th \(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u2/3)'\s-1o\s+1\*(#]
104	.ds Th \(#[\s+2I\s-2\h'-\w'I'u3/5'\v'-.3m'o\v'.3m'\*(#]
105	.ds ae a\h'-(\w'a'u*4/10)'e
106	.ds Ae A\h'-(\w'A'u*4/10)'E
107	. \" corrections for vroff
108	.if v .ds ~ \\k:\h'-(\\n(.wu9/10-\(#H)'\s-2\u~\d\s+2\h'\|\\n:u'
109	.if v .ds ^ \\k:\h'-(\\n(.wu10/11-\(#H)'\v'-.4m'^\v'.4m'\h'\|\\n:u'
110	. \" for low resolution devices (crt and lpr)
111	.if \n(.H>23 .if \n(.V>19 \
112	\{\
113	. ds : e
114	. ds 8 ss
115	. ds o a
116	. ds d- d\h'-1'\(ga
117	. ds D- D\h'-1'\(hy
118	. ds th \o'bp'
119	. ds Th \o'LP'
120	. ds ae ae
121	. ds Ae AE
122	.\}
123	.rm #[ #] #H #V #F C
124	.\" ========================================================================
125	.\"
126	.IX Title "WWW::Mechanize::Link 3"
127	.TH WWW::Mechanize::Link 3 "2008-11-23" "perl v5.8.7" "User Contributed Perl Documentation"
128	.\" For nroff, turn off justification. Always turn off hyphenation; it makes
129	.\" way too many mistakes in technical documents.
130	.if n .ad l
131	.nh
132	.SH "NAME"
133	WWW::Mechanize::Link \- Link object for WWW::Mechanize
134	.SH "SYNOPSIS"
135	.IX Header "SYNOPSIS"
136	Link object to encapsulate all the stuff that Mech needs but nobody
137	wants to deal with as an array.
138	.SH "Constructor"
139	.IX Header "Constructor"
140	.SS "\fInew()\fP"
141	.IX Subsection "new()"
142	.Vb 8
143	\& my $link = WWW::Mechanize::Link\->new( {
144	\& url => $url,
145	\& text => $text,
146	\& name => $name,
147	\& tag => $tag,
148	\& base => $base,
149	\& attr => $attr_href,
150	\& } );
151	.Ve
152	.PP
153	For compatibility, this older interface is also supported:
154	.PP
155	.Vb 1
156	\& new( $url, $text, $name, $tag, $base, $attr_href )
157	.Ve
158	.PP
159	Creates and returns a new \f(CW\(C`WWW::Mechanize::Link\(C'\fR object.
160	.SH "Accessors"
161	.IX Header "Accessors"
162	.ie n .SS "$link\->\fIurl()\fP"
163	.el .SS "\f(CW$link\fP\->\fIurl()\fP"
164	.IX Subsection "$link->url()"
165	\&\s-1URL\s0 from the link
166	.ie n .SS "$link\->\fItext()\fP"
167	.el .SS "\f(CW$link\fP\->\fItext()\fP"
168	.IX Subsection "$link->text()"
169	Text of the link
170	.ie n .SS "$link\->\fIname()\fP"
171	.el .SS "\f(CW$link\fP\->\fIname()\fP"
172	.IX Subsection "$link->name()"
173	\&\s-1NAME\s0 attribute from the source tag, if any.
174	.ie n .SS "$link\->\fItag()\fP"
175	.el .SS "\f(CW$link\fP\->\fItag()\fP"
176	.IX Subsection "$link->tag()"
177	Tag name (one of: \(L"a\(R", \(L"area\(R", \(L"frame\(R", \(L"iframe\(R" or \(L"meta\(R").
178	.ie n .SS "$link\->\fIbase()\fP"
179	.el .SS "\f(CW$link\fP\->\fIbase()\fP"
180	.IX Subsection "$link->base()"
181	Base \s-1URL\s0 to which the links are relative.
182	.ie n .SS "$link\->\fIattrs()\fP"
183	.el .SS "\f(CW$link\fP\->\fIattrs()\fP"
184	.IX Subsection "$link->attrs()"
185	Returns hash ref of all the attributes and attribute values in the tag.
186	.ie n .SS "$link\->\s-1\fIURI\s0()\fP"
187	.el .SS "\f(CW$link\fP\->\s-1\fIURI\s0()\fP"
188	.IX Subsection "$link->URI()"
189	Returns the \s-1URL\s0 as a \s-1URI::URL\s0 object.
190	.ie n .SS "$link\->\fIurl_abs()\fP"
191	.el .SS "\f(CW$link\fP\->\fIurl_abs()\fP"
192	.IX Subsection "$link->url_abs()"
193	Returns a \s-1URI::URL\s0 object for the absolute form of the string.
194	.SH "COPYRIGHT"
195	.IX Header "COPYRIGHT"
196	Copyright (c) 2004\-2008 Andy Lester. All rights reserved. This program is
197	free software; you can redistribute it and/or modify it under the same
198	terms as Perl itself.