NAME

Solstice::IconService - Gives access to a library of icons.

SYNOPSIS

  use Solstice::IconService;
  

DESCRIPTION

Superclass

Solstice::Service

Export

No symbols exported.

Methods

new([\%params])

Creates a new Solstice::IconService object.

setSize($int)

Set the size attribute, in pixels. Available values are 16, 20 and 32.

getSize()

Return the size attribute.

setLocked($bool)

Set the locked boolean attribute. Specifies a "locked" version of the icon if set.

getLocked()

Return the locked attribute.

setColor($string)

getColor()

getIconByType($type) {

Return the icon path for the passed file content-type. Returns the path for a generic icon if the type is unknown.

getIconByName($name)

Return an icon path for the passed icon name.

getIconByAction($name)

Return an icon path for the passed icon name.

Private Methods

_getObjectIconPath($icon)

Return a file path for an icon file.

_getActionIconPath($icon)

Return a file path for an icon file.

_getClassName()

Return the class name. Overridden to avoid a ref() in the superclass.

Modules Used

Solstice::Service.

AUTHOR

Catalyst Group, <catalyst@u.washington.edu>

VERSION

$Revision: 3364 $

COPYRIGHT

Copyright 1998-2007 Office of Learning Technologies, University of Washington

Licensed under the Educational Community License, Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: http://www.opensource.org/licenses/ecl1.php

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.