ActiveTcl 8.4 - Online Docs : ActiveTcl 8.4.18.0 Documentation Index





	advanced \| search help

Reference

ActiveTcl

ActiveTcl 8.4.18.0 User Guide

Welcome

Installation Guide

License

Release Notes

ActiveTcl 8.4.18.0 Documentation Index

BWidgets

Tcl 8.5 Dict backport

Expect (Unix)

Expect (Windows)

Img

[incr Tcl]

[incr Tk]

IWidgets

Tcl 8.5 Clock backport

Oratcl FAQ

Oratcl

Snack

Sqlite

Tablelist

Tcl Manual

Tk Manual

TclDOM

Tcllib

Tcllibc

TclSOAP

Tutorial

TclVFS

TclX

TclXML

TclXSLT

Tcom

tDOM

Tile

TkCon

(Reference)

tkHTML

Tklib

TkTable

Tktreectrl

TLS

TEApot Package Management

TROFS

Vu widgets

XOTcl

MyASPN >> Reference >> ActiveTcl >> ActiveTcl 8.4.18.0 User Guide

ActiveTcl 8.4.18.0 Documentation Index

TEApot Package Management
Tcl	Tk	TclX	TkCon (Reference)	TclXML	Img
Tcllib	Tklib	BWidgets	TclSOAP	TclDOM	tkHTML
[incr Tcl]	[incr Tk]	IWidgets	TclVFS	TclXSLT	Tcom
Snack	TkTable	Expect (Unix)	Expect (Windows)	Tktreectrl
tDOM	XOTcl	Oratcl	Oratcl FAQ	Sqlite	Tile
Vu widgets	Tablelist	TROFS	Tcl 8.5 Clock backport	Tutorial	TLS
Tcllibc			Tcl 8.5 Dict backport

Package references

Name	Version	Origin	Primary author(s)

TkCon	2.4	http://sf.net/projects/tkcon	Jeff Hobbs
TclX	8.4	http://sf.net/projects/tclx	Karl Lehenbauer, Mark Diekhans, Jeff Hobbs
Expect	5.44.1	http://sf.net/projects/expect	Don Libes
IncrTcl/Tk	3.4	http://sf.net/projects/incrTcl	Michael McLennan
TkTable	2.9	http://sf.net/projects/tktable	Jeff Hobbs
Vuwidgets	2.3	http://sf.net/projects/tktable	Jeff Hobbs
Tile	0.7.8	http://tktable.sourceforge.net/tile/	Joe English
BWidgets	1.8	http://sf.net/projects/tcllib	Jeff Hobbs, Damon Courtney
IWidgets	4.0.2	http://sf.net/projects/incrTcl	Michael McLennan
Tcllib	1.10	http://sf.net/projects/tcllib	Multiple
Tklib	0.4.1	http://sf.net/projects/tcllib	Multiple
TkImg	1.3	http://sf.net/projects/tkimg	Jan Nijtmans
TclXML	2.6	http://sf.net/projects/tclxml	Steve Ball
TclDOM	2.6	http://sf.net/projects/tclxml	Steve Ball
TclSOAP	1.6.7	http://sf.net/projects/tclsoap	Pat Thoyts
Snack	2.2.10	http://www.speech.kth.se/snack/	Kare Sjolander
TkTreectrl	2.1	http://sf.net/projects/tktreectrl	Tim Baker
TkHTML	2.0	http://tkhtml.tcl.tk	Richard Hipp
Tcom	3.9	http://www.vex.net/~cthuang/tcom/	Chin T. Huang
XOTcl	1.5.5	http://www.xotcl.org/	Uwe Zdun, Gustaf Neumann
OraTcl	4.3	http://sf.net/projects/oratcl	Tom Poindexter, Todd Helfter
SQLite	3.5.1	http://www.sqlite.org	Richard Hipp
tDOM	0.8.2	http://www.tdom.org/	Jochen Loewer, Rolf Ade
TLS	1.5.1	http://sf.net/projects/tls	Dan Razell, Matt Newman
Trofs	0.4.4	http://math.nist.gov/~DPorter/tcltk/trofs/	Don Portter

Sitemap

Tcl_DumpActiveMemory - Validated memory allocation interface.

Tcl_StandardChannels - How the Tcl library deals with the standard channels

TCL_MEM_DEBUG - Compile-time flag to enable Tcl memory debugging.

Tcl - Tool Command Language

filename - File name conventions supported by Tcl commands

library - standard library of Tcl procedures

Safe Base - A mechanism for creating and manipulating safe interpreters.

tclsh - Simple shell containing Tcl interpreter

tcltest - Test harness support code and utilities

tclvars - Variables used by Tcl

Tcl Built-In Commands

String Handling

append - Append to variable

binary - Insert and extract fields from binary strings

format - Format a string in the style of sprintf

re_syntax - Syntax of Tcl regular expressions.

regexp - Match a regular expression against a string

regsub - Perform substitutions based on regular expression pattern matching

scan - Parse string using conversion specifiers in the style of sscanf

string - Manipulate strings

subst - Perform backslash, command, and variable substitutions

List Handling

concat - Join lists together

join - Create a string by joining together list elements

lappend - Append list elements onto a variable

lindex - Retrieve an element from a list

linsert - Insert elements into a list

list - Create a list

llength - Count the number of elements in a list

lrange - Return one or more adjacent elements from a list

lreplace - Replace elements in a list with new elements

lsearch - See if a list contains a particular element

lset - Change an element in a list

lsort - Sort the elements of a list

split - Split a string into a proper Tcl list

Math

expr - Evaluate an expression

Control Constructs

after - Execute a command after a time delay

break - Abort looping command

catch - Evaluate script and trap exceptional returns

continue - Skip to the next iteration of a loop

error - Generate an error

eval - Evaluate a Tcl script

for - ``For'' loop

foreach - Iterate over all elements in one or more lists

if - Execute scripts conditionally

return - Return from a procedure

switch - Evaluate one of several scripts, depending on a given value

update - Process pending events and idle callbacks

uplevel - Execute a script in a different stack frame

vwait - Process events until a variable is written

while - Execute script repeatedly as long as a condition is met

Variables and Procedures

array - Manipulate array variables

global - Access global variables

incr - Increment the value of a variable

namespace - create and manipulate contexts for commands and variables

proc - Create a Tcl procedure

rename - Rename or delete a command

set - Read and write variables

trace - Monitor variable accesses, command usages and command executions

unset - Delete variables

upvar - Create link to variable in a different stack frame

variable - create and initialize a namespace variable

Input and Output

close - Close an open channel.

eof - Check for end of file condition on channel

fblocked - Test whether the last input operation exhausted all available input

fconfigure - Set and get options on a channel

fcopy - Copy data from one channel to another.

file - Manipulate file names and attributes

fileevent - Execute a script when a channel becomes readable or writable

flush - Flush buffered output for a channel

gets - Read a line from a channel

open - Open a file-based or command pipeline channel

puts - Write to a channel

read - Read from a channel

seek - Change the access position for an open channel

socket - Open a TCP network connection

tell - Return current access position for an open channel

Packages and Source files

load - Load machine code and initialize new commands.

loadTk - Load Tk into a safe interpreter.

package - Facilities for package loading and version control

pkg::create - Construct an appropriate \fBpackage ifneeded\fR

pkg_mkIndex - Build an index for automatic loading of packages

source - Evaluate a file or resource as a Tcl script

Interpreter Routines

bgerror - Command invoked to process background errors

history - Manipulate the history list

info - Return information about the state of the Tcl interpreter

interp - Create and manipulate Tcl interpreters

memory - Control Tcl memory debugging capabilities.

unknown - Handle attempts to use non-existent commands

Library Procedures

encoding - Manipulate encodings

http - Client-side implementation of the HTTP/1.0 protocol.

msgcat - Tcl message catalog

System Related

cd - Change working directory

clock - Obtain and manipulate time

exec - Invoke subprocesses

exit - End the application

glob - Return names of files that match patterns

pid - Retrieve process identifiers

pwd - Return the absolute path of the current working directory

time - Time the execution of a script

Platform-specific

dde - Execute a Dynamic Data Exchange command

registry - Manipulate the Windows registry

resource - Manipulate Macintosh resources

Tcl C Procedures

Initialization

Tcl_AppInit - perform application-specific initialization

Tcl_CallWhenDeleted - Arrange for callback when interpreter is deleted

Tcl_CreateInterp - create and delete Tcl command interpreters

Tcl_CreateSlave - manage multiple Tcl interpreters, aliases and hidden commands.

Tcl_Exit - end the application or thread (and invoke exit handlers)

Tcl_FindExecutable - identify or return the name of the binary file containing the application

Tcl_GetVersion - get the version of the library at runtime

Tcl_Init - find and source initialization script

Tcl_InitStubs - initialize the Tcl stubs mechanism

Tcl_Interp - client-visible fields of interpreter structures

Tcl_PkgRequire - package version control

Tcl_SourceRCFile - source the Tcl rc file

Tcl_StaticPackage - make a statically linked package available via the \fBload\fR command

Tcl_Main - main program and event loop definition for Tcl-based applications

Utilities

Tcl_Alloc - allocate or free heap memory

Tcl_SetAssocData - manage

Tcl_Concat - concatenate a collection of strings

Tcl_DString - manipulate dynamic strings

Tcl_GetEncoding - procedures for creating and using encodings.

Tcl_GetIndexFromObj - lookup string in table of keywords

Tcl_GetInt - convert from string to integer, double, or boolean

Tcl_InitHashTable - procedures to manage hash tables

Tcl_Preserve - avoid freeing storage while it's being used

Tcl_PrintDouble - Convert floating value to string

Tcl_RegExpMatch - Pattern matching with regular expressions

Tcl_SplitList - manipulate Tcl lists

Tcl_SplitPath - manipulate platform-dependent file paths

Tcl_StringMatch - test whether a string matches a pattern

Tcl_UtfToUpper - routines for manipulating the case of Unicode characters and UTF-8 strings.

Tcl_UniCharIsAlpha - routines for classification of Tcl_UniChar characters

Utf - routines for manipulating UTF-8 strings.

Tcl_WrongNumArgs - generate standard error message for wrong number of arguments

Input and Output

Tcl_StackChannel - stack an I/O channel on top of another, and undo it

Tcl_CreateChannel - procedures for creating and manipulating channels

Tcl_CreateChannelHandler - call a procedure when a channel becomes readable or writable

Tcl_CreateCloseHandler - arrange for callbacks when channels are closed

Tcl_CreateFileHandler - associate procedure callbacks with files or devices (Unix only)

Tcl_FSRegister - procedures to interact with any filesystem

Tcl_GetOpenFile - Get a standard IO File * handle from a channel. (Unix only)

Tcl_GetStdChannel - procedures for retrieving and replacing the standard channels

Tcl_OpenFileChannel - buffered I/O facilities using channels

Tcl_OpenTcpClient - procedures to open channels using TCP sockets

The Event Loop

Tcl_AsyncCreate - handle asynchronous events

Tcl_CreateTimerHandler - call a procedure at a

Tcl_DoOneEvent - wait for events and invoke event handlers

Tcl_DoWhenIdle - invoke a procedure when there are no pending events

Notifier - the event queue and notifier interfaces

Tcl_Sleep - delay execution for a given number of milliseconds

Thread - Tcl thread support.

Objects

Tcl_BooleanObj - manipulate Tcl objects as boolean values

Tcl_ByteArrayObj - manipulate Tcl objects as a arrays of bytes

Tcl_DoubleObj - manipulate Tcl objects as floating-point values

Tcl_IntObj - manipulate Tcl objects as integers and wide integers

Tcl_ListObj - manipulate Tcl objects as lists

Tcl_NewObj - manipulate Tcl objects

Tcl_RegisterObjType - manipulate Tcl object types

Tcl_StringObj - manipulate Tcl objects as strings

Invoking the Interpreter

Tcl_AllowExceptions - allow all exceptions in next script evaluation

Tcl_Backslash - parse a backslash sequence

Tcl_CommandComplete - Check for unmatched braces in a Tcl command

Tcl_Eval - execute Tcl scripts

Tcl_ExprLong - evaluate an expression

Tcl_ExprLongObj - evaluate an expression

Tcl_ParseCommand - parse Tcl scripts and expressions

Tcl_RecordAndEvalObj - save command on history list before evaluating

Tcl_RecordAndEval - save command on history list before evaluating

Tcl_SetRecursionLimit - set maximum allowable nesting depth in interpreter

Tcl_SubstObj - perform substitutions on Tcl objects

Commands

Tcl_AddErrorInfo - record information about errors

Tcl_BackgroundError - report Tcl error that occurred in background processing

Tcl_CreateCommand - implement new commands in C

Tcl_CreateMathFunc - Define, query and enumerate math functions for expressions

Tcl_CreateObjCommand - implement new commands in C

Tcl_Panic - report fatal error and abort

Tcl_SaveResult - save and restore an interpreter's result

Tcl_SetErrno - manipulate errno to store and retrieve error codes

Tcl_SetResult - manipulate Tcl result

Variables

Tcl_CreateTrace - arrange for command execution to be traced

Tcl_LinkVar - link Tcl variable to C variable

Tcl_SetVar - manipulate Tcl variables

Tcl_TraceCommand - monitor renames and deletes of a command

Tcl_TraceVar - monitor accesses to a variable

Tcl_UpVar - link one variable to another

Operating System Interface

Tcl_Access - check file permissions and other attributes

Tcl_DetachPids - manage child processes in background

Tcl_PutEnv - procedures to manipulate the environment

Tcl_GetCwd - manipulate the current working directory

Tcl_GetHostName - get the name of the local host

Tcl_GetTime - get date and time

Tcl_MacSetEventProc - procedures to handle Macintosh resources and other Macintosh specifics

Tcl_SignalId - Convert signal codes

Tcl_TranslateFileName - convert file name to native form and replace tilde with home directory

Tk

Tk built-in commands

General

console - Control the console on systems without a real console

destroy - Destroy one or more windows

tk - Manipulate Tk internal state

tkerror - Command invoked to process background errors

tkvars - Variables used or set by Tk

tkwait - Wait for variable to change or window to be destroyed

winfo - Return window-related information

wish - Simple windowing shell

wm - Communicate with window manager

Resources and Options

bitmap - Images that display two colors

colors - symbolic color names recognized by Tk

cursors - mouse cursors available in Tk

font - Create and inspect fonts.

image - Create and manipulate images

keysyms - keysyms recognized by Tk

option - Add/retrieve window options to/from the option database

options - Standard options supported by widgets

tk_setPalette - Modify the Tk color palette

photo - Full-color images

Widgets

button - Create and manipulate button widgets

canvas - Create and manipulate canvas widgets

checkbutton - Create and manipulate checkbutton widgets

entry - Create and manipulate entry widgets

frame - Create and manipulate frame widgets

label - Create and manipulate label widgets

labelframe - Create and manipulate labelframe widgets

listbox - Create and manipulate listbox widgets

menu - Create and manipulate menu widgets

menubutton - Create and manipulate menubutton widgets

message - Create and manipulate message widgets

tk_optionMenu - Create an option menubutton and its menu

panedwindow - Create and manipulate panedwindow widgets

radiobutton - Create and manipulate radiobutton widgets

scale - Create and manipulate scale widgets

scrollbar - Create and manipulate scrollbar widgets

spinbox - Create and manipulate spinbox widgets

text - Create and manipulate text widgets

Dialogs and toplevels

tk_chooseColor - pops up a dialog box for the user to select a color.

tk_chooseDirectory - pops up a dialog box for the user to select a directory.

tk_dialog - Create modal dialog and wait for response

tk_getOpenFile - pop up a dialog box for the user to select a file to open or save.

tk_messageBox - pops up a message window and waits for user response.

tk_popup - Post a popup menu

toplevel - Create and manipulate toplevel widgets

Geometry management

grid - Geometry manager that arranges widgets in a grid

lower - Change a window's position in the stacking order

pack - Geometry manager that packs around edges of cavity

place - Geometry manager for fixed or rubber-sheet placement

raise - Change a window's position in the stacking order

Events and bindings

bind - Arrange for X events to invoke Tcl scripts

bindtags - Determine which bindings apply to a window, and order of evaluation

event - Miscellaneous event facilities: define virtual events and generate events

focus - Manage the input focus

tk_focusNext - Utility procedures for managing the input focus.

grab - Confine pointer and keyboard events to a window sub-tree

Inter-client Communication

bell - Ring a display's bell

clipboard - Manipulate Tk clipboard

selection - Manipulate the X selection

send - Execute a command in a different application

Tk C Procedures

Initialization

Tk_CreateErrorHandler - handle X protocol errors

Tk_MainLoop - loop for events until all windows are deleted

Tk_MainWindow - functions for querying main

Tk_ParseArgv - process command-line options

Tk_SetAppName - Set the name of an application for ``send'' commands

Tk_StrictMotif - Return value of tk_strictMotif variable

Tk_InitStubs - initialize the Tk stubs mechanism

Tk_Init - add Tk to an interpreter and make a new Tk application.

Tk_Main - main program for Tk-based applications

Widget Implementation

Tk_CoordsToWindow - Find window containing a point

Tk_GeometryRequest - specify desired geometry or internal border for a window

Tk_GetAnchorFromObj - translate between strings and anchor positions

Tk_GetScrollInfo - parse arguments for scrolling commands

Tk_GetUid - convert from string to unique identifier

Tk_MaintainGeometry - maintain geometry of one window relative to another

Tk_ManageGeometry - arrange to handle geometry requests for a window

Tk_MapWindow - map or unmap a window

Tk_MoveToplevelWindow - Adjust the position of a top-level window

Tk_Name - convert between names and window tokens

Tk_RestackWindow - Change a window's position in the stacking order

Tk_SetClass - set or retrieve a window's class

Tk_SetClassProcs - register widget specific procedures

Tk_SetGrid - control the grid for interactive resizing

Tk_SetWindowVisual - change visual characteristics of window

Tk_WindowId - retrieve information from Tk's local data structure

Events and Bindings

Tk_CreateBindingTable - invoke scripts in response to X events

Tk_CreateEventHandler - associate procedure callback with an X event

Tk_Grab - manipulate grab state in an application

Tk_HandleEvent - invoke event handlers for window system events

Tk_QueueWindowEvent - Add a window event to the Tcl event queue

Tk_RestrictEvents - filter and selectively delay X events

Tk_SetCaretPos - set the display caret location

Resources and Options

Tk_AddOption - Add an option to the option database

Tk_ConfigureWidget - process configuration options for widgets

Tk_ConfigureWindow - change window configuration or attributes

Tk_CreateWindow - create or delete window

Tk_FontId - accessor functions for

Tk_GetOption - retrieve an option from the option database

Tk_SetOptions - process configuration options

Images

Tk_CreateImageType - define new kind of image

Tk_CreateItemType - define new kind of canvas item

Tk_CreatePhotoImageFormat - define new file format for photo images

Tk_DeleteImage - Destroy an image.

Tk_FindPhoto - manipulate the image data stored in a photo image.

Tk_AllocBitmapFromObj - maintain database of single-plane pixmaps

Tk_ImageChanged - notify widgets that image needs to be redrawn

Tk_NameOfImage - Return name of image.

Canvas Widgets

Tk_CanvasPs - utility procedures for generating Postscript for canvases

Tk_CanvasTkwin - utility procedures for canvas type managers

Tk_CanvasTextInfo - additional information for managing text items in canvases

Graphics Routines

Tk_Alloc3DBorderFromObj - draw borders with three-dimensional appearance

Tk_DrawFocusHighlight - draw the traversal highlight ring for a widget

Tk_GetCapStyle - translate between strings and cap styles

Tk_GetColormap - allocate and free colormaps

Tk_AllocColorFromObj - maintain database of colors

Tk_AllocCursorFromObj - maintain database of cursors

Tk_GetDash - convert from string to valid dash structure.

Tk_AllocFontFromObj - maintain database of fonts

Tk_GetGC - maintain database of read-only graphics contexts

Tk_GetImage - use an image in a widget

Tk_GetJoinStyle - translate between strings and join styles

Tk_GetJustifyFromObj - translate between strings and justification styles

Tk_GetPixelsFromObj - translate between strings and screen units

Tk_GetPixmap - allocate and free pixmaps

Tk_GetReliefFromObj - translate between strings and relief values

Tk_GetRootCoords - Compute root-window coordinates of window

Tk_MeasureChars - routines to measure and display simple single-line strings.

Tk_ComputeTextLayout - routines to measure and display single-font, multi-line, justified text.

System-specific

Tk_CreateClientMessageHandler - associate procedure callback with ClientMessage type X events

Tk_CreateGenericHandler - associate procedure callback with all X events

Tk_FreeXId - make X resource identifier available for reuse

Tk_GetHINSTANCE - retrieve the global application instance handle

Tk_GetHWND - manage interactione between the Windows handle and an X window

Tk_GetVRootGeometry - Get location and size of virtual root for window

Tk_GetVisual - translate from string to visual

Tk_HWNDToWindow - Find Tk's window information for a Windows window

Tk_IdToWindow - Find Tk's window information for an X window

Tk_InternAtom - manage cache of X atoms

Selection and Clipboard

Tk_ClipboardClear - Manage the clipboard

Tk_ClearSelection - Deselect a selection

Tk_CreateSelHandler - arrange to handle requests for a selection

Tk_GetSelection - retrieve the contents of a selection

Tk_OwnSelection - make a window the owner of the primary selection