brian d foy > Netscape-Bookmarks-1.95 > Netscape::Bookmarks::Alias

Download:
Netscape-Bookmarks-1.95.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 1.5   Source  

NAME ^

Netscape::Bookmarks::Alias - object for an Alias in a Netscape Bookmarks file

SYNOPSIS ^

        use Netscape::Bookmarks;
        use Netscape::Bookmarks::Alias;

        my $bookmarks = Netscape::Bookmarks->new();

        my $alias = Netscape::Bookmarks::Alias->new();

        $bookmarks->add( $alias );
        # ... and other Netscape::Bookmark::Category methods

DESCRIPTION ^

This module provides an abstraction for an Alias object in a Netscape Bookmarks file. An alias is simply a reference to another link in the Bookmarks file, henceforth called the target. If you change the alias, the target link also changes.

Methods

new( ALIASID )
$obj->alias_of()

Returns the alias key for this alias

$obj->target( ALIAS_KEY )

Returns the target Link of the given alias key. The return value is a Netscape::Bookmarks::Link object if the target exists, or undef in scalar context or the empty list in list context if the target does not exist. If you want to simply check to see if a target exists, use target_exists.

add_target( $link_obj, ALIAS_KEY )

Adds a target link for the given ALIAS_KEY. You can add target links before the Alias is created.

target_exists( TARGET_KEY )

For the given target key returns TRUE or FALSE if the target exists.

SOURCE AVAILABILITY ^

This source is part of a SourceForge project which always has the latest sources in CVS, as well as all of the previous releases.

        http://sourceforge.net/projects/nsbookmarks/

If, for some reason, I disappear from the world, one of the other members of the project can shepherd this module appropriately.

AUTHOR ^

brian d foy, <bdfoy@cpan.org>

COPYRIGHT AND LICENSE ^

Copyright (c) 2002-2007 brian d foy. All rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

SEE ALSO ^

Netscape::Bookmarks

syntax highlighting: