.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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" '' . ds C` . ds C' '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 >0, 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. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Geo::GoogleEarth::Pluggable::Base 3pm" .TH Geo::GoogleEarth::Pluggable::Base 3pm "2021-01-04" "perl v5.32.0" "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" Geo::GoogleEarth::Pluggable::Base \- Geo::GoogleEarth::Pluggable Base package .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use base qw{Geo::GoogleEarth::Pluggable::Base}; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The is the base of all Geo::GoogleEarth::Pluggable packages. .SH "USAGE" .IX Header "USAGE" .SH "CONSTRUCTOR" .IX Header "CONSTRUCTOR" .SS "new" .IX Subsection "new" .Vb 3 \& my $document = Geo::GoogleEarth::Pluggable\->new(key1=>value1, \& key2=>[value=>{opt1=>val1}], \& key3=>{value=>{opt2=>val2}}); .Ve .SH "METHODS" .IX Header "METHODS" .SS "name" .IX Subsection "name" Sets or returns the name property. .PP .Vb 3 \& my $name=$folder\->name; \& $placemark\->name("New Name"); \& $document\->name("New Name"); .Ve .SS "description" .IX Subsection "description" Sets or returns the description property. .PP .Vb 3 \& my $description=$folder\->description; \& $placemark\->description("New Description"); \& $document\->description("New Description"); .Ve .SS "Snippet" .IX Subsection "Snippet" Returns the Snippet used in the Snippet \s-1XML\s0 element or a Placemark. The default Snippet from Google Earth is to use the first line of the description however this package defaults to a zero line Snippet. .PP Snippet is rendered with maxLines as the length of the array ref and the content joined with new lines. .PP Typical use .PP .Vb 2 \& $document\->Point(Snippet=>"Line 1"); \& $document\->Point(Snippet=>["Line 1", "Line 2"]); .Ve .PP Extended used .PP .Vb 5 \& my $snippet=$placemark\->Snippet; #[] always array reference \& $placemark\->Snippet([]); #default \& $placemark\->Snippet(["line 1", "line 2", "line 3"]); \& $placemark\->Snippet("My Snippet Text"); #folded into array reference. \& $placemark\->Snippet("line 1", "line 2", "line 3"); #folded into array reference .Ve .SS "lookat" .IX Subsection "lookat" Sets or returns a Geo::GoogleEarth::Pluggable::LookAt object .SH "BUGS" .IX Header "BUGS" Please log on \s-1RT\s0 and send to the geo-perl email list. .SH "SUPPORT" .IX Header "SUPPORT" DavisNetworks.com supports all Perl applications including this package. .SH "AUTHOR" .IX Header "AUTHOR" .Vb 2 \& Michael R. Davis (mrdvt92) \& CPAN ID: MRDVT .Ve .SH "COPYRIGHT" .IX Header "COPYRIGHT" This program is free software licensed under the... .PP .Vb 1 \& The BSD License .Ve .PP The full text of the license can be found in the \s-1LICENSE\s0 file included with this module. .SH "SEE ALSO" .IX Header "SEE ALSO" Geo::GoogleEarth::Pluggable creates a GoogleEarth Document.