internal package Foswiki::Plugins::JQueryPlugin::IconService

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

internal package Foswiki::Plugins::JQueryPlugin::IconService

Singleton class that handles all sorts of icons, image as well as font icons

ObjectMethod unload

initialize the service so that it can be reused

ObjectMethod finish

finalizer

ObjectMethod loadIconFont($name)

loads the given font into the current page.

ObjectMethod getIconFont($name)

get an icon font definition. $name can either be the font name, such as "fontawesome", or the prefix as used by the icon itself, e.g. fa for fontawesome icons.

ObjectMethod getIconUrlPath ( $iconName ) → $pubUrlPath

Returns the path to the named icon searching along a given icon search path. This path can be in $Foswiki::cfg{JQueryPlugin}{IconSearchPath} or will fall back to FamFamFamSilkIcons, FamFamFamSilkCompanion1Icons, FamFamFamFlagIcons, FamFamFamMiniIcons, FamFamFamMintIcons As you see installing Foswiki:Extensions/FamFamFamContrib would be nice to have.

= $iconName: name of icon; you will have to know the icon name by heart as listed in your favorite icon set, meaning there's no mapping between something like "semantic" and "physical" icons = $pubUrlPath: the path to the icon as it is attached somewhere in your wiki or the empty string if the icon was not found

ObjectMethod getIcon($id) → \%icon;

get the icon descriptor for the given id

ObjectMethod getIcons() → @list;

get all icons as a sorted list

ObjectMethod getIconIterator() → Foswiki::ListIterator

get a list iterator for all icons

ObjectMethod _readIcons()

read all icon definitions