The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Icon-Theme-List-0.0.0
River stage zero No dependents
++
/ Icon::Theme::List

NAME

Icon::Theme::List - Lists installed icon themes.

VERSION

Version 0.0.0

SYNOPSIS

    use Icon::Theme::List;

    my $iconlist = Icon::Theme::List->new();

FUNCTIONS

new

This initiates it.

One object is accepted and it is a hash reference.

args hash

dir

This dir to use instead of trying to find it automatically.

If this is not specified, the locations below will be checked.

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

check

This checks if the specified theme is present.

One arguement is required and that is the name of the theme to check to see if it is present.

A return value of true means it is present.

    my $returned=$iconlist->check('hicolor');
    if( $iconlist->{error} ){
        print "Error!\n";
    }else{
        if( $returned ){
            print "It is present.\n";
        }
    }

list

This lists the available icon themes.

The returned value is a array.

    my @themes=$iconlist->list;
    if($iconlist->{error}){
        print "Error!\n";
    }

errorblank

This is a internal that blanks any previous errors.

ERROR CODES

The current error code can be found by checking $iconlist->{error}. If it is true, a error is present. A more verbose description can be found by checking $iconlist->{errorString}.

If $iconlist->{perror} is true, then it means that a permanent error is set.

1

No dir specified and one could not be located.

This means that the locations listed below don't exist.

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

2

The specified icon directory is actually not a directory.

3

No theme specified.

AUTHOR

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

BUGS

Please report any bugs or feature requests to bug-icon-theme-list at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Icon-Theme-List. 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::List

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.