diff options
Diffstat (limited to 'itcl/iwidgets3.0.0/demos/html/scrolledcanvas.n.html')
| -rw-r--r-- | itcl/iwidgets3.0.0/demos/html/scrolledcanvas.n.html | 649 |
1 files changed, 343 insertions, 306 deletions
diff --git a/itcl/iwidgets3.0.0/demos/html/scrolledcanvas.n.html b/itcl/iwidgets3.0.0/demos/html/scrolledcanvas.n.html index bf0da2c7f77..400bccb46ee 100644 --- a/itcl/iwidgets3.0.0/demos/html/scrolledcanvas.n.html +++ b/itcl/iwidgets3.0.0/demos/html/scrolledcanvas.n.html @@ -1,306 +1,343 @@ -<HTML> -<HEAD> -<TITLE>iwidgets2.2.0 User Commands - scrolledcanvas</TITLE> -</HEAD> -<BODY BGCOLOR="#FFFFFF"> -<H1>iwidgets2.2.0 User Commands - scrolledcanvas</H1> -<HR> -<PRE> - -</PRE> -<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE> - - -</PRE> -<H2>NAME</H2><PRE> - scrolledcanvas - Create and manipulate scrolled canvas widg- - ets - - -</PRE> -<H2>SYNOPSIS</H2><PRE> - <STRONG>scrolledcanvas</STRONG> <EM>pathName</EM> ?<EM>options</EM>? - - -</PRE> -<H2>INHERITANCE</H2><PRE> - itk::Widget <- Labeledwidget <- scrolledcanvas - - -</PRE> -<H2>STANDARD OPTIONS</H2><PRE> - <STRONG>activeBackground</STRONG> <STRONG>background</STRONG> <STRONG>borderWidthcursor</STRONG> - <STRONG>exportSelection</STRONG> <STRONG>font</STRONG> <STRONG>foreground</STRONG> <STRONG>highlightColor</STRONG> - <STRONG>highlightThickness</STRONG> <STRONG>insertBorderWidthinsertOffTimeinsertOnTime</STRONG> - <STRONG>insertWidth</STRONG> <STRONG>relief</STRONG> <STRONG>repeatDelay</STRONG> <STRONG>repeatInterval</STRONG> - <STRONG>selectBackground</STRONG> <STRONG>selectBorderWidthselectForeground</STRONG> - - See the "options" manual entry for details on the standard - options. - - -</PRE> -<H2>ASSOCIATED OPTIONS</H2><PRE> - <STRONG>closeEnough</STRONG> <STRONG>confine</STRONG> <STRONG>scrollRegion</STRONG> <STRONG>xScrollIncrement</STRONG> - <STRONG>yScrollIncrement</STRONG> - - See the "canvas" widget manual entry for details on the - above associated options. - - <STRONG>activeRelief</STRONG> <STRONG>elementBorderWidth</STRONG> <STRONG>jumptroughColor</STRONG> - - See the "scrollbar" widget manual entry for details on the - above associated options. - - -</PRE> -<H2>INHERITED OPTIONS</H2><PRE> - <STRONG>labelBitmap</STRONG> <STRONG>labelFont</STRONG> <STRONG>labelImage</STRONG> <STRONG>labelMargin</STRONG> - <STRONG>labelPos</STRONG> <STRONG>labelText</STRONG> <STRONG>labelVariable</STRONG> - - See the "labeledwidget" class manual entry for details on - the inherited options. - - -</PRE> -<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE> - Name: <STRONG>autoMargin</STRONG> - Class: <STRONG>AutoMargin</STRONG> - Command-Line Switch: <STRONG>-automargin</STRONG> - - Specifies the autoresize extra margin to reserve. This - option is only effective with autoresize turned on. - The default is 10. - - Name: <STRONG>autoResize</STRONG> - Class: <STRONG>AutoResize</STRONG> - Command-Line Switch: <STRONG>-autoresize</STRONG> - - Automatically adjusts the scrolled region to be the - bounding box covering all the items in the canvas fol- - lowing the execution of any method which creates or - destroys items. Thus, as new items are added, the - scrollbars adjust accordingly. - - Name: <STRONG>height</STRONG> - Class: <STRONG>Height</STRONG> - Command-Line Switch: <STRONG>-height</STRONG> - - Specifies the height of the scrolled canvas widget in - any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The - default height is 30 pixels. - - Name: <STRONG>hscrollMode</STRONG> - Class: <STRONG>ScrollMode</STRONG> - Command-Line Switch: <STRONG>-hscrollmode</STRONG> - - Specifies the the display mode to be used for the hor- - izontal scrollbar: <STRONG>static,</STRONG> <STRONG>dynamic,</STRONG> or <STRONG>none</STRONG>. In static - mode, the scroll bar is displayed at all times. - Dynamic mode displays the scroll bar as required, and - none disables the scroll bar display. The default is - static. - - Name: <STRONG>sbWidth</STRONG> - Class: <STRONG>Width</STRONG> - Command-Line Switch: <STRONG>-sbwidth</STRONG> - - Specifies the width of the scrollbar in any of the - forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The default width is - 15 pixels.. - - Name: <STRONG>scrollMargin</STRONG> - Class: <STRONG>ScrollMargin</STRONG> - Command-Line Switch: <STRONG>-scrollmargin</STRONG> - - Specifies the distance between the canvas and scrollbar - in any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The - default is 3 pixels. - - Name: <STRONG>textBackground</STRONG> - Class: <STRONG>Background</STRONG> - Command-Line Switch <STRONG>-textbackground</STRONG> - - Specifies the background color for the canvas. This - allows the background within the canvas to be different - from the normal background color. - - - Name: <STRONG>vscrollMode</STRONG> - Class: <STRONG>ScrollMode</STRONG> - Command-Line Switch: <STRONG>-vscrollmode</STRONG> - - Specifies the the display mode to be used for the vert- - ical scrollbar: <STRONG>static,</STRONG> <STRONG>dynamic,</STRONG> or <STRONG>none</STRONG>. In static - mode, the scroll bar is displayed at all times. - Dynamic mode displays the scroll bar as required, and - none disables the scroll bar display. The default is - static. - - Name: <STRONG>width</STRONG> - Class: <STRONG>Width</STRONG> - Command-Line Switch: <STRONG>-width</STRONG> - - Specifies the width of the scrolled canvas widget in - any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The - default height is 30 pixels. - -</PRE> -<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE> - - - -</PRE> -<H2>DESCRIPTION</H2><PRE> - The <STRONG>scrolledcanvas</STRONG> command creates a scrolled canvas with - additional options to manage horizontal and vertical - scrollbars. This includes options to control which - scrollbars are displayed and the method, i.e. statically or - dynamically. - - - -</PRE> -<H2>METHODS</H2><PRE> - The <STRONG>scrolledcanvas</STRONG> command creates a new Tcl command whose - name is <EM>pathName</EM>. This command may be used to invoke vari- - ous operations on the widget. It has the following general - form: - - <EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...? - - <EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com- - mand. The following commands are possible for scrolledcan- - vas widgets: - - -</PRE> -<H2>ASSOCIATED METHODS</H2><PRE> - <STRONG>addtag</STRONG> <STRONG>bbox</STRONG> <STRONG>bind</STRONG> <STRONG>canvasx</STRONG> - <STRONG>canvasy</STRONG> <STRONG>coords</STRONG> <STRONG>create</STRONG> <STRONG>dchars</STRONG> - <STRONG>delete</STRONG> <STRONG>dtag</STRONG> <STRONG>find</STRONG> <STRONG>focus</STRONG> - <STRONG>gettags</STRONG> <STRONG>icursor</STRONG> <STRONG>index</STRONG> <STRONG>insert</STRONG> - <STRONG>itemconfigure</STRONG> <STRONG>lower</STRONG> <STRONG>move</STRONG> <STRONG>postscript</STRONG> - <STRONG>raise</STRONG> <STRONG>scale</STRONG> <STRONG>scan</STRONG> <STRONG>select</STRONG> - <STRONG>type</STRONG> <STRONG>xview</STRONG> <STRONG>yview</STRONG> - - See the "canvas" manual entry for details on the associated - methods. - - -</PRE> -<H2>WIDGET-SPECIFIC METHODS</H2><PRE> - <EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM> - Returns the current value of the configuration option - given by <EM>option</EM>. <EM>Option</EM> may have any of the values - accepted by the <STRONG>scrolledcanvas</STRONG> command. - - <EM>pathName</EM> <STRONG>childsite</STRONG> - Returns the child site widget path name. - - <EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...? - Query or modify the configuration options of the - widget. If no <EM>option</EM> is specified, returns a list - describing all of the available options for <EM>pathName</EM> - (see <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of - this list). If <EM>option</EM> is specified with no <EM>value</EM>, then - the command returns a list describing the one named - option (this list will be identical to the correspond- - ing sublist of the value returned if no <EM>option</EM> is - specified). If one or more <EM>option</EM> - <EM>value</EM> pairs are - specified, then the command modifies the given widget - option(s) to have the given value(s); in this case the - command returns an empty string. <EM>Option</EM> may have any - of the values accepted by the <STRONG>scrolledcanvas</STRONG> command. - - <EM>pathName</EM> <STRONG>justify</STRONG> <EM>direction</EM> - Justifies the canvas contents via the scroll bars in - one of four directions: <STRONG>left</STRONG>, <STRONG>right</STRONG>, <STRONG>top</STRONG>, or <STRONG>bottom</STRONG>. - - - -</PRE> -<H2>COMPONENTS</H2><PRE> - Name: <STRONG>scrCanvas</STRONG> - Class: <STRONG>Canvas</STRONG> - - The scrCanvas component is the canvas widget. See the - "canvas" widget manual entry for details on the scrCan- - vas component item. - - Name: <STRONG>hSB</STRONG> - Class: <STRONG>Scrollbar</STRONG> - - The hSB component is the horizontal scroll bar. See - the "ScrollBar" widget manual entry for details on the - hSB component item. - - Name: <STRONG>vSB</STRONG> - Class: <STRONG>Scrollbar</STRONG> - - The vSB component is the vertical scroll bar. See the - "ScrollBar" widget manual entry for details on the vSB - component item. - - - -</PRE> -<H2>EXAMPLE</H2><PRE> - scrolledcanvas .sc - - .sc create rectangle 100 100 400 400 -fill red - .sc create rectangle 300 300 600 600 -fill green - .sc create rectangle 200 200 500 500 -fill blue - - pack .sc -padx 10 -pady 10 -fill both -expand yes - - - -</PRE> -<H2>AUTHOR</H2><PRE> - Mark L. Ulferts - - -</PRE> -<H2>KEYWORDS</H2><PRE> - scrolledcanvas, canvas, widget - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -</PRE> -</BODY> -</HTML> +<TITLE>scrolledcanvas - Create and manipulate scrolled canvas widgets</TITLE> +<H1>scrolledcanvas - Create and manipulate scrolled canvas widgets</H1> + +</pre><H2>SYNOPSIS</H2> +<B>scrolledcanvas<I> <I>pathName </I>?<I>options</I>? +</pre><H2>INHERITANCE</H2> +itk::Widget <- Labeledwidget <- Scrolledwidget <- Scrolledcanvas +</pre><H2>STANDARD OPTIONS</H2> +<P> +<table cellpadding=5> +<td valign=top> +<B>activeBackground</B><br> +<B>exportSelection</B><br> +<B>highlightThickness</B><br> +<B>insertWidth</B><br> +<B>selectForeground</B><br> +</td> +<td valign=top> +<B>background</B><br> +<B>font</B><br> +<B>insertBorderWidth</B><br> +<B>relief</B><br> +</td> +<td valign=top> +<B>borderWidth</B><br> +<B>foreground</B><br> +<B>insertOffTime</B><br> +<B>selectBackground</B><br> +</td> +<td valign=top> +<B>cursor</B><br> +<B>highlightColor</B><br> +<B>insertOnTime</B><br> +<B>selectBorderWidth</B><br> +</td> +</table> +<P> +See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/options.n.html"> "options" </A> manual entry for details on the standard options. +</pre><H2>ASSOCIATED OPTIONS</H2> +<P> +<table cellpadding=5> +<td valign=top> +<B>closeEnough</B><br> +<B>yScrollIncrement</B><br> +</td> +<td valign=top> +<B>confine</B><br> +</td> +<td valign=top> +<B>scrollRegion</B><br> +</td> +<td valign=top> +<B>xScrollIncrement</B><br> +</td> +</table> +<P> +See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/canvas.n.html"> "canvas" </A> widget manual entry for details on the above +associated options. +<P> +<table cellpadding=5> +<td valign=top> +<B>activeRelief</B><br> +</td> +<td valign=top> +<B>elementBorderWidth</B><br> +</td> +<td valign=top> +<B>jump</B><br> +</td> +<td valign=top> +<B>troughColor</B><br> +</td> +</table> +<P> +See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/scrollbar.n.html"> "scrollbar" </A> widget manual entry for details on the above +associated options. +</pre><H2>INHERITED OPTIONS</H2> +<P> +<table cellpadding=5> +<td valign=top> +<B>disabledForeground</B><br> +<B>labelMargin</B><br> +<B>state</B><br> +</td> +<td valign=top> +<B>labelBitmap</B><br> +<B>labelPos</B><br> +</td> +<td valign=top> +<B>labelFont</B><br> +<B>labelText</B><br> +</td> +<td valign=top> +<B>labelImage</B><br> +<B>labelVariable</B><br> +</td> +</table> +<P> +See the <A HREF="labeledwidget.n.html"> "labeledwidget" </A> class manual entry for details on the inherited options. +</pre><H2>WIDGET-SPECIFIC OPTIONS</H2> +<P> +<pre> +Name: <B>autoMargin</B> +Class: <B>AutoMargin</B> +Command-Line Switch: <B>-automargin</B> +</pre> +<UL> +Specifies the autoresize extra margin to reserve. This option is only +effective with autoresize turned on. The default is 10. +</UL> +<P> +<pre> +Name: <B>autoResize</B> +Class: <B>AutoResize</B> +Command-Line Switch: <B>-autoresize</B> +</pre> +<UL> +Automatically adjusts the scrolled region to be the bounding +box covering all the items in the canvas following the execution +of any method which creates or destroys items. Thus, as new +items are added, the scrollbars adjust accordingly. +</UL> +<P> +<pre> +Name: <B>height</B> +Class: <B>Height</B> +Command-Line Switch: <B>-height</B> +</pre> +<UL> +Specifies the height of the scrolled canvas widget in any of the forms +acceptable to <B>Tk_GetPixels</B>. The default height is 30 pixels. +</UL> +<P> +<pre> +Name: <B>hscrollMode</B> +Class: <B>ScrollMode</B> +Command-Line Switch: <B>-hscrollmode</B> +</pre> +<UL> +Specifies the the display mode to be used for the horizontal +scrollbar: <B>static, dynamic,</B> or <B>none</B>. In static mode, the +scroll bar is displayed at all times. Dynamic mode displays the +scroll bar as required, and none disables the scroll bar display. The +default is static. +</UL> +<P> +<pre> +Name: <B>sbWidth</B> +Class: <B>Width</B> +Command-Line Switch: <B>-sbwidth</B> +</pre> +<UL> +Specifies the width of the scrollbar in any of the forms acceptable +to <B>Tk_GetPixels</B>. The default width is 15 pixels.. +</UL> +<P> +<pre> +Name: <B>scrollMargin</B> +Class: <B>ScrollMargin</B> +Command-Line Switch: <B>-scrollmargin</B> +</pre> +<UL> +Specifies the distance between the canvas and scrollbar in any of the +forms acceptable to <B>Tk_GetPixels</B>. The default is 3 pixels. +</UL> +<P> +<pre> +Name: <B>textBackground</B> +Class: <B>Background</B> +Command-Line Switch <B>-textbackground</B> +</pre> +<UL> +Specifies the background color for the canvas. This allows the background +within the canvas to be different from the normal background color. +</UL> +<P> +<pre> +Name: <B>vscrollMode</B> +Class: <B>ScrollMode</B> +Command-Line Switch: <B>-vscrollmode</B> +</pre> +<UL> +Specifies the the display mode to be used for the vertical +scrollbar: <B>static, dynamic,</B> or <B>none</B>. In static mode, the +scroll bar is displayed at all times. Dynamic mode displays the +scroll bar as required, and none disables the scroll bar display. The +default is static. +</UL> +<P> +<pre> +Name: <B>width</B> +Class: <B>Width</B> +Command-Line Switch: <B>-width</B> +</pre> +<UL> +Specifies the width of the scrolled canvas widget in any of the forms +acceptable to <B>Tk_GetPixels</B>. The default height is 30 pixels. +</UL> +</pre><HR> + +</pre><H2>DESCRIPTION</H2> +<P> +The <B>scrolledcanvas</B> command creates +a scrolled canvas with additional options to manage +horizontal and vertical scrollbars. This includes options to control +which scrollbars are displayed and the method, i.e. statically or +dynamically. + +</pre><H2>METHODS</H2> +<P> +The <B>scrolledcanvas</B> command creates a new Tcl command whose +name is <I>pathName</I>. This +command may be used to invoke various +operations on the widget. It has the following general form: +<pre> +<I>pathName option </I>?<I>arg arg ...</I>? +</pre> +<I>Option</I> and the <I>arg</I>s +determine the exact behavior of the command. The following +commands are possible for scrolledcanvas widgets: +</pre><H2>ASSOCIATED METHODS</H2> +<P> +<table cellpadding=5> +<td valign=top> +<B>addtag</B><br> +<B>canvasy<B><br> +<B>delete</B><br> +<B>gettags</B><br> +<B>itemconfigure</B><br> +<B>raise</B><br> +<B>type</B><br> +</td> +<td valign=top> +<B>bbox</B><br> +<B>coords</B><br> +<B>dtag</B><br> +<B>icursor</B><br> +<B>lower</B><br> +<B>scale</B><br> +<B>xview</B><br> +</td> +<td valign=top> +<B>bind</B><br> +<B>create</B><br> +<B>find</B><br> +<B>index</B><br> +<B>move</B><br> +<B>scan</B><br> +<B>yview</B><br> +</td> +<td valign=top> +<B>canvasx</B><br> +<B>dchars</B><br> +<B>focus</B><br> +<B>insert</B><br> +<B>postscript</B><br> +<B>select</B><br> +</td> +</table> +<P> +See the <A HREF="http://www.sco.com/Technology/tcl/man/tk_man/canvas.n.html"> "canvas" </A> manual entry for details on the associated methods. + +</pre><H2>WIDGET-SPECIFIC METHODS</H2> +<DL> +<DT> <I>pathName <B>cget</B> <I>option</I> +</I></B> +<DD> Returns the current value of the configuration option given +by <I>option</I>. +<I>Option</I> may have any of the values accepted by the <B>scrolledcanvas</B> +command. +</DL> +<DL> +<DT> <I>pathName <B>childsite</B> +</I></B> +<DD> Returns the child site widget path name. +</DL> +<DL> +<DT> <I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value option value ...</I>? +</I></B> +<DD> Query or modify the configuration options of the widget. +If no <I>option</I> is specified, returns a list describing all of +the available options for <I>pathName</I> (see <B>Tk_ConfigureInfo</B> for +information on the format of this list). If <I>option</I> is specified +with no <I>value</I>, then the command returns a list describing the +one named option (this list will be identical to the corresponding +sublist of the value returned if no <I>option</I> is specified). If +one or more <I>option-value</I> pairs are specified, then the command +modifies the given widget option(s) to have the given value(s); in +this case the command returns an empty string. +<I>Option</I> may have any of the values accepted by the <B>scrolledcanvas</B> +command. +</DL> +<DL> +<DT> <I>pathName <B>justify <I>direction</I> +</I></B> +<DD> Justifies the canvas contents via the scroll bars in one of four directions: +<B>left</B>, <B>right</B>, <B>top</B>, or <B>bottom</B>. + +</DL> +</pre><H2>COMPONENTS</H2> +<P> +<pre> +Name: <B>canvas</B> +Class: <B>Canvas</B> +</pre> +<UL> +The canvas component is the canvas widget. See the "canvas" widget +manual entry for details on the canvas component item. +</UL> +<P> +<pre> +Name: <B>horizsb</B> +Class: <B>Scrollbar</B> +</pre> +<UL> +The horizsb component is the horizontal scroll bar. See the "ScrollBar" +widget manual entry for details on the horizsb component item. +</UL> +<P> +<pre> +Name: <B>vertsb</B> +Class: <B>Scrollbar</B> +</pre> +<UL> +The vertsb component is the vertical scroll bar. See the "ScrollBar" widget +manual entry for details on the vertsb component item. +</UL> +</table> + +</pre><H2>EXAMPLE</H2> +<pre> + scrolledcanvas .sc + + .sc create rectangle 100 100 400 400 -fill red + .sc create rectangle 300 300 600 600 -fill green + .sc create rectangle 200 200 500 500 -fill blue + + pack .sc -padx 10 -pady 10 -fill both -expand yes +</pre> +</pre><H2>AUTHOR</H2> +<A HREF="mailto:mulferts@spd.dsccc.com">Mark L. Ulferts</A> +</pre><H2>KEYWORDS</H2> +scrolledcanvas, canvas, widget |