GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  XML::XBEL::FOLDER (3)

.ds Aq ’

NAME

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

CONTENTS

SYNOPSIS



 use XML::XBEL::Folder;



DESCRIPTION

OOP for reading/writing XBEL folders.

PACKAGE METHODS

    __PACKAGE__->new(\%args)

Valid arguments are :
o <B>titleB>

String.

o <B>descB>

String.

o <B>idB>

String.

o <B>addedB>

String.

o <B>foldedB>

yes (default) or no.

o <B>infoB>

Hash ref, with the following key/value pairs :
o owner

Array ref.

Returns a XML::XBEL::Folder object.

OBJECT METHODS

CW$obj->title($title)

Get/set the title for an XBEL folder.

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

CW$obj->desc($description)

Get/set the description for an XBEL folder.

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

CW$obj->info(\%args)

Get/set the metadata for an XBEL document.

Valid args are :
o <B>ownerB>

Array reference

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

CW$obj->id($id)

Get/set the id attribute for an XBEL folder.

CW$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.

CW$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.

CW$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.

CW$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.

CW$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.

CW$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.

CW$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.

CW$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.

CW$obj->delete()

Delete an XBEL folder.

CW$obj->toString($format)

CW$obj->toFile($filename,$format)

CW$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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 XML::XBEL::FOLDER (3) 2016-04-03

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.