--- /dev/null
+<!-- manual page source format generated by PolyglotMan v3.0.4, -->
+<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
+
+<HTML>
+<HEAD>
+<TITLE>legend(n) manual page</TITLE>
+</HEAD>
+<BODY>
+<A HREF="#toc">Table of Contents</A><P>
+
+<H2><A NAME="sect0" HREF="#toc0">NAME </A></H2>
+legend - Create and manipulate EPTcl legends <P>
+
+<H2><A NAME="sect1" HREF="#toc1">SYNOPSIS </A></H2>
+<B>legend read<I>
+filename </I></B> options <P>
+ <B>legend parse<I> string </I></B> <P>
+ <B>legend set<I> list </I></B> <P>
+
+<H2><A NAME="sect2" HREF="#toc2">DESCRIPTION
+</A></H2>
+<P>
+ <B>legend </B> creates legend object, which is used to store and manipulate
+descriptive information about maps. There are three ways to create legend:
+
+<DL>
+
+<DT>from file, which shoild be an EPPL7 legend file </DT>
+<DD></DD>
+
+<DT>from string, which should
+hold content of such file </DT>
+<DD></DD>
+
+<DT>from Tcl list, simular to one, used for <B>array
+set </B> command </DT>
+<DD></DD>
+</DL>
+<P>
+<B>legend </B> command returns handle for legend which is unique
+identifier, used for subsequent references for this legend. It creates
+new Tcl command with name of this identifier, that used to manipulate
+legend. <P>
+Actually, legend object is combination of global array and Tcl
+procedure, and legend handle is simply name of both of them. <P>
+
+<H2><A NAME="sect3" HREF="#toc3">OPTIONS
+</A></H2>
+
+<DL>
+
+<DT><B>legend read<I> filename </I></B> </DT>
+<DD>Opens and reads text file in EPPL7 format. Each
+line of this file contain number and descriptive text, separated by two
+spaces (originally, there should be some information concering printing
+map on line printer (not graphical one) between this spaces, but this
+format is no longer used and supported. Numbers between 0 and 65535 are
+considered map classes and numbers -2 and -1 have special meaning - they
+are considered legend title and subtitle respecitvely. There can be several
+lines with same classes in legend. They are concatenated. Note that EPTcl
+never uses this line separations as line breaks when outputting legend
+(may be this should go to BUGS section) </DD>
+
+<DT><B>legend parse<I> string </I></B> </DT>
+<DD>Produces
+legend from string which should be identical to content of EPPL7 legend
+file. </DD>
+
+<DT><B>legend set<I> list </I></B> </DT>
+<DD>Produces legend from Tcl list. Such list can be
+obtained by <B>array get <I>legendname </I></B> command. Differ from <B>array set </B> in that
+finds correct name for legend and defines object command for it. Can be
+used to create empty legend for subsequentual filling by <I>legendname <B>set
+</B></I> subcommand. In this case empty list should be specified. </DD>
+</DL>
+<P>
+
+<H2><A NAME="sect4" HREF="#toc4">OBJECT COMMAND
+</A></H2>
+
+<DL>
+
+<DT><I>legendName<B> classes </B></I> </DT>
+<DD>Return sorted list of classes defined in legend </DD>
+
+<DT><I>legendName<B>
+delete </B></I> </DT>
+<DD>Destructor of object. Unsets all data and destroys object command.
+</DD>
+
+<DT><I>legendName<B> drawable<I> ?boolean? </I></B></I></DT>
+<DD>if boolean specified, set legend drawmode
+and return nothing. Otherwise returns 0 or 1, depending of current settings.
+Drawmode controls if legend could be displayed in legend box. </DD>
+
+<DT><I>legendName<B>
+get <I> class </I></B></I> </DT>
+<DD>Returns value of given class or string "Not defined",such
+class is not defined. String could be changed by changing value of element
+<B>udefined_legend </B> of global array <B>fgis </B> </DD>
+
+<DT><I>legendName<B> print<I> </I></B></I></DT>
+<DD>Returns content
+of legend in form of EPPL7 legend format as string. </DD>
+
+<DT><I>legendName<B> set <I>class
+value </I></B></I> </DT>
+<DD>Changes description of given class </DD>
+
+<DT><I>legendName<B> subtitle </B></I> ?<I>string
+</I>? </DT>
+<DD>If no <I>string </I> specified, returns current legend subtitle. Otherwise
+replaces subtitle by given string </DD>
+
+<DT><I>legendName<B> title </B></I> ?<I>string </I>? </DT>
+<DD>If no <I>string
+</I> specified, returns current legend title. Otherwise replaces title by given
+string </DD>
+</DL>
+
+<H2><A NAME="sect5" HREF="#toc5">BUGS </A></H2>
+None noticed <P>
+
+<HR><P>
+<A NAME="toc"><B>Table of Contents</B></A><P>
+<UL>
+<LI><A NAME="toc0" HREF="#sect0">NAME</A></LI>
+<LI><A NAME="toc1" HREF="#sect1">SYNOPSIS</A></LI>
+<LI><A NAME="toc2" HREF="#sect2">DESCRIPTION</A></LI>
+<LI><A NAME="toc3" HREF="#sect3">OPTIONS</A></LI>
+<LI><A NAME="toc4" HREF="#sect4">OBJECT COMMAND</A></LI>
+<LI><A NAME="toc5" HREF="#sect5">BUGS</A></LI>
+</UL>
+</BODY></HTML>
projects / sites / home_page.git / blobdiff