📄 uitcldocs.html
字号:
<html><head><!-- /vobs/wpwr/docs/tornado-api/guitcl-win/UITclDocs.html - generated by refgen from UITclDocs.cpp --> <title> UITcl Library [win32] </title></head><body bgcolor="#FFFFFF"> <hr><a name="top"></a><p align=right><a href="libIndex.html"><i>Tornado API Reference : GUI Tcl Library (WINDOWS)</i></a></p></blockquote><h1>UITcl Library [win32]</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>UITcl Library [win32]</strong> - UITcl Library</p></blockquote><h4>TCL PROCEDURES</h4><blockquote><p><p><b><a href="./UITclDocs.html#systemColorsEnumerate">systemColorsEnumerate</a></b> - enumerates pre-defined system colors<br><b><a href="./UITclDocs.html#helpLaunch">helpLaunch</a></b> - start winhelp using a specified file, ID, mode, and so forth<br><b><a href="./UITclDocs.html#applicationTitleSet">applicationTitleSet</a></b> - sets the title of the application<br><b><a href="./UITclDocs.html#applicationReturnCodeSet">applicationReturnCodeSet</a></b> - sets the return code for the application<br><b><a href="./UITclDocs.html#applicationRegistryPathSet">applicationRegistryPathSet</a></b> - sets the path where the persistent state of this application should be saved<br><b><a href="./UITclDocs.html#averageCharSizeGet">averageCharSizeGet</a></b> - retrieves the average character size of a window<br><b><a href="./UITclDocs.html#dialogUnitsToPixels">dialogUnitsToPixels</a></b> - conversion routine<br><b><a href="./UITclDocs.html#pixelsToDialogUnits">pixelsToDialogUnits</a></b> - conversion routine<br><b><a href="./UITclDocs.html#mainWindowCreate">mainWindowCreate</a></b> - Creates a main window for the application<br><b><a href="./UITclDocs.html#dialogCreate">dialogCreate</a></b> - Creates a dialog<br><b><a href="./UITclDocs.html#toolbarCreate">toolbarCreate</a></b> - create a toolbar on a window<br><b><a href="./UITclDocs.html#windowCreate">windowCreate</a></b> - creates a child window<br><b><a href="./UITclDocs.html#fileDialogCreate">fileDialogCreate</a></b> - create a standard file browser dialog<br><b><a href="./UITclDocs.html#dirBrowseDialogCreate">dirBrowseDialogCreate</a></b> - create a standard directory browser dialog<br><b><a href="./UITclDocs.html#windowClientSizeGet">windowClientSizeGet</a></b> - retrieves the size of the client area of a dialog or window<br><b><a href="./UITclDocs.html#windowSizeSet">windowSizeSet</a></b> - sets the size of a dialog or window<br><b><a href="./UITclDocs.html#windowPositionSet">windowPositionSet</a></b> - sets the position of a dialog or window<br><b><a href="./UITclDocs.html#windowSizeGet">windowSizeGet</a></b> - retrieves the size of a dialog or window<br><b><a href="./UITclDocs.html#windowPositionGet">windowPositionGet</a></b> - retrieves the position of a dialog or window<br><b><a href="./UITclDocs.html#windowSizeCallbackSet">windowSizeCallbackSet</a></b> - sets the Tcl script to be called when a dialog or window has been resized<br><b><a href="./UITclDocs.html#windowSizeCallbackGet">windowSizeCallbackGet</a></b> - returns the script called when the user or system resizes the dialog or window<br><b><a href="./UITclDocs.html#windowActivateCallbackSet">windowActivateCallbackSet</a></b> - sets the Tcl script to be called when a dialog or window is activated<br><b><a href="./UITclDocs.html#windowActivateCallbackGet">windowActivateCallbackGet</a></b> - returns the script called when the window or dialog is activated<br><b><a href="./UITclDocs.html#windowInitCallbackSet">windowInitCallbackSet</a></b> - sets the Tcl script called when a dialog or window is initialized<br><b><a href="./UITclDocs.html#windowInitCallbackGet">windowInitCallbackGet</a></b> - returns the script called when the dialog or window is initialized<br><b><a href="./UITclDocs.html#windowShowCallbackSet">windowShowCallbackSet</a></b> - sets the Tcl script called when a dialog or window is displayed<br><b><a href="./UITclDocs.html#windowShowCallbackGet">windowShowCallbackGet</a></b> - returns the script called when the dialog or window is displayed<br><b><a href="./UITclDocs.html#windowExitCallbackSet">windowExitCallbackSet</a></b> - sets the Tcl script called when a dialog or window is exited<br><b><a href="./UITclDocs.html#windowExitCallbackGet">windowExitCallbackGet</a></b> - returns the script called when the user or system exits the dialog or window<br><b><a href="./UITclDocs.html#windowQueryCloseCallbackSet">windowQueryCloseCallbackSet</a></b> - sets the Tcl script to be called when closing a dialog or window<br><b><a href="./UITclDocs.html#windowQueryCloseCallbackGet">windowQueryCloseCallbackGet</a></b> - returns the script called to determine whether the dialog or window can be closed safely<br><b><a href="./UITclDocs.html#windowHidden">windowHidden</a></b> - determines whether a particular UITcl window or dialog is hidden<br><b><a href="./UITclDocs.html#windowVisible">windowVisible</a></b> - determines whether a particular UITcl window or dialog is visible on the screen<br><b><a href="./UITclDocs.html#windowHide">windowHide</a></b> - hides or shows a Tcl window, dialog, or toolbar<br><b><a href="./UITclDocs.html#windowShow">windowShow</a></b> - shows or hides a Tcl window, dialog, or toolbar<br><b><a href="./UITclDocs.html#windowActiveGet">windowActiveGet</a></b> - gets the name of the currently active Tcl window, dialog, or toolbar<br><b><a href="./UITclDocs.html#windowActiveSet">windowActiveSet</a></b> - sets the named Tcl window as the active window<br><b><a href="./UITclDocs.html#windowTitleSet">windowTitleSet</a></b> - sets the title of a dialog or window<br><b><a href="./UITclDocs.html#windowTitleGet">windowTitleGet</a></b> - gets the title of a dialog or window<br><b><a href="./UITclDocs.html#windowHandleGet">windowHandleGet</a></b> - gets the internal Windows handle of a dialog or window<br><b><a href="./UITclDocs.html#windowEventGet">windowEventGet</a></b> - returns the most recent event that has occured in a dialog or window<br><b><a href="./UITclDocs.html#windowHelpFileSet">windowHelpFileSet</a></b> - sets the help file to be used for the named dialog or window<br><b><a href="./UITclDocs.html#windowHelpFileGet">windowHelpFileGet</a></b> - gets the path of help file.<br><b><a href="./UITclDocs.html#windowHelpIDSet">windowHelpIDSet</a></b> - sets the help ID and (optionally) the help file to be used for named dialog or window<br><b><a href="./UITclDocs.html#windowHelpIDGet">windowHelpIDGet</a></b> - gets the help ID of the window<br><b><a href="./UITclDocs.html#windowPropertySet">windowPropertySet</a></b> - sets the value of a property<br><b><a href="./UITclDocs.html#autoTimerCallbackSet">autoTimerCallbackSet</a></b> - see <b><a href="./UITclDocs.html#windowTimerCallbackSet">windowTimerCallbackSet</a></b><br><b><a href="./UITclDocs.html#windowTimerCallbackSet">windowTimerCallbackSet</a></b> - sets or removes the timer script for the given dialog or window<br><b><a href="./UITclDocs.html#autoTimerCallbackGet">autoTimerCallbackGet</a></b> - see <b><a href="./UITclDocs.html#windowTimerCallbackGet">windowTimerCallbackGet</a></b><br><b><a href="./UITclDocs.html#windowTimerCallbackGet">windowTimerCallbackGet</a></b> - returns the timer script for the given dialog or window<br><b><a href="./UITclDocs.html#windowClose">windowClose</a></b> - closes a dialog or window<br><b><a href="./UITclDocs.html#allControlsDestroy">allControlsDestroy</a></b> - destroys all the controls in a dialog or window<br><b><a href="./UITclDocs.html#windowExists">windowExists</a></b> - determines whether a particular window exists<br><b><a href="./UITclDocs.html#controlEventGet">controlEventGet</a></b> - returns the most recent event that has occured on a control<br><b><a href="./UITclDocs.html#controlHandleGet">controlHandleGet</a></b> - returns the handle of a tcl control<br><b><a href="./UITclDocs.html#controlPositionSet">controlPositionSet</a></b> - sets the position of a control in a dialog or window<br><b><a href="./UITclDocs.html#controlPositionGet">controlPositionGet</a></b> - retrieves the position of a control<br><b><a href="./UITclDocs.html#controlSizeSet">controlSizeSet</a></b> - sets the size of a control in a dialog or window<br><b><a href="./UITclDocs.html#controlSizeGet">controlSizeGet</a></b> - retrieves the size of a control in a dialog or window<br><b><a href="./UITclDocs.html#controlHelpIDSet">controlHelpIDSet</a></b> - sets the help ID to be used for the named control in a dialog or window<br><b><a href="./UITclDocs.html#controlHide">controlHide</a></b> - hides or shows a control in a dialog or window<br><b><a href="./UITclDocs.html#controlHidden">controlHidden</a></b> - retrieves the hidden state of a control in a dialog or window<br><b><a href="./UITclDocs.html#controlEnable">controlEnable</a></b> - enables or disables a control in a dialog or window<br><b><a href="./UITclDocs.html#controlEnabled">controlEnabled</a></b> - retrieves the enabled state of a control in a dialog or window<br><b><a href="./UITclDocs.html#controlExists">controlExists</a></b> - determines whether a particular control exists in a dialog or window<br><b><a href="./UITclDocs.html#controlFocusSet">controlFocusSet</a></b> - sets focus to a control in a dialog or window<br><b><a href="./UITclDocs.html#controlCallbackSet">controlCallbackSet</a></b> - sets a Tcl script to process events for a control in a dialog or window<br><b><a href="./UITclDocs.html#controlCallbackGet">controlCallbackGet</a></b> - retrieves the Tcl script (if any) established to process events for a control<br><b><a href="./UITclDocs.html#controlContextMenuShow">controlContextMenuShow</a></b> - show the specified context menu.<br><b><a href="./UITclDocs.html#controlLockUpdate">controlLockUpdate</a></b> - locks the updating of the control.<br><b><a href="./UITclDocs.html#controlUnlockUpdate">controlUnlockUpdate</a></b> - Unlocks all the updates on the control.<br><b><a href="./UITclDocs.html#controlParentSet">controlParentSet</a></b> - sets the specifed window as the parent of the control.<br><b><a href="./UITclDocs.html#controlValuesSet">controlValuesSet</a></b> - sets the data or text of a control<br><b><a href="./UITclDocs.html#controlValuesGet">controlValuesGet</a></b> - retrieves values of controls<br><b><a href="./UITclDocs.html#controlStructureSet">controlStructureSet</a></b> - sets the structure of a hierarchy (tree) control<br><b><a href="./UITclDocs.html#controlPropertySet">controlPropertySet</a></b> - allows to configure the control properties<br><b><a href="./UITclDocs.html#controlPropertyGet">controlPropertyGet</a></b> - returns the value of the specified property of a control.<br><b><a href="./UITclDocs.html#controlCheckSet">controlCheckSet</a></b> - checks a control in a window or dialog<br><b><a href="./UITclDocs.html#controlChecked">controlChecked</a></b> - retrieves the check state of a control in a window or dialog<br><b><a href="./UITclDocs.html#controlSelectionSet">controlSelectionSet</a></b> - sets the selection in a control in a dialog or window<br><b><a href="./UITclDocs.html#controlSelectionGet">controlSelectionGet</a></b> - gets the selection in a control in a dialog or window<br><b><a href="./UITclDocs.html#controlExpandingItemGet">controlExpandingItemGet</a></b> - gets information about the currently expanding item of a treelist control.<br><b><a href="./UITclDocs.html#controlItemDelete">controlItemDelete</a></b> - delete the specified item in a control.<br><b><a href="./UITclDocs.html#controlItemInsert">controlItemInsert</a></b> - inserts the provided item into the control.<br><b><a href="./UITclDocs.html#controlTabsAdd">controlTabsAdd</a></b> - add the strings as new tabs in a tab control.<br><b><a href="./UITclDocs.html#controlItemPropertySet">controlItemPropertySet</a></b> - sets the value of the specified property.<br><b><a href="./UITclDocs.html#controlItemPropertyGet">controlItemPropertyGet</a></b> - gets the property of an item in a control<br><b><a href="./UITclDocs.html#controlTextInsert">controlTextInsert</a></b> - inserts the text into a text control.<br><b><a href="./UITclDocs.html#controlCreate">controlCreate</a></b> - creates a control in a Tcl window, dialog, or toolbar<br><b><a href="./UITclDocs.html#controlDestroy">controlDestroy</a></b> - destroys a control in a dialog or window<br><p></blockquote><h4>DESCRIPTION</h4><blockquote><p>UITcl API library<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./UITclDocs.html#top">UITcl Library</a></b><hr><a name="systemColorsEnumerate"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (WINDOWS) : Tcl Procedures</i></a></p></blockquote><h1>systemColorsEnumerate</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>systemColorsEnumerate</strong> - enumerates pre-defined system colors</p><p></blockquote><h4>LOCALE</h4><blockquote><p>Tcl Windows GUI<p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>systemColorsEnumerate</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This function lists the pre-defined colors available for use inin controlColorsSet.<p></blockquote><h4>ARGUMENTS</h4><blockquote><p>N/A<p></blockquote><h4>RETURNS </h4><blockquote><p>A list containing all the system colors.<p></blockquote><h4>ERRORS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./UITclDocs.html#top">UITcl Library</a></b><hr><a name="helpLaunch"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (WINDOWS) : Tcl Procedures</i></a></p></blockquote><h1>helpLaunch</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>helpLaunch</strong> - start winhelp using a specified file, ID, mode, and so forth</p><p></blockquote><h4>LOCALE</h4><blockquote><p>Tcl Windows GUI<p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>helpLaunch <i>mode</i> <i>helpfile</i> <i>context</i> [<i>2ndaryWindowName</i>]</pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This function displays the topic associated with <i>context</i> in thespecified help file. It is displayed in either the specified help window,the main help window, or a popup help window. <i>context</i> is interpretedaccording to mode.<p></blockquote><h4>ARGUMENTS</h4><blockquote><p><i>mode</i> defines how <i>context</i> is interpreted. It can have the followingvalues:<p><dl><dt><b>context</b><dd>interprets <i>context</i> as an ID to identify the topic<p><dt><b>contextpopup</b><dd>interprets <i>context</i> as an ID to identify the topic and displays itin a popup window; <i>2ndaryWindowName</i> is not used.<p><dt><b>keyword</b><dd>interprets <i>context</i> as a keyword identifying the topic;<i>2ndaryWindowName</i> is not used.<p><dt><b>index</b><dd>provides a help index. <i>context</i> must be an empty string.<p><dt><b>search</b><dd> provides partial keyword search (search for help on...). <i>context</i> is akeyword, or an empty string to show the user a list of keywords. </dl><p><i>helpfile</i> specifies the fully qualified path to the help file.<p><i>context</i> can be a numeric, a keyword, or an empty string depending on thevalue of <i>mode</i>.<p><i>2ndaryWindowName</i> is the name of a secondary window specified in the<b>WINDOWS</b> section of the help file project. It is only used when <i>mode</i> is<b>context</b> and it places the topic in this window instead of <b>main</b>.<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./UITclDocs.html#top">UITcl Library</a></b><hr><a name="applicationTitleSet"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (WINDOWS) : Tcl Procedures</i></a></p></blockquote><h1>applicationTitleSet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>applicationTitleSet</strong> - sets the title of the application</p><p></blockquote><h4>LOCALE</h4><blockquote><p>Tcl Windows GUI<p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>applicationTitleSet <i>title</i></pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This function sets the title of the application that will be subsequently used<br> as the title for message boxes, etc.<p></blockquote><h4>ARGUMENTS</h4><blockquote><p><p><dl><dt><i>title</i><dd> specifies the caption string. </dl><p></blockquote><h4>RETURNS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./UITclDocs.html#top">UITcl Library</a></b><hr><a name="applicationReturnCodeSet"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (WINDOWS) : Tcl Procedures</i></a></p></blockquote><h1>applicationReturnCodeSet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>applicationReturnCodeSet</strong> - sets the return code for the application</p><p></blockquote><h4>LOCALE</h4><blockquote><p>Tcl Windows GUI<p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>applicationReturnCodeSet <i>returnCode</i></pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This function sets the return code that the application returnswhen it exits.<p></blockquote><h4>ARGUMENTS</h4><blockquote><p><p><dl><dt><i>returnCode</i><dd> specifies the integer return code. </dl><p></blockquote><h4>RETURNS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./UITclDocs.html#top">UITcl Library</a></b><hr><a name="applicationRegistryPathSet"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (WINDOWS) : Tcl Procedures</i></a></p></blockquote><h1>applicationRegistryPathSet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>applicationRegistryPathSet</strong> - sets the path where the persistent state of this application should be saved</p><p></blockquote><h4>LOCALE</h4><blockquote><p>Tcl Windows GUI<p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>applicationRegistryPathSet <i>registryPath</i></pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>sets the path where the persistent state of the objects in the applicationwill be used. This needs to be set before any windows are created so thattheir persistent state can be retrived.The registry key is usually the name of a company. It is stored in akey of the following form:<p><pre><company name>\<app name>\<sec name>\<value name>.</pre></blockquote><h4>ARGUMENTS</h4><blockquote><p><dl><dt><i>registryPath</i><dd> specifies the registry path </dl><p></blockquote><h4>RETURNS</h4><blockquote><p>N/A<p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./UITclDocs.html#top">UITcl Library</a></b><hr><a name="averageCharSizeGet"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (WINDOWS) : Tcl Procedures</i></a></p></blockquote><h1>averageCharSizeGet</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>averageCharSizeGet</strong> - retrieves the average character size of a window</p><p></blockquote><h4>LOCALE</h4><blockquote><p>Tcl Windows GUI<p></blockquote><h4>SYNOPSIS</h4><blockquote><p><pre>averageCharSizeGet [-title] <i>windowName</i></pre></blockquote><h4>DESCRIPTION</h4><blockquote><p>This function returns the width and height of the window, typically usefulin calculating the sizes of controls that reside on the window client area.The width and height returned are in dialog units, the units that are deviceindependent.<p></blockquote><h4>ARGUMENTS</h4><blockquote><p><dl><dt><i>windowName</i><dd>specifies the name or title of the window<p><dt><b>-title</b><dd> causes <i>windowName</i> to be interpreted as the title of the window. </dl><p></blockquote><h4>RETURNS </h4><blockquote><p>the width and height of a character as a list.<p></blockquote><h4>ERRORS</h4><blockquote><p><ul><li> unable to locate window <i>window</i> </ul><p><p></blockquote><h4>SEE ALSO</h4><blockquote><p><b><a href="./UITclDocs.html#top">UITcl Library</a></b>, <b><a href="./UITclDocs.html#dialogUnitsToPixels">dialogUnitsToPixels</a></b>, <b><a href="./UITclDocs.html#pixelsToDialogUnits">pixelsToDialogUnits</a></b><hr><a name="dialogUnitsToPixels"></a><p align=right><a href="rtnIndex.html"><i>GUI Tcl Library (WINDOWS) : Tcl Procedures</i></a></p></blockquote><h1>dialogUnitsToPixels</h1> <blockquote></a></blockquote><h4>NAME</h4><blockquote> <p><strong>dialogUnitsToPixels</strong> - conversion routine</p>⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -