diff options
Diffstat (limited to 'doc/refman.tex')
| -rw-r--r-- | doc/refman.tex | 138 |
1 files changed, 122 insertions, 16 deletions
diff --git a/doc/refman.tex b/doc/refman.tex index 78470c6..8128ba0 100644 --- a/doc/refman.tex +++ b/doc/refman.tex @@ -35,8 +35,8 @@ menucolor=webdarkblue, citecolor=webbrightgreen, pdftitle={Zinc, an advanced scriptable Canvas.}, - pdfauthor={Patrick Lecoanet, Centre d'ÉTUDE de la Navigation Aérienne}, - pdfsubject={The 3.2.4 Reference Manual.}, + pdfauthor={Patrick Lecoanet, Centre d'Étude de la Navigation Aérienne}, + pdfsubject={The 3.2.6 Reference Manual.}, pdfkeywords={tk tcl perl x11 canvas opengl script gui zinc}, pagebackref, pdfpagemode=None, @@ -94,7 +94,7 @@ \index{#2} \latexhtml{\ifpdf\hyperdef{mapcmd}{#2}{}\fi}{\htmlrule[WIDTH="300" left]} {\tt\large mapinfo #1 {\bf #2} #3}\\ - {\tt\large \$zinc->mapinfo(#1, {\bf #2}, #3) } + {\tt\large \$mainwindow->mapinfo(#1, {\bf #2}, #3) } % slightly buggy XXX : missing commas when #3 contains many words } @@ -201,7 +201,7 @@ \title{Zinc, an advanced scriptable Canvas.\\The 3.2.6 Reference Manual.} \author{Patrick Lecoanet} -\date{27 May 2002} +\date{24 June 2002} \begin{document} @@ -433,6 +433,16 @@ if you want them to be integrated in a future release of Zinc. The Zinc command creates a new Zinc widget, the general form is \begin{quotation} +{\tt\large zinc}\bigskip + +{\tt\large \$version = \$mainwindow->zinc();} +{\tt\large \$Tk::Zinc::version();} + +\end{quotation} + +This two expressions can be used to get the version of Zinc. The string returned by the second expression also details the graphic head available. For example : ``zinc-version-3205d X11 GL''. + +\begin{quotation} {\tt\large zinc pathname ?options?}\bigskip {\tt\large \$mainwindow->Zinc(?option=>value?, ..., ?option=>value?);} @@ -450,7 +460,7 @@ describes the use of groups. The chapter \conceptref{Item ids, tags and indices} describes the item ids and item tags, used as argument in most commands. The options are used to configure how the newly created widget will behave. -They can be changed later by using the \cmdref{configure} and \cmdref{cget} +They can be changed later by using the \cmdref{configure} and \cmdref{itemconfigure} Tk commands. Options apply only to the widget itself. They are a Tk supported concept and @@ -956,7 +966,7 @@ Each item is associated with a unique numerical id which is returned by the \cmd or \cmdref{clone} commands. All commands on items accept those ids as (often first) parameter in order to uniquely identify on which item they should operate. When an id has been allocated to an item, it is never collected even after the item has been destroyed, -in a Zinc session two items cannot have the same id. This is property can be quite useful +in a Zinc session two items cannot have the same id. This property can be quite useful when used in conjonction with tags, which are described below. \section{Tags} @@ -1085,6 +1095,12 @@ item. Indices are accepted as parameters by commands managing text: \cmdref{curs \ident{x} and \ident{y} are interpreted as window coordinates. If the point lies outside of the area corvered by the item, they refer to the first or last character in the line that is closest to the point. +\item{\ident{bol}} +\item{\ident{eol}} +\item{\ident{bow}} +\item{\ident{eow}} +\item{\ident{up}} +\item{\ident{down}} \end{description} @@ -1756,6 +1772,7 @@ false. \zinccmd{gname}{gradientName} {\tt\large \$zinc->{\bf gname}('black:100|white:0/0', 'fading');} +{\tt\large \$exist = \$zinc->{\bf gname}('name_or_gradient');} \begin{blockindent} This command sets a name binding between the given gradient description and the given @@ -1763,6 +1780,10 @@ false. gradient will not be deallocated until the \cmdref{gdelete} command is invoqued on the name (and no item use the gradient). This feature can be a big performance gain when using many gradients in an animation, the name acts here as a caching mecanism. + + When gname is called with only one argument, it returns iehter false or the + name of a named gradient if the argument is either a named gradient or the name + of a named gradient. \end{blockindent} @@ -2256,7 +2277,7 @@ the group. Most items can be used here but notable exceptions are the \objectref performed.} \attribute{group}{composealpha}{boolean}{Specifies if the alpha value inherited from -the parent group should be composed with the alpha of this group. The default value is +the parent group must be composed with the alpha of this group. The default value is {\tt true}.} \attribute{group}{composerotation}{boolean}{Specifies if the current rotation should be @@ -2342,7 +2363,7 @@ Applicable attributes for \ident{track} are : as circles otherwise it will be plotted as squares. The default value is {\tt false}.} \attribute{track}{composealpha}{boolean}{Specifies if the alpha value inherited from -the parent group should be composed with the alpha of this item. The default value is +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} \attribute{track}{composerotation}{boolean}{Specifies if the current rotation should be @@ -2544,7 +2565,7 @@ borders} Applicable attributes for \ident{waypoint} are: \attribute{waypoint}{composealpha}{boolean}{Specifies if the alpha value inherited from -the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} \attribute{waypoint}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}. } @@ -2682,9 +2703,15 @@ Applicable attributes for \ident{tabular} are: \attribute{tabular}{anchor}{anchor}{The anchor used in positionning the item. The default value is {\tt nw}.} +<<<<<<< refman.tex +\attribute{tabular}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{tabular}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{tabular}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -2727,6 +2754,10 @@ case, they must get the focus for keyboards events with the command \cmdref{focu Zinc options (see chapter \conceptref{Widget options}{options} can be used for configuring the text input (for example : \optref{insertbackground}, \optref{insertofftime} \optref{insertontime}, \optref{insertwidth}). +A perl module, called Tk::ZincText (see the section \conceptref{ZincText.pm}{zinctext}) is provided for easing text input in text items +(it can also be used for text input in labelled items such as \objectref{track}, +\objectref{waypoints} or \objectref{tabular}). + Applicable attributes for \ident{text} are: @@ -2740,9 +2771,15 @@ value is {\tt nw}.} characters, the overstrike and underline lines. The default value is the current value of the widget option \optref{forecolor}.} +<<<<<<< refman.tex +\attribute{text}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{text}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{text}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -2808,14 +2845,20 @@ value is {\tt nw}.} \attribute{icon}{color}{gradient}{Specifies the fill color used for drawing the bitmap. The default value is the current value of the widget option \optref{forecolor}.} +<<<<<<< refman.tex +\attribute{icon}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{icon}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{icon}{composerotation}{boolean}{Specifies if the current rotation should be -composed with the local transform. The default value is {\tt true}.} +composed with the local transform. The default value is {\tt false}.} \attribute{icon}{composescale}{boolean}{Specifies if the current scale should be composed -with the local transform. The default value is {\tt true}.} +with the local transform. The default value is {\tt false}.} \attribute{icon}{connecteditem}{item}{Specifies the item relative to which this item is placed.} @@ -2862,9 +2905,15 @@ circles. The default value is the current value of the widget option \optref{for \attribute{reticle}{brightlinestyle}{linestyle}{This is the line style of the highlighted circles. The default value is {\tt simple}.} +<<<<<<< refman.tex +\attribute{reticle}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{reticle}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{reticle}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -2922,9 +2971,15 @@ Map items are used for XXX. map. The texts and symbols that are part of the map are also drawn in this color. The default value is the current value of the widget option \optref{forecolor}.} +<<<<<<< refman.tex +\attribute{map}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{map}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{map}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -2977,9 +3032,15 @@ value is {\tt ""}.} Applicable attributes for \ident{rectangle} are: +<<<<<<< refman.tex +\attribute{rectangle}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{rectangle}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{rectangle}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -3053,9 +3114,15 @@ value is {\tt true}.} closed. This is only pertinent if the arc extent is less than 360 degrees. The default value is {\tt false}.} +<<<<<<< refman.tex +\attribute{arc}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{arc}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{arc}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -3149,9 +3216,15 @@ flat. The default value is {\tt round}.} \attribute{curve}{closed}{boolean}{Specifies if the curve outline should be drawn between the first and last vertex or not. The default value is {\tt true}.} +<<<<<<< refman.tex +\attribute{curve}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{curve}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{curve}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -3249,9 +3322,15 @@ Applicable attributes for \ident{bezier} are: attribute is only applicable if the bezier is not closed and the outline relief is flat. The default value is {\tt round}.} +<<<<<<< refman.tex +\attribute{bezier}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{bezier}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{bezier}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -3327,9 +3406,15 @@ XXX A relire et reprendre \attribute{triangles}{colors}{gradientlist}{Specifies the colors of each vertex of the triangles XXX.} +<<<<<<< refman.tex +\attribute{triangles}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{triangles}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{triangles}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -3378,9 +3463,15 @@ Applicable attributes for \ident{window} items are: \attribute{window}{anchor}{anchor}{The anchor used in positionning the item. The default value is {\tt nw}.} +<<<<<<< refman.tex +\attribute{window}{composealpha}{boolean}{Specifies if the alpha value inherited from +the parent group must be composed with the alpha of this item. The default value is {\tt true}.} + +======= \attribute{window}{composealpha}{boolean}{Specifies if the alpha value inherited from the parent group should be composed with the alpha of this item. The default value is {\tt true}.} +>>>>>>> 1.29 \attribute{window}{composerotation}{boolean}{Specifies if the current rotation should be composed with the local transform. The default value is {\tt true}.} @@ -3470,7 +3561,11 @@ labelformat, you can : Fields can have bindings (see command \cmdref{bind}). It is also possible to know which field the mouse cursor is over with the command \cmdref{currentpart}. Fields can be -configured by modifying their attributes as described by next section. +configured by modifying their attributes as described by next section. A perl module, +called Tk::ZincText (see the section \conceptref{ZincText.pm}{zinctext}) is provided for easing text input in text fields (it can also be +used for text input in \objectref{text} item). + + \section{Attributes for fields} \object{field} @@ -3748,11 +3843,14 @@ by any new user of Zinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.} others popular formats are added including JPEG, XPM and PNG. \end{blockindent} +<<<<<<< refman.tex +======= \attrtype{priority} \begin{blockindent} A strictly positive integer value for the display priority. \end{blockindent} +>>>>>>> 1.29 \attrtype{item} \begin{blockindent} Describes an item id or a tag. If a tag is provided an item will be searched for the tag @@ -3891,13 +3989,20 @@ by any new user of Zinc: \attrtyperef{gradient} and \attrtyperef{labelformat}.} dimensional delta (used for example to describe the speed vector of a track item). \end{blockindent} +\attrtype{priority} +\begin{blockindent} + A strictly positive integer value for the display priority. +\end{blockindent} + \attrtype{relief} \begin{blockindent} - Describes a border relief. The possible values are {\tt flat}, {\tt groove}, {\tt - raised}, {\tt ridge}, {\tt sunken}, {\tt roundraised}, {\tt roundsunken}, - {\tt roundgroove}, {\tt roundridge}, {\tt sunkenrule}, {\tt raisedrule}. + Describes a border relief. The possible values, illustrated in the following figure are + {\tt flat}, + {\tt raised}, {\tt sunken}, {\tt ridge}, {\tt groove}, + {\tt roundraised}, {\tt roundsunken}, {\tt roundridge}, {\tt roundgroove}, + {\tt raisedrule}, {\tt sunkenrule}. -\fig{allreliefs}{Examples of all available reliefs} +\fig{allreliefs}{Examples of all available non-flat reliefs} \end{blockindent} @@ -4105,6 +4210,7 @@ are all accessible through an application called \ident{zinc-demos}. These tiny useful for newcomers and as starting points for developing real applications. \section{ZincText.pm} +\concept{zinctext} This perl module offers some text input fonctionalities... To be detailed! |