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

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::Launcher - Start menu launcher asset for a Win32 Perl

VERSION ^

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

SYNOPSIS ^

  my $batlauncher = Perl::Dist::WiX::Asset::Launcher->new(
    parent => $dist,
    name   => 'CPAN Client',
    bin    => 'cpan',
  );
  
  $batlauncher->install();

  my $exelauncher = Perl::Dist::WiX::Asset::Launcher->new(
    parent => $dist,
    name   => 'Padre Development Environment',
    bin    => 'padre',
    exe    => 1,
  );
  
  $exelauncher->install();

DESCRIPTION ^

This asset creates a Start Menu entry for a script or executable file in the perl binary directory.

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::Launcher object.

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

name

The required name parameter is the name of the link in the start menu.

bin

The bin parameter is the name of the script or executable file to link to.

exe

The exe parameter specifies if the file is an executable file, as opposed to a script that has been converted to a batch file.

directory_id

The directory_id parameter specifies the directory that the Start menu link is to be created in.

install

The install method installs the Start Menu link described by the Perl::Dist::WiX::Asset::Launcher object and returns true (or throws an exception.)

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 AND LICENSE ^

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: