Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

geo::googleearth::pluggable::folder(3pm) [debian man page]

Geo::GoogleEarth::Pluggable::Folder(3pm)		User Contributed Perl Documentation		  Geo::GoogleEarth::Pluggable::Folder(3pm)

NAME

       Geo::GoogleEarth::Pluggable::Folder - Geo::GoogleEarth::Pluggable::Folder object

SYNOPSIS

	 use Geo::GoogleEarth::Pluggable;
	 my $document=Geo::GoogleEarth::Pluggable->new;
	 my $folder=$document->Folder(name=>"My Folder");

DESCRIPTION

       Geo::GoogleEarth::Pluggable::Folder is a Geo::GoogleEarth::Pluggable::Base with a few other methods.

USAGE

	 my $folder=$document->Folder();  #add folder to $document
	 my $subfolder=$folder->Folder(); #add folder to $folder

METHODS

   initialize
       We overide the default "initialize" method in order to append the "plugins" method from Module::Pluggable on to the packages list of the
       Method::Autoload package.

       The "packages" property is what is needed by Method::Autoload package.  The "plugins" method is what is provided by Module::Pluggable.  So,
       the Folder package now has available to it every method in the "Plugins" folder at runtime.

   Folder
       Constructs a new Folder object and appends it to the parent folder object.  Returns the object reference if you need to make any setting
       changes after construction.

	 my $folder=$folder->Folder(name=>"My Folder");
	 $folder->Folder(name=>"My Folder");

   NetworkLink
       Constructs a new NetworkLink object and appends it to the parent folder object.	Returns the object reference if you need to make any
       setting changes after construction.

	 $folder->NetworkLink(name=>"My NetworkLink", url=>"./anotherdoc.kml");

   LookAt
       Constructs a new LookAt object and returns the object reference to assign to other object "lookat" properties.

	 $document->LookAt(
			   latitude  => $lat,	 #decimal degrees
			   longitude => $lon,	 #decimal degrees
			   range     => $range,  #meters
			   tilt      => $tilt,	 #decimal degrees from veritical
			   heading   => $header, #decimal degrees from North
			  );

   type
       Returns the object type.

	 my $type=$folder->type;

   node
   data
       Pushes arguments onto data array and returns an array or reference that holds folder object content.  This is a list of objects that
       supports a type and structure method.

	 my $data=$folder->data;
	 my @data=$folder->data;
	 $folder->data($placemark);

   open
BUGS

       Please log on RT and send to the geo-perl email list.

LIMITATIONS

       Due to limitations in Perl hashes, it is not possible to specify the order of certain elements and attributes in the XML.

TODO

SUPPORT

       Try geo-perl email list.

AUTHOR

	 Michael R. Davis (mrdvt92)
	 CPAN ID: MRDVT

COPYRIGHT

       This program is free software licensed under the...

	 The BSD License

       The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

       Geo::GoogleEarth::Pluggable, Module::Pluggable Method::Autoload, XML::LibXML::LazyBuilder

perl v5.14.2							    2011-06-26				  Geo::GoogleEarth::Pluggable::Folder(3pm)

Check Out this Related Man Page

Geo::GoogleEarth::Pluggable::Base(3pm)			User Contributed Perl Documentation		    Geo::GoogleEarth::Pluggable::Base(3pm)

NAME

       Geo::GoogleEarth::Pluggable::Base - Geo::GoogleEarth::Pluggable Base package

SYNOPSIS

	 use base qw{Geo::GoogleEarth::Pluggable::Base};

DESCRIPTION

       The is the base of all Geo::GoogleEarth::Pluggable packages.

USAGE

CONSTRUCTOR

   new
	 my $document = Geo::GoogleEarth::Pluggable->new(key1=>value1,
							 key2=>[value=>{opt1=>val1}],
							 key3=>{value=>{opt2=>val2}});

METHODS

   document
       Always returns the document object.  Every object should know what document it is in.

   name
       Sets or returns the name property.

	 my $name=$folder->name;
	 $placemark->name("New Name");
	 $document->name("New Name");

   description
       Sets or returns the description property.

	 my $description=$folder->description;
	 $placemark->description("New Description");
	 $document->description("New Description");

   Snippet
       Returns the Snippet used in the Snippet XML 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.

       Snippet is rendered with maxLines as the length of the array ref and the content joined with new lines.

       Typical use

	 $document->Point(Snippet=>"Line 1");
	 $document->Point(Snippet=>["Line 1", "Line 2"]);

       Extended used

	 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

   lookat
       Sets or returns a Geo::GoogleEarth::Pluggable::LookAt object

BUGS

       Please log on RT and send to the geo-perl email list.

SUPPORT

       DavisNetworks.com supports all Perl applications including this package.

AUTHOR

	 Michael R. Davis (mrdvt92)
	 CPAN ID: MRDVT

COPYRIGHT

       This program is free software licensed under the...

	 The BSD License

       The full text of the license can be found in the LICENSE file included with this module.

SEE ALSO

       Geo::GoogleEarth::Pluggable creates a GoogleEarth Document.

perl v5.14.2							    2011-06-26				    Geo::GoogleEarth::Pluggable::Base(3pm)
Man Page