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


Perl-Dist-WiX documentation  | view source Contained in the Perl-Dist-WiX distribution.

Index


NAME

Top

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

VERSION

Top

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

SYNOPSIS

Top

	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

Top

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

METHODS

Top

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

Top

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

Top

Curtis Jewell <csjewell@cpan.org>

SEE ALSO

Top

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

COPYRIGHT

Top


Perl-Dist-WiX documentation  | view source Contained in the Perl-Dist-WiX distribution.