/ 
Perl-Dist-WiX-1.500002
River stage one • 1 direct dependent • 1 total dependent
/ Perl::Dist::WiX::Tag::Icon

NAME

Perl::Dist::WiX::Tag::Icon - <Icon> tag that stores its type of target.

VERSION

This document describes Perl::Dist::WiX::Tag::Icon version 1.500.

SYNOPSIS

my $tag = Perl::Dist::WiX::Tag::Icon->new(
	sourcefile  => catfile($dist->dist_dir(), 'padre.ico'),
	target_type => 'exe',
	id          => 'padre.exe.ico' # I_ is prepended to this.
);

DESCRIPTION

This is an XML tag that specifies an icon that is used in a Perl::Dist::WiX-based distribution.

METHODS

This class is a WiX3::XML::Icon and inherits its API, so only additional API is documented here.

new

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

If an error occurs, it throws an exception.

It inherits all the parameters described in the WiX3::XML::Icon->new() method documentation, and adds one additional parameter.

target_type

The required string target_type parameter stores the extension of the target of a shortcut icon, or 'msi' if this is the icon for the msi.

get_target_type

The method get_target_type param retrieves the extension of the target of the shortcut icon that was stored in the object.

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>

SEE ALSO

Perl::Dist::WiX, http://wix.sourceforge.net/manual-wix3/wix_xsd_icon.htm,

COPYRIGHT

Copyright 2009 - 2010 Curtis Jewell.

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.