adding the doc of -confine -scrollregion -tracksymbol -xscrollcommand -xscrollincrement -yscrollcommand -yscrollincrement TkZinc options

1 files changed, 82 insertions, 10 deletions

diff --git a/doc/refman.tex b/doc/refman.tex
index 1366899..b12a6ae 100644
--- a/doc/refman.tex
+++ b/doc/refman.tex
@@ -36,7 +36,7 @@
     citecolor=webbrightgreen,
     pdftitle={Zinc, an advanced scriptable Canvas.},
     pdfauthor={Patrick Lecoanet, Christophe Mertz, Centre d'Étude de la Navigation Aérienne},
-    pdfsubject={The pre-3.3 (3.294) Reference Manual.},
+    pdfsubject={The pre-3.3 (3.2.95) Reference Manual.},
     pdfkeywords={tk tcl perl x11 canvas opengl script gui TkZinc},
     pagebackref,
     pdfpagemode=None,
@@ -210,7 +210,7 @@
 
 \title{Zinc, an advanced scriptable Canvas.\\The pre 3.3 (3.2.95) Reference Manual.\\\small{[CENA technical Note NT03-532]} }
 \author{Patrick Lecoanet, Christophe Mertz}
-\date{27 June 2003}
+\date{8 Octobre 2003}
 
 
 \begin{document}
@@ -293,11 +293,11 @@ This document is also referenced as CENA technical note NT03-532.
 
 \subsection{Differences between 3.2.95 and 3.2.6 release}
 \begin{itemize}
-\item  TkZinc now works on windows (with Tcl).
-\item  compilation on Linux works fine now.
+\item  TkZinc with Tcl/Tk now works on windows and MacOS X (with X11 and fink).
+\item  compilation on Linux works fine now, and TkZinc for Perl is on the CPAN
 \item  A powerful perl module Tk::Zinc::Graphics has been added to help creating
 complex curves 
-\item  png images with transparencies can now be displayed (requires openGL rendering only)
+\item  png images with transparencies can now be displayed (requires openGL rendering)
 \item  bezier items have been suppressed; they can now be easily replaced by curve items.
 \item  curve items support now a higher level of description: they may be composed of line
 segments, and bezier segments. In the future they may also support other kinds of segments
@@ -576,6 +576,13 @@ actual source of the default color. Its default value is
   coordinates (See \cident{TkGet\_Pixels}). The default value is {\tt 2}.
 \end{blockindent}
 
+\option{confine}{confine}{Confine}
+\begin{blockindent}
+  Specifies a boolean value that indicates whether or not it should be allowable
+  to set the TkZinc's view outside the region defined by the \optref{scrollregion}.
+  Defaults to true, which means that the view will be constrained within the scroll region.
+\end{blockindent}
+
 \option{cursor}{cursor}{Cursor}
 \begin{blockindent}
   Specifies the cursor to use when the pointer is in the TkZinc window.  The default
@@ -696,8 +703,8 @@ actual source of the default color. Its default value is
 \option{relief}{relief}{Relief}
 \begin{blockindent}
   Specifies the border relief. This option can be given any legal value for a relief
-  (See \attrtyperef{relief} for a description of possible values). XXX what is the meaning
-  of this option. The default value is {\tt flat}.
+  (See \attrtyperef{relief} for a description of possible values). The default
+   value is {\tt flat}.
 \end{blockindent}
 
 \option{render}{render}{Render}
@@ -716,6 +723,13 @@ actual source of the default color. Its default value is
   default value is {\tt true}.
 \end{blockindent}
 
+\option{scrollregion}{scrollRegion}{ScrollRegion}
+\begin{blockindent}
+  Specifies a list with four coordinates describing the left, top, right, and bottom
+  coordinates of a rectangular region. This region is used for scrolling purposes and
+  is considered to be the boundary of the information in the TkZinc.
+\end{blockindent}
+
 \option{selectbackground}{selectBackground}{SelectBackground}  %% XXX CM Foreground ?!
 \begin{blockindent}
   Specifies the background color to use for displaying the selection in text
@@ -767,6 +781,7 @@ actual source of the default color. Its default value is
   attribute. The default value is {\tt 6}.
 \end{blockindent}
 
+
 \option{trackmanagehistory}{trackManageHistory}{TrackManageHistory}
 \begin{blockindent}
   This option accepts any form valid for a boolean. It specifies if the track items
@@ -774,13 +789,70 @@ actual source of the default color. Its default value is
   speckles. If this option is turned off and then back on, the history list is erased
   and the collection is resumed at the next available position. The number of
   position collected in the history list is specified by the option
-  \optref{trackmanagedhistorysize}.  When this many positions are collected, the
+  \optref{trackmanagedhistorysize}. When this many positions are collected, the
   oldest is dropped to make room for the new one on a first in first out basis. The
   number of past positions actually displayed if specified for each track by the
-  \attributeref{track}{visiblehistorysize} attribute.  The default is to enable the history
+  \attributeref{track}{visiblehistorysize} attribute. The default is to enable the history
   collection.
 \end{blockindent}
 
+
+\option{tracksymbol}{trackSymbol}{TrackSymbol}
+\begin{blockindent}
+  Specifies the symbol displayed at the current position of a track. This option
+  accepts a \attrtyperef{bitmap}. The default value is {\tt AtcSymbol15}.
+\end{blockindent}
+
+
+\option{xscrollcommand}{xScrollCommand}{ScrollCommand}
+\begin{blockindent}
+  Specifies a callback used to communicate with horizontal scrollbars. When
+  the view in the widget's window changes (or whenever anything else occurs
+  that could change the display in a scrollbar, such as a change in the total
+  size of the widget's contents), the widget will make a callback passing two
+  numeric arguments in addition to any specified in the callback. Each of the
+  numbers is a fraction between 0 and 1, which indicates a position in the
+  document. 0 indicates the beginning of the document, 1 indicates the end,
+  .333 indicates a position one third the way through the document, and so on.
+  The first fraction indicates the first information in the document that is
+  visible in the window, and the second fraction indicates the information
+  just after the last portion that is visible. Typically the xScrollCommand
+  option consists of the scrollbar widget object and the method ``set'' i.e.
+  [set => \$sb]: this will cause the scrollbar to be updated whenever the view
+  in the window changes. If this option is not specified, then no command
+  will be executed.
+\end{blockindent}
+
+\option{xscrollincrement}{scrollincrement}{xScrollIncrement}
+\begin{blockindent}
+  Specifies an increment for horizontal scrolling. If the value of this option
+  is greater than zero, the horizontal view in the window will be constrained
+  so that the TkZinc x coordinate at the left edge of the window is always an
+  even multiple of {\tt xScrollIncrement}; furthermore, the units for scrolling
+  (e.g., the change in view when the left and right arrows of a scrollbar are
+  selected) will also be {\tt xScrollIncrement}. If the value of this option
+  is less than or equal to zero, then horizontal scrolling is unconstrained.
+\end{blockindent}
+
+\option{yscrollcommand}{yScrollCommand}{ScrollCommand}
+\begin{blockindent}
+  Specifies a callback used to communicate with vertical scrollbars. This option
+  is treated in the same way as the xScrollCommand option, except that it is used
+  for vertical scrollbars and is provided by widgets that support vertical
+  scrolling. See the description of xScrollCommand for details on how this option is used.
+\end{blockindent}
+
+\option{yscrollincrement}{scrollincrement}{yScrollIncrement}
+\begin{blockindent}
+  Specifies an increment for vertical scrolling. If the value of this option
+  is greater than zero, the vertical view in the window will be constrained
+  so that the TkZinc y coordinate at the left edge of the window is always an
+  even multiple of {\tt yScrollIncrement}; furthermore, the units for scrolling
+  (e.g., the change in view when the top and bottom arrows of a scrollbar are
+  selected) will also be {\tt yScrollIncrement}. If the value of this option
+  is less than or equal to zero, then vertical scrolling is unconstrained.
+\end{blockindent}
+
 \option{width}{width}{Width}
 \begin{blockindent}
   Specifies the width of the TkZinc window. This value can be given in any of
@@ -2889,7 +2961,7 @@ position. The default is {\tt false}. Not yet available without openGL}
 {\tt 1}.}
 
 \attribute{track}{symbol}{bitmap}{The symbol displayed at the current position. The
-default value is {\tt AtcSymbol15}.}
+default value is the current value of the widget option \optref{tracksymbol}.} 
 
 \attribute{track}{symbolcolor}{gradient}{The uniforme (possibly transparent) color of the symbol
 displayed at the current position. The first color of a real gradient color will be used.