1 <!-- manual page source format generated by PolyglotMan v3.0.4, -->
2 <!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
6 <TITLE>legend(n) manual page</TITLE>
9 <A HREF="#toc">Table of Contents</A><P>
11 <H2><A NAME="sect0" HREF="#toc0">NAME </A></H2>
12 legend - Create and manipulate EPTcl legends <P>
14 <H2><A NAME="sect1" HREF="#toc1">SYNOPSIS </A></H2>
16 filename </I></B> options <P>
17 <B>legend parse<I> string </I></B> <P>
18 <B>legend set<I> list </I></B> <P>
20 <H2><A NAME="sect2" HREF="#toc2">DESCRIPTION
23 <B>legend </B> creates legend object, which is used to store and manipulate
24 descriptive information about maps. There are three ways to create legend:
28 <DT>from file, which shoild be an EPPL7 legend file </DT>
31 <DT>from string, which should
32 hold content of such file </DT>
35 <DT>from Tcl list, simular to one, used for <B>array
36 set </B> command </DT>
40 <B>legend </B> command returns handle for legend which is unique
41 identifier, used for subsequent references for this legend. It creates
42 new Tcl command with name of this identifier, that used to manipulate
44 Actually, legend object is combination of global array and Tcl
45 procedure, and legend handle is simply name of both of them. <P>
47 <H2><A NAME="sect3" HREF="#toc3">OPTIONS
52 <DT><B>legend read<I> filename </I></B> </DT>
53 <DD>Opens and reads text file in EPPL7 format. Each
54 line of this file contain number and descriptive text, separated by two
55 spaces (originally, there should be some information concering printing
56 map on line printer (not graphical one) between this spaces, but this
57 format is no longer used and supported. Numbers between 0 and 65535 are
58 considered map classes and numbers -2 and -1 have special meaning - they
59 are considered legend title and subtitle respecitvely. There can be several
60 lines with same classes in legend. They are concatenated. Note that EPTcl
61 never uses this line separations as line breaks when outputting legend
62 (may be this should go to BUGS section) </DD>
64 <DT><B>legend parse<I> string </I></B> </DT>
66 legend from string which should be identical to content of EPPL7 legend
69 <DT><B>legend set<I> list </I></B> </DT>
70 <DD>Produces legend from Tcl list. Such list can be
71 obtained by <B>array get <I>legendname </I></B> command. Differ from <B>array set </B> in that
72 finds correct name for legend and defines object command for it. Can be
73 used to create empty legend for subsequentual filling by <I>legendname <B>set
74 </B></I> subcommand. In this case empty list should be specified. </DD>
78 <H2><A NAME="sect4" HREF="#toc4">OBJECT COMMAND
83 <DT><I>legendName<B> classes </B></I> </DT>
84 <DD>Return sorted list of classes defined in legend </DD>
88 <DD>Destructor of object. Unsets all data and destroys object command.
91 <DT><I>legendName<B> drawable<I> ?boolean? </I></B></I></DT>
92 <DD>if boolean specified, set legend drawmode
93 and return nothing. Otherwise returns 0 or 1, depending of current settings.
94 Drawmode controls if legend could be displayed in legend box. </DD>
97 get <I> class </I></B></I> </DT>
98 <DD>Returns value of given class or string "Not defined",such
99 class is not defined. String could be changed by changing value of element
100 <B>udefined_legend </B> of global array <B>fgis </B> </DD>
102 <DT><I>legendName<B> print<I> </I></B></I></DT>
104 of legend in form of EPPL7 legend format as string. </DD>
106 <DT><I>legendName<B> set <I>class
107 value </I></B></I> </DT>
108 <DD>Changes description of given class </DD>
110 <DT><I>legendName<B> subtitle </B></I> ?<I>string
112 <DD>If no <I>string </I> specified, returns current legend subtitle. Otherwise
113 replaces subtitle by given string </DD>
115 <DT><I>legendName<B> title </B></I> ?<I>string </I>? </DT>
117 </I> specified, returns current legend title. Otherwise replaces title by given
121 <H2><A NAME="sect5" HREF="#toc5">BUGS </A></H2>
125 <A NAME="toc"><B>Table of Contents</B></A><P>
127 <LI><A NAME="toc0" HREF="#sect0">NAME</A></LI>
128 <LI><A NAME="toc1" HREF="#sect1">SYNOPSIS</A></LI>
129 <LI><A NAME="toc2" HREF="#sect2">DESCRIPTION</A></LI>
130 <LI><A NAME="toc3" HREF="#sect3">OPTIONS</A></LI>
131 <LI><A NAME="toc4" HREF="#sect4">OBJECT COMMAND</A></LI>
132 <LI><A NAME="toc5" HREF="#sect5">BUGS</A></LI>