Pratt 1.5.6

data/pkgs/tile-0.8.2/doc/xml/progressbar.tmml

@@ -0,0 +1,151 @@
+<manpage cat="cmd" id="progressbar" title="progressbar" version="0.6">
+<!-- This file was automatically generated.  DO NOT EDIT (yet)! -->
+<!-- 
+     Copyright (c) 2005 Joe English
+ -->
+<?TROFF.TH title="progressbar" section="n" date="0.6" source="tile" manual="Tile Widget Set" ?>
+<namesection>
+<name>ttk::progressbar</name>
+<desc>Provide progress feedback</desc>
+</namesection>
+<synopsis>
+<syntax>
+<b>ttk::progressbar</b> <m>pathName</m> ?<m>options</m>?
+</syntax>
+</synopsis>
+<section>
+<title>STANDARD OPTIONS</title>
+<sl cat="stdopt" cols="4">
+<li>-class</li>
+<li>-cursor</li>
+<li>-style</li>
+<li>-takefocus</li>
+</sl>
+</section>
+<section>
+<title>OPTIONS</title>
+<optionlist>
+<optiondef>
+<name>-orient</name>
+<dbname>orient</dbname>
+<dbclass>Orient</dbclass>
+<desc>One of <b>horizontal</b> or <b>vertical</b>.
+Specifies the orientation of the progress bar.
+</desc>
+</optiondef>
+<optiondef>
+<name>-length</name>
+<dbname>length</dbname>
+<dbclass>Length</dbclass>
+<desc>Specifies the length of the long axis of the progress bar
+(width if horizontal, height if vertical).
+</desc>
+</optiondef>
+<optiondef>
+<name>-mode</name>
+<dbname>mode</dbname>
+<dbclass>Mode</dbclass>
+<desc>One of <b>determinate</b> or <b>indeterminate</b>.
+</desc>
+</optiondef>
+<optiondef>
+<name>-maximum</name>
+<dbname>maximum</dbname>
+<dbclass>Maximum</dbclass>
+<desc>A floating point number specifying the maximum <b>-value</b>.
+Defaults to 100.
+</desc>
+</optiondef>
+<optiondef>
+<name>-value</name>
+<dbname>value</dbname>
+<dbclass>Value</dbclass>
+<desc>The current value of the progress bar.
+In <i>determinate</i> mode, this represents the amount of work completed.
+In <i>indeterminate</i> mode, it is interpreted modulo <b>-maximum</b>;
+that is, the progress bar completes one "cycle" when
+the <b>-value</b> increases by <b>-maximum</b>.
+</desc>
+</optiondef>
+<optiondef>
+<name>-variable</name>
+<dbname>variable</dbname>
+<dbclass>Variable</dbclass>
+<desc>The name of a Tcl variable which is linked to the <b>-value</b>.
+If specified, the <b>-value</b> of the progress bar is 
+automatically set to the value of the variable whenever 
+the latter is modified.
+</desc>
+</optiondef>
+<optiondef>
+<name>-phase</name>
+<dbname>phase</dbname>
+<dbclass>Phase</dbclass>
+<desc>Read-only option.
+The widget periodically increments the value of this option 
+whenever the <b>-value</b> is greater than 0 and,
+in <i>determinate</i> mode, less than <b>-maximum</b>.
+This option may be used by the current theme 
+to provide additional animation effects.
+</desc>
+</optiondef>
+</optionlist>
+</section>
+<section>
+<title>DESCRIPTION</title>
+<p>A progress bar widget shows the status of a long-running operation.
+They can operate in two modes: <i>determinate</i> mode shows the
+amount completed relative to the total amount of work to be done,
+and <i>indeterminate</i> mode provides an animated display to
+let the user know that something is happening.
+</p>
+</section>
+<section>
+<title>WIDGET COMMAND</title>
+<dl>
+<dle>
+<dt><m>pathName</m> <b>cget</b> <m>option</m></dt>
+<dd>Returns the current value of the specified <i>option</i>; see <i>widget(n)</i>.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>configure</b> ?<m>option</m>? ?<m>value option value ...</m>?</dt>
+<dd>Modify or query widget options; see <i>widget(n)</i>.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>instate</b> <m>statespec</m> ?<m>script</m>?</dt>
+<dd>Test the widget state; see <i>widget(n)</i>.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>start</b> ?<m>interval</m>?</dt>
+<dd>Begin autoincrement mode:
+schedules a recurring timer event that calls <b>step</b> 
+every <i>interval</i> milliseconds.
+If omitted, <i>interval</i> defaults to 50 milliseconds (20 steps/second).
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>state</b> ?<m>stateSpec</m>?</dt>
+<dd>Modify or query the widget state; see <i>widget(n)</i>.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>step</b> ?<m>amount</m>?</dt>
+<dd>Increments the <b>-value</b> by <i>amount</i>.  
+<i>amount</i> defaults to 1.0 if omitted.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>stop</b></dt>
+<dd>Stop autoincrement mode:
+cancels any recurring timer event initiated by <i>pathName</i> <b>start</b>.
+</dd>
+</dle>
+</dl>
+</section>
+<seealso>
+<ref>widget(n)</ref>
+</seealso>
+</manpage>

data/pkgs/tile-0.8.2/doc/xml/radiobutton.tmml

@@ -0,0 +1,109 @@
+<manpage cat="widget" id="radiobutton" title="radiobutton" version="0.2">
+<!-- This file was automatically generated.  DO NOT EDIT (yet)! -->
+<!-- 
+     Copyright (c) 2004 Joe English
+ -->
+<?TROFF.TH title="radiobutton" section="n" date="0.2" source="tile" manual="Tile Widget Set" ?>
+<namesection>
+<name>ttk::radiobutton</name>
+<desc>Mutually exclusive option widget</desc>
+</namesection>
+<synopsis>
+<syntax>
+<b>ttk::radiobutton</b> <m>pathName</m> ?<m>options</m>?
+</syntax>
+</synopsis>
+<section>
+<title>DESCRIPTION</title>
+<p><b cat="AMBIGUOUS widget cmd">radiobutton</b> widgets are used in groups to show or change
+a set of mutually-exclusive options.
+Radiobuttons are linked to a Tcl variable,
+and have an associated value; when a radiobutton is clicked,
+it sets the variable to its associated value.
+</p>
+</section>
+<section>
+<title>STANDARD OPTIONS</title>
+<sl cat="stdopt" cols="4">
+<li>-class</li>
+<li>-compound</li>
+<li>-cursor</li>
+<li>-image</li>
+<li>-state</li>
+<li>-style</li>
+<li>-takefocus</li>
+<li>-text</li>
+<li>-textvariable</li>
+<li>-underline</li>
+<li>-width</li>
+</sl>
+</section>
+<section>
+<title>OPTIONS</title>
+<optionlist>
+<optiondef>
+<name>-command</name>
+<dbname>command</dbname>
+<dbclass>Command</dbclass>
+<desc>A Tcl script to evaluate whenever the widget is invoked.
+</desc>
+</optiondef>
+<optiondef>
+<name>-value</name>
+<dbname>Value</dbname>
+<dbclass>Value</dbclass>
+<desc>The value to store in the associated <i>-variable</i> 
+when the widget is selected. 
+</desc>
+</optiondef>
+<optiondef>
+<name>-variable</name>
+<dbname>variable</dbname>
+<dbclass>Variable</dbclass>
+<desc>The name of a global variable whose value is linked to the widget.
+Default value is <b>::selectedButton</b>.
+</desc>
+</optiondef>
+</optionlist>
+</section>
+<section>
+<title>WIDGET COMMAND</title>
+<p>In addition to the standard 
+<b>cget</b>, <b>configure</b>, <b>instate</b>, and <b>state</b> 
+commands, radiobuttons support the following additional
+widget commands:
+</p>
+<dl>
+<dle>
+<dt><m>pathname</m> invoke</dt>
+<dd>Sets the <i>-variable</i> to the <i>-value</i>, selects the widget,
+and evaluates the associated <i>-command</i>.  
+Returns the result of the <i>-command</i>, or the empty
+string if no <i>-command</i> is specified.
+</dd>
+</dle>
+</dl>
+</section>
+<section>
+<title>WIDGET STATES</title>
+<p>The widget does not respond to user input if the <b>disabled</b> state is set.
+The widget sets the <b>selected</b> state whenever 
+the linked <b>-variable</b> is set to the widget's <b>-value</b>,
+and clears it otherwise.
+The widget sets the <b>alternate</b> state whenever the 
+linked <b>-variable</b> is unset.  
+(The <b>alternate</b> state may be used to indicate a ``tri-state'' 
+or ``indeterminate'' selection.)
+</p>
+</section>
+<seealso>
+<ref>widget(n)</ref>
+<ref>keynav(n)</ref>
+<ref>checkbutton(n)</ref>
+</seealso>
+<keywords>
+<keyword>widget</keyword>
+<keyword>button</keyword>
+<keyword>option</keyword>
+</keywords>
+</manpage>

data/pkgs/tile-0.8.2/doc/xml/scrollbar.tmml

@@ -0,0 +1,233 @@
+<manpage cat="widget" id="scrollbar" title="scrollbar" version="0.5">
+<!-- This file was automatically generated.  DO NOT EDIT (yet)! -->
+<!-- 
+     SOURCE: tk/doc/scrollbar.n, r1.4
+    
+     Copyright (c) 1990-1994 The Regents of the University of California.
+     Copyright (c) 1994-1996 Sun Microsystems, Inc.
+     Copyright (c) 2004 Joe English
+    
+     See the file "license.terms" for information on usage and redistribution
+     of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+     
+     scrollbar.n,v 1.4 2006/11/27 05:45:02 jenglish Exp
+ -->
+<?TROFF.TH title="scrollbar" section="n" date="0.5" source="tile" manual="Tile Widget Set" ?>
+<namesection>
+<name>ttk::scrollbar</name>
+<desc>Control the viewport of a scrollable widget</desc>
+</namesection>
+<synopsis>
+<syntax>
+<b>ttk::scrollbar</b> <m>pathName</m> ?<m>options...</m>?
+</syntax>
+</synopsis>
+<section>
+<title>STANDARD OPTIONS</title>
+<sl cat="stdopt" cols="4">
+<li>-class</li>
+<li>-cursor</li>
+<li>-style</li>
+<li>-takefocus</li>
+</sl>
+</section>
+<section>
+<title>WIDGET-SPECIFIC OPTIONS</title>
+<optionlist>
+<optiondef>
+<name>-command</name>
+<dbname>command</dbname>
+<dbclass>Command</dbclass>
+<desc>A Tcl script prefix to evaluate 
+to change the view in the widget associated with the scrollbar.
+Additional arguments are appended to the value of this option,
+as described in <ref refid="scrolling-commands">SCROLLING COMMANDS</ref> below,
+whenever the user requests a view change by manipulating the scrollbar.
+<br/>This option typically consists of a two-element list,
+containing the name of a scrollable widget followed by
+either <b>xview</b> (for horizontal scrollbars)
+or <b>yview</b> (for vertical scrollbars).
+</desc>
+</optiondef>
+<optiondef>
+<name>-orient</name>
+<dbname>orient</dbname>
+<dbclass>Orient</dbclass>
+<desc>One of <b>horizontal</b> or <b>vertical</b>.
+Specifies the orientation of the scrollbar.
+</desc>
+</optiondef>
+</optionlist>
+</section>
+
+
+<section>
+<title>DESCRIPTION</title>
+<p>Scrollbar widgets are typically linked to an associated window
+that displays a document of some sort,
+such as a file being edited or a drawing.
+A scrollbar displays a <i>thumb</i> in the 
+middle portion of the scrollbar,
+whose position and size provides information 
+about the portion of the document visible in
+the associated window.
+The thumb may be dragged by the user to control the
+visible region.
+Depending on the theme, two or more arrow buttons may also be present;
+these are used to scroll the visible region in discrete units.
+</p>
+</section>
+<section>
+<title>WIDGET COMMAND</title>
+<dl>
+<dle>
+<dt><m>pathName</m> <b>cget</b> <m>option</m></dt>
+<dd>Returns the current value of the specified <i>option</i>; see <i>widget(n)</i>.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>configure</b> ?<m>option</m>? ?<m>value option value ...</m>?</dt>
+<dd>Modify or query widget options; see <i>widget(n)</i>.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>get</b></dt>
+<dd>Returns the scrollbar settings in the form of a list whose
+elements are the arguments to the most recent <b cat="AMBIGUOUS ambiguous cmd">set</b> widget command.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>instate</b> <m>statespec</m> ?<m>script</m>?</dt>
+<dd>Test the widget state; see <i>widget(n)</i>.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>set</b> <m>first last</m></dt>
+<dd>This command is normally invoked by the scrollbar's associated widget 
+from an <b>-xscrollcommand</b> or <b>-yscrollcommand</b> callback.
+Specifies the visible range to be displayed.
+<i>first</i> and <i>last</i> are real fractions between 0 and 1.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>state</b> ?<m>stateSpec</m>?</dt>
+<dd>Modify or query the widget state; see <i>widget(n)</i>.
+</dd>
+</dle>
+</dl>
+</section>
+<section>
+<title>INTERNAL COMMANDS</title>
+<p>The following widget commands are used internally
+by the TScrollbar widget class bindings.
+</p>
+<dl>
+<dle>
+<dt><m>pathName</m> <b>delta</b> <m>deltaX deltaY</m></dt>
+<dd>Returns a real number indicating the fractional change in
+the scrollbar setting that corresponds to a given change
+in thumb position.  For example, if the scrollbar is horizontal,
+the result indicates how much the scrollbar setting must change
+to move the thumb <i>deltaX</i> pixels to the right (<i>deltaY</i> is
+ignored in this case).
+If the scrollbar is vertical, the result indicates how much the
+scrollbar setting must change to move the thumb <i>deltaY</i> pixels
+down.  The arguments and the result may be zero or negative.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>fraction</b> <m>x y</m></dt>
+<dd>Returns a real number between 0 and 1 indicating where the point
+given by <i>x</i> and <i>y</i> lies in the trough area of the scrollbar,
+where 0.0 corresponds to the top or left of the trough
+and 1.0 corresponds to the bottom or right.
+<i>X</i> and <i>y</i> are pixel coordinates relative to the scrollbar
+widget.
+If <i>x</i> and <i>y</i> refer to a point outside the trough, the closest
+point in the trough is used.
+</dd>
+</dle>
+<dle>
+<dt><m>pathName</m> <b>identify</b> <m>x y</m></dt>
+<dd>Returns the name of the element under the point given 
+by <i>x</i> and <i>y</i>, or an empty string if the point does
+not lie in any element of the scrollbar.
+<i>X</i> and <i>y</i> are pixel coordinates relative to the scrollbar widget.
+</dd>
+</dle>
+</dl>
+</section>
+<section id="scrolling-commands">
+<title>SCROLLING COMMANDS</title>
+<p>When the user interacts with the scrollbar, for example by dragging
+the thumb, the scrollbar notifies the associated widget that it
+must change its view.
+The scrollbar makes the notification by evaluating a Tcl command
+generated from the scrollbar's <b>-command</b> option.
+The command may take any of the following forms.
+In each case, <i>prefix</i> is the contents of the
+<b>-command</b> option, which usually has a form like <b>.t yview</b>
+</p>
+<dl>
+<dle>
+<dt><m>prefix</m> <b>moveto</b> <m>fraction</m></dt>
+<dd><i>Fraction</i> is a real number between 0 and 1.
+The widget should adjust its view so that the point given
+by <i>fraction</i> appears at the beginning of the widget.
+If <i>fraction</i> is 0 it refers to the beginning of the
+document.  1.0 refers to the end of the document, 0.333
+refers to a point one-third of the way through the document,
+and so on.
+</dd>
+</dle>
+<dle>
+<dt><m>prefix</m> <b>scroll</b> <m>number</m> <b>units</b></dt>
+<dd>The widget should adjust its view by <i>number</i> units.
+The units are defined in whatever way makes sense for the widget,
+such as characters or lines in a text widget.
+<i>Number</i> is either 1, which means one unit should scroll off
+the top or left of the window, or -1, which means that one unit
+should scroll off the bottom or right of the window.
+</dd>
+</dle>
+<dle>
+<dt><m>prefix</m> <b>scroll</b> <m>number</m> <b>pages</b></dt>
+<dd>The widget should adjust its view by <i>number</i> pages.
+It is up to the widget to define the meaning of a page;  typically
+it is slightly less than what fits in the window, so that there
+is a slight overlap between the old and new views.
+<i>Number</i> is either 1, which means the next page should
+become visible, or -1, which means that the previous page should
+become visible.
+</dd>
+</dle>
+</dl>
+</section>
+<section>
+<title>WIDGET STATES</title>
+<p>The scrollbar automatically sets the <b>disabled</b> state bit.
+when the entire range is visible (range is 0.0 to 1.0),
+and clears it otherwise.
+It also sets the <b>active</b> and <b>pressed</b> state flags
+of individual elements, based on the position and state of the mouse pointer.
+</p>
+</section>
+<section>
+<title>EXAMPLE</title>
+<example>
+set f [frame .f]
+ttk::scrollbar $f.hsb -orient horizontal -command [list $f.t xview]
+ttk::scrollbar $f.vsb -orient vertical -command [list $f.t yview]
+text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set] 
+grid $f.t -row 0 -column 0 -sticky nsew
+grid $f.vsb -row 0 -column 1 -sticky nsew
+grid $f.hsb -row 1 -column 0 -sticky nsew
+grid columnconfigure $f 0 -weight 1
+grid rowconfigure $f 0 -weight 1
+</example>
+</section>
+<keywords>
+<keyword>scrollbar</keyword>
+<keyword>widget</keyword>
+</keywords>
+</manpage>