Curtis Jewell > Perl-Dist-WiX-1.500002 > Perl::Dist::WiX::Asset::Website

Download:
Perl-Dist-WiX-1.500002.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  3
View/Report Bugs
Module Version: 1.500   Source  

NAME ^

Perl::Dist::WiX::Asset::Website - Website link asset for a Win32 Perl

VERSION ^

This document describes Perl::Dist::WiX::Asset::Website version 1.500.

SYNOPSIS ^

  my $distribution = Perl::Dist::WiX::Asset::Website->new(
      parent     => $dist,
          name       => 'Strawberry Perl Website',
          url        => 'http://strawberryperl.com/',
          icon_file  => 'C:\icons\strawberry.ico',
          icon_index => 1,
  );

DESCRIPTION ^

This asset creates a website link in the Start Menu using the parameters given.

METHODS ^

This class is a Perl::Dist::WiX::Role::Asset and shares its API.

new

The new constructor takes a series of parameters, validates then and returns a new Perl::Dist::WiX::Asset::Website object.

It inherits all the params described in the Perl::Dist::WiX::Role::Asset->new() method documentation, and adds some additional params.

name

The required name parameter is the name of the link on the Start Menu, and also becomes the name of the .url file in the win32 directory under the image location.

url

The required url parameter is the website to link to.

directory_id

The optional directory_id parameter is the ID of the Start Menu directory (or subdirectory of that entry) used by the distribution.

Defaults to 'App_Menu_Websites', which puts the shortcut in the 'Related Websites' subdirectory of the Start Menu directory used by the distribution.

icon_file

The optional icon_file parameter is the file that contains the icon for the Start Menu entry.

Defaults to undef, which allows Windows to use its default icon for websites.

icon_index

The optional icon_index parameter is the index within a .dll file containing multiple icons of the icon to use.

This defaults to 1, meaning the first icon in the file, if icon_file is set, and udenf if it is not.

install

The install method installs the website link described by the Perl::Dist::WiX::Asset::Website object and returns true.

SUPPORT ^

Bugs should be reported via the CPAN bug tracker at

http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Perl-Dist-WiX

For other issues, contact the author.

AUTHOR ^

Curtis Jewell <csjewell@cpan.org>

Adam Kennedy <adamk@cpan.org>

SEE ALSO ^

Perl::Dist::WiX, Perl::Dist::WiX::Role::Asset

COPYRIGHT ^

Copyright 2009 - 2010 Curtis Jewell.

Copyright 2007 - 2009 Adam Kennedy.

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

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

syntax highlighting: