[ Main Table Of Contents | Table Of Contents | Keyword Index ]

famfamfam::subset(n) 1 doc "FamFamFam Icon Sets For Tcl"

Name

famfamfam::subset - FamFamFam Sub Setting

Table Of Contents
Synopsis
Description
API
Bugs, Ideas, Feedback
Keywords
Category
Copyright

Synopsis

package require Tk 8.5
package require Tcl 8.5
package require img::png
package require famfamfam ?1.1?
package require famfamfam::subset 1

::famfamfam::subset new name version path
::famfamfam::subset save iconset name path
::famfamfam::subset done

Description

Welcome to famfamfam, a set of packages providing access to the same-named icon sets created by Mark James, at http://www.famfamfam.com/lab/icons/

This package is a helper to ease the creation of icon packages which are a subset of one or more icon packages based on the famfamfam core.

It resides in the Icon Set level of the architecture arch_subset

API

::famfamfam::subset new name version path

This method starts the generation of a new icon package, with the given name and version. The package is assembled in the directory path. The directory will be created if necessary.

The result of the method is the empty string.

An error will be thrown if a package is already in assembly.

After this method has been issued the methods save and done can be used to add icons to the new package, and to complete the assembly.

As a side-effect the famfamfam core is configured with an callback which will automatically save all icons which are loaded by famfamfam core based packages.

::famfamfam::subset save iconset name path

This method adds the specified icon to the icon package started with method new.

The result of the method is the empty string.

An error will be thrown if no package is in assembly.

::famfamfam::subset done

This method completes the generation of the icon package started with method new.

The result of the method is the empty string.

An error will be thrown if no package is in assembly.

The auto-save callback installed by new is removed.