<?xml version='1.0' encoding='UTF-8' standalone='no'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="_btext_8tcl">
<title>/Users/bernard/b20/bsoft/tcltk/btext.tcl File Reference</title>
<indexterm><primary>/Users/bernard/b20/bsoft/tcltk/btext.tcl</primary></indexterm>
<para>

<para>Window to show text information. </para>
 
</para>
<simplesect>
    <title>Functions    </title>
        <itemizedlist>
            <listitem><para><link linkend="_btext_8tcl_1a7a3cc6e8c9a77e3b8ecb032a290939fd">openTextWindow</link> w</para>

<para>Open a text editing window. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1af46e1c391eeec60fafe6febfff9c3911">showInfo</link> theinfo</para>

<para>Opens a text window with the supplied information. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1a31f058ca11760f9d984eadf26b29a3e7">editTextFile</link> filename</para>

<para>Reads a text file for editing. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1a6fedb5a5dc3c326fae8688c3f790ffa7">openTextFile</link> wtxt</para>

<para>Opens a text file for editing. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1ae26366cfcbf1a9d2384ac80c2644e266">readTextFile</link> wtxt filename</para>

<para>Reads a text file. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1a569fb5898e371cadec8660c2da5a2f9d">saveTextFile</link> wtxt filename</para>

<para>Saves a text file using its current name. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1a6262579375aea8eefd2a98d3cab26609">saveAsTextFile</link> wtxt</para>

<para>Saves a text file with a new name. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1af64bf4277f73e1fbb8f8eef0f24a5f23">updateText</link> wtxt chan</para>

<para>Updates text originating from an open channel. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1a8a323fe0c615440b0dc9c2bd5428ff13">executeCommand</link> cmd logfile</para>

<para>Executes a command and sends the output to a channel for updating. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1accb17508d9f3f394bbcd3358c5d2c939">getFilename</link> w</para>

<para>Gets a file name entry. </para>
</listitem>
            <listitem><para><link linkend="_btext_8tcl_1aee42c0423f8e472520f538ebfb65d1fc">getDirectoryName</link> w</para>

<para>Gets a directory entry. </para>
</listitem>
        </itemizedlist>
</simplesect>
<section>
<title>Detailed Description</title>

<para>Window to show text information. </para>

<para><formalpara><title>Author: </title>

<para>Bernard Heymann </para>
</formalpara>
<formalpara><title>Date: </title>

<para>Created: 20010516 </para>

<para>Modified: 20130123 </para>
</formalpara>
</para>
</section>
<section>
<title>Function Documentation</title>
<anchor xml:id="_btext_8tcl_1a31f058ca11760f9d984eadf26b29a3e7"/>    <section>
    <title>editTextFile()</title>
<indexterm><primary>editTextFile</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>editTextFile</secondary></indexterm>
<para><computeroutput>editTextFile filename </computeroutput></para><para>

<para>Reads a text file for editing. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>filename</entry>
                                <entry>
<para>file name (including path). </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 95 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1a8a323fe0c615440b0dc9c2bd5428ff13"/>    <section>
    <title>executeCommand()</title>
<indexterm><primary>executeCommand</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>executeCommand</secondary></indexterm>
<para><computeroutput>executeCommand cmd logfile </computeroutput></para><para>

<para>Executes a command and sends the output to a channel for updating. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>cmd</entry>
                                <entry>
<para>the command (with arguments) </para>
</entry>
                            </row>
                            <row>
                                <entry>logfile</entry>
                                <entry>
<para>a text file to write to. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 183 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1aee42c0423f8e472520f538ebfb65d1fc"/>    <section>
    <title>getDirectoryName()</title>
<indexterm><primary>getDirectoryName</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>getDirectoryName</secondary></indexterm>
<para><computeroutput>getDirectoryName w </computeroutput></para><para>

<para>Gets a directory entry. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>w</entry>
                                <entry>
<para>an entry window </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 214 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1accb17508d9f3f394bbcd3358c5d2c939"/>    <section>
    <title>getFilename()</title>
<indexterm><primary>getFilename</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>getFilename</secondary></indexterm>
<para><computeroutput>getFilename w </computeroutput></para><para>

<para>Gets a file name entry. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>w</entry>
                                <entry>
<para>an entry window </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 202 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1a6fedb5a5dc3c326fae8688c3f790ffa7"/>    <section>
    <title>openTextFile()</title>
<indexterm><primary>openTextFile</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>openTextFile</secondary></indexterm>
<para><computeroutput>openTextFile wtxt </computeroutput></para><para>

<para>Opens a text file for editing. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>wtxt</entry>
                                <entry>
<para>text window. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 108 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1a7a3cc6e8c9a77e3b8ecb032a290939fd"/>    <section>
    <title>openTextWindow()</title>
<indexterm><primary>openTextWindow</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>openTextWindow</secondary></indexterm>
<para><computeroutput>openTextWindow w </computeroutput></para><para>

<para>Open a text editing window. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>w</entry>
                                <entry>
<para>window name to contain &quot;.text&quot; window. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 16 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1ae26366cfcbf1a9d2384ac80c2644e266"/>    <section>
    <title>readTextFile()</title>
<indexterm><primary>readTextFile</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>readTextFile</secondary></indexterm>
<para><computeroutput>readTextFile wtxt filename </computeroutput></para><para>

<para>Reads a text file. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>wtxt</entry>
                                <entry>
<para>a text window </para>
</entry>
                            </row>
                            <row>
                                <entry>filename</entry>
                                <entry>
<para>file name (including path). </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 120 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1a6262579375aea8eefd2a98d3cab26609"/>    <section>
    <title>saveAsTextFile()</title>
<indexterm><primary>saveAsTextFile</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>saveAsTextFile</secondary></indexterm>
<para><computeroutput>saveAsTextFile wtxt </computeroutput></para><para>

<para>Saves a text file with a new name. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>wtxt</entry>
                                <entry>
<para>a text window </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 154 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1a569fb5898e371cadec8660c2da5a2f9d"/>    <section>
    <title>saveTextFile()</title>
<indexterm><primary>saveTextFile</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>saveTextFile</secondary></indexterm>
<para><computeroutput>saveTextFile wtxt filename </computeroutput></para><para>

<para>Saves a text file using its current name. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>wtxt</entry>
                                <entry>
<para>a text window </para>
</entry>
                            </row>
                            <row>
                                <entry>filename</entry>
                                <entry>
<para>file name (including path). </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 139 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1af46e1c391eeec60fafe6febfff9c3911"/>    <section>
    <title>showInfo()</title>
<indexterm><primary>showInfo</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>showInfo</secondary></indexterm>
<para><computeroutput>showInfo theinfo </computeroutput></para><para>

<para>Opens a text window with the supplied information. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>theinfo</entry>
                                <entry>
<para>text information. </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 80 of file btext.tcl.</para>
    </section><anchor xml:id="_btext_8tcl_1af64bf4277f73e1fbb8f8eef0f24a5f23"/>    <section>
    <title>updateText()</title>
<indexterm><primary>updateText</primary><secondary>btext.tcl</secondary></indexterm>
<indexterm><primary>btext.tcl</primary><secondary>updateText</secondary></indexterm>
<para><computeroutput>updateText wtxt chan </computeroutput></para><para>

<para>Updates text originating from an open channel. </para>
</para>

<para>
                <formalpara>
                    <title>
Parameters                    </title>
                    <para>
                    <table frame="all">
                        <tgroup cols="2" align="left" colsep="1" rowsep="1">
                        <colspec colwidth="1*"/>
                        <colspec colwidth="4*"/>
                        <tbody>
                            <row>
                                <entry>wtxt</entry>
                                <entry>
<para>a text window </para>
</entry>
                            </row>
                            <row>
                                <entry>chan</entry>
                                <entry>
<para>the channel </para>
</entry>
                            </row>
                        </tbody>
                        </tgroup>
                    </table>
                    </para>
                </formalpara>
                </para>
<para>
Definition at line 166 of file btext.tcl.</para>
</section>
</section>
</section>
