view release on metacpan or  search on metacpan

lib/App/Chart/Weblink.pm  view on Meta::CPAN

=head1 NAME

App::Chart::Weblink -- web page links for symbols

=head1 SYNOPSIS

 use App::Chart::Weblink;

=head1 DESCRIPTION

A weblink is a URL to some web site page related to a symbol, such as a
company information page or commodity contract specifications.  The weblinks
for a given symbol are presented under the "View/Web" menu in the main Chart
GUI.

=head1 FUNCTIONS

=over 4

=item App::Chart::Weblink->new (name=>..., pred=>...)

Create and register a new weblink.  The return is a new
C<App::Chart::Weblink> object, though usually this is not of interest (only
all the links later with C<links_for_symbol> below).

=item @list = App::Chart::Weblink->links_for_symbol ($symbol)

Return a list of C<App::Chart::Weblink> objects for use on the given symbol.
Eg.

    my @links = App::Chart::Weblink->links_for_symbol ('BHP.AX');

=back

=head1 METHODS

=over 4

=item C<< $string = $weblink->name >>

Return the menu item name for C<$weblink>.  This can include a "_"
underscore for a mnemonic.

=item C<< $string = $weblink->url ($symbol) >>

Return the url for C<$weblink> on C<$symbol>.

=item C<< $bool = $weblink->sensitive ($symbol) >>

Return true if the menu item for C<$weblink> should be sensitive for
C<$symbol>, ie. there's a target URL for that symbol.

=item C<< $weblink->open ($symbol) >>

Open a web browser to show C<$weblink> for C<$symbol>.

=back

=head1 SEE ALSO

L<App::Chart::Weblink::SandP>, L<App::Chart::Gtk2::WeblinkMenu>

=cut