Zane C. Bowers-Hadley

NAME

Icon::Theme::Helper - Helps locating icon files.

VERSION

Version 0.0.0

SYNOPSIS

    use Icon::Theme::Helper;

    my $iconhelper = Icon::Theme::Helper->new();

METHODS

new

This initializes the object.

args hash ref

alwaysIncludeHicolor

Always include the hicolor theme.

This defaults to '1'.

alwaysIncludeGnome

Always include the gnome theme.

This defaults to '1'.

dir

This is the icon dir to use.

If this is not defined, the first directory found below will be used.

    /usr/local/share/icons
    /usr/share/icons

maxSize

This is the maximum size to use.

If undefined, there is no upper size limit.

minSize

This is the minimum size to use.

If undefined, there is no lower size limit.

scalable

Wether or not to use scalable icons.

If not defined, this defaults to 1.

size

This is the prefered size to use.

If this is not defined, '32' is used.

skip

A list of inherited themes to skip.

theme

This is the icon theme to use.

If none is specified, 'hicolor' is used.

getIcon

This returns the icon file.

The first arguement is the context and the second is the icon name.

    my $iconFile=$iconhelper->getIcon('Places', 'desktop');

getMimeTypeIcon

This searches and feches a MIME type icon.

One arguement is taken and it is the MIME type.

    $iconFile=$iconhelper->getMimeTypeIcon('application/pdf');

ERROR METHODS

error

This fetches any current errors.

A return of undef, false, indicates no error is present.

    if($iconhelper->error){
        warn("Error!");
    }

errorblank

This blanks any previous error.

This is a internal function.

ERROR CODES

1

No directory specified and one could not be automatically located.

2

The specified directory does not exist.

3

The specified theme does not exist.

4

The theme is not a Freedesktop.org compliant theme.

5

Parsing the index for the specified config failed.

6

No context specified.

7

No icon name specified.

8

No MIME type specified.

AUTHOR

Zane C. Bowers, <vvelox at vvelox.net>

BUGS

Please report any bugs or feature requests to bug-icon-theme-helper at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Icon-Theme-Helper. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Icon::Theme::Helper

You can also look for information at:

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE

Copyright 2009 Zane C. Bowers, all rights reserved.

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