950 lines
30 KiB
HTML
950 lines
30 KiB
HTML
<html>
|
|
<head>
|
|
<title>Wcb Command Reference</title>
|
|
|
|
<meta name="Author" content="Csaba Nemethi">
|
|
<meta name="Keywords" content="callback, widget, Tk entry, tile entry,
|
|
BWidget Entry, spinbox, tile combobox, listbox, tablelist, text, ctext">
|
|
</head>
|
|
|
|
<body bgcolor=#ffffff>
|
|
<div align=center>
|
|
<h1>Wcb Command Reference</h1>
|
|
|
|
<h3>by</h3>
|
|
|
|
<h2>Csaba Nemethi</h2>
|
|
|
|
<address>
|
|
<a href="mailto:csaba.nemethi@t-online.de">csaba.nemethi@t-online.de</a>
|
|
</address>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="contents"></a>
|
|
<h2>Contents</h2>
|
|
|
|
<ul>
|
|
<li><a href="#callback">The <code><b>wcb::callback</b></code> Command</a>
|
|
<li><a href="#cbappend">The <code><b>wcb::cbappend</b></code> Command</a>
|
|
<li><a href="#cbprepend">The <code><b>wcb::cbprepend</b></code> Command</a>
|
|
<li><a href="#cancel">The <code><b>wcb::cancel</b></code> Command</a>
|
|
<li><a href="#canceled">The <code><b>wcb::canceled</b></code> Command</a>
|
|
<li><a href="#extend">The <code><b>wcb::extend</b></code> Command</a>
|
|
<li><a href="#replace">The <code><b>wcb::replace</b></code> Command</a>
|
|
<li><a href="#pathname">The <code><b>wcb::pathname</b></code> Command</a>
|
|
<li><a href="#change">The <code><b>wcb::changeEntryText</b></code>
|
|
Command</a>
|
|
<li><a href="#entrylen">The <code><b>wcb::postInsertEntryLen</b></code>
|
|
Command</a>
|
|
<li><a href="#entrytext">The <code><b>wcb::postInsertEntryText</b></code>
|
|
Command</a>
|
|
<li><a href="#entrycb">Before-<code><b>insert</b></code> Callbacks for Tk
|
|
entry, tile entry, BWidget Entry, spinbox, and tile combobox Widgets</a>
|
|
<li><a href="#textcb">Before-<code><b>insert</b></code> Callbacks for text
|
|
and ctext Widgets</a>
|
|
</ul>
|
|
|
|
<div align=center>
|
|
<p><a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="callback"></a>
|
|
<h2>The <code><b><font size=5>wcb::callback</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::callback</code> - Retrieve, set, and remove widget callbacks
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::callback</b> <i>widgetName</i> <b>before</b>|<b>after</b> <i>option</i> ?<i>callback</i> <i>callback</i> ...?
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>Retrieves, sets, or removes the callbacks for the Tk entry, tile entry,
|
|
BWidget Entry, spinbox, tile combobox, listbox, tablelist, text, or
|
|
ctext widget <code><i>widgetName</i></code>, the argument
|
|
<code><b>before</b></code> or <code><b>after</b></code>, and the
|
|
command corresponding to <code><i>option</i></code>. The values
|
|
of the <code><i>option</i></code> argument can be:
|
|
|
|
<p>
|
|
<ul>
|
|
<li><code><b>insert</b></code>, <code><b>delete</b></code>, or
|
|
<code><b>motion</b></code>, for a Tk entry, tile entry, BWidget
|
|
Entry, spinbox, tile combobox, text, or ctext widget;
|
|
<li><code><b>activate</b></code>, for a listbox or tablelist widget;
|
|
<li><code><b>selset</b></code> or <code><b>selclear</b></code>, for a
|
|
listbox, tablelist, text, or ctext widget;
|
|
<li><code><b>activatecell</b></code>, <code><b>cellselset</b></code>,
|
|
or <code><b>cellselclear</b></code>, for a tablelist widget.
|
|
</ul>
|
|
|
|
<p>If no arguments after the <code><i>option</i></code> parameter are
|
|
specified, then the procedure just returns the current before- or
|
|
after-callback list, respectively, for the given widget operation.
|
|
|
|
<p>Otherwise:
|
|
|
|
<p>
|
|
<ul>
|
|
<li>If at least one of the arguments following the
|
|
<code><i>option</i></code> parameter is a nonempty string, then:
|
|
|
|
<p>
|
|
<ul>
|
|
<li>if called for the first time for this widget with at least
|
|
one nonempty argument following the
|
|
<code><i>option</i></code> parameter, then the procedure
|
|
renames the Tcl command <code><i>widgetName</i></code> to
|
|
<code>_<i>widgetName</i></code> and builds a new procedure
|
|
<code><i>widgetName</i></code>, in which the execution of
|
|
the widget operations associated with the above values of
|
|
<code><i>option</i></code> is preceded by invocations of
|
|
the corresponding before-callbacks and followed by calls to
|
|
the corresponding after-callbacks, in the global scope;
|
|
|
|
<p>
|
|
<li>it sets the callback list to the one built from these
|
|
arguments and returns the new list.
|
|
</ul>
|
|
<p>
|
|
|
|
<li>If all arguments following the <code><i>option</i></code>
|
|
parameter are empty, then the procedure unregisters all the
|
|
corresponding before- or after-callbacks for the given widget and
|
|
returns an empty string.
|
|
</ul>
|
|
|
|
<p>When a callback is invoked, the name of the original Tcl command for
|
|
the widget <code><i>widgetName</i></code> as well as the command
|
|
arguments are automatically appended to it as parameters.
|
|
|
|
<p>The following table shows the widget subcommands corresponding to
|
|
the above values of <code><i>option</i></code>, together with the
|
|
arguments of these subcommands:
|
|
|
|
<p><a name="callback_table"></a>
|
|
<table border=2 cellspacing=0 cellpadding=4>
|
|
<tr bgcolor=#ffffe0>
|
|
<th align=left>Widget</th>
|
|
<th align=left><code><i>option</i></code></th>
|
|
<th align=left>Subcommand</th>
|
|
<th align=left>Arguments</th>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td rowspan=3><nobr>Tk entry, tile entry,</nobr><br>
|
|
BWidget Entry,<br>
|
|
spinbox, or<br>
|
|
tile combobox</td>
|
|
<td><code><b>insert</b></code></td>
|
|
<td><code><b>insert</b></code></td>
|
|
<td><code><i>index</i> <i>string</i></code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>delete</b></code></td>
|
|
<td><code><b>delete</b></code></td>
|
|
<td><code><i>from</i> ?<i>to</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>motion</b></code></td>
|
|
<td><code><b>icursor</b></code></td>
|
|
<td><code><i>index</i></code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td rowspan=3>listbox</td>
|
|
<td><code><b>activate</b></code></td>
|
|
<td><code><b>activate</b></code></td>
|
|
<td><code><i>index</i></code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>selset</b></code></td>
|
|
<td><code><b>selection set</b></code></td>
|
|
<td><code><i>first</i> ?<i>last</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>selclear</b></code></td>
|
|
<td><code><b>selection clear</b></code></td>
|
|
<td><code><i>first</i> ?<i>last</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td rowspan=6>tablelist</td>
|
|
<td><code><b>activate</b></code></td>
|
|
<td><code><b>activate</b></code></td>
|
|
<td><code><i>index</i></code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>selset</b></code></td>
|
|
<td><code><b>selection set</b></code></td>
|
|
<td><code><i>first</i> ?<i>last</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>selclear</b></code></td>
|
|
<td><code><b>selection clear</b></code></td>
|
|
<td><code><i>first</i> ?<i>last</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>activatecell</b></code></td>
|
|
<td><code><b>activatecell</b></code></td>
|
|
<td><code><i>cellIndex</i></code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>cellselset</b></code></td>
|
|
<td><code><b>cellselection set</b></code></td>
|
|
<td><code><i>first</i> ?<i>last</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>cellselclear</b></code></td>
|
|
<td><code><b>cellselection clear</b></code></td>
|
|
<td><code><i>first</i> ?<i>last</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td rowspan=5>text or ctext</td>
|
|
<td><code><b>insert</b></code></td>
|
|
<td><code><b>insert</b></code></td>
|
|
<td><code><i>index</i> <i>string</i> ?<i>tagList</i>
|
|
<i>string</i> <i>tagList</i> ...?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>delete</b></code></td>
|
|
<td><code><b>delete</b></code></td>
|
|
<td><code><i>from</i> ?<i>to</i>?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>motion</b></code></td>
|
|
<td><code><b>mark set insert</b></code></td>
|
|
<td><code><i>index</i></code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>selset</b></code></td>
|
|
<td><code><b>tag add sel</b></code></td>
|
|
<td><code><i>from</i> ?<i>to</i>
|
|
<i>from</i> <i>to</i> ...?</code></td>
|
|
</tr>
|
|
|
|
<tr>
|
|
<td><code><b>selclear</b></code></td>
|
|
<td><code><b>tag remove sel</b></code></td>
|
|
<td><code><i>from</i> ?<i>to</i>
|
|
<i>from</i> <i>to</i> ...?</code></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<h4>Remarks:</h4>
|
|
|
|
<ol>
|
|
<li>You may abbreviate the words <code><b>before</b></code>,
|
|
<code><b>after</b></code>, <code><b>insert</b></code>,
|
|
<code><b>delete</b></code>, <code><b>motion</b></code>, and
|
|
<code><b>activate</b></code> (for listbox widgets) to a minimum
|
|
of one character. Similarly, the first four characters of
|
|
the words <code><b>selset</b></code> and
|
|
<code><b>selclear</b></code>, the first eight characters of
|
|
<code><b>cellselset</b></code> and
|
|
<code><b>cellselclear</b></code>, and the first nine characters
|
|
of <code><b>activatecell</b></code> are sufficient for Wcb to
|
|
recognize these options.
|
|
|
|
<p>
|
|
<li>After a successful invocation of this command with at least one
|
|
nonempty callback following the <code><i>option</i></code>
|
|
argument, you can use either the new procedure
|
|
<code><i>widgetName</i></code> or the original Tcl command
|
|
<code>_<i>widgetName</i></code> to perform any valid operation on
|
|
the widget <code><i>widgetName</i></code>. Use the old Tcl
|
|
command <code>_<i>widgetName</i></code> if you want to prevent
|
|
the callbacks from being invoked when executing the respective
|
|
widget subcommand.
|
|
|
|
<p>
|
|
<li>When destroying a widget <code><i>widgetName</i></code> for which
|
|
<code><b>wcb::callback</b></code> has replaced the corresponding
|
|
Tcl command with a new procedure, the original command
|
|
<code>_<i>widgetName</i></code> is deleted automatically by the
|
|
Tcl interpreter (this is not true in the case of a BWidget Entry,
|
|
tablelist, or ctext widget). The new widget procedure
|
|
<code><i>widgetName</i></code> would persist, but Wcb arranges
|
|
for it to be deleted from within a cleanup script bound to the
|
|
<code><b><Destroy></b></code> event. This cleanup
|
|
script is associated with a binding tag called
|
|
<code><b>WcbCleanup</b></code>, which is appended to the list of
|
|
binding tags of the widget the first time when registering some
|
|
callbacks for it. (In the case of a BWidget Entry,
|
|
tablelist, or ctext widget, this script also deletes the original
|
|
Tcl command <code>_<i>widgetName</i></code>.)
|
|
|
|
<p>
|
|
<li>The cleanup script mentioned above also unregisters all callbacks
|
|
defined for <code><i>widgetName</i></code>, thus ensuring that a
|
|
widget with the same path created later will not inherit them
|
|
from the widget just deleted (this can be important in some
|
|
applications). For this reason, you should be careful not
|
|
to remove <code><b>WcbCleanup</b></code> from the list of binding
|
|
tags of the given widget!
|
|
</ol>
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>callback, widget, Tk entry, tile entry, BWidget Entry, spinbox, tile
|
|
combobox, listbox, tablelist, text, ctext
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="cbappend"></a>
|
|
<h2>The <code><b><font size=5>wcb::cbappend</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::cbappend</code> - Append to a callback list
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::cbappend</b> <i>widgetName</i> <b>before</b>|<b>after</b> <i>option</i> ?<i>callback</i> <i>callback</i> ...?
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>This command is almost identical to <code><b><a href=
|
|
"#callback">wcb::callback</a></b></code>. The only difference is
|
|
that <code><b>wcb::cbappend</b></code> <i>appends</i> the arguments
|
|
specified after the <code><i>option</i></code> parameter to the current
|
|
callback list (if present), while <code><b>wcb::callback</b></code>
|
|
<i>replaces</i> the old callbacks with these arguments.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>callback, append, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="cbprepend"></a>
|
|
<h2>The <code><b><font size=5>wcb::cbprepend</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::cbprepend</code> - Prepend to a callback list
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::cbprepend</b> <i>widgetName</i> <b>before</b>|<b>after</b> <i>option</i> ?<i>callback</i> <i>callback</i> ...?
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>This command is almost identical to <code><b><a href=
|
|
"#callback">wcb::callback</a></b></code>. The only difference is
|
|
that <code><b>wcb::cbprepend</b></code> <i>prepends</i> the arguments
|
|
specified after the <code><i>option</i></code> parameter to the current
|
|
callback list (if present), while <code><b>wcb::callback</b></code>
|
|
<i>replaces</i> the old callbacks with these arguments.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>callback, prepend, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="cancel"></a>
|
|
<h2>The <code><b><font size=5>wcb::cancel</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::cancel</code> - Cancel a widget command
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::cancel</b> ?<i>script</i>?
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>This procedure is designed to be invoked from a before-callback for a
|
|
widget command. It cancels the execution of that command and of
|
|
the remaining callbacks, and evaluates the <code><i>script</i></code>
|
|
argument in the global scope. If this argument is not specified,
|
|
it defaults to the <code><b>bell</b></code> command.
|
|
|
|
<p>The return value is the one obtained from <code><i>script</i></code>
|
|
if this argument is specified and nonempty. Otherwise, the
|
|
command returns an empty string.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>cancel, command, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="canceled"></a>
|
|
<h2>The <code><b><font size=5>wcb::canceled</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::canceled</code> - Query the canceled status of a widget
|
|
command
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::canceled</b> <i>widgetName</i> <i>option</i>
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>Returns the value <code>1</code> if the most recent invocation of the
|
|
widget operation corresponding to <code><i>widgetName</i></code> and
|
|
<code><i>option</i></code> has been aborted by some before-callback by
|
|
invoking <code><b><a href="#cancel">wcb::cancel</a></b></code>;
|
|
otherwise, the return value is <code>0</code>. The arguments must
|
|
fulfil the same restrictions as in the case of the <code><b><a href=
|
|
"#callback">wcb::callback</a></b></code> command.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>cancel, command, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="extend"></a>
|
|
<h2>The <code><b><font size=5>wcb::extend</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::extend</code> - Extend the argument list of a widget command
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::extend</b> ?<i>arg</i> <i>arg</i> ...?
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>This procedure is designed to be invoked from a before-callback for a
|
|
widget command. It appends the values given in the optional
|
|
<code><i>arg</i></code> parameters to the argument list of that
|
|
command. The new argument list will be passed to the remaining
|
|
callbacks for that command, too.
|
|
|
|
<p>This procedure simply passes its parameters to the
|
|
<code><b>lappend</b></code> command, called for the argument list of
|
|
the respective widget operation.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>extend, argument, command, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="replace"></a>
|
|
<h2>The <code><b><font size=5>wcb::replace</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::replace</code> - Replace arguments of a widget command with
|
|
new ones
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::replace</b> <i>first</i> <i>last</i> ?<i>arg</i> <i>arg</i> ...?
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>This procedure is designed to be invoked from a before-callback for a
|
|
widget command. It replaces the arguments having the indices
|
|
<code><i>first</i></code> through <code><i>last</i></code> of that
|
|
command with the optional <code><i>arg</i></code> parameters. The
|
|
new argument list will be passed to the remaining callbacks for that
|
|
command, too. The arguments are numbered from <code>0</code> (see
|
|
the <a href="#callback_table">table</a> in the description of the
|
|
<code><b><a href="#callback">wcb::callback</a></b></code> command).
|
|
|
|
<p>This procedure simply passes its parameters to the
|
|
<code><b>lreplace</b></code> command, called for the argument list of
|
|
the respective widget operation.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>replace, argument, command, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="pathname"></a>
|
|
<h2>The <code><b><font size=5>wcb::pathname</font></b></code> Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::pathname</code> - Query the path name of the widget
|
|
corresponding to a Tcl command name
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::pathname</b> <i>origCmd</i>
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>This procedure returns the path name of the widget corresponding to the
|
|
Tcl command name <code><i>origCmd</i></code> passed to a callback.
|
|
|
|
<p>When a before- or after-callback for a widget is invoked, the name
|
|
of the original Tcl command associated with that widget is
|
|
automatically appended to it as parameter. This procedure can be
|
|
used within a callback to derive the path name of the widget from the
|
|
command name passed to the callback as argument. It simply
|
|
returns the string range obtained from <code><i>origCmd</i></code> by
|
|
removing the <code>"::_"</code> prefix.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>path name, command, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="change"></a>
|
|
<h2>The <code><b><font size=5>wcb::changeEntryText</font></b></code>
|
|
Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::changeEntryText</code> - Change the text of a Tk entry, tile
|
|
entry, BWidget Entry, spinbox, or tile combobox widget
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::changeEntryText</b> <i>widgetName string</i>
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>Replaces the text of the Tk entry, tile entry, BWidget Entry, spinbox,
|
|
or tile combobox widget <code><i>widgetName</i></code> with
|
|
<code><i>string</i></code>, by using the <code><b>delete</b></code> and
|
|
<code><b>insert</b></code> operations. If the first subcommand is
|
|
canceled by some before-<code><b>delete</b></code> callback then the
|
|
procedure returns without inserting the new text; if the second
|
|
operation is canceled by some before-<code><b>insert</b></code>
|
|
callback then the command restores the original contents of the widget.
|
|
|
|
<p>The procedure keeps the position of the insertion cursor. The
|
|
return value is <code>1</code> on success and <code>0</code> on
|
|
failure, i.e., if one of the attempted operations was canceled by some
|
|
before-callback.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>Tk entry, tile entry, BWidget Entry, spinbox, tile combobox, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="entrylen"></a>
|
|
<h2>The <code><b><font size=5>wcb::postInsertEntryLen</font></b></code>
|
|
Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::postInsertEntryLen</code> - Query the would-be length of the
|
|
text in a Tk entry, tile entry, BWidget Entry, spinbox, or tile
|
|
combobox widget
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::postInsertEntryLen</b> <i>widgetName string</i>
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>Returns the length of the text that would be contained in the Tk entry,
|
|
tile entry, BWidget Entry, spinbox, or tile combobox widget
|
|
<code><i>widgetName</i></code> after inserting
|
|
<code><i>string</i></code>.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>insert, Tk entry, tile entry, BWidget Entry, spinbox, tile combobox,
|
|
widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="entrytext"></a>
|
|
<h2>The <code><b><font size=5>wcb::postInsertEntryText</font></b></code>
|
|
Command</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::postInsertEntryText</code> - Query the would-be text of a Tk
|
|
entry, tile entry, BWidget Entry, spinbox, or tile combobox widget
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<pre>
|
|
<b>wcb::postInsertEntryText</b> <i>widgetName index string</i>
|
|
</pre>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>Returns the text that would be contained in the Tk entry, tile entry,
|
|
BWidget Entry, spinbox, or tile combobox widget
|
|
<code><i>widgetName</i></code> after inserting
|
|
<code><i>string</i></code> before the character indicated by
|
|
<code><i>index</i></code>.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>insert, Tk entry, tile entry, BWidget Entry, spinbox, tile combobox,
|
|
widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="entrycb"></a>
|
|
<h2>Before-<code><b><font size=5>insert</b></font></code> Callbacks for Tk
|
|
entry, tile entry, BWidget Entry, spinbox, and tile combobox Widgets</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::checkStrFor*</code>, <code>wcb::convStrTo*</code>,
|
|
<code>wcb::checkEntryFor*</code>, <code>wcb::checkEntryLen</code> -
|
|
Before-<code><b>insert</b></code> callbacks for Tk entry, tile entry,
|
|
BWidget Entry, spinbox, and tile combobox widgets
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrForRegExp</b></code>
|
|
<td align="right"><code>{<i>exp w idx str</i>}</code>
|
|
<tr>
|
|
<td>
|
|
<td>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrForAlpha</b></code>
|
|
<td align="right"><code>{<i>w idx str</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrForNum</b></code>
|
|
<td align="right"><code>{<i>w idx str</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrForAlnum</b></code>
|
|
<td align="right"><code>{<i>w idx str</i>}</code>
|
|
<tr>
|
|
<td>
|
|
<td>
|
|
<tr>
|
|
<td><code><b>wcb::convStrToUpper</b></code>
|
|
<td align="right"><code>{<i>w idx str</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::convStrToLower</b></code>
|
|
<td align="right"><code>{<i>w idx str</i>}</code>
|
|
<tr>
|
|
<td>
|
|
<td>
|
|
<tr>
|
|
<td><code><b>wcb::checkEntryForInt</b></code>
|
|
<td align="right"><code>{<i>w idx str</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::checkEntryForUInt</b></code>
|
|
<td align="right"><code>{<i>max w idx str</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::checkEntryForReal</b></code>
|
|
<td align="right"><code>{<i>w idx str</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::checkEntryForFixed</b> </code>
|
|
<td align="right"><code>{<i>cnt w idx str</i>}</code>
|
|
<tr>
|
|
<td>
|
|
<td>
|
|
<tr>
|
|
<td><code><b>wcb::checkEntryLen</b></code>
|
|
<td align="right"><code>{<i>len w idx str</i>}</code>
|
|
</table>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>The <code><b>wcb::checkStrForRegExp</b></code> callback checks whether
|
|
the string <code><i>str</i></code> to be inserted into the Tk entry,
|
|
tile entry, BWidget Entry, spinbox, or tile combobox widget
|
|
<code><i>w</i></code> is matched by the regular expression
|
|
<code><i>exp</i></code>; if not, it cancels the
|
|
<code><b>insert</b></code> operation.
|
|
|
|
<p>The three other <code><b>wcb::checkStrFor*</b></code> callbacks
|
|
check whether the string <code><i>str</i></code> to be inserted into
|
|
the Tk entry, tile entry, BWidget Entry, spinbox, or tile combobox
|
|
widget <code><i>w</i></code> is alphabetic, numeric, or alphanumeric,
|
|
respectively; if not, they cancel the <code><b>insert</b></code>
|
|
operation. These procedures just invoke the callback
|
|
<code><b>wcb::checkStrForRegExp</b></code>, passing to it the
|
|
Unicode-based patterns <code>{^[[:alpha:]]*$}</code>,
|
|
<code>{^[[:digit:]]*$}</code>, and <code>{^[[:alnum:]]*$}</code> for Tk
|
|
versions 8.1 or higher, and the ASCII patterns
|
|
<code>{^[A-Za-z]*$}</code>, <code>{^[0-9]*$}</code>, and
|
|
<code>{^[A-Za-z0-9]*$}</code> if Tk version 8.0 is being used.
|
|
|
|
<p>The <code><b>wcb::convStrTo*</b></code> callbacks replace the string
|
|
<code><i>str</i></code> to be inserted into the Tk entry, tile entry,
|
|
BWidget Entry, spinbox, or tile combobox widget <code><i>w</i></code>
|
|
with its uppercase or lowercase equivalent, respectively.
|
|
|
|
<p>The <code><b>wcb::checkEntryFor*</b></code> callbacks check whether
|
|
the text contained in the Tk entry, tile entry, BWidget Entry, spinbox,
|
|
or tile combobox widget <code><i>w</i></code> after inserting the
|
|
string <code><i>str</i></code> before the character indicated by the
|
|
index <code><i>idx</i></code> would represent (the starting part of) an
|
|
integer number, unsigned integer no greater than
|
|
<code><i>max</i></code>, real number, or real number in fixed-point
|
|
format with at most <code><i>cnt</i></code> digits after the decimal
|
|
point, respectively; if not, they cancel the <code><b>insert</b></code>
|
|
operation. <code><i>max</i></code> and <code><i>cnt</i></code>
|
|
should be nonnegative numbers or <code><b>*</b></code>;
|
|
<code><i>max</i> = <b>*</b></code> means: no upper bound for the
|
|
Tk entry, tile entry, BWidget Entry, spinbox, or tile combobox value,
|
|
while <code><i>cnt</i> = <b>*</b></code> stands for an
|
|
unlimited number of digits after the decimal point.
|
|
|
|
<p>The <code><b>wcb::checkEntryLen</b></code> callback checks whether
|
|
the length of the text contained in the Tk entry, tile entry, BWidget
|
|
Entry, spinbox, or tile combobox widget <code><i>w</i></code> after
|
|
inserting the string <code><i>str</i></code> would be greater than
|
|
<code><i>len</i></code>; if yes, it cancels the
|
|
<code><b>insert</b></code> operation.
|
|
|
|
<p>These callback procedures are implemented in the file
|
|
<code><b>wcbEntry.tcl</b></code>, contained in the
|
|
<code><b>scripts</b></code> directory. They return an empty
|
|
string.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>callback, insert, Tk entry, tile entry, BWidget Entry, spinbox, tile
|
|
combobox, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
|
|
|
|
<p><hr>
|
|
|
|
|
|
<a name="textcb"></a>
|
|
<h2>Before-<code><b><font size=5>insert</font></b></code> Callbacks for text
|
|
and ctext Widgets</h2>
|
|
|
|
<dl>
|
|
<dt><b>NAME</b>
|
|
<dd><code>wcb::checkStrsFor*</code>, <code>wcb::convStrsTo*</code> -
|
|
Before-<code><b>insert</b></code> callbacks for text and ctext widgets
|
|
|
|
<p>
|
|
<dt><b>SYNOPSIS</b>
|
|
<dd>
|
|
<dd><table border=0 cellpadding=0 cellspacing=0>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrsForRegExp</b> </code>
|
|
<td align="right"><code>{<i>exp w idx args</i>}</code>
|
|
<tr>
|
|
<td>
|
|
<td>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrsForAlpha</b></code>
|
|
<td align="right"><code>{<i>w idx args</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrsForNum</b></code>
|
|
<td align="right"><code>{<i>w idx args</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::checkStrsForAlnum</b></code>
|
|
<td align="right"><code>{<i>w idx args</i>}</code>
|
|
<tr>
|
|
<td>
|
|
<td>
|
|
<tr>
|
|
<td><code><b>wcb::convStrsToUpper</b></code>
|
|
<td align="right"><code>{<i>w idx args</i>}</code>
|
|
<tr>
|
|
<td><code><b>wcb::convStrsToLower</b></code>
|
|
<td align="right"><code>{<i>w idx args</i>}</code>
|
|
</table>
|
|
|
|
<p>
|
|
<dt><b>DESCRIPTION</b>
|
|
<dd>The <code><b>wcb::checkStrsForRegExp</b></code> callback checks whether
|
|
the strings to be inserted into the text or ctext widget
|
|
<code><i>w</i></code>, contained in the list <code><i>args</i></code>
|
|
of the form <code><i>string</i> ?<i>tagList</i> <i>string</i>
|
|
<i>tagList</i> ...?</code>, are matched by the regular expression
|
|
<code><i>exp</i></code>; if not, it cancels the
|
|
<code><b>insert</b></code> operation.
|
|
|
|
<p>The three other <code><b>wcb::checkStrsFor*</b></code> callbacks
|
|
check whether the strings to be inserted into the text or ctext widget
|
|
<code><i>w</i></code>, contained in the list <code><i>args</i></code>
|
|
of the form <code><i>string</i> ?<i>tagList</i> <i>string</i>
|
|
<i>tagList</i> ...?</code>, are alphabetic, numeric, or
|
|
alphanumeric, respectively; if not, they cancel the
|
|
<code><b>insert</b></code> operation. These procedures just
|
|
invoke the callback <code><b>wcb::checkStrsForRegExp</b></code>,
|
|
passing to it the Unicode-based patterns
|
|
<code>{^[[:alpha:]\n]*$}</code>, <code>{^[[:digit:]\n]*$}</code>, and
|
|
<code>{^[[:alnum:]\n]*$}</code> for Tk versions 8.1 or higher, and the
|
|
ASCII patterns <code>"^\[A-Za-z\n]*$"</code>,
|
|
<code>"^\[0-9\n]*$"</code>, and <code>"^\[A-Za-z0-9\n]*$"</code> if Tk
|
|
version 8.0 is being used (in this case, the presence of the
|
|
<code>"\n"</code> makes the regular expressions a bit ugly).
|
|
|
|
<p>The <code><b>wcb::convStrsTo*</b></code> callbacks replace the
|
|
strings to be inserted into the text or ctext widget
|
|
<code><i>w</i></code>, contained in the list <code><i>args</i></code>
|
|
of the form <code><i>string</i> ?<i>tagList</i> <i>string</i>
|
|
<i>tagList</i> ...?</code>, with their uppercase or lowercase
|
|
equivalents, respectively.
|
|
|
|
<p>These callback procedures are implemented in the file
|
|
<code><b>wcbText.tcl</b></code>, contained in the
|
|
<code><b>scripts</b></code> directory. They return an empty
|
|
string.
|
|
|
|
<p>
|
|
<dt><b>KEYWORDS</b>
|
|
<dd>callback, insert, text, ctext, widget
|
|
</dl>
|
|
|
|
<div align=center>
|
|
<p><a href="#contents">Contents</a>
|
|
<a href="index.html">Start page</a>
|
|
</div>
|
|
</body>
|
|
</html>
|