Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XML::XBEL::Folder(3)  User Contributed Perl Documentation XML::XBEL::Folder(3)

NAME
       XML::XBEL::Folder - OOP for reading/writing XBEL	folders.

SYNOPSIS
	use XML::XBEL::Folder;

DESCRIPTION
       OOP for reading/writing XBEL folders.

PACKAGE	METHODS
   __PACKAGE__->new(\%args)
       Valid arguments are :

       o   title

	   String.

       o   desc

	   String.

       o   id

	   String.

       o   added

	   String.

       o   folded

	   yes (default) or no.

       o   info

	   Hash	ref, with the following	key/value pairs	:

	   o	 owner

		 Array ref.

       Returns a XML::XBEL::Folder object.

OBJECT METHODS
   $obj->title($title)
       Get/set the title for an	XBEL folder.

       Returns a string	when called with no arguments; otherwise returns true
       or false.

   $obj->desc($description)
       Get/set the description for an XBEL folder.

       Returns a string	when called with no arguments; otherwise returns true
       or false.

   $obj->info(\%args)
       Get/set the metadata for	an XBEL	document.

       Valid args are :

       o   owner

	   Array reference

       Returns an array	reference when called with no arguments; otherwise
       returns true or false.

   $obj->id($id)
       Get/set the id attribute	for an XBEL folder.

   $obj->added($datetime)
       Get/set the creation datetime for an XBEL folder.

       Returns a string	when called with no arguments; otherwise returns true
       or false.

   $obj->folded($bool)
       Get/set the folded state	for an XBEL folder.

       Returns a string	when called with no arguments; otherwise returns true
       or false.

   $obj->bookmarks($recursive)
       Returns a list of child XML::XBEL::Bookmark objects.

       Where $recursive	is a boolean indicating	whether	to return all the
       bookmarks in an XBEL folder or only its immediate children.

   $obj->folders($recursive)
       Returns a list of child XML::XBEL::Folder objects.

       Where $recursive	is a boolean indicating	whether	to return all the
       folders in an XBEL folder or only its immediate children.

   $obj->aliases($recursive)
       Returns a list of child XML::XBEL::Alias	objects.

       Where $recursive	is a boolean indicating	whether	to return all the
       aliases in an XBEL folder or only its immediate children.

   $obj->add_bookmark(XML::XBEL::Bookmark)
       Add a new bookmark to an	XBEL folder.

       If passed a hash	ref, valid arguments are the same as those defined for
       the XML::XBEL::Bookmark object constructor.

   $obj->add_folder(XML::XBEL::Folder)
       Add a new folder	to an XBEL folder.

       If passed a hash	ref, valid arguments are the same as those defined for
       the XML::XBEL::Folder object constructor.

   $obj->add_alias(XML::XBEL::Alias)
       Add a new alias to an XBEL folder.

       If passed a hash	ref, valid arguments are the same as those defined for
       the XML::XBEL::Alias object constructor.

   $obj->delete()
       Delete an XBEL folder.

   $obj->toString($format)
   $obj->toFile($filename,$format)
   $obj->toFH(\*$fh,$format)
VERSION
       $Revision: 1.5 $

DATE
       $Date: 2004/06/24 02:15:15 $

AUTHOR
       Aaron Straup Cope <ascope@cpan.org>

SEE ALSO
       XML::XBEL

       XML::XBEL::Bookmark

       XML::XBEL::Alias

       XML::XBEL::Separator

LICENSE
       Copyright (c) 2004 Aaron	Straup Cope. All rights	reserved.

       This is free software, you may use it and distribute it under the same
       terms as	Perl itself.

perl v5.32.0			  2020-08-11		  XML::XBEL::Folder(3)

NAME | SYNOPSIS | DESCRIPTION | PACKAGE METHODS | OBJECT METHODS | VERSION | DATE | AUTHOR | SEE ALSO | LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XML::XBEL::Folder&sektion=3&manpath=FreeBSD+12.2-RELEASE+and+Ports>

home | help