Import Tix 8.4.3.5 (as of svn r86089)
This commit is contained in:
Zachary Ware
42
man/GNUmakefile
Normal file
42
man/GNUmakefile
Normal file
@@ -0,0 +1,42 @@
|
||||
# GNUmakefile --
|
||||
#
|
||||
# This GNUmakefile requires GNU make. It builds the HTML version
|
||||
# of the Tix man pages. You normally do not need to use this
|
||||
# GNUmakefile, as all the HTML man pages are already included in
|
||||
# the Tix source distribution.
|
||||
#
|
||||
# You need to use this file when you are create a Tix source
|
||||
# distribution from the Tix CVS tree. See
|
||||
# ../docs/MakeSrcDist.txt for more information.
|
||||
#
|
||||
# Copyright (c) 2000-2001 Tix Project Group.
|
||||
#
|
||||
# See the file "license.terms" for information on usage and
|
||||
# redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
#
|
||||
# $Id: GNUmakefile,v 1.1 2001/01/22 08:01:22 ioilam Exp $
|
||||
|
||||
TCLSH = tclsh
|
||||
MAN2HTML = ../tools/tix-man2html.tcl
|
||||
UPDATEIDX = ../tools/man2html-fixindex.tcl
|
||||
NROFF_SRCS = $(shell echo *.n *.1)
|
||||
|
||||
all: html/contents.htm
|
||||
|
||||
html/contents.htm: ${NROFF_SRCS} ${MAN2HTML} ${UPDATEIDX} GNUmakefile
|
||||
${TCLSH} ${MAN2HTML} --htmldir=html --srcdir=../..
|
||||
${TCLSH} ${UPDATEIDX} html
|
||||
|
||||
distclean:
|
||||
-cd html; rm -rf *.htm *~ Keywords UserCmd
|
||||
-cd html; rm -rf TclCmd TclLib
|
||||
-cd html; rm -rf TkCmd TkLib
|
||||
-cd html; rm -rf TixCmd TixLib
|
||||
|
||||
test:
|
||||
env TEST_ONLY=true $(MAKE) all
|
||||
|
||||
full:
|
||||
env WITH_TCL_TK=true $(MAKE) all
|
||||
|
||||
|
||||
47
man/Makefile
Normal file
47
man/Makefile
Normal file
@@ -0,0 +1,47 @@
|
||||
# GNUmakefile --
|
||||
#
|
||||
# This Makefile builds the HTML version
|
||||
# of the Tix man pages. You normally do not need to use this
|
||||
# Makefile, as all the HTML man pages are already included in
|
||||
# the Tix source distribution.
|
||||
#
|
||||
# Copyright (c) 2000-2001 Tix Project Group.
|
||||
#
|
||||
# See the file "license.terms" for information on usage and
|
||||
# redistribution of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
#
|
||||
# $Id: Makefile,v 1.2 2001/12/09 03:25:15 idiscovery Exp $
|
||||
|
||||
TCLSH = tclsh
|
||||
MAN2HTML = ../tools/tix-man2html.tcl
|
||||
UPDATEIDX = ../tools/man2html-fixindex.tcl
|
||||
NROFF_SRCS = \
|
||||
TixIntro.n compound.n pixmap.n tix.n tixBalloon.n tixButtonBox.n \
|
||||
tixCheckList.n tixComboBox.n tixControl.n tixDestroy.n tixDirList.n \
|
||||
tixDirSelectDialog.n tixDirTree.n tixDisplayStyle.n \
|
||||
tixExFileSelectBox.n tixExFileSelectDialog.n tixFileEntry.n \
|
||||
tixFileSelectBox.n tixFileSelectDialog.n tixForm.n tixGetBoolean.n \
|
||||
tixGetInt.n tixGrid.n tixHList.n tixInputOnly.n \
|
||||
tixLabelEntry.n tixLabelFrame.n tixListNoteBook.n \
|
||||
tixMeter.n tixMwm.n tixNBFrame.n tixNoteBook.n tixOptionMenu.n \
|
||||
tixPanedWindow.n tixPopupMenu.n tixScrolledHList.n tixScrolledListBox.n \
|
||||
tixScrolledText.n tixScrolledWindow.n tixSelect.n tixStdButtonBox.n \
|
||||
tixTList.n tixTree.n tixUtils.n tixwish.1
|
||||
|
||||
all: html/contents.htm
|
||||
|
||||
html/contents.htm: ${NROFF_SRCS} ${MAN2HTML} ${UPDATEIDX} GNUmakefile
|
||||
${TCLSH} ${MAN2HTML} --htmldir=html --srcdir=../..
|
||||
${TCLSH} ${UPDATEIDX} html
|
||||
|
||||
distclean:
|
||||
-cd html; rm -rf *.htm *~ Keywords UserCmd
|
||||
-cd html; rm -rf TclCmd TclLib
|
||||
-cd html; rm -rf TkCmd TkLib
|
||||
-cd html; rm -rf TixCmd TixLib
|
||||
|
||||
test:
|
||||
env TEST_ONLY=true $(MAKE) all
|
||||
|
||||
full:
|
||||
env WITH_TCL_TK=true $(MAKE) all
|
||||
261
man/TixIntro.n
Normal file
261
man/TixIntro.n
Normal file
@@ -0,0 +1,261 @@
|
||||
'\"
|
||||
'\" $Id: TixIntro.n,v 1.4 2001/01/22 07:59:48 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH TixIntro n 8.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
.SH NAME
|
||||
TixIntro \- Introduction to the Tix library
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
Tix, which stands for Tk Interface Extension, is an extension library
|
||||
for Tcl/Tk. Tix adds many new widgets, image types and other commands that
|
||||
allows you to create compelling Tcl/Tk-based GUI applications.
|
||||
.PP
|
||||
One advantage of Tix over other Tk widget libraries is many of the Tix
|
||||
standard widgets are implemented in native code. This enhances
|
||||
performance and provides native look-and-feel for your applications.
|
||||
.PP
|
||||
This version of Tix works with Tcl/Tk version 8.0 or above.
|
||||
If Tix has been installed properly on your system, you can load the
|
||||
package into any Tk script by invoking the command
|
||||
.CS
|
||||
package require Tix
|
||||
.CE
|
||||
After this command has successfully returned, you can start using the
|
||||
functionalities of the Tix library. See the \fBEXAMPLES\fR section
|
||||
below for example scripts that use Tix.
|
||||
.PP
|
||||
If the "package require Tix" command fails, you
|
||||
probably need to install a new copy of Tix on your system. You can
|
||||
download the latest version of Tix from the web site
|
||||
http://tix.sourceforge.net/.
|
||||
.PP
|
||||
'\"
|
||||
.SH STANDARD WIDGETS
|
||||
Tix includes the following standard widgets which, like their counterparts in
|
||||
Tk, are implemented in native code to achieve high performance and
|
||||
native look-and-feel.
|
||||
.TP
|
||||
\fBtixGrid\fR
|
||||
The \fBtixGrid\fR widget displays items in a spread-sheet format.
|
||||
.TP
|
||||
\fBtixHList\fR
|
||||
Hierarchical listbox widget. This widget display entries in a
|
||||
tree-like format.
|
||||
.TP
|
||||
\fBtixInputOnly\fR
|
||||
A transparent window that can be used to cover another widget so as to
|
||||
disable mouse input.
|
||||
.TP
|
||||
\fBtixNBFrame\fR
|
||||
The \fBtixNBFrame\fR widget is used internally by the
|
||||
\fBtixNoteBook\fR widget to display choices among a set of overlapping
|
||||
pages.
|
||||
.TP
|
||||
\fBtixTList\fR
|
||||
Tabular listbox widget. This widget is similar to the built-in Tk
|
||||
\fBlistbox\fR widget but provides more flexibility in displaying the
|
||||
list entries.
|
||||
.SH MEGA WIDGETS
|
||||
Tix provides many new types of \fImega widgets\fR: these are widgets
|
||||
that are composed of built-in Tk widgets and the Tix standard widgets
|
||||
mentioned above.
|
||||
.TP
|
||||
\fBtixBalloon\fR
|
||||
The \fBtixBalloon\fR widget provides context-sensitive on-screen
|
||||
help.
|
||||
.TP
|
||||
\fBtixButtonBox\fR
|
||||
A convenience class for creating a box of \fBbutton\fR widgets.
|
||||
.TP
|
||||
\fBtixCheckList\fR
|
||||
A subclass of \fBtixTree\fR that presents single- or multiple
|
||||
choices to the user in a tree-like format.
|
||||
.TP
|
||||
\fBtixComboBox\fR
|
||||
A combination of the \fBlistbox\fR and \fBentry\fR widgets that allows
|
||||
the user to input an item by typing or by selecting from a list of
|
||||
items.
|
||||
.TP
|
||||
\fBtixControl\fR
|
||||
The \fBtixControl\fR widget allows the user to adjust a value using
|
||||
arrow buttons.
|
||||
.TP
|
||||
\fBtixDirList\fR
|
||||
A directory selection widget that displays the file system as a
|
||||
cascading list.
|
||||
.TP
|
||||
\fBtixDirSelectDialog\fR
|
||||
A dialog for selecting a directory. \fIThis widget is
|
||||
deprecated.\fR Use \fBtk_chooseDirectory\fR instead.
|
||||
.TP
|
||||
\fBtixDirTree\fR
|
||||
A directory selection widget that displays the file system in a tree
|
||||
format.
|
||||
.TP
|
||||
\fBtixExFileSelectBox\fR
|
||||
A widget for selecting a file. \fIThis widget is
|
||||
deprecated.\fR Use \fBtk_getOpenFile\fR instead.
|
||||
.TP
|
||||
\fBtixExFileSelectDialog\fR
|
||||
A dialog for selecting a file. \fIThis widget is
|
||||
deprecated.\fR Use \fBtk_getOpenFile\fR instead.
|
||||
.TP
|
||||
\fBtixFileEntry\fR
|
||||
A special entry widget that allows the user to choose a file by typing
|
||||
in its name or by selecting from a file dialog.
|
||||
.TP
|
||||
\fBtixFileSelectBox\fR
|
||||
A widget for selecting a file. \fIThis widget is
|
||||
deprecated.\fR Use \fBtk_getOpenFile\fR instead.
|
||||
.TP
|
||||
\fBtixFileSelectDialog\fR
|
||||
A dialog for selecting a file. \fIThis widget is
|
||||
deprecated.\fR Use \fBtk_getOpenFile\fR instead.
|
||||
.TP
|
||||
\fBtixLabelEntry\fR
|
||||
A convenience class for creating an \fBentry\fR with an associated
|
||||
\fBlabel\fR widget.
|
||||
.TP
|
||||
\fBtixLabelFrame\fR
|
||||
A labelled \fBframe\fR widget for grouping together a set of related
|
||||
widgets.
|
||||
.TP
|
||||
\fBtixListNoteBook\fR
|
||||
The \fBtixListNoteBook\fR widget allows the user to choose from a
|
||||
set of over-lapping pages by selecting from a list box.
|
||||
.TP
|
||||
\fBtixMeter\fR
|
||||
The \fBtixMeter\fR widget displays a bar graph to indicate progress.
|
||||
.TP
|
||||
\fBtixNoteBook\fR
|
||||
The \fBtixNoteBook\fR widget allows the user to choose from a
|
||||
set of over-lapping pages with a tabbed notebook metaphore.
|
||||
.TP
|
||||
\fBtixOptionMenu\fR
|
||||
The \fBtixOptionMenu\fR widget allows the user to choose a value from
|
||||
a pop-up menu.
|
||||
.TP
|
||||
\fBtixPanedWindow\fR
|
||||
The \fBtixPanedWindow\fR widgets allows the user to adjust the
|
||||
visible size of several \fBframe\fR widgets with handle bars.
|
||||
.TP
|
||||
\fBtixPopupMenu\fR
|
||||
The \fBtixPopupMenu\fR widget can be used to implement
|
||||
context-sensitive pop-up menu.
|
||||
.TP
|
||||
\fBtixScrolledHList\fR
|
||||
A \fBtixHList\fR widget with smart scrollbars. Like other Tix scrolled
|
||||
widgets, the scroll bars can be displayed on an as-needed basis.
|
||||
.TP
|
||||
\fBtixScrolledListBox\fR
|
||||
A Tk \fBlistbox\fR widget with smart scrollbars.
|
||||
.TP
|
||||
\fBtixScrolledText\fR
|
||||
A Tk \fBtext\fR widget with smart scrollbars.
|
||||
.TP
|
||||
\fBtixScrolledWindow\fR
|
||||
A Tk \fBframe\fR widget with smart scrollbars.
|
||||
.TP
|
||||
\fBtixSelect\fR
|
||||
The \fBtixSelect\fR widget uses a set of buttons to present
|
||||
single- or multiple selection options to the user.
|
||||
.TP
|
||||
\fBtixStdButtonBox\fR
|
||||
A subclass of \fBtixButtonBox\fR that provides four standard
|
||||
buttons (OK, Apply, Cancel Help) for Motif(TM)-like dialog boxes.
|
||||
.TP
|
||||
\fBtixTree\fR
|
||||
A subclass of \fBtixScrolledHList\fR that supports expanding and collapsing
|
||||
of entries in a hierarchical list.
|
||||
.SH DISPLAY ITEMS
|
||||
Three Tix standard widgets \fBtixGrid\fR, \fBtixHList\fR and
|
||||
\fBtixTList\fR support the \fIDisplay Items\fR mechanism. Display
|
||||
items are created by the widget command of these standard widgets. You can
|
||||
customize the items using \fIstyles\fR objects.
|
||||
.TP
|
||||
\fBtixDisplayStyle\fR
|
||||
Create style objects to customize display items.
|
||||
.SH IMAGE TYPES
|
||||
Tix provides two additional image types to the Tk \fBimage\fR
|
||||
framework.
|
||||
.TP
|
||||
\fBcompound\fR
|
||||
The \fBcompound\fR image type allows you to combine images, widgets,
|
||||
and text strings into a single Tk \fBimage\fR object.
|
||||
.TP
|
||||
\fBpixmap\fR
|
||||
The \fBpixmap\fR image type supports the XPM format.
|
||||
.SH OTHER COMMANDS
|
||||
The following Tcl command are also included in the Tix library to
|
||||
perform various functions.
|
||||
.TP
|
||||
\fBtixDestroy\fR
|
||||
Destroy Tix objects instances of classes defined by \fBtixClass\fR construct.
|
||||
.TP
|
||||
\fBtixForm\fR
|
||||
A geometry manager based on attachment rules. \fIThis geometry manager
|
||||
is deprecated\fR. Use the Tk \fBgrid\fR geometry manager instead.
|
||||
.TP
|
||||
\fBtixMwm\fR
|
||||
A command to communicate with the Mwm, the Motif(TM) Window
|
||||
Manager. Works on Unix only.
|
||||
.TP
|
||||
\fBtix\fR
|
||||
The \fBtix\fR command controls the Tix application context.
|
||||
.TP
|
||||
\fBtixGetBoolean\fR
|
||||
The \fBtixGetBoolean\fR command converts a string to a boolean value.
|
||||
.TP
|
||||
\fBtixGetInt\fR
|
||||
The \fBtixGetInt\fR command converts a string to a integer value.
|
||||
.TP
|
||||
\fBtixUtils\fR
|
||||
The \fBtixUtils\fR manual page describes some utility Tix commands.
|
||||
.SH EXECUTABLE PROGRAM
|
||||
.TP
|
||||
\fBtixwish\fR
|
||||
The \fBtixwish\fR program can be used to execute Tix-based
|
||||
applications. \fBtixwish\fR \fIis deprecated\fR. You shuld use the
|
||||
standard wish program from Tk and access Tix via the "package require
|
||||
Tix" command.
|
||||
.SH EXAMPLES
|
||||
The following is an example script that uses a \fBtixTree\fR widget.
|
||||
.PP
|
||||
.CS
|
||||
set tree [tixTree .t]
|
||||
pack $tree -expand yes -fill both
|
||||
for {set i 0} {$i < 2} {incr i} {
|
||||
$tree subwidget hlist add $i -itemtype imagetext \\
|
||||
-text "Folder $i" -image [tix getimage folder]
|
||||
for {set j 0} {$j < 5} {incr j} {
|
||||
$tree subwidget hlist add $i.$j -itemtype imagetext \\
|
||||
-text "File $i.$j" -image [tix getimage textfile]
|
||||
}
|
||||
}
|
||||
$tree autosetmode
|
||||
.CE
|
||||
.SH KEYWORDS
|
||||
'\"
|
||||
Tix, mega widgets
|
||||
|
||||
|
||||
|
||||
334
man/compound.n
Normal file
334
man/compound.n
Normal file
@@ -0,0 +1,334 @@
|
||||
'\"
|
||||
'\" $Id: compound.n,v 1.3 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH compound n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
.SH NAME
|
||||
compound \- multi-line compound image type.
|
||||
.SH SYNOPSIS
|
||||
\fBimage create compound \fR?\fIname\fR? ?\fIoptions\fR?
|
||||
.BE
|
||||
'\"
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
'\"
|
||||
Compound image types can be used to create images that consists of
|
||||
multiple horizontal lines; each line is composed of a series of items
|
||||
(texts, bitmaps, images or spaces) arranged from left to
|
||||
right. Compound images are mainly used to embed complex drawings into
|
||||
widgets that support the \fB\-image\fR option. As shown in the EXAMPLE
|
||||
section below, a compound image can be used to display a bitmap and a
|
||||
text string simutaneously in a TK \fBbutton(n)\fR widget.
|
||||
'\"
|
||||
.SH "CREATING COMPOUND IMAGES"
|
||||
.PP
|
||||
Like all images, compound images are created using the \fBimage create\fR
|
||||
command. Compound images support the following \fIoptions\fR:
|
||||
.TP
|
||||
\fB\-background \fIcolor\fR
|
||||
'\"
|
||||
Specifies the background color of the compound image. This color is
|
||||
also used as the default background color for the bitmap items in the
|
||||
compound image.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-borderwidth \fIpixels\fR
|
||||
'\"
|
||||
Specifies a non-negative value indicating the width of the 3-D border
|
||||
drawn around the compound image.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-font \fIfont\fR
|
||||
'\"
|
||||
Specifies the default font for the text items in the compound image.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-foreground \fIcolor\fR
|
||||
'\"
|
||||
Specifies the default foreground color for the bitmap and text items
|
||||
in the compound image.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padx \fIvalue\fR
|
||||
'\"
|
||||
Specifies a non-negative value indicating how much extra space to
|
||||
request for the compound image in the X-direction. The \fIvalue\fR may
|
||||
have any of the forms acceptable to \fBTk_GetPixels(3)\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-pady \fIvalue\fR
|
||||
'\"
|
||||
Specifies a non-negative value indicating how much extra space to
|
||||
request for the compound image in the Y-direction.
|
||||
.TP
|
||||
\fB\-relief \fIvalue\fR
|
||||
'\"
|
||||
Specifies the 3-D effect desired for the background of the compound
|
||||
image. Acceptable values are \fBraised\fR, \fBsunken\fR, \fBflat\fR,
|
||||
\fBridge\fR, and \fBgroove\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-showbackground \fIvalue\fR
|
||||
'\"
|
||||
Specifies whether the background and the 3D borders should be drawn.
|
||||
Must be a valid boolean value. By default the background is not drawn
|
||||
and the compound image appears to have a transparent background.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-window \fIpathName\fR
|
||||
'\"
|
||||
Specifies the window in which the compound image is displayed. One
|
||||
compound image can be displayed in only one window. When that window
|
||||
is destroyed, the compound image is automatically destroyed as well.
|
||||
This option must be specified when calling the \fBimage create
|
||||
compound\fR command and cannot be changed by the \fBconfigure\fR image
|
||||
command.
|
||||
'\"
|
||||
.SH "IMAGE COMMAND"
|
||||
.PP
|
||||
When a compound image is created, Tk also creates a new command whose
|
||||
name is the same as the image. This command may be used to invoke
|
||||
various operations on the image. It has the following general form:
|
||||
.RS
|
||||
.CS
|
||||
\fIimageName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
\fIOption\fR and the \fIarg\fRs
|
||||
'\"
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for compound images:
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIimageName \fBadd line\fR ?\fIoption value ...\fR?
|
||||
'\"
|
||||
Creates a new line at the bottom of the compound image. Lines support
|
||||
the following \fIoptions\fR:
|
||||
.RS
|
||||
.TP
|
||||
\fB\-anchor\fR value
|
||||
'\"
|
||||
Specifies how the line should be aligned along the horizontal axis.
|
||||
When the values are \fBw\fR, \fBsw\fR or \fBnw\fR, the line is aligned
|
||||
to the left. When the values are \fBc\fR, \fBs\fR or \fBn\fR, the line
|
||||
is aligned to the middle. When the values are \fBe\fR, \fBse\fR or
|
||||
\fBne\fR, the line is aligned to the right.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padx \fIvalue\fR
|
||||
'\"
|
||||
Specifies a non-negative value indicating how much extra space to
|
||||
request for this line in the X-direction.
|
||||
.RE
|
||||
'\"
|
||||
.TP
|
||||
\fIimageName \fBadd \fIitem-type\fR ?\fIoption value ...\fR?
|
||||
'\"
|
||||
Creates a new item of the type \fIitem-type\fR at the end of the last
|
||||
line of the compound image. All types of items support
|
||||
these following common \fIoptions\fR:
|
||||
.RS
|
||||
.TP
|
||||
\fB-anchor\fR value
|
||||
'\"
|
||||
Specifies how the item should be aligned along the vertical axis. When
|
||||
the values are \fBn\fR, \fBnw\fR or \fBne\fR, the item is aligned to
|
||||
the top of the line. When the values are \fBc\fR, \fBw\fR or \fBe\fR,
|
||||
the item is aligned to the middle of the line. When the values are
|
||||
\fBs\fR, \fBse\fR or \fBsw\fR, the item is aligned to the bottom of
|
||||
the line.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padx \fIvalue\fR
|
||||
'\"
|
||||
Specifies a non-negative value indicating how much extra space to
|
||||
request for this item in the X-direction.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-pady \fIvalue\fR
|
||||
'\"
|
||||
Specifies a non-negative value indicating how much extra space to
|
||||
request for this item in the Y-direction.
|
||||
'\"
|
||||
.TP
|
||||
\fIitem-type\fR can be any of the following:
|
||||
.RE
|
||||
'\"
|
||||
'\"----------------------------------------
|
||||
.TP
|
||||
\fIimageName \fBadd bitmap\fR ?\fIoption value ...\fR?
|
||||
'\"
|
||||
Creates a new bitmap item of at the end of the last
|
||||
line of the compound image. Additional \fIoptions\fR accepted by the
|
||||
bitmap type are:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fB\-background \fIcolor\fR
|
||||
'\"
|
||||
Specifies the background color of the bitmap item.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-bitmap \fIname\fR
|
||||
'\"
|
||||
Specifies a bitmap to display in this item, in any of the forms
|
||||
acceptable to \fBTk_GetBitmap(3)\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-foreground \fIcolor\fR
|
||||
'\"
|
||||
Specifies the foreground color of the bitmap item.
|
||||
'\"
|
||||
.RE
|
||||
'\"----------------------------------------
|
||||
.TP
|
||||
\fIimageName \fBadd image\fR ?\fIoption value ...\fR?
|
||||
'\"
|
||||
Creates a new image item of at the end of the last
|
||||
line of the compound image. Additional \fIoptions\fR accepted by the
|
||||
image type are:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fB\-image \fIname\fR
|
||||
Specifies an image to display in this item. \fIname\fR
|
||||
must have been created with the \fBimage create\fR command.
|
||||
'\"
|
||||
.RE
|
||||
'\"----------------------------------------
|
||||
.TP
|
||||
\fIimageName \fBadd space\fR ?\fIoption value ...\fR?
|
||||
Creates a new space item of at the end of the last line of the
|
||||
compound image. Space items do not display anything. They just acts as
|
||||
space holders that add additional spaces between items inside a
|
||||
compound image. Additional \fIoptions\fR accepted by the image type
|
||||
are:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fB\-width \fIvalue\fR
|
||||
Specifies the width of this space. The \fIvalue\fR may have any of the
|
||||
forms acceptable to \fBTk_GetPixels(3)\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-height \fIvalue\fR
|
||||
Specifies the height of this space. The \fIvalue\fR may have any of
|
||||
the forms acceptable to \fBTk_GetPixels(3)\fR.
|
||||
'\"
|
||||
.RE
|
||||
'\"----------------------------------------
|
||||
.TP
|
||||
\fIimageName \fBadd text\fR ?\fIoption value ...\fR?
|
||||
Creates a new text item of at the end of the last line of the compound
|
||||
image. Additional \fIoptions\fR accepted by the text type are:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fB\-background \fIcolor\fR
|
||||
Specifies the background color of the text item.
|
||||
.TP
|
||||
\fB\-font \fIname\fR
|
||||
Specifies the font to be used for this text item.
|
||||
.TP
|
||||
\fB\-foreground \fIcolor\fR
|
||||
'\"
|
||||
Specifies the foreground color of the text item.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-justify\fR \fIvalue\fR
|
||||
'\"
|
||||
When there are multiple lines of text displayed in a text item, this
|
||||
option determines how the lines line up with each other. \fIvalue\fR
|
||||
must be one of \fBleft\fR, \fBcenter\fR, or \fBright\fR. \fBLeft\fR
|
||||
means that the lines' left edges all line up, \fBcenter\fR means that
|
||||
the lines' centers are aligned, and \fBright\fR means that the lines'
|
||||
right edges line up.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-text \fIstring\fR
|
||||
'\"
|
||||
Specifies a text string to display in this text item.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-underline\fR \fIvalue\fR
|
||||
'\"
|
||||
Specifies the integer index of a character to underline in the text
|
||||
item. 0 corresponds to the first character of the text displayed in
|
||||
the text item, 1 to the next character, and so on.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-wraplength\fR \fIvalue\fR
|
||||
'\"
|
||||
This option specifies the maximum line length of the label string on
|
||||
this text item. If the line length of the label string exceeds this
|
||||
length, it is wrapped onto the next line, so that no line is longer
|
||||
than the specified length. The value may be specified in any of the
|
||||
standard forms for screen distances. If this value is less than or
|
||||
equal to 0 then no wrapping is done: lines will break only at newline
|
||||
characters in the text.
|
||||
'\"
|
||||
.RE
|
||||
'\"----------------------------------------
|
||||
'\"
|
||||
.TP
|
||||
\fIimageName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBimage create compound\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIimageName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options for the image. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIimageName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given option(s) to have the given value(s); in this case
|
||||
the command returns an empty string. \fIOption\fR may have any of the
|
||||
values accepted by the \fBimage create compound\fR command, except the
|
||||
\fB\-window\fR option
|
||||
'\".
|
||||
'\"----------------------------------------
|
||||
'\"
|
||||
.SH EXAMPLE
|
||||
'\"
|
||||
The following example creates a compound image with a bitmap and a
|
||||
text string and places this image into a Tk \fBbitton(n)\fR
|
||||
widget. Notice that the image must be created after the creation of
|
||||
the window that it resides in.
|
||||
.PP
|
||||
.CS
|
||||
set btn [button .b]
|
||||
set img [image create compound -window $btn]
|
||||
$img add line
|
||||
$img add bitmap -bitmap warning
|
||||
$img add space -width 8
|
||||
$img add text -text "Warning" -underline 0
|
||||
$btn config -image $img
|
||||
pack $btn
|
||||
.CE
|
||||
'\"
|
||||
.SH KEYWORDS
|
||||
image(n), Tix(n)
|
||||
|
||||
|
||||
8
man/html/.cvsignore
Normal file
8
man/html/.cvsignore
Normal file
@@ -0,0 +1,8 @@
|
||||
contents.htm
|
||||
TclCmd
|
||||
TkCmd
|
||||
TixCmd
|
||||
Keywords
|
||||
UserCmd
|
||||
TclLib
|
||||
TkLib
|
||||
10
man/html/README.txt
Normal file
10
man/html/README.txt
Normal file
@@ -0,0 +1,10 @@
|
||||
RCS $Id: README.txt,v 1.1 2001/01/22 00:36:05 ioilam Exp $
|
||||
|
||||
This directory contains HTML version of the Tix manual pages. All the
|
||||
HTML files are auto-generated, so do not edit them directly. If you
|
||||
need to make a change, edit the Nroff sources in the parent directory.
|
||||
|
||||
If there are no other files in this directory except this README.txt
|
||||
file, you probably have a checked-out copy of the Tix CVS tree. See
|
||||
the file ../GNUmakefile about how to generate the HTML files.
|
||||
|
||||
73
man/index.html
Normal file
73
man/index.html
Normal file
@@ -0,0 +1,73 @@
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>Tix Manual Index</TITLE>
|
||||
<!-- $Id: index.html,v 1.4 2005/03/25 20:15:53 hobbs Exp $ -->
|
||||
</HEAD>
|
||||
<BODY BGCOLOR="#ffffff" TEXT="#000000" LINK="#0000ff" VLINK="#800000" ALINK="#800080">
|
||||
<FONT FACE="Tahoma, Arial, Helvetica">
|
||||
|
||||
<Center><H2>Tix Manual Index</H2></Center>
|
||||
|
||||
<h3> General Documents </h3>
|
||||
|
||||
<ul>
|
||||
|
||||
<li> <b><a href="../ABOUT.html">ABOUT.html</a></b><br>
|
||||
A brief descriptions of Tix.
|
||||
<p>
|
||||
|
||||
<li> <b><a href="../docs/Release.html">Release Notes</a></b><br>
|
||||
Important release notes about this version of Tix.
|
||||
<p>
|
||||
|
||||
|
||||
<li> <b><a href="../license.terms">license.terms</a></b><br>
|
||||
Licensing terms and a <b><i>disclaimer of all
|
||||
liabilities</i></b>. You should use Tix only if you agree to
|
||||
<i><b>all</b></i> of its licensing terms. <p>
|
||||
|
||||
<li> <b><a href="../Roadmap.html">Roadmap.html</a></b><br>
|
||||
Planned future changes to Tix.
|
||||
<p>
|
||||
|
||||
</ul>
|
||||
|
||||
<h3> Programming with Tix </h3>
|
||||
|
||||
<ul>
|
||||
|
||||
<li> <b><a href="../docs/html/TixUser/TixUser.html">
|
||||
/docs/html/TixUser/TixUser.html</a></b><br>
|
||||
|
||||
Tix Users's Guide. An introduction to Tix under Python or Tcl.<BR>
|
||||
Also available in <A HREF="docs/pdf/TixUser.pdf">PDF</A>.
|
||||
<p>
|
||||
|
||||
|
||||
<li> <b><a href="../docs/tix-book/tix.book.html">
|
||||
/docs/tix-book/tix.book.html</a></b><br>
|
||||
|
||||
Tix Programmer's Guide. It was written for Tix 4.0, but most
|
||||
of its contents are still relevant for this version of Tix.
|
||||
<p>
|
||||
|
||||
<li> <b><a href="../man/html/contents.htm">/man/html/contents.htm</a></b><br>
|
||||
Tix Manual Pages.
|
||||
<p>
|
||||
|
||||
<li> <b><a href="../docs/FAQ.html">/docs/FAQ.html</a></b><br>
|
||||
Frequent Asked Questions about Tix.
|
||||
<p>
|
||||
|
||||
<li> <b><a href="../tools/README.html">/tools/README.html</a></b><br>
|
||||
Useful development tools included in this package
|
||||
<p>
|
||||
|
||||
</ul>
|
||||
|
||||
<hr>
|
||||
|
||||
<a href="http://tix.sourceforge.net">Tix Home Page</a><br>
|
||||
</FONT>
|
||||
</BODY>
|
||||
</HTML>
|
||||
236
man/man.macros
Normal file
236
man/man.macros
Normal file
@@ -0,0 +1,236 @@
|
||||
'\" The definitions below are for supplemental macros used in Tcl/Tk
|
||||
'\" manual entries.
|
||||
'\"
|
||||
'\" .AP type name in/out ?indent?
|
||||
'\" Start paragraph describing an argument to a library procedure.
|
||||
'\" type is type of argument (int, etc.), in/out is either "in", "out",
|
||||
'\" or "in/out" to describe whether procedure reads or modifies arg,
|
||||
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
|
||||
'\" needed; use .AS below instead)
|
||||
'\"
|
||||
'\" .AS ?type? ?name?
|
||||
'\" Give maximum sizes of arguments for setting tab stops. Type and
|
||||
'\" name are examples of largest possible arguments that will be passed
|
||||
'\" to .AP later. If args are omitted, default tab stops are used.
|
||||
'\"
|
||||
'\" .BS
|
||||
'\" Start box enclosure. From here until next .BE, everything will be
|
||||
'\" enclosed in one large box.
|
||||
'\"
|
||||
'\" .BE
|
||||
'\" End of box enclosure.
|
||||
'\"
|
||||
'\" .CS
|
||||
'\" Begin code excerpt.
|
||||
'\"
|
||||
'\" .CE
|
||||
'\" End code excerpt.
|
||||
'\"
|
||||
'\" .VS ?version? ?br?
|
||||
'\" Begin vertical sidebar, for use in marking newly-changed parts
|
||||
'\" of man pages. The first argument is ignored and used for recording
|
||||
'\" the version when the .VS was added, so that the sidebars can be
|
||||
'\" found and removed when they reach a certain age. If another argument
|
||||
'\" is present, then a line break is forced before starting the sidebar.
|
||||
'\"
|
||||
'\" .VE
|
||||
'\" End of vertical sidebar.
|
||||
'\"
|
||||
'\" .DS
|
||||
'\" Begin an indented unfilled display.
|
||||
'\"
|
||||
'\" .DE
|
||||
'\" End of indented unfilled display.
|
||||
'\"
|
||||
'\" .SO
|
||||
'\" Start of list of standard options for a Tk widget. The
|
||||
'\" options follow on successive lines, in four columns separated
|
||||
'\" by tabs.
|
||||
'\"
|
||||
'\" .SE
|
||||
'\" End of list of standard options for a Tk widget.
|
||||
'\"
|
||||
'\" .OP cmdName dbName dbClass
|
||||
'\" Start of description of a specific option. cmdName gives the
|
||||
'\" option's name as specified in the class command, dbName gives
|
||||
'\" the option's name in the option database, and dbClass gives
|
||||
'\" the option's class in the option database.
|
||||
'\"
|
||||
'\" .UL arg1 arg2
|
||||
'\" Print arg1 underlined, then print arg2 normally.
|
||||
'\"
|
||||
'\" RCS: @(#) $Id: man.macros,v 1.2 2001/01/22 00:32:09 ioilam Exp $
|
||||
'\"
|
||||
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
|
||||
.if t .wh -1.3i ^B
|
||||
.nr ^l \n(.l
|
||||
.ad b
|
||||
'\" # Start an argument description
|
||||
.de AP
|
||||
.ie !"\\$4"" .TP \\$4
|
||||
.el \{\
|
||||
. ie !"\\$2"" .TP \\n()Cu
|
||||
. el .TP 15
|
||||
.\}
|
||||
.ta \\n()Au \\n()Bu
|
||||
.ie !"\\$3"" \{\
|
||||
\&\\$1 \\fI\\$2\\fP (\\$3)
|
||||
.\".b
|
||||
.\}
|
||||
.el \{\
|
||||
.br
|
||||
.ie !"\\$2"" \{\
|
||||
\&\\$1 \\fI\\$2\\fP
|
||||
.\}
|
||||
.el \{\
|
||||
\&\\fI\\$1\\fP
|
||||
.\}
|
||||
.\}
|
||||
..
|
||||
'\" # define tabbing values for .AP
|
||||
.de AS
|
||||
.nr )A 10n
|
||||
.if !"\\$1"" .nr )A \\w'\\$1'u+3n
|
||||
.nr )B \\n()Au+15n
|
||||
.\"
|
||||
.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
|
||||
.nr )C \\n()Bu+\\w'(in/out)'u+2n
|
||||
..
|
||||
.AS Tcl_Interp Tcl_CreateInterp in/out
|
||||
'\" # BS - start boxed text
|
||||
'\" # ^y = starting y location
|
||||
'\" # ^b = 1
|
||||
.de BS
|
||||
.br
|
||||
.mk ^y
|
||||
.nr ^b 1u
|
||||
.if n .nf
|
||||
.if n .ti 0
|
||||
.if n \l'\\n(.lu\(ul'
|
||||
.if n .fi
|
||||
..
|
||||
'\" # BE - end boxed text (draw box now)
|
||||
.de BE
|
||||
.nf
|
||||
.ti 0
|
||||
.mk ^t
|
||||
.ie n \l'\\n(^lu\(ul'
|
||||
.el \{\
|
||||
.\" Draw four-sided box normally, but don't draw top of
|
||||
.\" box if the box started on an earlier page.
|
||||
.ie !\\n(^b-1 \{\
|
||||
\h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
|
||||
.\}
|
||||
.el \}\
|
||||
\h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
|
||||
.\}
|
||||
.\}
|
||||
.fi
|
||||
.br
|
||||
.nr ^b 0
|
||||
..
|
||||
'\" # VS - start vertical sidebar
|
||||
'\" # ^Y = starting y location
|
||||
'\" # ^v = 1 (for troff; for nroff this doesn't matter)
|
||||
.de VS
|
||||
.if !"\\$2"" .br
|
||||
.mk ^Y
|
||||
.ie n 'mc \s12\(br\s0
|
||||
.el .nr ^v 1u
|
||||
..
|
||||
'\" # VE - end of vertical sidebar
|
||||
.de VE
|
||||
.ie n 'mc
|
||||
.el \{\
|
||||
.ev 2
|
||||
.nf
|
||||
.ti 0
|
||||
.mk ^t
|
||||
\h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
|
||||
.sp -1
|
||||
.fi
|
||||
.ev
|
||||
.\}
|
||||
.nr ^v 0
|
||||
..
|
||||
'\" # Special macro to handle page bottom: finish off current
|
||||
'\" # box/sidebar if in box/sidebar mode, then invoked standard
|
||||
'\" # page bottom macro.
|
||||
.de ^B
|
||||
.ev 2
|
||||
'ti 0
|
||||
'nf
|
||||
.mk ^t
|
||||
.if \\n(^b \{\
|
||||
.\" Draw three-sided box if this is the box's first page,
|
||||
.\" draw two sides but no top otherwise.
|
||||
.ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
|
||||
.el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
|
||||
.\}
|
||||
.if \\n(^v \{\
|
||||
.nr ^x \\n(^tu+1v-\\n(^Yu
|
||||
\kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
|
||||
.\}
|
||||
.bp
|
||||
'fi
|
||||
.ev
|
||||
.if \\n(^b \{\
|
||||
.mk ^y
|
||||
.nr ^b 2
|
||||
.\}
|
||||
.if \\n(^v \{\
|
||||
.mk ^Y
|
||||
.\}
|
||||
..
|
||||
'\" # DS - begin display
|
||||
.de DS
|
||||
.RS
|
||||
.nf
|
||||
.sp
|
||||
..
|
||||
'\" # DE - end display
|
||||
.de DE
|
||||
.fi
|
||||
.RE
|
||||
.sp
|
||||
..
|
||||
'\" # SO - start of list of standard options
|
||||
.de SO
|
||||
.SH "STANDARD OPTIONS"
|
||||
.LP
|
||||
.nf
|
||||
.ta 4c 8c 12c
|
||||
.ft B
|
||||
..
|
||||
'\" # SE - end of list of standard options
|
||||
.de SE
|
||||
.fi
|
||||
.ft R
|
||||
.LP
|
||||
See the \\fBoptions\\fR manual entry for details on the standard options.
|
||||
..
|
||||
'\" # OP - start of full description for a single option
|
||||
.de OP
|
||||
.LP
|
||||
.nf
|
||||
.ta 4c
|
||||
Command-Line Name: \\fB\\$1\\fR
|
||||
Database Name: \\fB\\$2\\fR
|
||||
Database Class: \\fB\\$3\\fR
|
||||
.fi
|
||||
.IP
|
||||
..
|
||||
'\" # CS - begin code excerpt
|
||||
.de CS
|
||||
.RS
|
||||
.nf
|
||||
.ta .25i .5i .75i 1i
|
||||
..
|
||||
'\" # CE - end code excerpt
|
||||
.de CE
|
||||
.fi
|
||||
.RE
|
||||
..
|
||||
.de UL
|
||||
\\$1\l'|0\(ul'\\$2
|
||||
..
|
||||
92
man/pixmap.n
Normal file
92
man/pixmap.n
Normal file
@@ -0,0 +1,92 @@
|
||||
'\"
|
||||
'\" $Id: pixmap.n,v 1.3 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH pixmap n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\" Note: do not modify the .SH NAME line immediately below!
|
||||
.SH NAME
|
||||
pixmap \- image type for the XPM file format.
|
||||
.SH SYNOPSIS
|
||||
\fBimage create pixmap \fR?\fIname\fR? ?\fIoptions\fR?
|
||||
.BE
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
XPM is a popular X Window image file format for storing color icons.
|
||||
The \fBpixmap\fR image type defined by the \fBTix(n)\fR library can be
|
||||
used to create color images using XPM files.
|
||||
|
||||
.SH "CREATING PIXMAPS"
|
||||
.PP
|
||||
Like all images, pixmaps are created using the \fBimage create\fR
|
||||
command. Pixmaps support the following \fIoptions\fR:
|
||||
.TP
|
||||
\fB\-data \fIstring\fR
|
||||
'\"
|
||||
Specifies the contents of the source pixmap as a string. The string
|
||||
must adhere to the XPM file format (e.g., as generated by the
|
||||
\fBpixmap(1)\fR program). If both the \fB\-data\fR and \fB\-file\fR
|
||||
options are specified, the \fB\-data\fR option takes precedence.
|
||||
Please note that the XPM file parsing code in the xpm library is
|
||||
extremely fragile. The first line of the string must be "\fB/* XPM
|
||||
*/\fR" or otherwise a segmatation fault will be caused.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-file \fIname\fR
|
||||
'\"
|
||||
\fIname\fR gives the name of a file whose contents define the source
|
||||
pixmap. The file must adhere to the XPM file format (e.g., as
|
||||
generated by the \fBpixmap(1)\fR program).
|
||||
'\"
|
||||
.SH "IMAGE COMMAND"
|
||||
.PP
|
||||
When a pixmap image is created, Tk also creates a new command whose
|
||||
name is the same as the image. This command may be used to invoke
|
||||
various operations on the image. It has the following general form:
|
||||
.RS
|
||||
.CS
|
||||
\fIimageName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
\fIOption\fR and the \fIarg\fRs
|
||||
'\"
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for pixmap images:
|
||||
.TP
|
||||
\fIimageName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBimage create pixmap\fR command.
|
||||
.TP
|
||||
\fIimageName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options for the image. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIimageName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given option(s) to have the given value(s); in this case
|
||||
the command returns an empty string. \fIOption\fR may have any of the
|
||||
values accepted by the \fBimage create pixmap\fR command.
|
||||
|
||||
.SH KEYWORDS
|
||||
pixmap(1), image(n), Tix(n)
|
||||
|
||||
|
||||
252
man/tix.n
Normal file
252
man/tix.n
Normal file
@@ -0,0 +1,252 @@
|
||||
'\"
|
||||
'\" $Id: tix.n,v 1.5 2004/12/24 00:38:31 hobbs Exp $
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH tix n 8.4 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
.SH NAME
|
||||
tix \- Manipulate internal states of the Tix library
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtix\fR \fIoption \fR?\fIarg arg ...\fR?
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "CONFIGURATION OPTIONS"
|
||||
'\"
|
||||
This manual page descripts the \fBtix\fR command, which manipulates
|
||||
the internal states of the Tix library. If you're looking for a general
|
||||
introduction to the Tix library, please refer to the \fBTixIntro\fR
|
||||
manual page.
|
||||
.PP
|
||||
The Tix application context supports the following configuration
|
||||
options. Usually, these options are set using the X resource database,
|
||||
i.e., in the user's \fB\.Xdefault\fR file. For example, to choose a
|
||||
different color scheme for the Tix widgets, these two lines can be
|
||||
added to the user's \fB\.Xdefault\fR file:
|
||||
.RS
|
||||
.CS
|
||||
*TixScheme: Gray
|
||||
*TixFontSet: 14Point
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -binding binding Binding
|
||||
This is an obsolete option.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-debug debug Debug
|
||||
Specifies whether the Tix widgets should run in debug mode.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-fontset tixFontSet TixFontSet
|
||||
Specifies the fontset to use for the Tix widgets. Valid options are
|
||||
\fBWmDefault\fR,
|
||||
\fBTK\fR, \fBTkWin\fR, \fB12Point\fR and \fB14Point\fR. \fBTK\fR specifies that the
|
||||
standard TK fonts should be used. The default value is \fBWmDefault\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-scheme tixScheme TixScheme
|
||||
Specifies the color scheme to use for the Tix widgets. Valid options
|
||||
are \fBWmDefault\fR,
|
||||
\fBTK\fR, \fBTkWin\fR, \fBGray\fR, \fBBlue\fR, \fBBisque\fR, \fBSGIGray\fR and
|
||||
\fBTixGray\fR. If you want the
|
||||
standard TK color scheme, you can use the value \fBTK\fR.
|
||||
The default value is \fBWmDefault\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-schemepriority tixSchemePriority TixSchemePriority
|
||||
Specifies the priority level of the TK options set by th Tix
|
||||
schemes. Please refer to the TK \fBoption(n)\fR manual page for a
|
||||
discussion of the priority level of Tix options. The default value is
|
||||
79, which makes the Tix schemes at a higher priority than the
|
||||
settings in the .Xdefaults file. If you want to allow the Tix schemes
|
||||
to be overridden by the settings in the .Xdefaults file, you can set
|
||||
the following line in you .Xdefaults file:
|
||||
.CS
|
||||
*TixSchemePriority: 21
|
||||
.CE
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \fBtix\fR command provides access to miscellaneous elements of
|
||||
Tix's internal state and the Tix \fBapplication context\fR. Most of
|
||||
the information manipulated by this command pertains to the
|
||||
application as a whole, or to a screen or display, rather than to a
|
||||
particular window. The command can take any of a number of different
|
||||
forms depending on the \fIoption\fR argument. The legal forms are:
|
||||
'\"
|
||||
.TP
|
||||
\fBtix addbitmapdir\fR \fIdirectory\fR
|
||||
'\"
|
||||
Tix maintains a list of directory under which which the \fBtix
|
||||
getimage\fR and \fBtix getbitmap\fR commands will search for image
|
||||
files. The standard bitmap directory is
|
||||
\fB$TIX_LIBRARY/bitmaps\fR. The \fBaddbitmapdir\fR command adds
|
||||
\fIdirectory\fR into this list. By using this command, the image files
|
||||
of an applications can also be located using the \fBtix getimage\fR ot
|
||||
\fBtix getbitmap\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fBtix cget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may be any of the options described in the
|
||||
\fBCONFIGURATION OPTIONS\fR section.
|
||||
'\"
|
||||
.TP
|
||||
\fBtix configure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the Tix application
|
||||
context. If no \fIoption\fR is specified, returns a list describing
|
||||
all of the available options (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given option(s) to have the given value(s); in this case
|
||||
the command returns an empty string. \fIOption\fR may be any of the
|
||||
options described in the \fBCONFIGURATION OPTIONS\fR section.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fBtix filedialog \fR?\fIclass\fR?
|
||||
'\"
|
||||
Returns the file selection dialog that may be shared among different
|
||||
modules of this application. This command will create a file selection
|
||||
dialog widget when it is called the first time. This dialog will be
|
||||
returned by all subsequent calls to \fBtix filedialog\fR. An optional
|
||||
\fIclass\fR parameter can be passed to specified what type of file
|
||||
selection dialog widget is desired. Possible options are
|
||||
\fBtixFileSelectDialog\fR or \fBtixExFileSelectDialog.\fR
|
||||
'\"
|
||||
.TP
|
||||
\fBtix getbitmap \fIname\fR
|
||||
'\"
|
||||
Locates a bitmap file of the name \fIname\fR.xpm or \fIname\fR in one
|
||||
of the bitmap directories (see the \fBaddbitmapdir\fR command
|
||||
above). By using \fBtix getbitmap\fR, you can advoid hard coding the
|
||||
pathnames of the bitmap files in your application. When successful, it
|
||||
returns the complete pathname of the bitmap file, prefixed with the
|
||||
character \fB@\fR. The returned value can be used to configure the
|
||||
\fB\-bitmap\fR option of the TK and Tix widgets.
|
||||
'\"
|
||||
.TP
|
||||
\fBtix getimage \fIname\fR
|
||||
'\"
|
||||
Locates an image file of the name \fIname\fR.xpm, \fIname\fR.xbm or
|
||||
\fIname\fR.ppm in one of the bitmap directories (see the
|
||||
\fBaddbitmapdir\fR command above). If more than one file with the same
|
||||
name (but different extensions) exist, then the image type is chosen
|
||||
according to the depth of the X display: xbm images are chosen on
|
||||
monochrome displays and color images are chosen on color displays. By
|
||||
using \fBtix getimage\fR, you can advoid hard coding the pathnames of
|
||||
the image files in your application. When successful, this command
|
||||
returns the name of the newly created image, which can be used to
|
||||
configure the \fB\-image\fR option of the TK and Tix widgets.
|
||||
'\"
|
||||
.TP
|
||||
\fBtix initstyle\fR
|
||||
'\"
|
||||
Init the style defaults for Tix. Prior to Tix 8.4 this was done by
|
||||
simply package requiring Tix, but this call is now required to
|
||||
explicitly use Tix style.
|
||||
'\"
|
||||
.TP
|
||||
\fBtix option\fR ?\fIargs ...\fR?
|
||||
'\"
|
||||
Manipulates the options manitained by the Tix scheme
|
||||
mechanism. Available options are:
|
||||
.CS
|
||||
active_bg active_fg bg
|
||||
bold_font dark1_bg dark1_fg
|
||||
dark2_bg dark2_fg disabled_fg
|
||||
fg fixed_font font
|
||||
inactive_bg inactive_fg input1_bg
|
||||
input2_bg italic_font light1_bg
|
||||
light1_fg light2_bg light2_fg
|
||||
menu_font output1_bg output2_bg
|
||||
select_bg select_fg selector
|
||||
.CE
|
||||
The arguments to the \fBtix option\fR command can take the
|
||||
following form(s):
|
||||
.RS
|
||||
.TP
|
||||
\fBtix option get\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of \fIoption\fR.
|
||||
.RE
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fBtix resetoptions\fR \fInewScheme newFontSet\fR ?\fInewScmPrio\fR?
|
||||
'\"
|
||||
'\"
|
||||
Resets the scheme and fontset of the Tix application to
|
||||
\fInewScheme\fR and \fInewFontSet\fR, respectively. This affects only
|
||||
those widgets created \fBafter\fR this call. Therefore, it is best to
|
||||
call the \fBresetoptions\fR command \fBbefore\fR the creation of any
|
||||
widgets in a Tix application.
|
||||
|
||||
The optional parameter \fInewScmPrio\fR can be given to reset the
|
||||
priority level of the TK options set by the Tix schemes.
|
||||
'\"
|
||||
'\"
|
||||
.SH BUGS
|
||||
'\"
|
||||
.IP [1]
|
||||
In this release of Tix, the following configuration options have been
|
||||
disabled. Assigning values to them will cause no effect:
|
||||
.CS
|
||||
-binding
|
||||
-debug
|
||||
-fontset
|
||||
-scheme
|
||||
-schemepriority
|
||||
.CE
|
||||
In addition, the following options to the \fBtix\fR command have been
|
||||
disabled. Invoking the \fBtix\fR command with these options will cause
|
||||
no effect:
|
||||
.CS
|
||||
resetoptions
|
||||
.CE
|
||||
.IP [2]
|
||||
Because of the way TK handles the X option database, after tixwish has
|
||||
started up, it is not possible to reset the color schemes and font
|
||||
sets using the \fBtix config\fR command. Instead, the \fBtix
|
||||
resetoptions\fR command must be used.
|
||||
'\"
|
||||
.PP
|
||||
The tk_setPalette command does not work very well under Tix. To use
|
||||
it, one must follow these steps:
|
||||
.RS
|
||||
.CS
|
||||
tix resetoptions TK TK
|
||||
tk_setPalette lightblue
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
.SH KEYWORDS
|
||||
file selection dialog
|
||||
|
||||
225
man/tixBalloon.n
Normal file
225
man/tixBalloon.n
Normal file
@@ -0,0 +1,225 @@
|
||||
'\"
|
||||
'\" $Id: tixBalloon.n,v 1.1 2001/01/22 00:37:59 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixBalloon n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixBalloon \- Create and manipulate tixBalloon widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixBalloon \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBtixBalloon\fR class is derived from the \fBTixShell\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The Balloon widget supports all the standard options of a frame widget.
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-initwait initWait InitWait
|
||||
In milliseconds. Specifies how long the balloon should wait before
|
||||
popping up in a widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the which help message to display when the mouse pointer
|
||||
enters a widget associated with this balloon. Valid options are
|
||||
\fBboth\fR: display both the balloon message and the status bar
|
||||
message, \fBballoon\fR: display only the balloon message,
|
||||
\fBstatus\fR: display only the status bar message and \fBnone\fR:
|
||||
display no messages.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-statusbar statusBar statusBar
|
||||
Specifies the widget to use as the status bar of this balloon. This
|
||||
widget must have a "-text" option. Usually a label widget is used.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlabel\fR
|
||||
Class: \fBLabel\fR
|
||||
.fi
|
||||
.IP
|
||||
The label widget that shows the little arrow bitmap in the pop-up
|
||||
balloon window.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBmessage\fR
|
||||
Class: \fBLabel\fR
|
||||
.fi
|
||||
.IP
|
||||
The message widget that shows the descriptive message in the the pop-up
|
||||
balloon window.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixBalloon\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a Balloon widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
Balloon widget such as its cursor and relief.
|
||||
|
||||
The Balloon widget can be used to show popped-up messages
|
||||
that describe the functions of the widgets in an application. A
|
||||
Balloon widget can be bound to a number of widgets. When the user
|
||||
moves the cursor inside a widget to which a Balloon widget has been
|
||||
bound, a small pop-up window with a descriptive message will be shown
|
||||
on the screen.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixBalloon\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the Balloon widget's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
Balloon widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for Balloon widgets:
|
||||
.TP
|
||||
\fIpathName \fBbind\fR widget ?\fIoption value ... \fR?
|
||||
'\"
|
||||
Binds the Balloon widget to the \fIwidget\fR. The messages to be
|
||||
shown can be passed as extra arguments to this command in \fIoption
|
||||
value\fR pairs. Possible options: \fB\-balloonmsg\fR specifies the
|
||||
string to show on the pop-up balloon window; \fB\-statusmsg\fR
|
||||
specifies the string to show on the status bar; \fB\-msg\fR specifies a
|
||||
string to show on both the balloon window and the stats bar window.
|
||||
When used together, the \fB\-msg\fR option has a lower precedence than
|
||||
the \fB\-balloonmsg\fR and \fB\-statusmsg\fR options.
|
||||
|
||||
The \fBbind\fR command can also be used to change the messages after
|
||||
the initial bindings were set. Example:
|
||||
.PP
|
||||
.nf
|
||||
button .b
|
||||
tixBalloon .bal
|
||||
|
||||
# Add balloon binding
|
||||
.bal bind .b -msg "This is a button"
|
||||
|
||||
...
|
||||
|
||||
# Change the balloon binding
|
||||
.bal bind .b -msg "This is a useful button"
|
||||
.fi
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixBalloon\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixBalloon\fR command.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBunbind\fI widget\fR
|
||||
'\"
|
||||
Cancels the Balloon widget's binding with \fIwidget\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
After a widget has be bound to a Balloon widget, when the user moves
|
||||
the cursor into this widget, the Balloon widget is activated: if the
|
||||
\fB\-balloonmsg\fR option of this widget is set, the balloon window
|
||||
pops up; if the \fB\-statusmsg\fR option of this widget is set, the
|
||||
message will be displayed in the status bar widget.
|
||||
.PP
|
||||
When the user moves the cursor out of the widget, the Balloon widget
|
||||
is de-activated: the balloon window is withdrawn and the status-bar
|
||||
message removed.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
188
man/tixButtonBox.n
Normal file
188
man/tixButtonBox.n
Normal file
@@ -0,0 +1,188 @@
|
||||
'\"
|
||||
'\" $Id: tixButtonBox.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixButtonBox n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixButtonBox \- Create and manipulate Tix ButtonBox widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixButtonBox \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-anchor \-background \-cursor
|
||||
\-relief \-borderWidth
|
||||
'\"
|
||||
.SE
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -orientation orientation Orientation
|
||||
\fBStatic Option\fR. Specifies the orientation of the button
|
||||
subwidgets. Only the values "horizontal" and "vertical" are recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padx Pad
|
||||
Specifies the horizontal padding between two neighboring button
|
||||
subwidgets in the ButtonBox widget.
|
||||
'\"----------END
|
||||
|
||||
'\"----------BEGIN
|
||||
.OP \-pady pady Pad
|
||||
Specifies the vertical padding between two neighboring button
|
||||
subwidgets in the ButtonBox widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the state of all the buttons inside the ButtonBox widget.
|
||||
|
||||
\fINote\fR:
|
||||
Setting this option using the \fIconfig\fR widget command will enable
|
||||
or disable all the buttons subwidgets. Original states of the
|
||||
individual buttons are \fInot\fR saved. Only the values "normal" and
|
||||
"disabled" are recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
.PP
|
||||
'\"
|
||||
All the button subwidgets created as a result of the \fBadd\fR command
|
||||
can be accessed by the \fBsubwidget\fR command. They are identified by
|
||||
the \fBbuttonName\fR parameter to the \fBadd\fR command. Here is an
|
||||
example:
|
||||
.PP
|
||||
.CS
|
||||
set bbox [tixButtonBox .bbox]
|
||||
pack $bbox
|
||||
$bbox add eat -text Eat
|
||||
$bbox add sleep -text Sleep
|
||||
$bbox subwidget eat config -fg green
|
||||
$bbox subwidget sleep config -fg red
|
||||
.CE
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixButtonBox\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a ButtonBox
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
ButtonBox such as its cursor and relief.
|
||||
'\"
|
||||
.PP
|
||||
The ButtonBox widget can be used as a container widget to hold the
|
||||
``action'' buttons in a dialog box.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET COMMAND"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixButtonBox\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the ButtonBox's window. This command may
|
||||
be used to invoke various operations on the widget. It has the
|
||||
following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as
|
||||
the ButtonBox widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for ButtonBox widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBadd \fIbuttonName \fR?\fIoption value ...\fR?
|
||||
'\"
|
||||
Add a new button subwidget with the name \fIbuttonName\fR into
|
||||
the ButtonBox widget. Additional configuration options can be given to
|
||||
configure the new button subwidget.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixButtonBox\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixButtonBox\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinvoke \fIbuttonName\fR
|
||||
'\"
|
||||
Invoke the button subwidget with the name \fIbuttonName\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no additional arguments are given, returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When no additional arguments are given, the widget command of the
|
||||
specified subwidget will be called with these parameters.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
TixButtonBox widgets have no default bindings. The button subwidgets
|
||||
retain their default Tk bindings.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), Container Widgets
|
||||
|
||||
|
||||
|
||||
238
man/tixCheckList.n
Normal file
238
man/tixCheckList.n
Normal file
@@ -0,0 +1,238 @@
|
||||
'\"
|
||||
'\" $Id: tixCheckList.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixCheckList n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixCheckList \- Create and manipulate tixCheckList widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixCheckList \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixCheckList\fR class is derived from the \fBTixTree\fR class
|
||||
and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixCheckList\fR supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browseCmd BrowseCmd
|
||||
Specifies a command to call whenever the user browses on an entry
|
||||
(usually by single-clicking on the entry). The command is called with
|
||||
one argument, the pathname of the entry.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies a command to call whenever the user activates an entry
|
||||
(usually by double-clicking on the entry). The command
|
||||
is called with one argument, the pathname of the entry.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-radio radio Radio
|
||||
A Boolean value. If set to true, the user can select at most one item
|
||||
at a time; if set to false, the user can select as many items as
|
||||
possible.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhlist\fR
|
||||
Class: \fBTixHList\fR
|
||||
.fi
|
||||
.IP
|
||||
The hierarchical listbox that displays the CheckList.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixCheckList\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a CheckList widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the CheckList
|
||||
widget such as its cursor and relief.
|
||||
.PP
|
||||
The CheckList widget displays a list of items to be selected by the
|
||||
user. CheckList acts similarly to the Tk checkbutton or radiobutton
|
||||
widgets, except it is capable of handling many more items than
|
||||
checkbuttons or radiobuttons.
|
||||
.PP
|
||||
The items are contained in the \fBhlist\fR subwidget. Each item may
|
||||
be in one of the following status: \fBon\fR (indicated by a check
|
||||
bitmap), \fBoff\fR (indicated by a cross bitmap) \fBdefault\fR
|
||||
(indicated by a gray box bitmap) or \fBnone\fR, in which case the item
|
||||
will not be accompanied by a bitmap. The items whose status is
|
||||
\fBon\fR, \fBoff\fR or \fBdefault\fR are called the \fIselectable\fR
|
||||
items and can be checked or crossed by the user. All selectable
|
||||
entries must be of the type \fBimagetext\fR.
|
||||
.PP
|
||||
The items whose status is \fBnone\fR cannot be checked or crossed by
|
||||
the user; usually they are included in the \fBhlist\fR subwidget only
|
||||
for explanation purposes or as separators.
|
||||
.PP
|
||||
Initially, all the items have a \fInone\fR status. To make an item
|
||||
selectable, you can call the \fBsetstatus\fR command to change its
|
||||
status (see below).
|
||||
'\"
|
||||
.PP
|
||||
Notice that CheckList is a subclass of the TixTree widget and thus is
|
||||
is capable of displaying a hierachy of selectable entries. When
|
||||
necessary, you can call the \fBsetmode\fR method (see
|
||||
\fBTixTree(n)\fR) to define the hierachical structure of the
|
||||
selectable entries.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixCheckList\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the CheckList's window. This command may
|
||||
be used to invoke various operations on the widget. It has the
|
||||
following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
CheckList widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for CheckList widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBgetselection\fR ?\fIstatus\fR?
|
||||
'\"
|
||||
Returns a list of items whose status matches \fIstatus\fR. If
|
||||
\fIstatus\fR is not specified, the list of items in the "\fBon\fR"
|
||||
status will be returned.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBgetstatus\fR \fIentryPath\fR
|
||||
'\"
|
||||
Returns the current status of \fIentryPath\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsetstatus\fR \fIentryPath status\fR
|
||||
'\"
|
||||
Sets the status of \fIentryPath\fR to be \fIstatus\fR. A bitmap will
|
||||
be displayed next to the entry its status is \fBon\fR, \fBoff\fR or
|
||||
\fBdefault\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH EXAMPLE
|
||||
'\"
|
||||
.PP
|
||||
This example creates several choices for the user to select.
|
||||
.PP
|
||||
.CS
|
||||
set c [tixCheckList .c]
|
||||
$c subwidget hlist add choice1 -itemtype imagetext -text Choice1
|
||||
$c subwidget hlist add choice2 -itemtype imagetext -text Choice2
|
||||
$c subwidget hlist add choice3 -itemtype imagetext -text Choice3
|
||||
$c setstatus choice1 on
|
||||
$c setstatus choice2 off
|
||||
$c setstatus choice3 off
|
||||
pack $c
|
||||
.CE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
'\"
|
||||
The basic mouse and keyboard bindings of the CheckList widget are the
|
||||
same as the bindings of the TixTree widget.
|
||||
|
||||
In addition, the status of the entries in the CheckList are toggled
|
||||
under the following conditions:
|
||||
'\"
|
||||
.IP [1]
|
||||
When the user press the mouse button over an entry.
|
||||
'\"
|
||||
.IP [2]
|
||||
When the user press the <space> key over an entry.
|
||||
'\"
|
||||
.IP [3]
|
||||
When the user press the <Return> key over an entry.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), tixHList(n), tixTree(n)
|
||||
|
||||
|
||||
466
man/tixComboBox.n
Normal file
466
man/tixComboBox.n
Normal file
@@ -0,0 +1,466 @@
|
||||
'\"
|
||||
'\" $Id: tixComboBox.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixComboBox n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixComboBox - Create and manipulate tixComboBox widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixComboBox \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixComboBox\fR class is derived from the \fBTixLabelWidget\fR
|
||||
class and inherits all the commands, options and subwidgets
|
||||
of its super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixComboBox\fR supports all the standard options of a frame widget.
|
||||
See the options(n) manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.PP
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-anchor anchor Anchor
|
||||
Specifies how the string inside the entry subwidget should be aligned.
|
||||
Only the values "w" or "e" are allowed. When set the "w", the entry is
|
||||
aligned to its beginning. When set to "e", it is aligned to its end.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-arrowbitmap arrowBitmap ArrowBitmap
|
||||
Specifies the bitmap to be used in the arrow button beside the entry
|
||||
widget. The default is an downward arrow bitmap in the file
|
||||
$tix_library/bitmaps/cbxarrow
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browseCmd BrowseCmd
|
||||
Specifies the command to be called when the user browses through the
|
||||
listbox. This command can be used to provide instant feedback when the
|
||||
user examines items in the listbox before committing a choice.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the ComboBox is invoked
|
||||
or when the \fB\-value\fR of the ComboBox is changed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-crossbitmap crossBitmap CrossBitmap
|
||||
Specifies the bitmap to be used in the "cross" button to the left of
|
||||
the entry widget. The default is a bitmap in the file
|
||||
$tix_library/bitmaps/cross
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the ComboBox.
|
||||
changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disabledforeground disabledforeground DisabledForeground
|
||||
Specifies the foreground color to be used when the ComboBox is disabled.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dropdown dropdown Dropdown
|
||||
A Boolean value specifying the style of the ComboBox. When set to
|
||||
"true", the listbox is only displayed temporarily when the arrow
|
||||
button is pressed. When set to "false", the listbox is always
|
||||
displayed.
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-editable editable Editable
|
||||
Specifies whether the user is allowed to type into the entry subwidget of
|
||||
the ComboBox.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-fancy fancy Fancy
|
||||
A Boolean value specifying whether the cross and tick button
|
||||
subwidgets should be shown.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-grab grab Grab
|
||||
Specifies the pointer grabbing policy when the listbox is popped up.
|
||||
Only values "global", "local" or "none" are allowed. By default global
|
||||
grab is used. However, when you are developing your application, you
|
||||
may want to use only local grabbing so that in the event of errors,
|
||||
your X display won't be locked up.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhistoryLimit\fR
|
||||
Class: \fBhistoryLimit\fR
|
||||
Switch: \fB\-historylimit\fR
|
||||
Alias: \fB\-histlimit\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies how many previous user inputs can be stored in the history
|
||||
list.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-history history History
|
||||
A Boolean value specifying whether previous user inputs should be
|
||||
stored in the history list.
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-label label Label
|
||||
Specifies the string to display as the label of this ComboBox widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-labelside labelSide LabelSide
|
||||
Specifies where the label should be displayed relative to the entry
|
||||
subwidget. Valid options are: \fBtop\fR, \fBleft\fR, \fBright\fR,
|
||||
\fBbottom\fR, \fBnone\fR or \fBacrosstop\fR.
|
||||
'\"----------END
|
||||
'\"'
|
||||
'\"----------BEGIN
|
||||
.OP \-listcmd listCmd listCmd
|
||||
Specifies a TCL command to be called every time when the listbox pops
|
||||
up. This option allows you to fill up the listbox on-demand. This
|
||||
option is ignored when the listbox is not in the \fBdropdown\fR style.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-listwidth listWidth listWidth
|
||||
If set, this option controls the width of the listbox subwidget when
|
||||
it is popped up. The option is ignored when the listbox is not in the
|
||||
\fBdropdown\fR style.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-prunehistory prunehistory PruneHistory
|
||||
Specifies whether duplicated previous user inputs should be pruned
|
||||
from the the history list. Only Boolean values are allowed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selection selection Selection
|
||||
Contains the selection in the ComboBox (the string displayed in the
|
||||
entry subwidget). Depending on the \fB\-selectmode\fR, the selection
|
||||
of a ComboBox may be different than its \fB\-value\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selection selection Selection
|
||||
This option stores the temporary selection. When the user types in a
|
||||
text string inside the entry widget, that string is considered as a
|
||||
temporary input and is stored inside the \fB\-selection\fR option. The
|
||||
\fB\-value\fR option is updated only when the user presses the return
|
||||
key.
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selectmode selectMode SelectMode
|
||||
Specifies the how the combobox responds to the mouse button events in
|
||||
the listbox subwidget; can eithet be \fB"browse"\fR or
|
||||
\fB"immediate"\fR. The default \fB\-selectmode\fR is "browse". See the
|
||||
\fBBINDINGS\fR section below.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the whether the ComboBox is normal or disabled.
|
||||
Only the values "normal" and "disabled" are recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-tickbitmap tickBitmap tickBitmap
|
||||
Specifies the bitmap to be used in the "tick" button to the left of
|
||||
the entry widget. The default is a bitmap in the file
|
||||
$tix_library/bitmaps/tick
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-validatecmd validateCmd ValidateCmd
|
||||
Specifies a TCL command to be called when the \fB\-value\fR of the
|
||||
ComboBox is about to change. This command is called with one parameter
|
||||
-- the new \fB\-value\fR entered by the user. This command is to
|
||||
validate this new value by returning a value it deems valid.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-value value Value
|
||||
Specifies the string to be displayed in the entry subwidget of the
|
||||
ComboBox. When queried, the returned value is the last value
|
||||
selected by the user. When the \fB\-value\fR option is changed as a
|
||||
result of the \fBconfig -value\fR widget command, the TCL command
|
||||
specified by the \fB\-command\fR option is called.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-variable variable Variable
|
||||
Specifies the global variable in which the value of the
|
||||
ComboBox should be stored. The value of the ComboBox
|
||||
will be automatically updated when this variable is changed.
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBarrow\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The down arrow button.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBcross\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The cross button. Available only when \fB\-fancy\fR is set.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBentry\fR
|
||||
Class: \fBEntry\fR
|
||||
.fi
|
||||
.IP
|
||||
The entry that shows the value of this \fBtixControl\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlabel\fR
|
||||
Class: \fBLabel\fR
|
||||
.fi
|
||||
.IP
|
||||
The label subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlistbox\fR
|
||||
Class: \fBListbox\fR
|
||||
.fi
|
||||
.IP
|
||||
The listbox that holds all the list entries.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBslistbox\fR
|
||||
Class: \fBTixScrolledListBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The scrolled-listbox that provides the scrollbars.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBtick\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The tick button. Available only when \fB\-fancy\fR is set.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixComboBox\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a \fBtixComboBox\fR widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
ComboBox such as its cursor and relief.
|
||||
|
||||
The Tix ComboBox widget is similar to the combo box control in
|
||||
MS Windows. The user can select a choice by either typing in the entry
|
||||
subwdget or selecting from the listbox subwidget.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixComboBox\fR command creates a new Tcl command whose name is the
|
||||
same as the path name of the ComboBox's window. This command
|
||||
may be used to invoke various operations on the widget. It has the
|
||||
following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
ComboBox widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for ComboBox widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBaddhistory\fI string \fR
|
||||
'\"
|
||||
Add the string to the beinning of the listbox.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBappendhistory\fI string \fR
|
||||
Append the string to the end of the listbox.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixComboBox\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixComboBox\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBflash \fIindex string\fR
|
||||
'\"
|
||||
Flashes the ComboBox. \fBflash\fR is usually called by a
|
||||
\fI\-command\fR procedure to acknowledge to the user that he has
|
||||
selected a value for the ComboBox.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinsert \fIindex string\fR
|
||||
Insert the \fI string\fR into the listbox at the specified index.
|
||||
\fIindex\fR must be a valid listbox index.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpick \fIindex\fR
|
||||
Set the (\fIindex\fR)th item in the listbox to be the current value of
|
||||
the ComboBox. As a result, the \fIvalue\fR of the ComboBox is changed
|
||||
and the TCL command sepcified by the \fI\-command\fR option will be
|
||||
called.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
When no options are given, returns the pathname of the subwidget of
|
||||
the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget will
|
||||
be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.PP
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
.IP [1]
|
||||
If the \fB\-selectmode\fR is "immediate", when the user enters a
|
||||
keystroke, clicks on an item or drags the mouse pointer in the
|
||||
listbox, the \fB\-value\fR of the ComboBox will be immediately set to
|
||||
this item and the \fB\-command\fR procedure will be called.
|
||||
'\"
|
||||
'\"
|
||||
.IP [2]
|
||||
If the \fB\-selectmode\fR is "browse", when the user enters a
|
||||
keystroke, clicks on an item or drags the mouse pointer in the
|
||||
listbox, the \fB\-selection\fR of the ComboBox will be immediately set
|
||||
to the new content of the entry subwidget; also the \fB\-browsecmd\fR
|
||||
procedure will be called. The \fB\-value\fR option will be changed
|
||||
only when the user invokes the ComboBox (see [3] below). If the user
|
||||
presses the <Escape> key at any time, any new \fB\-selection\fR will
|
||||
be ignored and the text inside the entry subwidget will be restored to
|
||||
the current \fB\-value\fR of the ComboBox.
|
||||
'\"
|
||||
.IP [3]
|
||||
If the \fB\-dropdown\fR option is true, the user can invoke the
|
||||
ComboBox by releasing the left mouse button over the desired item in
|
||||
the listbox. If the \fB\-dropdown\fR option is false, the user can
|
||||
invoke the ComboBox by double-clicking over the desired item in the
|
||||
listbox. In both cases, the user can also invoke the listbox by
|
||||
pressing the <Return> or <Tab> key inside the entry subwidget, or
|
||||
switching the input focus to another widget inside the same toplevel
|
||||
widget
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.PP
|
||||
.SH BUGS
|
||||
.PP
|
||||
Starting from Tix vetsion 4.0, the default \fB\-value\fR of the
|
||||
ComboBox is the empty string. If you want the ComboBox to show a
|
||||
string by default, you must configure its \fB\-value\fR option
|
||||
explicitly.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.PP
|
||||
.SH KEYWORDS
|
||||
Tix(n), ComboBox(n), listbox(n)
|
||||
|
||||
|
||||
375
man/tixControl.n
Normal file
375
man/tixControl.n
Normal file
@@ -0,0 +1,375 @@
|
||||
'\"
|
||||
'\" $Id: tixControl.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixControl n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixControl \- Create and manipulate tixControl widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixControl \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixControl\fR class is derived from the \fBTixLabelWidget\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The Control widget supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-allowempty allowEmpty AllowEmpty
|
||||
Specifies whether the Control widget should allow the empty string
|
||||
as a valid input.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-autorepeat autorepeat AutoRepeat
|
||||
Specifies whether the Control widget should have autorepeat behavior.
|
||||
If set to be "true", the value of the Control widget will be
|
||||
automatically incremented or decremented when the user holds down the
|
||||
mouse button over the arrow buttons. Only values "true" and
|
||||
"false" will be recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the \fB\-value\fR option of
|
||||
the Control widget is changed. The command will be called with one
|
||||
arguments -- the new value of the Control widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-decrcmd decrCmd DecrCmd
|
||||
Specifies a TCL command to be called when the the user presses the
|
||||
down-arrow button subwidget. This command is called with one parameter
|
||||
-- the current \fB\-value\fR of this Control widget. This
|
||||
command is to decrement this value by one step, according to its own
|
||||
definition of "decrement", and return the decremented value, which
|
||||
will be stored in the \fB\-value\fR of this Control widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the Control widget
|
||||
changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disableforeground disableForeground DisableForeground
|
||||
The foreground color to use for of the entry subwidget when the
|
||||
Control widget is disabled.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-incrcmd incrCmd IncrCmd
|
||||
Specifies a TCL command to be called when the the user presses the
|
||||
up-arrow button subwidget. This command is called with one parameter
|
||||
-- the current \fB\-value\fR of this Control widget. This
|
||||
command is to increment this value by one step, according to its own
|
||||
definition of "increment", and return the incremented value, which
|
||||
will be stored in the \fB\-value\fR of this Control widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-initwait initwait Initwait
|
||||
Specifies how long the Control widget should wait initially before
|
||||
it starts to automatically increment or decrement its value in the
|
||||
autorepeat mode. In milliseconds.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-integer integer Integer
|
||||
A Boolean value specifying whether only integer numbers are accepted.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-label label Label
|
||||
Specifies the string to display as the label of this Control widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-labelside labelSide LabelSide
|
||||
Specifies where the label should be displayed relative to the entry
|
||||
subwidget. Valid options are: \fBtop\fR, \fBleft\fR, \fBright\fR,
|
||||
\fBbottom\fR, \fBnone\fR or \fBacrosstop\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBmax\fR
|
||||
Class: \fBMax\fR
|
||||
Switch: \fB\-max\fR
|
||||
Alias: \fB\-ulimit\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the upper limit of the value of the Control widget. When set
|
||||
to empty string, the Control widget has no upper limit.
|
||||
'\"----------END
|
||||
'\"'
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBmin\fR
|
||||
Class: \fBMin\fR
|
||||
Switch: \fB\-min\fR
|
||||
Alias: \fB\-llimit\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the lower limit of the value of the Control widget.When set
|
||||
to empty string, the Control widget has no lower limit.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-repeatrate repeatRate RepeatRate
|
||||
Specifies how often the value of the Control widget should be
|
||||
incremented or decremented when it is in the autorepeat mode. In
|
||||
milliseconds.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selectmode selectMode SelectMode
|
||||
Specifies how the Control widget should react to \fC<KeyPress>\fR
|
||||
events. When set to "immediate", any user keyboard inputs will
|
||||
immediately change the \fB\-value\fR option. When set to "normal", the
|
||||
user keyboard inputs will be copied to the \fB\-value\fR option only
|
||||
if the\fC <Return>\fR key is pressed or the keyboard focus is
|
||||
changed. The use of the immediate mode is discouraged. For effective
|
||||
use of the Control widget, one should use the normal mode together
|
||||
with the \fBupdate\fR widget command (see below).
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the whether the Control widget is normal or
|
||||
disabled. Only the values "normal" and "disabled" are recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-step step Step
|
||||
Specifies by how much the value of the Control widget should be
|
||||
incremented or decrmented when the user press the arrow buttons.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-validatecmd validateCmd ValidateCmd
|
||||
Specifies a TCL command to be called when the -value of the
|
||||
Control widget is about to change. This command is called
|
||||
with one parameter -- the new \fB\-value\fR entered by the user. This
|
||||
command is to validate this new value by returning a value it deems
|
||||
valid.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-value value Value
|
||||
Specifies the value of the Control widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-variable variable Variable
|
||||
Specifies the global variable in which the value of the
|
||||
Control widget should be stored. The value of the Control widget
|
||||
will be automatically updated when this variable is changed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBdecr\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The down arrow button.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBentry\fR
|
||||
Class: \fBEntry\fR
|
||||
.fi
|
||||
.IP
|
||||
The entry that shows the value of this Control widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBincr\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The up arrow button.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlabel\fR
|
||||
Class: \fBLabel\fR
|
||||
.fi
|
||||
.IP
|
||||
The label subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixControl\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a Control widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
Control widget such as its cursor and relief.
|
||||
|
||||
The Control widget is also known as the \fBSpinBox\fR widget.
|
||||
It is generally used to control a value. The user can adjust the value
|
||||
by pressing the two arrow buttons or by entering the value directly
|
||||
into the entry. The new value will be checked against the user-defined
|
||||
upper and lower limits.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixControl\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the Control widget's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
Control widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for Control widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixControl\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixControl\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdecr\fR
|
||||
'\"
|
||||
Decrements the value of the Control widget by the step specified
|
||||
by the \fI\-step\fR option.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBincr\fR
|
||||
'\"
|
||||
Increments the value of the Control widget by the step
|
||||
specified by the \fI\-step\fR option.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinvoke\fR
|
||||
'\"
|
||||
Causes the command specified by the \fI\-command\fR option to be
|
||||
invoked.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBupdate\fR
|
||||
'\"
|
||||
If the user has modified the entry using keyboard inputs, the update
|
||||
command will \fBupdate\fR the \fB\-value\fR of this Control
|
||||
widget. When the Control widget's \fB\-selectmode\fR option is set to
|
||||
"normal", one should call the \fBupdate\fR command on this widget
|
||||
before examining its \fB\-value\fR option. This command has no effect
|
||||
in if the \fB\-selectmode\fR option is set to "immediate".
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
'\"
|
||||
When the user presses the up/down arrow buttons (or press the <Up> and
|
||||
<Down> arrow keys on the keyboard), the value of the tixControl widget
|
||||
is adjusted according to the \fB\-validatecmd\fR, \fB\-incrcmd\fR,
|
||||
\fB\-decrcmd\fR, \fB\-step\fR, \fB\-max\fR and \fB\-min\fR options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
37
man/tixDestroy.n
Normal file
37
man/tixDestroy.n
Normal file
@@ -0,0 +1,37 @@
|
||||
'\"
|
||||
'\" $Id: tixDestroy.n,v 1.1 2001/01/22 00:37:59 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH tixDestroy n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
.SH NAME
|
||||
tixDestroy \- Destroy Tix Objects
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixDestroy\fR \fIobjectName\fR
|
||||
'\"
|
||||
.BE
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
The \fBtixDestroy\fR destroys a Tix object whose class is declared by
|
||||
the \fBtixClass\fR keyword. When the object is destroyed, its
|
||||
\fBDestructor\fR function is called and the memory allocated for this
|
||||
object is freed.
|
||||
'\"
|
||||
.SH KEYWORDS
|
||||
Tix, Object
|
||||
|
||||
262
man/tixDirList.n
Normal file
262
man/tixDirList.n
Normal file
@@ -0,0 +1,262 @@
|
||||
'\"
|
||||
'\" $Id: tixDirList.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixDirList n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixDirList \- Create and manipulate tixDirList widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixDirList \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixDirList\fR class is derived from the \fBTixScrolledHList\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixDirList\fR supports all the standard options of a frame widget.
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browseCmd BrowseCmd
|
||||
Specifies a command to call whenever the user browses on a directory
|
||||
(usually by single-clicking on the name of the directory). The command
|
||||
is called with one argument, the complete pathname of the directory.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the user activates on a directory
|
||||
(usually by double-clicking on the name of the directory). The command
|
||||
is called with one argument, the complete pathname of the directory.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dircmd dircmd DirCmd
|
||||
Specifies the TCL command to be called when a directory listing is
|
||||
needed for a particular directory. If this option is not specified, by
|
||||
default the DirList widget will attempt to read the directory as a
|
||||
Unix directory. On special occasions, the application programmer may
|
||||
want to supply a special method for reading directories: for example,
|
||||
when he needs to list remote directories. In this case, the
|
||||
\fB\-dircmd\fR option can be used. The specified command accepts two
|
||||
arguments: the first is the name of the directory to be listed; the
|
||||
second is a Boolean value indicating whether hidden sub-directories
|
||||
should be listed. This command returns a list of names of the
|
||||
sub-directories of this directory. For example:
|
||||
.PP
|
||||
.CS
|
||||
proc read_dir {dir show_hidden} {
|
||||
if {$dir == "C:\\"} {
|
||||
return {DOS NORTON WINDOWS}
|
||||
} else {
|
||||
return {}
|
||||
}
|
||||
}
|
||||
.CE
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the DirList widget
|
||||
changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
'\"
|
||||
.OP \-showhidden showHidden ShowHidden
|
||||
Specifies whether hidden directories should be shown. By default, a
|
||||
directory name starting with a period "." is considered as a hidden
|
||||
directory. This rule can be overridden by supplying an alternative
|
||||
\fB\-dircmd\fR option.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
.OP \-root root Root
|
||||
'\"
|
||||
Specifies the name of the root directory. Usually this is \fB"/"\fR
|
||||
under Unix machines, but can be changed to \fB"C:\\"\fR in DOS environments.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
.OP \-rootname rootName RootNAme
|
||||
'\"
|
||||
Specifies a text string to display at the root directory. If
|
||||
unspecified, the text string will be the same as the string specified
|
||||
by \fB\-root\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvalue\fR
|
||||
Class: \fBValue\fR
|
||||
Switch: \fB\-value\fR
|
||||
Alias: \fB\-directory\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the name of the current directory to be displayed in the
|
||||
DirList widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhlist\fR
|
||||
Class: \fBTixHList\fR
|
||||
.fi
|
||||
.IP
|
||||
The hierarchical listbox that displays the directory listing.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixDirList\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a DirList widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
DirList such as its cursor and relief.
|
||||
|
||||
The DirList widget displays a list view of a directory, its
|
||||
previous directories and its sub-directories. The user can choose one
|
||||
of the directories displayed in the list or change to another
|
||||
directory.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixDirList\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the DirList's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
DirList widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for DirList widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixDirList\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBchdir\fR \fIdir\fR
|
||||
'\"
|
||||
Change the current directory to \fIdir\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixDirList\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
'\"
|
||||
The mouse and keyboard bindings of the DirList widget are the same as
|
||||
the bindings of the HList widget.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
176
man/tixDirSelectDialog.n
Normal file
176
man/tixDirSelectDialog.n
Normal file
@@ -0,0 +1,176 @@
|
||||
'\"
|
||||
'\" $Id: tixDirSelectDialog.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixDirSelectDialog n 4.1 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixDirSelectDialog \- Create and manipulate directory selection dialogs.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixDirSelectDialog \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixDirSelectDialog\fR supports all the standard options of a
|
||||
toplevel widget. See the \fBoptions(n)\fR manual entry for details on
|
||||
the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the user selects a directory
|
||||
in the dialog box. The command is called with one extra argument, the
|
||||
complete pathname of the directory. If the user cancels the selection,
|
||||
this command is not called.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBdirbox\fR
|
||||
Class: \fBTixDirSelectBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The DirSelectBox widget that consists of the main part of the dialog.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBcancel\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The "Cancel" button.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBok\fR
|
||||
Class: \fBButon\fR
|
||||
.fi
|
||||
.IP
|
||||
The "OK" button.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixDirSelectDialog\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a DirSelectDialog
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
DirSelectDialog such as its cursor and relief.
|
||||
|
||||
The DirSelectDialog widget presents the directories in the file system
|
||||
in a dialog window. The user can use this dialog window to navigate
|
||||
through the file system to select the desired directory.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixDirSelectDialog\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the DirSelectDialog's window.
|
||||
This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
DirSelectDialog widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for DirSelectDialog widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixDirSelectDialog\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixDirSelectDialog\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpopup\fR
|
||||
'\"
|
||||
Pops up the DirSelectDialog widget on the screen.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
.SH EXAMPLE
|
||||
'\"
|
||||
.CS
|
||||
set dlg [tixDirSelectDialog .dlg -command SelectDir]
|
||||
$dlg popup
|
||||
|
||||
proc SelectDir {dir} {
|
||||
puts "You have selected \\"$dir\\""
|
||||
}
|
||||
.CE
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
243
man/tixDirTree.n
Normal file
243
man/tixDirTree.n
Normal file
@@ -0,0 +1,243 @@
|
||||
'\"
|
||||
'\" $Id: tixDirTree.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixDirTree n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixDirTree \- Create and manipulate tixDirTree widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixDirTree \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixDirTree\fR class is derived from the \fBTixScrolledHList\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixDirTree\fR supports all the standard options of a frame widget.
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browseCmd BrowseCmd
|
||||
Specifies a command to call whenever the user browses on a directory
|
||||
(usually by single-clicking on the name of the directory). The command
|
||||
is called with one argument, the complete pathname of the directory.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the user activates on a directory
|
||||
(usually by double-clicking on the name of the directory). The command
|
||||
is called with one argument, the complete pathname of the directory.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dircmd dircmd DirCmd
|
||||
Specifies the TCL command to be called when a directory listing is
|
||||
needed for a particular directory. If this option is not specified, by
|
||||
default the DirTree widget will attempt to read the directory as a
|
||||
Unix directory. On special occasions, the application programmer may
|
||||
want to supply a special method for reading directories: for example,
|
||||
when he needs to list remote directories. In this case, the
|
||||
\fB\-dircmd\fR option can be used. The specified command accepts two
|
||||
arguments: the first is the name of the directory to be listed; the
|
||||
second is a Boolean value indicating whether hidden sub-directories
|
||||
should be listed. This command returns a list of names of the
|
||||
sub-directories of this directory. For example:
|
||||
.CS
|
||||
proc read_dir {dir show_hidden} {
|
||||
if {$dir == "C:\\"} {
|
||||
return {DOS NORTON WINDOWS}
|
||||
} else {
|
||||
return {}
|
||||
}
|
||||
}
|
||||
.CE
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the DirTree widget
|
||||
changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
'\"
|
||||
.OP \-showhidden showHidden ShowHidden
|
||||
Specifies whether hidden directories should be shown. By default, a
|
||||
directory name starting with a period "." is considered as a hidden
|
||||
directory. This rule can be overridden by supplying an alternative
|
||||
\fB\-dircmd\fR option.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvalue\fR
|
||||
Class: \fBValue\fR
|
||||
Switch: \fB\-value\fR
|
||||
Alias: \fB\-directory\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the name of the current directory to be displayed in the
|
||||
DirTree widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhlist\fR
|
||||
Class: \fBTixHList\fR
|
||||
.fi
|
||||
.IP
|
||||
The hierarchical listbox that displays the directory listing.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixDirTree\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a DirTree widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
DirTree such as its cursor and relief.
|
||||
|
||||
The DirTree widget displays a list view of a directory, its
|
||||
previous directories and its sub-directories. The user can choose one
|
||||
of the directories displayed in the list or change to another
|
||||
directory.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixDirTree\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the DirTree's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
DirTree widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for DirTree widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixDirTree\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBchdir\fR \fIdir\fR
|
||||
'\"
|
||||
Change the current directory to \fIdir\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixDirTree\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
'\"
|
||||
The mouse and keyboard bindings of the DirTree widget are the same as
|
||||
the bindings of the HList widget.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
473
man/tixDisplayStyle.n
Normal file
473
man/tixDisplayStyle.n
Normal file
@@ -0,0 +1,473 @@
|
||||
'\"
|
||||
'\" $Id: tixDisplayStyle.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixDisplayStyle n 8.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixDisplayStyle \- Create style object for Tix display items.
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixDisplayStyle \fIitemType\fR ?\fI\-stylename name\fR? ?\fI\-refwindow pathName\fR? ?\fIoptions value ...\fR?
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
The Tix \fBDisplay Items\fR mechanism is devised to
|
||||
solve a general problem: many Tix widgets (both existing and planned
|
||||
ones) display many items of many types simutaneously.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
For example, a hierarchical listbox widget (HList) can display items
|
||||
of images, plain text and subwindows in the form of a
|
||||
hierarchy. Another widget, the tabular listbox, (TList, currently
|
||||
planned and will be released in Tix 4.1) also display items of the
|
||||
same types, although it arranges the items in a tabular form. Yet
|
||||
another widget, the spreadsheet widget, also displays similar types
|
||||
items, but in yet another format.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
In these examples, the display items in different widgets are only
|
||||
different in how they are arranged by the \fBhost widget\fR. In Tix,
|
||||
display items are clearly separated from the host widgets. The
|
||||
advantage is two-fold: first, the creation and configuration of
|
||||
display items become uniform across different host widgets. Second,
|
||||
new display item types can be added without the need to modify the
|
||||
existing host widgets.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
In a way, Tix display items are similar to the items inside Tk
|
||||
the canvas widget. However, unlike the Tix display items, the canvas
|
||||
items are not independent of the canvas widget; this makes it
|
||||
impossible to use the canvas items inside other types of TK widgets.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The appearance of a display item is controlled by a set of
|
||||
\fIattributes\fR. It is observed that each the attributes usually fall
|
||||
into one of two categroies: "\fIindividual\fR" or
|
||||
"\fIcollective\fR". For example, the text items inside a HList widget
|
||||
may all display a different text string; however, in most cases, the
|
||||
text items share the same color, font and spacing. Instead of keeping
|
||||
a duplicated version of the same attributes inside each display item,
|
||||
it will be advantageous to put the collective attributes in a
|
||||
special object called a \fBdisplay style\fR. First, there is the space
|
||||
concern: a host widget may have many thousands of items; keeping
|
||||
dupilcated attributes will be very wasteful. Second, when it becomes
|
||||
necessary to change a collective attribute, such as changing all the
|
||||
text items' foreground color to red, it will be more efficient to
|
||||
change only the display style object than to modify all the text
|
||||
items one by one.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The attributes of the a display item are thus stored in two places: it
|
||||
has a set of \fBitem options\fR to store its individual attributes. Each
|
||||
display item is also associated with a \fIdisplay style\fR, which specifies
|
||||
the collective attributes of all items associated with itself.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The division between the individual and collective attributes are
|
||||
fixed and cannot be changed. Thus, when it becomes necessary for some
|
||||
items to differ in their collective attributes, two or more \fBdisplay
|
||||
styles\fR can be used. For example, suppose you want to display two
|
||||
columns of text items inside an HList widget, one column in red and
|
||||
the other in blue. You can create a TextStyle object called "red",
|
||||
which defines a red foreground, and another called "blue", which
|
||||
defines a blue foreground. You can then associate all text items of
|
||||
the first column to "red" and the second column to "blue".
|
||||
'\"
|
||||
.SH DISPLAY ITEM TYPES AND OPTIONS
|
||||
'\"
|
||||
Currently there are four types of display items: \fBtext\fR,
|
||||
\fBimage\fR, \fBimagetext\fR and \fBwindow\fR. (TODO: need to document
|
||||
the "image" item)
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\" ImageText
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH IMAGETEXT ITEMS
|
||||
'\"
|
||||
Display items of the type \fBimagetext\fR are used to display an image
|
||||
together with a text string. Imagetext items support the following options:
|
||||
'\"
|
||||
.PP
|
||||
\fBITEM OPTIONS\fR
|
||||
.PP
|
||||
.RS
|
||||
'\"----------BEGIN
|
||||
.OP \-bitmap bitmap Bitmap
|
||||
Specifies the bitmap to display in the item.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-image image Image
|
||||
Specifies the image to display in the item. When both the
|
||||
\fB\-bitmap\fR and \fB\-image\fR options are specified, only the image
|
||||
will be displayed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-style imageTextStyle ImageTextStyle
|
||||
Specifies the display style to use for this item. Must be the
|
||||
name of a \fBimagetext\fR display style that has already be created by
|
||||
the \fBtixDisplayStyle(n)\fR command.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-showimage showImage ShowImage
|
||||
A Boolean value that specifies whether the image/bitmap should be
|
||||
displayed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-showtext showText ShowText
|
||||
A Boolean value that specifies whether the text string should be
|
||||
displayed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-text text Text
|
||||
Specifies the text string to display in the item.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-underline underline Underline
|
||||
Specifies the integer index of a character to underline in the text
|
||||
string in the item. 0 corresponds to the first character of the text
|
||||
displayed in the widget, 1 to the next character, and so on.
|
||||
'\"----------END
|
||||
.RE
|
||||
'\"
|
||||
.PP
|
||||
\fBSTYLE OPTIONS\fR
|
||||
'\"
|
||||
.PP
|
||||
The style information of \fBimagetext\fR items are stored in the
|
||||
\fBimagetext\fR display style. The following options are supported:
|
||||
'\"
|
||||
.RS
|
||||
'\"
|
||||
.PP
|
||||
\fBSTANDARD OPTIONS\fR
|
||||
'\"
|
||||
.PP
|
||||
.ta 6c
|
||||
.nf
|
||||
activeBackground activeForeground
|
||||
anchor background
|
||||
disabledBackground disabledForeground
|
||||
foreground font
|
||||
justify padX
|
||||
padY selectBackground
|
||||
selectForeground wrapLength
|
||||
.fi
|
||||
.ta 4c
|
||||
.PP
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard
|
||||
options.
|
||||
.PP
|
||||
'\"
|
||||
.PP
|
||||
\fBSTYLE-SPECIFIC OPTIONS\fR
|
||||
.PP
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBgap\fR
|
||||
Class: \fBGap\fR
|
||||
Switch: \fB\-gap\fR
|
||||
'\"
|
||||
.fi
|
||||
.IP
|
||||
Specifies the distance between the bitmap/image and the text string,
|
||||
in number of pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
'\"**********************************************************************
|
||||
'\"
|
||||
'\" text
|
||||
'\"
|
||||
'\"**********************************************************************
|
||||
.SH TEXT ITEMS
|
||||
'\"
|
||||
Display items of the type \fBtext\fR are used to display a text string
|
||||
in a widget. Text items support the following options:
|
||||
'\"
|
||||
.PP
|
||||
\fBITEM OPTIONS\fR
|
||||
.PP
|
||||
.RS
|
||||
'\"----------BEGIN
|
||||
.OP \-style textStyle TextStyle
|
||||
Specifies the display style to use for this text item. Must be the
|
||||
name of a \fBtext\fR display style that has already be created by the
|
||||
\fBtixDisplayStyle(n)\fR command.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-text text Text
|
||||
Specifies the text string to display in the item.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-underline underline Underline
|
||||
Specifies the integer index of a character to underline in the item.
|
||||
0 corresponds to the first character of the text displayed in the
|
||||
widget, 1 to the next character, and so on.
|
||||
'\"----------END
|
||||
.RE
|
||||
'\"
|
||||
\fBSTYLE OPTIONS\fR
|
||||
.PP
|
||||
.RS
|
||||
.PP
|
||||
\fBSTANDARD OPTIONS\fR
|
||||
'\"
|
||||
.PP
|
||||
.ta 6c
|
||||
.nf
|
||||
activeBackground activeForeground
|
||||
anchor background
|
||||
disabledBackground disabledForeground
|
||||
foreground font
|
||||
justify padX
|
||||
padY selectBackground
|
||||
selectForeground wrapLength
|
||||
.fi
|
||||
.ta 4c
|
||||
.PP
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard
|
||||
options.
|
||||
'\"
|
||||
'\"
|
||||
.PP
|
||||
.RE
|
||||
'\"**********************************************************************
|
||||
'\"
|
||||
'\" Window
|
||||
'\"
|
||||
'\"**********************************************************************
|
||||
.SH WINDOW ITEMS
|
||||
'\"
|
||||
Display items of the type \fBwindow\fR are used to display a
|
||||
sub-window in a widget. \fBWindow\fR items support the following
|
||||
options:
|
||||
'\"
|
||||
.PP
|
||||
\fBITEM OPTIONS\fR
|
||||
.PP
|
||||
.RS
|
||||
'\"----------BEGIN
|
||||
.OP \-style windowStyle WindowStyle
|
||||
Specifies the display style to use for this window item. Must be the
|
||||
name of a \fBwindow\fR display style that has already be created by
|
||||
the \fBtixDisplayStyle(n)\fR command.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBwindow\fR
|
||||
Class: \fBWindow\fR
|
||||
Switch: \fB\-window\fR
|
||||
Alias: \fB\-widget\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the sub-window to display in the item.
|
||||
'\"----------END
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
\fBSTYLE OPTIONS\fR
|
||||
.PP
|
||||
.RS
|
||||
\fBSTANDARD OPTIONS\fR
|
||||
'\"
|
||||
.PP
|
||||
.ta 6c
|
||||
.nf
|
||||
anchor
|
||||
padX padY
|
||||
.PP
|
||||
.fi
|
||||
.ta 4c
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard
|
||||
options.
|
||||
'\"
|
||||
.PP
|
||||
.RE
|
||||
'\"
|
||||
'\"**********************************************************************
|
||||
'\"
|
||||
.SH CREATING DISPLAY ITEMS
|
||||
'\"
|
||||
'\"
|
||||
Display items do not exist on their and thus they cannot be created
|
||||
independently of the widgets they reside in. As a rule, display items
|
||||
are created by special widget commands of their "host" widgets. For
|
||||
example, the HList widgets has a command \fBitem\fR which can be used
|
||||
to create new display items. The following code creates a new imagetext
|
||||
item at the third column of the entry foo inside an HList widget:
|
||||
'\"
|
||||
.PP
|
||||
.nf
|
||||
tixHList .h -columns 3
|
||||
.h add foo
|
||||
.h item create foo 2 \-itemtype imagetext \-text Hello \-image image1
|
||||
.fi
|
||||
.PP
|
||||
'\"
|
||||
The \fBitem create\fR command of the HList widget accepts a variable
|
||||
number of arguments. The special argument \fB\-itemtype\fR specifies
|
||||
which type of display item to create. Options that are valid for this
|
||||
type of display items can then be specified by one or more
|
||||
\fIoption\-value\fR pairs.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
After the display item is created, they can then be configured or
|
||||
destroyed using the commands provided by the host widget. For example,
|
||||
the HList widget has the command \fBitem configure\fR, \fBitem cget\fR
|
||||
and \fBitem delete\fR for accessing the display items.
|
||||
'\"
|
||||
'\"**********************************************************************
|
||||
'\"
|
||||
.SH CREATING AND MANIPULATING DISPLAY STYLES
|
||||
'\"
|
||||
'\"
|
||||
Display styles are created by the command \fBtixDisplayStyle\fR:
|
||||
'\"
|
||||
'\"
|
||||
.PP
|
||||
\fIitemType\fR must be one of the existing display items types such as
|
||||
\fBtext\fR, \fBimagetext\fR, \fBwindow\fR or any new types added by
|
||||
the user. Additional arguments can be given in one or more
|
||||
\fIoption\-value\fR pairs. \fIoption\fR can be any of the valid option
|
||||
for this display style or any of the following:
|
||||
.PP
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fB\-stylename \fIname\fR
|
||||
'\"
|
||||
Specifies a name for this style. If unspecified, then a default name
|
||||
will be chosen for this style.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-refwindow \fIpathName\fR
|
||||
'\"
|
||||
Specifies a window to use for determine the default values of the
|
||||
display type. If unspecified, the main window will be used. Default
|
||||
values for the display types can be set via the options database. The
|
||||
following example sets the \fB\-disablebackground\fR and
|
||||
\fB\-disabledforeground\fR options of a \fBtext\fR display style via
|
||||
the option database:
|
||||
.CS
|
||||
option add *table.list*disabledForeground blue
|
||||
option add *table.list*disabledBackground darkgray
|
||||
tixDisplayStyle text -refwindow .table.list -fg red
|
||||
.CE
|
||||
'\"
|
||||
.PP
|
||||
By using the option database to set the options of the display styles,
|
||||
we can advoid hard-coding the option values and give the user more
|
||||
flexibility in customization. See option(n) for a detailed description
|
||||
of the option database.
|
||||
.RE
|
||||
'\"
|
||||
.SH STYLE COMMAND
|
||||
.PP
|
||||
The \fBtixDisplayStyle\fR command creates a new Tcl command whose name is the
|
||||
same as the name of the newly created display style. This command
|
||||
may be used to invoke various operations on the display style. It has the
|
||||
following general form:
|
||||
'\"
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIstyleName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIstyleName\fR is the name of the command. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible:
|
||||
'\"
|
||||
.TP
|
||||
\fIstyleName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the valid options of this
|
||||
display style.
|
||||
'\"
|
||||
.TP
|
||||
\fIstyleName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the display style. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIstyleName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given option(s) to have the given value(s); in this case
|
||||
the command returns an empty string. \fIOption\fR may have any of the
|
||||
valid options of this display style.
|
||||
'\"
|
||||
.TP
|
||||
\fIstyleName \fBdelete\fR
|
||||
'\"
|
||||
Destroy this display style object.
|
||||
'\"
|
||||
.SH EXAMPLE
|
||||
'\"
|
||||
The following example creates two columns of data in a HList
|
||||
widget. The first column is in red and the second column in blue. The
|
||||
colors of the columns are controlled by two different \fBtext\fR
|
||||
styles. Also, the anchor and font of the second column is chosen so
|
||||
that the income data is aligned properly.
|
||||
'\"
|
||||
.PP
|
||||
.CS
|
||||
set courier {courier 14}
|
||||
set h [tixHList .h -columns 2]; pack $h
|
||||
set red [tixDisplayStyle text -fg #800000]
|
||||
set blue [tixDisplayStyle text -fg #000080 \\
|
||||
-anchor e -font $courier]
|
||||
|
||||
foreach n {{Joe $10,000} {Peter $20,000} {Raj $90,000}} {
|
||||
set entry [$h addchild {}]
|
||||
$h item create $entry 0 -itemtype text \\
|
||||
-text [lindex $n 0] -style $red
|
||||
$h item create $entry 1 -itemtype text \\
|
||||
-text [lindex $n 1] -style $blue
|
||||
}
|
||||
.CE
|
||||
.SH KEYWORDS
|
||||
display item, display style, imagetext
|
||||
334
man/tixExFileSelectBox.n
Normal file
334
man/tixExFileSelectBox.n
Normal file
@@ -0,0 +1,334 @@
|
||||
'\"
|
||||
'\" $Id: tixExFileSelectBox.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixExFileSelectBox n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixExFileSelectBox \- Create and manipulate tixExFileSelectBox widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixExFileSelectBox \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixExFileSelectBox\fR class does not have a super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixExFileSelectBox\fR supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browseCmd BrowseCmd
|
||||
Specifies a command to call whenever the user browses on a filename in
|
||||
the file listbox (usually by single-clicking on the filename). The command
|
||||
is called with one argument, the complete pathname of the file.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the user chooses on a filename
|
||||
the file listbox (usually by double-clicking on the filename). The command
|
||||
is called with one argument, the complete pathname of the file.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dialog dialog Dialog
|
||||
Specifies a dialog box which contains this ExFileSelectBox widget. The
|
||||
dialog box must be a widget of the class TixShell or its
|
||||
descendant classes. \fIThis is an internal option and should not be used
|
||||
by application programmers.\fR
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.OP \-dircmd dircmd DirCmd
|
||||
Specifies the TCL command to be called when a file listing is needed
|
||||
for a particular directory. If this option is not specified, by
|
||||
default the ExFileSelectBox widget will attempt to read the directory
|
||||
as a Unix directory. On special occasions, the application programmer
|
||||
may want to supply a special method for reading directories: for
|
||||
example, when he needs to list remote files. In this case, the
|
||||
\fB\-dircmd\fR option can be used. The specified command accepts three
|
||||
arguments: the first is the name of the directory to be listed; the
|
||||
second is a list of file patterns, the third is a Boolean value
|
||||
indicating whether hidden files should be listed. This command returns
|
||||
a list of names of the files of this directory which match with the
|
||||
file patterns.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBdirectory\fR
|
||||
Class: \fBDirectory\fR
|
||||
Switch: \fB\-directory\fR
|
||||
Alias: \fB\-dir\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the current directory whose files and sub-directories are
|
||||
displayed in the ExFileSelectBox.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the ExFileSelectBox
|
||||
widget changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
'\"
|
||||
.OP \-filetypes fileTypes FileTypes
|
||||
Specifies the file types that can be selected from the "List Files of
|
||||
Type:" ComboBox subwidget. The value of this option must be a TCL
|
||||
list; each item of this list must in turn be a list of two elements.
|
||||
The first element is a list of file patterns. The second element is a
|
||||
string that describe these file patterns. For example:
|
||||
.nf
|
||||
tixExFileSelectBox .box -filetypes {
|
||||
{{*} {All files}}
|
||||
{{*.txt} {Text files}}
|
||||
{{*.c *.h} {C source files}}
|
||||
}
|
||||
.fi
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
'\"
|
||||
.OP \-showhidden showHidden ShowHidden
|
||||
Specifies whether hidden directories should be shown. By default, a
|
||||
directory name starting with a period "\." is considered as a hidden
|
||||
directory.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
'\"
|
||||
.OP \-pattern pattern Pattern
|
||||
Specifies whether the file pattern(s) to match with the files in the
|
||||
current directory. One or more file patterns can be given at the same
|
||||
time. For example, {*\.c *\.h} will match all files that have either the
|
||||
".h" or ".c" extensions.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvalue\fR
|
||||
Class: \fBValue\fR
|
||||
Switch: \fB\-value\fR
|
||||
Alias: \fB\-selection\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the name of the filename currently selected by the user.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBcancel\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The button widget with the "Cancel" label.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBdir\fR
|
||||
Class: \fBTixComboBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The ComboBox subwidget under the "Directories" heading.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBdirlist\fR
|
||||
Class: \fBTixDirList\fR
|
||||
.fi
|
||||
.IP
|
||||
The DirList subwidget that shows the hierarchical list of directories.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBfile\fR
|
||||
Class: \fBTixComboBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The ComboBox subwidget under the "Files" heading.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBfilelist\fR
|
||||
Class: \fBTixScrolledListBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The ScrolledListBox subwidget that shows the list of filenames.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhidden\fR
|
||||
Class: \fBCheckbutton\fR
|
||||
.fi
|
||||
.IP
|
||||
The checkbutton widget with the "Show Hidden Files" label.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBok\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The button widget with the "OK" label.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBtypes\fR
|
||||
Class: \fBTixComboBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The ComboBox subwidget under the "List Files of Type" heading.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixExFileSelectBox\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a
|
||||
ExFileSelectBox widget. Additional options, described above,
|
||||
may be specified on the command line or in the option database to
|
||||
configure aspects of the ExFileSelectBox such as its cursor
|
||||
and relief.
|
||||
|
||||
The ExFileSelectBox widget is usually embedded in a
|
||||
tixExFileSelectDialog widget. It provides an convenient method for the
|
||||
user to select files. The style of the ExFileSelectBox widget is very
|
||||
similar to the standard file dialog in MS Windows 3.1.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixExFileSelectBox\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the ExFileSelectBox's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
ExFileSelectBox widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for ExFileSelectBox widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixExFileSelectBox\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixExFileSelectBox\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBfilter\fR
|
||||
'\"
|
||||
Forces the ExFileSelectBox widget to re-filter all the filenames
|
||||
according to the \fB\-pattern\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinvoke\fR
|
||||
'\"
|
||||
Forces the ExFileSelectBox widget to perform actions as if the user
|
||||
has pressed the "OK" button.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
164
man/tixExFileSelectDialog.n
Normal file
164
man/tixExFileSelectDialog.n
Normal file
@@ -0,0 +1,164 @@
|
||||
'\"
|
||||
'\" $Id: tixExFileSelectDialog.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixExFileSelectDialog n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixExFileSelectDialog \- Create and manipulate tixExFileSelectDialog widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixExFileSelectDialog \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixExFileSelectDialog\fR class does not have a super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixExFileSelectDialog\fR supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the user chooses on a filename
|
||||
(usually by selecting the filename and clicking on the "OK" button").
|
||||
The command is called with one argument, the complete pathname of the
|
||||
file.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBfsbox\fR
|
||||
Class: \fBTixExFileSelectBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The ExFileSelectBox subwidget embedded inside the ExFileSelectDialog.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixExFileSelectDialog\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a ExFileSelectDialog
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
ExFileSelectDialog such as its cursor and relief.
|
||||
|
||||
The ExFileSelectDialog widget provides an convenient method for the
|
||||
user to select files. The style of the ExFileSelectDialog widget is
|
||||
very similar to the standard file dialog in MS Windows 3.1.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixExFileSelectDialog\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the ExFileSelectDialog's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
ExFileSelectDialog widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for ExFileSelectDialog widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixExFileSelectDialog\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixExFileSelectDialog\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpopdown\fR
|
||||
'\"
|
||||
Withdraws the ExFileSelectDialog from the screen.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpopup\fR
|
||||
'\"
|
||||
Pops up the ExFileSelectDialog on the screen.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fIname ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
274
man/tixFileEntry.n
Normal file
274
man/tixFileEntry.n
Normal file
@@ -0,0 +1,274 @@
|
||||
'\"
|
||||
'\" $Id: tixFileEntry.n,v 1.3 2002/01/25 08:48:47 idiscovery Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixFileEntry n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixFileEntry \- Create and manipulate tixFileEntry widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixFileEntry \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixFileEntry\fR class is derived from the \fBTixLabelWidget\fR
|
||||
class and inherits all the commands, options and
|
||||
subwidgets of its super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The FileEntry widget supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-activatecmd activateCmd ActivateCmd
|
||||
Specifies the command to be called when the user activates the
|
||||
\fBbutton\fR subwidget. This command is called before the file dialog
|
||||
is popped up and can be used to customize the file dialog (which may
|
||||
be shared by several FileEnt widget).
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the \fB\-value\fR option of
|
||||
the FileEntry is changed. This usually happens when the user inputs a
|
||||
filename into the entry subwidget and hits the <Return> key. The
|
||||
command will be called with one arguments -- the new value of the
|
||||
FileEntry widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dialogtype dialogType DialogType
|
||||
Specifies which type of file selection dialog should be popped up when
|
||||
the user invokes the \fBbutton\fR subwidget. Currently the following values
|
||||
are valid: \fBtixFileSelectDialog\fR, \fBtixExFileSelectDialog\fR,
|
||||
\fBtk_getOpenFile\fR, \fBtk_getSaveFile\fR or \fBtk_chooseDirectory\fR.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the FileEntry widget
|
||||
changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disableforeground disableForeground DisableForeground
|
||||
The foreground color to use for of the entry subwidget when the
|
||||
FileEntry widget is disabled.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-filebitmap fileBitmap FileBitmap
|
||||
Specifies the bitmap to display in side the \fBbutton\fR subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-label label Label
|
||||
Specifies the string to display as the label of this FileEntry widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-labelside labelSide LabelSide
|
||||
Specifies where the label should be displayed relative to the entry
|
||||
subwidget. Valid options are: \fBtop\fR, \fBleft\fR, \fBright\fR,
|
||||
\fBbottom\fR, \fBnone\fR or \fBacrosstop\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selectmode selectMode SelectMode
|
||||
Specifies how the FileEntry widget should react to \fC<KeyPress>\fR
|
||||
events. When set to "immediate", any user keyboard inputs will
|
||||
immediately change the \fB\-value\fR option. When set to "normal", the
|
||||
user keyboard inputs will be copied to the \fB\-value\fR option only
|
||||
if the\fC <Return>\fR key is pressed or the keyboard focus is
|
||||
changed. The use of the immediate mode is discouraged. For effective
|
||||
use of the FileEntry widget, one should use the normal mode together
|
||||
with the \fBupdate\fR widget command (see below).
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the whether the FileEntry widget is normal or disabled. Only
|
||||
the values "normal" and "disabled" are recognized.
|
||||
'\"----------END
|
||||
'\"'
|
||||
'\"----------BEGIN
|
||||
.OP \-validatecmd validateCmd ValidateCmd
|
||||
Specifies a TCL command to be called when the -value of the
|
||||
FileEntry widget is about to change. This command is called
|
||||
with one parameter -- the new \fB\-value\fR entered by the user. This
|
||||
command is to validate this new value by returning a value it deems
|
||||
valid.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-value value Value
|
||||
Specifies the value of the FileEntry.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-variable variable Variable
|
||||
Specifies the global variable in which the value of the FileEntry
|
||||
should be stored. The value of the FileEntry will be automatically
|
||||
updated when this variable is changed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBbutton\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The button subwidget next to the entry subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBentry\fR
|
||||
Class: \fBEntry\fR
|
||||
.fi
|
||||
.IP
|
||||
The entry subwidget in which the user can type in a filename.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixFileEntry\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a FileEntry
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
FileEntry such as its cursor and relief.
|
||||
.PP
|
||||
The FileEntry widget can be used to input a filename. The user can
|
||||
type in the filename manually. Alternatively, the user can press the
|
||||
button widget that sits next to the entry, which will bring up a file
|
||||
selection dialog of the type specified by the \fB\-dialogtype\fR option.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixFileEntry\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the FileEntry's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
FileEntry widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for FileEntry widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixFileEntry\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixFileEntry\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinvoke\fR
|
||||
'\"
|
||||
Forces the FileEntry widget to act as if the user has pressed the
|
||||
<return> key inside the entry subwidget.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBfiledialog\fR \fI?args?\fR
|
||||
'\"
|
||||
When no additional arguments are given, this command returns the
|
||||
pathname of the file dialog box associated with this FileEnt
|
||||
widget. When additional arguments are given, the widget command of the
|
||||
file dialog will be called with these arguments.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fIname ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name. When options are given, the widget
|
||||
command of the specified subwidget will be called with these options.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBupdate\fR
|
||||
'\"
|
||||
If the user has modified the entry using keyboard inputs, the update
|
||||
command will \fBupdate\fR the \fB\-value\fR of this FileEntry
|
||||
widget. When the FileEntry widget's \fB\-selectmode\fR option is set
|
||||
to "normal", one should call the \fBupdate\fR command on this widget
|
||||
before examining its \fB\-value\fR option. This command has no effect
|
||||
in if the \fB\-selectmode\fR option is set to "immediate".
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
240
man/tixFileSelectBox.n
Normal file
240
man/tixFileSelectBox.n
Normal file
@@ -0,0 +1,240 @@
|
||||
'\"
|
||||
'\" $Id: tixFileSelectBox.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixFileSelectBox n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
.SH NAME
|
||||
tixFileSelectBox \- Create and manipulate Tix FileSelectBox widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixFileSelectBox \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The FileSelectBox widget supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the standard
|
||||
options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"----------
|
||||
.OP \-browsecmd browsecmd browseCmd
|
||||
Specifies the command to execute when the user browses through the
|
||||
files. By default, if the \fB\-browsecmd\fR is specified, the browse
|
||||
command will be executed when the user clicks on a filename in the
|
||||
\fIFiles\fR listbox.
|
||||
'\"----------
|
||||
.OP \-command command Command
|
||||
Specifies the command to execute when the FileSelectBox is
|
||||
invoked. This command is executed with one parameter : the filename
|
||||
selected by the user.
|
||||
'\"----------
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBdirectory\fR
|
||||
Class: \fBDirectory\fR
|
||||
Switch: \fB\-directory\fR
|
||||
Alias: \fB\-dir\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the directory to look for files. By default this will be the
|
||||
current working directory of the program and will be changed as the
|
||||
user browses through the directories.
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the ExFileSelectBox
|
||||
widget changes.
|
||||
'\"----------END
|
||||
'\"----------
|
||||
.OP \-pattern pattern Pattern
|
||||
Specifies the matching pattern of the file names that should be listed in
|
||||
the \fIFiles\fR listbox. For example "*.c" matches all the filenames that
|
||||
end with ".c". If this option is set to the empty string, the default
|
||||
pattern "*" will be used.
|
||||
'\"----------
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvalue\fR
|
||||
Class: \fBValue\fR
|
||||
Switch: \fB\-value\fR
|
||||
Alias: \fB\-selection\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the name of the filename currently selected by the user.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBdirlist\fR
|
||||
Class: \fBTixScrolledListBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The scrolled listbox that shows the directories.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBfilelist\fR
|
||||
Class: \fBTixScrolledListBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The scrolled listbox that shows the files.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBfilter\fR
|
||||
Class: \fBTixComboBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The ComboBox listbox that shows the filter string.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBselection\fR
|
||||
Class: \fBTixComboBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The ComboBox listbox that shows the file selection.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"======================
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixFileSelectBox\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a FileSelectBox widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
FileSelectBox such as its cursor and relief.
|
||||
.PP
|
||||
The FileSelectBox is similar to the standard Motif(TM) file-selection
|
||||
box. It is generally used for the user to choose a file. FileSelectBox
|
||||
stores the files mostly recently selected into a ComboBox widget so
|
||||
that they can be quickly selected again. The \fBtixFileSelectDialog\fR
|
||||
widget is a combination of the FileSelectBox widget and a dialog
|
||||
widget.
|
||||
'\"
|
||||
.SH "WIDGET COMMAND"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixFileSelectBox\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the FileSelectBox's window.
|
||||
This command may be used to invoke various operations on the widget.
|
||||
It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
FileSelectBox widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for FileSelectBox widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixFileSelectBox\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixFileSelectBox\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBfilter\fR
|
||||
'\"
|
||||
Updates the files listed in the FileSelectBox according to the
|
||||
filtering pattern sepcified in the \fBfilter\fR subwidget.
|
||||
.TP
|
||||
\fIpathName \fBinvoke\fR
|
||||
Execute the command specified by the \fB\-command\fR option with the
|
||||
filename stored in the \fBselection\fR subwidget.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
.SH "DEFAULT BINDINGS"
|
||||
TIX automatically creates class bindings for FileSelectBoxes that give them
|
||||
the following default behavior:
|
||||
.IP [1]
|
||||
Mouse button 1 in the \fIDirectory\fR listbox will change the filter
|
||||
string to the selected directory.
|
||||
.IP [2]
|
||||
Mouse button 1 in the \fIFiles\fR listbox will change the filename
|
||||
that appears in the \fISelection\fR entry. It will also trigger the
|
||||
\fB\-browsecmd\fR if the option has been specified.
|
||||
.IP [3]
|
||||
The current directory will be changed by (1) double clicking the
|
||||
\fIDirectory\fR listbox or (2) invoking the \fIFilter\fR ComboBox.
|
||||
Please refer to the man page of \fBtixComboBox\fR for the default
|
||||
bindings of the ComboBoxes and how they can be invoked.
|
||||
.IP [4]
|
||||
The command specified by the option -command will be invoked by (1)
|
||||
double clicking the \fIFiles\fR listbox or (2) invoking
|
||||
\fISelection\fR ComboBox.
|
||||
'\"
|
||||
'\"
|
||||
.SH KEYWORDS
|
||||
tixFileSelectBox, tixComboBox, tixFileSelectDialog, Tix(n),
|
||||
|
||||
|
||||
|
||||
174
man/tixFileSelectDialog.n
Normal file
174
man/tixFileSelectDialog.n
Normal file
@@ -0,0 +1,174 @@
|
||||
'\"
|
||||
'\" $Id: tixFileSelectDialog.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixFileSelectDialog n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixFileSelectDialog \- Create and manipulate tixFileSelectDialog widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixFileSelectDialog \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixFileSelectDialog\fR class does not have a super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixFileSelectDialog\fR supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the user chooses on a filename
|
||||
(usually by selecting the filename and clicking on the "OK" button").
|
||||
The command is called with one argument, the complete pathname of the
|
||||
file.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBbtns\fR
|
||||
Class: \fBTixStdButtonBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The StdButtonBox subwidget at the bottom of FileSelectDialog. It
|
||||
contains the "OK", "Filter, "Cancel" and "Help" buttons.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBfsbox\fR
|
||||
Class: \fBTixFileSelectBox\fR
|
||||
.fi
|
||||
.IP
|
||||
The FileSelectBox subwidget at the top of the FileSelectDialog.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixFileSelectDialog\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a FileSelectDialog
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
FileSelectDialog such as its cursor and relief.
|
||||
.PP
|
||||
The FileSelectDialog widget provides an convenient method for the user
|
||||
to select files. The FileSelectBox is similar to the standard
|
||||
Motif(TM) file-selection box.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixFileSelectDialog\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the FileSelectDialog's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
FileSelectDialog widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for FileSelectDialog widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixFileSelectDialog\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixFileSelectDialog\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpopdown\fR
|
||||
'\"
|
||||
Withdraws the FileSelectDialog from the screen.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpopup\fR
|
||||
'\"
|
||||
Pops up the FileSelectDialog on the screen.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fIname ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
462
man/tixForm.n
Normal file
462
man/tixForm.n
Normal file
@@ -0,0 +1,462 @@
|
||||
'\"
|
||||
'\" $Id: tixForm.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixForm n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
.SH NAME
|
||||
tixForm \- Geometry manager based on attachment rules
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixForm\fI option arg ?arg ...?\fR
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixForm\fR command is used to communicate with the
|
||||
\fBtixForm\fR Geometry Manager, a geometry manager that arranges the
|
||||
geometry of the children in a parent window according to attachment
|
||||
rules. The \fBtixForm\fR geometry manager is very flexible and
|
||||
powerful; it can be used to emulate all the existing features of the
|
||||
Tk packer and placer geometry managers (see \fBpack(n)\fR,
|
||||
\fBplace(n)\fR).
|
||||
'\"
|
||||
The \fBtixForm\fR command can have any of several forms,
|
||||
depending on the \fIoption\fR argument:
|
||||
'\"
|
||||
.TP
|
||||
\fBtixForm\fI slave \fR?\fIoptions\fR?
|
||||
'\"
|
||||
If the first argument to \fBtixForm\fR is a window name (any value
|
||||
starting with ``.''), then the command is processed in the same way as
|
||||
\fBtixForm configure\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixForm check \fImaster\fR
|
||||
'\"
|
||||
This command checks whether there is circular dependency in the
|
||||
attachments of the master's slaves (see the section \fBCIRCULAR
|
||||
DEPENDENCY\fR below). It returns the Boolean value \fBTRUE\fR if it
|
||||
discover circular dependency and \fBFALSE\fR otherwise.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixForm configure\fI slave \fR?\fI\-option value ...\fR?
|
||||
'\"
|
||||
Sets or adjusts the attachment values of the slave window
|
||||
according to the \fI\-option value\fR argument pairs.
|
||||
'\"
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fB\-b\fR \fIattachment\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-bottom\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-bottom\fR \fIattachment\fR
|
||||
'\"
|
||||
Specifies an attachment for the bottom edge of the slave window. The
|
||||
attachment must specied according to the section \fBSPECIFYING
|
||||
ATTACHMENTS\fR below.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-bottomspring\fR \fIweight\fR
|
||||
'\"
|
||||
Specifies the weight of the spring at the bottom edge of the slave
|
||||
window. See the section \fBUSING SPRINGS\fR below.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-bp\fR \fIvalue\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-padbottom\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-bs\fR \fIweight\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-bottomspring\fR option.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-fill\fR \fImaster\fR
|
||||
'\"
|
||||
Specifies the fillings when springs are used for this widget. The
|
||||
value must be \fBx\fR, \fBy\fR, \fBboth\fR or \fBnone\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-in\fR \fImaster\fR
|
||||
'\"
|
||||
Places the slave window into the specified master window. If the slave
|
||||
was originally in another master window, all attachment values with
|
||||
respect to the original master window are discarded. Even if the
|
||||
attachment values are the same as in the original master window, they
|
||||
need to be specified again. The \fB\-in\fR flag, when needed, must appear
|
||||
as the first flag after the name of the slave. Otherwise an error is
|
||||
generated.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-l\fR \fIattachment\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-left\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-left\fR \fIattachment\fR
|
||||
'\"
|
||||
Specifies an attachment for the left edge of the slave window. The
|
||||
attachment must specied according to the section \fBSPECIFYING
|
||||
ATTACHMENTS\fR below.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-leftspring\fR \fIweight\fR
|
||||
'\"
|
||||
Specifies the weight of the spring at the left edge of the slave
|
||||
window. See the section \fBUSING SPRINGS\fR below.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-lp\fR \fIvalue\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-padleft\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-ls\fR \fIweight\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-leftspring\fR option.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padbottom\fR \fIvalue\fR
|
||||
'\"
|
||||
Specifies the amount of external padding to leave on the bottom side
|
||||
of the slave. The \fIvalue\fR may have any of the forms acceptable to
|
||||
\fBTk_GetPixels(3)\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padleft\fR \fIvalue\fR
|
||||
'\"
|
||||
Specifies the amount of external padding to leave on the left side of
|
||||
the slave.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padright\fR \fIvalue\fR
|
||||
'\"
|
||||
Specifies the amount of external padding to leave on the right side of
|
||||
the slave.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padtop\fR \fIvalue\fR
|
||||
'\"
|
||||
Specifies the amount of external padding to leave on the top side of
|
||||
the slave.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-padx\fR \fIvalue\fR
|
||||
'\"
|
||||
Specifies the amount of external padding to leave on both the left and
|
||||
the right sides of the slave.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-pady\fR \fIvalue\fR
|
||||
'\"
|
||||
Specifies the amount of external padding to leave on both the top and
|
||||
the bottom sides of the slave.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-r\fR \fIattachment\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-right\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-right\fR \fIattachment\fR
|
||||
'\"
|
||||
Specifies an attachment for the right edge of the slave window. The
|
||||
attachment must specied according to the section \fBSPECIFYING
|
||||
ATTACHMENTS\fR below.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-rightspring\fR \fIweight\fR
|
||||
'\"
|
||||
Specifies the weight of the spring at the right edge of the slave
|
||||
window. See the section \fBUSING SPRINGS\fR below.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-rp\fR \fIvalue\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-padright\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-rs\fR \fIweight\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-rightspring\fR option.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-t\fR \fIattachment\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-top\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-top\fR \fIattachment\fR
|
||||
'\"
|
||||
Specifies an attachment for the top edge of the slave window. The
|
||||
attachment must specied according to the section \fBSPECIFYING
|
||||
ATTACHMENTS\fR below.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-topspring\fR \fIweight\fR
|
||||
'\"
|
||||
Specifies the weight of the spring at the top edge of the slave
|
||||
window. See the section \fBUSING SPRINGS\fR below.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fB\-tp\fR \fIvalue\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-padtop\fR option.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-ts\fR \fIweight\fR
|
||||
'\"
|
||||
Abbreviation for the \fB\-topspring\fR option.
|
||||
'\"
|
||||
.RE
|
||||
.TP
|
||||
\fBtixForm forget\fI slave \fR?\fIslave ...\fR?
|
||||
'\"
|
||||
Removes each of the slaves from its master and unmaps their windows.
|
||||
The slaves will no longer be managed by tixForm. All attachment values
|
||||
with respect to their master windows are discarded. If another slave
|
||||
is attached to this slave, then the attachment of the other slave will
|
||||
be changed to grid attachment based on its geometry.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixForm grid \fImaster \fR?\fIx_size y_size\fR?
|
||||
'\"
|
||||
When \fIx_size\fR and \fIy_size\fR are given, this command returns the
|
||||
number of grids of the master window in a pair of integers of the form
|
||||
{\fIx_size y_size\fR}. When both \fIx_size\fR and \fIy_size\fR are
|
||||
given, this command changes the number of horizontal and vertical
|
||||
grids on the master window.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixForm info\fI slave\fR ?\fIoption\fR?
|
||||
'\"
|
||||
Queries the attachment options of a slave window. \fIoption\fR can be
|
||||
any of the options accepted by the \fBtixForm configure\fR command. If
|
||||
\fIoption\fR is given, only the value of that option is returned.
|
||||
Otherwise, this command returns a list whose elements are the current
|
||||
configuration state of the slave given in the same \fIoption\-value\fR form
|
||||
that might be specified to \fBtixForm configure\fR. The first two
|
||||
elements in this list list are "\fB\-in\fI master\fR" where
|
||||
\fImaster\fR is the slave's master window.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixForm slaves \fImaster\fR
|
||||
'\"
|
||||
Returns a list of all of the slaves for the master window. The order
|
||||
of the slaves in the list is the same as their order in the packing
|
||||
order. If master has no slaves then an empty string is returned.
|
||||
'\"
|
||||
.PP
|
||||
.SH SPECIFYING ATTACHMENTS
|
||||
'\"
|
||||
One can specify an attachment for each side of a slave window managed
|
||||
by tixForm. An attachment is specified in the the form "\-\fIside\fR
|
||||
{\fIanchor_point\fR \fIoffset\fR}". \-\fIside\fR can be one of
|
||||
\fB\-top\fR, \fB\-bottom\fR, \fB\-left\fR or \fB\-right\fR.
|
||||
.PP
|
||||
\fIOffset\fR is given in screen units (i.e. any of the forms
|
||||
acceptable to \fBTk_GetPixels\fR). A positive offset indicates
|
||||
shifting to a position to the right or bottom of an anchor point. A
|
||||
negative offset indicates shifting to a position to the left or top of
|
||||
an anchor point.
|
||||
.PP
|
||||
\fIAnchor_point\fR can be given in one of the
|
||||
following forms:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fBGrid Attachment\fR
|
||||
'\"
|
||||
The master window is divided into a number of horizontal and vertical
|
||||
grids. By default the master window is divided into 100x100 grids; the
|
||||
number of grids can be adjusted by the \fBtixForm grid\fR command. A
|
||||
grid attachment anchor point is given by a \fB%\fR sign followed by an
|
||||
\fBinteger\fR value. For example, \fB%0\fR spceifies the first grid
|
||||
line (the top or left edge of the master window). \fB%100\fR spceifies
|
||||
the last grid line (the bottom or right edge of the master window).
|
||||
'\"
|
||||
.TP
|
||||
\fBOpposite Side Attachment\fR
|
||||
'\"
|
||||
Opposite attachment specifies an anchor point located on the
|
||||
\fBopposite\fR side of another slave widget, which must be managed by
|
||||
tixForm in the same master window. An opposite attachment anchor point
|
||||
is given by the name of another widget. For example, "tixForm .b \-top
|
||||
{.a 0}" attaches the \fBtop\fR side of the widget \fB\.b\fR to the
|
||||
\fBbottom\fR of the widget \fB\.a\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fBParallel Side Attachment\fR
|
||||
'\"
|
||||
Opposite attachment specifies an anchor point located on the
|
||||
\fBsame\fR side of another slave widget, which must be managed by
|
||||
tixForm in the same master window. An parallel attachment anchor point
|
||||
is given by the sign \fB&\fR follwed by the name of another widget.
|
||||
For example, "tixForm .b \-top {&.a 0}" attaches the \fBtop\fR side of
|
||||
the widget \fB\.b\fR to the \fBtop\fR of the widget \fB\.a\fR, making
|
||||
the \fBtop\fR sides of these two widgets at the same vertical position
|
||||
in their parent window.
|
||||
'\"
|
||||
.TP
|
||||
\fBNo Attachment\fR
|
||||
'\"
|
||||
Specifies a side of the slave to be attached to nothing, indicated by
|
||||
the keyword \fBnone\fR. When the \fBnone\fR anchor point is given, the
|
||||
offser must be zero.
|
||||
|
||||
When a side of a slave is attached to \fB{none 0}\fR, the position
|
||||
of this side is calculated by the position of the other side and the
|
||||
natural size of the slave. For example, if a the \fBleft\fR side of a
|
||||
widget is attached to \fB{%0 100}\fR, its \fBright\fR side attached to
|
||||
\fB{none 0}\fR, and the natural size of the widget is \fB50\fR pixels,
|
||||
the \fBright\fR side of the widget will be positioned at pixel \fB{%0
|
||||
149}\fR.
|
||||
|
||||
When both \fB\-top\fR and \fB\-bottom\fR are attached to \fBnone\fR,
|
||||
then by default \fB\-top\fR will be attached to \fB{%0 0}\fR. When both
|
||||
\fB\-left\fR and \fB\-right\fR are attached to none, then by default
|
||||
\fB\-left\fR will be attached to \fB{%0 0}\fR.
|
||||
'\"
|
||||
.RE
|
||||
.PP
|
||||
Shifting effects can be achieved by specifying a non-zero offset with
|
||||
an anchor point. In the following example, the \fBtop\fR side of
|
||||
widget \fB\.b\fR is attached to the \fBbottom\fR of \fB\.a\fR; hence \fB\.b\fR
|
||||
always appears below \fB\.a\fR. Also, the left edge of \fB\.b\fR
|
||||
is attached to the \fBleft\fR side of \fB\.a\fR with a 10
|
||||
pixel offest. Therefore, the \fBleft\fR edge of \fB\.b\fR is always
|
||||
shifted 10 pixels to the right of \fB\.a\fR's \fBleft\fR edge:
|
||||
.PP
|
||||
.CS
|
||||
tixForm .b \-left {.a 10} \-top {.a 0}
|
||||
.CE
|
||||
.PP
|
||||
\fBABBREVIATIONS:\fR Certain abbreviations can be made on the
|
||||
attachment specifications: First an offset of zero can be omitted.
|
||||
Thus, the following two lines are equivalent:
|
||||
.PP
|
||||
.CS
|
||||
tixForm .b \-top {.a 0} \-right {%100 0}
|
||||
tixForm .b \-top {.a} \-right {%100}
|
||||
.CE
|
||||
.PP
|
||||
Also, because of the way TCL handles lists, when you omit the offset,
|
||||
you can also leave out the braces. So you can further simplify the
|
||||
above to:
|
||||
.PP
|
||||
.CS
|
||||
tixForm .b \-top .a \-right %100
|
||||
.CE
|
||||
.PP
|
||||
In the second case, when the anchor point is omitted, the offset must
|
||||
be given. A default anchor point is chosen according to the value of
|
||||
the offset. If the anchor point is \fB0\fR or positive, the default
|
||||
anchor point %0 is used; thus, "tixForm \.b \-top 15" attaches the top
|
||||
edge of \fB\.b\fR to a position 15 pixels below the top edge of the
|
||||
master window. If the anchor point is "\fB-0\fR" or negative, the
|
||||
default anchor point \fB%100\fR is used; thus, "tixForm \.a \-right
|
||||
\-2" attaches the right edge of \fB\.a\fR to a position 2 pixels to
|
||||
the left of the master window's \fBright\fR edge. An further example
|
||||
below shows a command with its equivalent abbreviation.
|
||||
'\"
|
||||
.CS
|
||||
tixForm .b \-top {%0 10} \-bottom {%100 0}
|
||||
tixForm .b \-top 10 \-bottom \-0
|
||||
.CE
|
||||
.PP
|
||||
.SH USING SPRINGS
|
||||
'\"
|
||||
To be written.
|
||||
'\"
|
||||
.PP
|
||||
.SH ALGORITHM OF TIXFORM
|
||||
'\"
|
||||
TixForm starts with any slave in the list of slaves of the master
|
||||
window. Then it tries to determine the position of each side of the
|
||||
slave.
|
||||
.PP
|
||||
If the attachment of a side of the slave is grid attachment, the
|
||||
position of the side is readily determined.
|
||||
.PP
|
||||
If the attachment of this side is \fBnone\fR, then tixForm tries to
|
||||
determine the position of the opposite side first, and then use the
|
||||
position of the opposite side and the natural size of the slave to
|
||||
determine the position of this side.
|
||||
.PP
|
||||
If the attachment is opposite or parallel widget attachments, then
|
||||
tixForm tries to determine the positions of the other widget first,
|
||||
and then use the positions of the other widget and the natural size of
|
||||
the slave determine the position of this side. This recursive
|
||||
algorithmis carried on until the positions of all slaves are
|
||||
determined.
|
||||
.PP
|
||||
.SH CIRCULAR DEPENDENCY
|
||||
.PP
|
||||
The algorithm of tixForm will fail if a circular dependency exists in
|
||||
the attachments of the slaves. For example:
|
||||
.PP
|
||||
.CS
|
||||
tixForm .c \-left .b
|
||||
tixForm .b \-right .c
|
||||
.CE
|
||||
.PP
|
||||
In this example, the position of the left side of \fB.b\fR depends on
|
||||
the right side of \fB.c\fR, which in turn depends on the left side of \fB.b\fR.
|
||||
.PP
|
||||
When a circular dependency is discovered during the execution of the
|
||||
tixForm algorithm, tixForm will generate a background error and the
|
||||
geometry of the slaves are undefined (and will be arbitrary). Notice
|
||||
that tixForm only executes the algorithm when the specification of the
|
||||
slaves' attachments is complete. Therefore, it allows intermediate
|
||||
states of circular dependency during the specification of the slaves'
|
||||
attachments. Also, unlike the Motif Form manager widget, tixForm
|
||||
defines circular dependency as "\fIdependency in the same
|
||||
dimension\fR". Therefore, the following code fragment will does not
|
||||
have circular dependency because the two widgets do not depend on each
|
||||
other in the same dimension (\fB\.b\fR depends \fB.c\fR in the
|
||||
horizontal dimension and \fB.c\fR depends on \fB.b\fR in the vertical
|
||||
dimension):
|
||||
.PP
|
||||
.CS
|
||||
tixForm .b \-left .c
|
||||
tixForm .c \-top .b
|
||||
.CE
|
||||
.PP
|
||||
.SH BUGS
|
||||
'\"
|
||||
.PP
|
||||
Springs have not been fully implemented yet.
|
||||
'\"
|
||||
.SH KEYWORDS
|
||||
Tix(n), Form, Geometry Management
|
||||
|
||||
48
man/tixGetBoolean.n
Normal file
48
man/tixGetBoolean.n
Normal file
@@ -0,0 +1,48 @@
|
||||
'\"
|
||||
'\" $Id: tixGetBoolean.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixGetBoolean n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
.SH NAME
|
||||
tixGetBoolean - Get the boolean value of a string.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixGetBoolean\fI ?-nocomplain? string\fR
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
'\"
|
||||
'\"
|
||||
The command \fBtixGetBoolean\fR returns "0" if the string is a valid
|
||||
TCL string for the boolean value FALSE. It returns "1" if the string
|
||||
is a valid TCL string for the boolean value TRUE.
|
||||
.PP
|
||||
When the string is not a valid TCL boolean value and the
|
||||
\fB-nocomplain\fR option is specified, \fBtixGetBoolean\fR will return
|
||||
"0". Otherwise it will generate an error.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.PP
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
49
man/tixGetInt.n
Normal file
49
man/tixGetInt.n
Normal file
@@ -0,0 +1,49 @@
|
||||
'\"
|
||||
'\" $Id: tixGetInt.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixGetInt n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
.SH NAME
|
||||
tixGetInt - Get the integer value of a string.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixGetInt\fI ?-nocomplain? ?-trunc? string\fR
|
||||
.BE
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
'\"
|
||||
'\"
|
||||
The command \fBtixGetInt\fR converts any number into an integer
|
||||
number. By default, it will round the number to the nearest integer.
|
||||
When the \fB-trunc\fR option is specified, the number is truncated
|
||||
instead of rounded.
|
||||
.PP
|
||||
When the string is not a valid TCL numerical value and the
|
||||
\fB-nocomplain\fR option is specified, \fBtixGetInt\fR will return
|
||||
"0". Otherwise it will generate an error.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.PP
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
222
man/tixGrid.n
Normal file
222
man/tixGrid.n
Normal file
@@ -0,0 +1,222 @@
|
||||
'\"
|
||||
'\" $Id: tixGrid.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH tixGrid n 4.1 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
.SH NAME
|
||||
tixGrid \- Create and manipulate Tix Grid widgets
|
||||
.SO
|
||||
\-background \-borderWidth \-cursor
|
||||
\-font \-foreground \-height
|
||||
\-highlightColor \-highlightThickness \-relief
|
||||
\-selectBackground \-selectForeground \-width
|
||||
\-xScrollCommand \-yScrollCommand
|
||||
.SE
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
.OP -editdonecmd editDoneCmd EditDoneCmd
|
||||
If non-empty, gives a Tcl command to be executed when the user has
|
||||
edited grid cell. When this command is called, it is passed with two
|
||||
additional parameters: \fIx\fR \fIy\fR, where (\fIx\fR,\fIy\fR) is the
|
||||
location of the cell that has just been edited.
|
||||
'\"
|
||||
.OP -editnotifycmd editNotifyCmd EditNotifyCmd
|
||||
If non-empty, gives a Tcl command to be executed when the user tries to edit a grid cell. When this command is called, it is passed with two additional parameters: \fIx\fR \fIy\fR, where (\fIx\fR,\fIy\fR,) is the location of the cell. This command should return a boolean value: \fBtrue\fR indicates that the cells is editable and \fBfalse\fR otherwise.
|
||||
'\"
|
||||
.OP -formatcmd formatCmd FormatCmd
|
||||
If non-empty, gives a Tcl command to be executed when the grid cells
|
||||
need to be formatted on the screen. Normally, this command calls the
|
||||
\fBformat\fR widget command (see below). When this command is called,
|
||||
it is passed with five additional parameters: \fItype\fR \fIx1\fR
|
||||
\fIy1\fR \fIx2\fR \fIy2\fR. \fItype\fR gives the logical type of the
|
||||
region in the grid. It may be one of the following. \fBx-region\fR:
|
||||
the horizontal margin; \fBy-region\fR: the vertical margin;
|
||||
\fBs-region\fR, the area where the the horizontal and vertical margins
|
||||
are joined; \fBmain\fR: all the cells that do not fall into the above
|
||||
three types. \fIx1\fR \fIy1\fR \fIx2\fR \fIy2\fR gives the extent of
|
||||
the region that needs formatting.
|
||||
'\"
|
||||
.OP -leftmargin leftMargin LeftMargin
|
||||
In the number of cells, gives the width of vertical margin. A zero
|
||||
indicates that no vertical should be drawn.
|
||||
'\"
|
||||
.OP -selectmode selectMode SelectMode
|
||||
Specifies one of several styles for manipulating the selection. The
|
||||
value of the option may be arbitrary, but the default bindings expect
|
||||
it to be either \fBsingle\fR, \fBbrowse\fR, \fBmultiple\fR, or
|
||||
\fBextended\fR; the default value is \fBsingle\fR.
|
||||
'\"
|
||||
.OP -selectunit selectUnit SelectUnit
|
||||
Specifies the selection unit. Valid values are \fBcell\fR,
|
||||
\fBcolumn\fR or \fBrow\fR.
|
||||
'\"
|
||||
.OP -topmargin topMargin TopMargin
|
||||
In the number of cells, gives the height of horizontal margin. A zero
|
||||
indicates that no horizontal should be drawn.
|
||||
.BE
|
||||
'\"
|
||||
.SH DESCRIPTION
|
||||
The \fBtixGrid\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a \fBtixGrid\fR widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
\fBtixGrid\fR widget such as its cursor and relief.
|
||||
.PP
|
||||
A Grid widget displays its contents in a two dimensional grid of
|
||||
cells. Each cell may contain one Tix \fBdisplay item\fR, which
|
||||
may be in text, graphics or other formats. See the
|
||||
\fBtixDisplayStyle\fR manual page for more information about Tix
|
||||
display items. Individual cells, or groups of cells, can be formatted
|
||||
with a wide range of attributes, such as its color, relief and border.
|
||||
'\"
|
||||
.SH "WIDGET COMMAND"
|
||||
.PP
|
||||
The \fBtixGrid\fR command creates a new Tcl command whose name is the
|
||||
same as the path name of the \fBtixGrid\fR widget's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
.RS
|
||||
.CS
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
\fBtixGrid\fR widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for \fBtixGrid\fR widgets:
|
||||
.TP
|
||||
\fIpathName \fBanchor \fIoption \fR?\fIargs ...\fR?
|
||||
Manipulates the \fBanchor cell\fR of the \fBtixGrid\fR widget. The
|
||||
anchor cell is the end of the selection that is fixed while the user
|
||||
is dragging out a selection with the mouse.
|
||||
.TP
|
||||
\fIpathName \fBbdtype\fR
|
||||
TODO place holder
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixGrid\fR command.
|
||||
.TP
|
||||
\fIpathName \fBconfigure \fR?\fIoption\fR? ?\fIvalue option value ...\fR?
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo(n)\fR
|
||||
for information on the format of this list.) If \fIoption\fR is
|
||||
specified with no \fIvalue\fR, then the command returns a list
|
||||
describing the one named option (this list will be identical to the
|
||||
corresponding sublist of the value returned if no \fIoption\fR is
|
||||
specified). If one or more \fIoption\-value\fR pairs are specified,
|
||||
then the command modifies the given widget option(s) to have the given
|
||||
value(s); in this case the command returns an empty
|
||||
string. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixGrid\fR command.
|
||||
.TP
|
||||
\fIpathName \fBdelete\fR \fIdim\fR \fIfrom \fR?\fIto\fR?
|
||||
\fIDim\fR may be \fBrow\fR or \fBcolumn\fR. If \fIto\fR is not given,
|
||||
deletes a single row (or column) at the position \fIfrom\fR. If
|
||||
\fIto\fR is given, deletes the range of rows (or columns) from
|
||||
position \fIfrom\fR through \fIto\fR.
|
||||
.TP
|
||||
\fIpathName \fBedit apply\fR
|
||||
If any cell is being edited, de-highlight the cell and applies the
|
||||
changes.
|
||||
.TP
|
||||
\fIpathName \fBedit set\fR \fIx\fR \fIy\fR
|
||||
Highlights the cell at (\fIx\fR,\fIy\fR) for editing, if the
|
||||
\fB-editnotify\fR command returns true for this cell.
|
||||
.TP
|
||||
\fIpathName \fBentrycget\fR \fIx\fR \fIy\fR \fIoption\fR
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR of the cell at (\fIx\fR,\fIy\fR). \fIOption\fR may have
|
||||
any of the values accepted by the \fBset\fR widget command.
|
||||
.TP
|
||||
\fIpathName \fBentryconfigure \fIx y \fR?\fIoption\fR? ?\fIvalue option value ...\fR?
|
||||
Query or modify the configuration options of the cell at
|
||||
(\fIx\fR,\fIy\fR). If no \fIoption\fR is specified, returns a list
|
||||
describing all of the available options for the cell (see
|
||||
\fBTk_ConfigureInfo(n)\fR for information on the format of this list.)
|
||||
If \fIoption\fR is specified with no \fIvalue\fR, then the command
|
||||
returns a list describing the one named option (this list will be
|
||||
identical to the corresponding sublist of the value returned if no
|
||||
\fIoption\fR is specified.) If one or more \fIoption\-value\fR pairs
|
||||
are specified, then the command modifies the given widget option(s) to
|
||||
have the given value(s); in this case the command returns an empty
|
||||
string. \fIOption\fR may have any of the values accepted by the
|
||||
\fBset\fR widget command.
|
||||
.TP
|
||||
\fIpathName \fBformat\fR
|
||||
TODO place holder
|
||||
.TP
|
||||
\fIpathName \fBindex\fR
|
||||
TODO place holder
|
||||
.TP
|
||||
\fIpathName \fBmove\fR \fIdim\fR \fIfrom\fR \fIto\fR \fIoffset\fR
|
||||
\fIDim\fR may be \fBrow\fR or \fBcolumn\fR. Moves the the range of
|
||||
rows (or columns) from position \fIfrom\fR through \fIto\fR by the
|
||||
distance indicated by \fIoffset\fR. For example, \fBmove row
|
||||
2 4 1\fR moves the rows 2,3,4 to rows 3,4,5.
|
||||
.TP
|
||||
\fIpathName \fBset \fIx y \fR?-itemtype \fItype\fR? ?\fIoption value...\fR?
|
||||
Creates a new display item at the cell at (\fIx\fR,\fIy\fR). The
|
||||
optional \fB-itemtype\fR parameter gives the type of the display
|
||||
item. An additional list of \fIoption-value\fR pairs specify options
|
||||
of the display item. If a display item already exists at this cell,
|
||||
the old item will be deleted automatically.
|
||||
.TP
|
||||
\fIpathName \fBsize \fIdim index \fR?\fIoption value ...\fR?
|
||||
Queries or sets the size of the row or column given by \fIdim\fR and
|
||||
\fIindex\fR. \fIDim\fR may be \fBrow\fR or \fBcolumn\fR. \fIIndex\fR
|
||||
may be any non-negative integer that gives the position of a given row
|
||||
(or column). \fIIndex\fR can also be the string \fBdefault\fR; in this
|
||||
case, this command queries or sets the default size of all rows (or
|
||||
columns).
|
||||
.PP
|
||||
When no \fIoption\fR-\fIvalue\fR pair is given, this command returns a
|
||||
list containing the current size setting of the given row (or
|
||||
column). When \fIoption\fR-\fIvalue\fR pairs are given, the
|
||||
corresponding options of the size setting of the given row are
|
||||
changed. \fIOption\fR may be one of the follwing:
|
||||
.RS
|
||||
.TP
|
||||
\fB-pad0\fR \fIpixels\fR
|
||||
Specifies the paddings to the left or a column or the top of a row.
|
||||
.TP
|
||||
\fB-pad1\fR \fIpixels\fR
|
||||
Specifies the paddings to the right or a column or the bottom of a row.
|
||||
.TP
|
||||
\fB-size\fR \fIval\fR
|
||||
Specifies the width of a column or the height of a row. \fIVal\fR may
|
||||
be: \fBauto\fR -- the width of the column is set the the widest cell
|
||||
in the column; a valid Tk screen distance unit (see
|
||||
\fBTk_GetPixels(n)\fR); or a real number following by the word
|
||||
\fBchars\fR (e.g. \fB3.4chars\fR) that sets the width of the column to
|
||||
the given number of characters.
|
||||
.RE
|
||||
.TP
|
||||
\fIpathName \fBunset\fR \fIx\fR \fIy\fR
|
||||
Clears the cell at (\fIx\fR,\fIy\fR) by removing its display item.
|
||||
.TP
|
||||
\fIpathName \fBxview\fR
|
||||
TODO place holder
|
||||
.TP
|
||||
\fIpathName \fByview\fR
|
||||
TODO place holder
|
||||
.SH KEYWORDS
|
||||
grid, spread sheet, table
|
||||
|
||||
|
||||
|
||||
|
||||
1052
man/tixHList.n
Normal file
1052
man/tixHList.n
Normal file
File diff suppressed because it is too large
Load Diff
110
man/tixInputOnly.n
Normal file
110
man/tixInputOnly.n
Normal file
@@ -0,0 +1,110 @@
|
||||
'\"
|
||||
'\" $Id: tixInputOnly.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH tixInputOnly n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixInputOnly \- Create and manipulate TIX \fBInputOnly\fR widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixInputOnly \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-cursor \-width \-height
|
||||
.SE
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
\fBTixInputOnly\fR does not have any widget specific options.
|
||||
'\"
|
||||
.BE
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixInputOnly\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a \fBtixInputOnly\fR
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
\fBtixInputOnly\fR such as its cursor or width.
|
||||
.PP
|
||||
\fBTixInputOnly\fR widgets are not visible to the user. The only
|
||||
purpose of \fBTixInputOnly\fR widgets are to accept inputs from the
|
||||
user, which can be done with the \fBbind\fR command.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET COMMAND"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixInputOnly\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the \fBtixInputOnly\fR's window. This
|
||||
command may be used to invoke various operations on the widget. It
|
||||
has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
InputOnly widget's path name. \fIOption\fR and the \fIarg\fRs determine
|
||||
the exact behavior of the command. The following commands are
|
||||
possible for \fBtixInputOnly\fR widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixInputOnly\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If
|
||||
no \fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixInputOnly\fR command.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
\fBtixInputOnly\fR widgets have no default bindings.
|
||||
'\"
|
||||
.SH BUGS
|
||||
\fBtixInputOnly\fR is currently implemented for the Unix version of Tix only.
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
183
man/tixLabelEntry.n
Normal file
183
man/tixLabelEntry.n
Normal file
@@ -0,0 +1,183 @@
|
||||
'\"
|
||||
'\" $Id: tixLabelEntry.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixLabelEntry n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixLabelEntry \- Create and manipulate tixLabelEntry widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixLabelEntry \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixLabelEntry\fR class is derived from the \fBTixLabelWidget\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The LabelEntry widget supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disableforeground disableForeground DisableForeground
|
||||
The foreground color to use for of the entry subwidget when the
|
||||
LabelEntry widget is disabled.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-label label Label
|
||||
Specifies the string to display as the label of this LabelEntry widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-labelside labelSide LabelSide
|
||||
Specifies where the label should be displayed relative to the entry
|
||||
subwidget. Valid options are: \fBtop\fR, \fBleft\fR, \fBright\fR,
|
||||
\fBbottom\fR, \fBnone\fR or \fBacrosstop\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the whether the LabelEntry widget is normal or disabled. Only
|
||||
the values "normal" and "disabled" are recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlabel\fR
|
||||
Class: \fBLabel\fR
|
||||
.fi
|
||||
.IP
|
||||
The label subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBentry\fR
|
||||
Class: \fBEntry\fR
|
||||
.fi
|
||||
.IP
|
||||
The entry subwidget.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixLabelEntry\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a LabelEntry
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
LabelEntry such as its cursor and relief.
|
||||
.PP
|
||||
The LabelEntry widget packages an entry widget and a label into one
|
||||
mega widget. It can be used be used to simplify the creation of
|
||||
"entry-form" type of interface. In this kind of interface, one must
|
||||
create many entry widgets with label widgets next to them and describe
|
||||
the use of each of the entry widgets.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixLabelEntry\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the LabelEntry's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
LabelEntry widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for LabelEntry widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixLabelEntry\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixLabelEntry\fR command.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fIname ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
205
man/tixLabelFrame.n
Normal file
205
man/tixLabelFrame.n
Normal file
@@ -0,0 +1,205 @@
|
||||
'\"
|
||||
'\" $Id: tixLabelFrame.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixLabelFrame n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixLabelFrame \- Create and manipulate tixLabelFrame widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixLabelFrame \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixLabelFrame\fR class is derived from the \fBTixLabelWidget\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The LabelFrame widget supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-label label Label
|
||||
Specifies the string to display as the label of this LabelFrame widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-labelside labelSide LabelSide
|
||||
Specifies where the label should be displayed relative to the entry
|
||||
subwidget. Valid options are: \fBtop\fR, \fBleft\fR, \fBright\fR,
|
||||
\fBbottom\fR, \fBnone\fR or \fBacrosstop\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padX Pad
|
||||
Specifies the amount of the horizontal padding around the \fBframe\fR
|
||||
subwidget. Must be a valid non-negative integer number.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-pady padY Pad
|
||||
Specifies the amount of the vertical padding around the \fBframe\fR
|
||||
subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBframe\fR
|
||||
Class: \fBFrame\fR
|
||||
.fi
|
||||
.IP
|
||||
The frame subwidget.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlabel\fR
|
||||
Class: \fBLabel\fR
|
||||
.fi
|
||||
.IP
|
||||
The label subwidget.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixLabelFrame\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a LabelFrame
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
LabelFrame such as its cursor and relief.
|
||||
'\"
|
||||
.SH CREATING WIDGETS INSIDE A LABELFRAME
|
||||
.PP
|
||||
'\"
|
||||
The LabelFrame widget packages a frame widget and a label into one
|
||||
mega widget. To create widgets inside a LabelFrame widget, one must
|
||||
create the new widgets relative to the \fBframe\fR subwidget and
|
||||
manage them inside the \fBframe\fR subwidget. An error will be
|
||||
generated if one tries to create widgets as immediate children of the
|
||||
LabelFrame. For example: the following is correct code, which creates
|
||||
new widgets inside the frame subwidget:
|
||||
.PP
|
||||
.CS
|
||||
tixLabelFrame .f
|
||||
set f [.f subwidget frame]
|
||||
button $f.b \-text hi
|
||||
pack $f.b
|
||||
.CE
|
||||
.PP
|
||||
The following example code is \fIincorrect\fR because it tries to
|
||||
create immediate children of the LabelFrame \fB\.f\fR:
|
||||
.PP
|
||||
.CS
|
||||
tixLabelFrame .f
|
||||
# wrong!
|
||||
button .f.b \-text hi
|
||||
pack .f.b
|
||||
.CE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixLabelFrame\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the LabelFrame's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
LabelFrame widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for LabelFrame widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixLabelFrame\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixLabelFrame\fR command.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fIname ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
.PP
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
261
man/tixListNoteBook.n
Normal file
261
man/tixListNoteBook.n
Normal file
@@ -0,0 +1,261 @@
|
||||
'\"
|
||||
'\" $Id: tixListNoteBook.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixListNoteBook n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixListNoteBook - Create and manipulate tixListNoteBook widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixListNoteBook \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The ListNoteBook widget supports all the standard options of a frame widget.
|
||||
See the options(n) manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dynamicgeometry dynamicGeometry DynamicGeometry
|
||||
If set to false, the size of the ListNotebook will match the size of the
|
||||
largest page. If set to true, the size of the ListNotebook will match the
|
||||
size of the current page (therefore, the size may change when the user
|
||||
selects different pages). The default value is false. A setting of true
|
||||
is discouraged.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-ipadx ipadX Pad
|
||||
The amount of internal horizontal paddings around the sides of the
|
||||
page subwidgets.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-ipady ipadY Pad
|
||||
The amount of internal vertical paddings around the sides of the
|
||||
page subwidgets.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhlist\fR
|
||||
Class: \fBTixHList\fR
|
||||
.fi
|
||||
.IP
|
||||
The HList widget that displays the names of the pages.
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
.LP
|
||||
In addition, all the page subwidgets created as a result of the
|
||||
\fBadd\fR command can be accessed by the \fBsubwidget\fR command. They
|
||||
are identified by the \fBpageName\fR parameter to the \fBadd\fR
|
||||
command.
|
||||
'\"
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixListNoteBook\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a ListNoteBook widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
ListNoteBook widget such as its cursor and relief.
|
||||
|
||||
The ListNoteBook widget is very similar to the TixNoteBook widget: it
|
||||
can be used to display many windows in a limited space using a
|
||||
"notebook" metaphore. The notebook is divided into a stack of pages
|
||||
(windows). At one time only one of these pages can be shown. The user
|
||||
can navigate through these pages by choosing the name of the desired
|
||||
page in the \fBhlist\fR subwidget.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixListNoteBook\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the ListNoteBook widget's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
ListNoteBook widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for ListNoteBook widgets:
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBadd\fI pageName \fR?\fIoption value ...\fR?
|
||||
'\"
|
||||
Adds a new ListNotebook page subwidget into the ListNoteBook widget.
|
||||
\fIpageName\fR must be the name of an existing entry of the
|
||||
\fBhlist\fR subwidget. You must create the entry before calling the
|
||||
\fBadd\fR command. Please refer to the \fBtixHList(n)\fR manual entry
|
||||
for adding entries in an HList widget.
|
||||
Additional parameters may be supplied to configure this page
|
||||
subwidget. Possible options are:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fB\-createcmd\fR
|
||||
Specifies a TCL command to be called the first time a page is shown on
|
||||
the screen. This option can be used to delay the creation of the
|
||||
contents of a page until necessary. Therefore, it can be used to speed
|
||||
up interface creation process especially when there are a large number
|
||||
of pages in a ListNoteBook widget.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-raisecmd\fR
|
||||
Specifies a TCL command to be called whenever this page is raised by
|
||||
the user.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
When successful, this command returns the pathname of the newly
|
||||
created page.
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR.\fIOption\fR may have any of the values accepted by the
|
||||
\fBtixListNoteBook\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixListNoteBook\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdelete\fI pageName\fR?
|
||||
'\"
|
||||
Deletes the page identified by \fIpageName\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpagecget\fR \fIpageName option\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR in the page given by \fIpageName\fR. \fIOption\fR may
|
||||
have any of the values accepted by the \fBadd\fR widget command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpageconfigure\fI pageName \fR?\fIoption\fR? ?\fIvalue ...\fR?
|
||||
'\"
|
||||
When no option is given, prints out the values of all options of this
|
||||
page. If \fIoption\fR is specified with no \fIvalue\fR, then the
|
||||
command returns the current value of that option. If one or more
|
||||
\fIoption\-value\fR pairs are specified, then the command modifies the
|
||||
given page's option(s) to have the given value(s); in this case the
|
||||
command returns an empty string. \fIOption\fR may be any of options
|
||||
accepted by the \fBadd\fR widget command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpages\fR
|
||||
'\"
|
||||
Returns a list of the names of all the pages.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBraise \fIpageName\fR
|
||||
'\"
|
||||
Raise the page identified by \fIpageName\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBraised\fR
|
||||
'\"
|
||||
Returns the name of the currently raised page.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH EXAMPLE
|
||||
'\"
|
||||
.CS
|
||||
set n [tixListNoteBook .n]; pack $n
|
||||
$n subwidget hlist add page1 -text "Page 1"
|
||||
$n subwidget hlist add page2 -text "Page 2"
|
||||
|
||||
set page1 [$n add page1]
|
||||
set page2 [$n add page2]
|
||||
|
||||
button $page1.b -text "On page1"
|
||||
button $page2.b -text "On page2"
|
||||
|
||||
pack $page1.b
|
||||
pack $page2.b
|
||||
|
||||
$n raise page2
|
||||
.CE
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
When the user activates an entry in the \fBhlist\fR subwidget, the
|
||||
page associated with that entry will be raised to the front. This can
|
||||
be done by using the mouse or keyboard. The \fIhlist\fR subwidget
|
||||
operates with its \fB\-selectmode\fR option set to single. See the
|
||||
event bindings of the HList widget for more details.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), tixHList(n)
|
||||
|
||||
|
||||
|
||||
130
man/tixMeter.n
Normal file
130
man/tixMeter.n
Normal file
@@ -0,0 +1,130 @@
|
||||
'\"
|
||||
'\" $Id: tixMeter.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixMeter n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixMeter \- Create and manipulate Tix Meter widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixMeter \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
None.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The Meter widget supports all the standard options of a frame widget.
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard
|
||||
options.
|
||||
'\"
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-fillcolor fillColor FillColor
|
||||
The color of the progress bar.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.OP \-text text Text
|
||||
The text string to place inside the progress bar. If not specified,
|
||||
then the text string will be the percentage value specified by the
|
||||
\fB\-value\fR option.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.OP \-value value Value
|
||||
A real value that specifies the progress. Must be between 0.0 to 1.0.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixMeter\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a Meter widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
Meter widget such as its cursor and relief.
|
||||
|
||||
The Meter widget can be used to show the pregress of a background job
|
||||
which may take a long time to execute.
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixMeter\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the Meter widget's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
Meter widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for Meter widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixMeter\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixMeter\fR command.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
There is no bindings for the Meter widget.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), Meter Widget
|
||||
|
||||
|
||||
|
||||
|
||||
114
man/tixMwm.n
Normal file
114
man/tixMwm.n
Normal file
@@ -0,0 +1,114 @@
|
||||
'\"
|
||||
'\" $Id: tixMwm.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixMwm n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
.SH NAME
|
||||
tixMwm - Communicate with the Motif(tm) window manager.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixMwm\fI option pathName \fR?\fIargs\fR?
|
||||
.SH COMMAND OPTIONS
|
||||
.PP
|
||||
.TP
|
||||
\fBtixMwm decoration \fIpathName\fR ?\fIoption\fR? ?\fIvalue ...\fR?
|
||||
'\"
|
||||
When no options are given, this command returns the values of all the
|
||||
decorations options for the toplevel window with the \fIpathName\fR.
|
||||
|
||||
When only one option is given without specifying the value, the
|
||||
current value of that option is returned.
|
||||
|
||||
When more than one "option value" pairs are passed to this command,
|
||||
the specified values will be assigned to the corresponding options. As
|
||||
a result, the appearance of the Motif decorations around the toplevel
|
||||
window will be changed.
|
||||
|
||||
Possible options are: \fB-border\fR, \fB-menu\fR, \fB-maximize\fR,
|
||||
\fB-minimize\fR, \fB-resizeh\fR and \fB-title\fR. The value must be a
|
||||
Boolean value. The values returned by this command are undefined when
|
||||
the window is not managed by mwm.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fBtixMwm ismwmrunning \fIpathName\fR
|
||||
This returns true if mwm is running on the screen where the specified
|
||||
window is located, false otherwise.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fBtixMwm protocol \fIpathName\fR
|
||||
'\"
|
||||
When no additional options are given, this command returns all
|
||||
protocols associated with this toplevel window.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixMwm protocol \fIpathName \fBactivate\fI protocol_name\fR
|
||||
'\"
|
||||
Activate the mwm protocol message in mwm's menu.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixMwm protocol \fIpathName \fBadd\fI protocol_name menu_message\fR
|
||||
'\"
|
||||
Add a new mwm protocol message for this toplevel window. The
|
||||
message is identified by the string name specified in
|
||||
\fIprotocol_name\fR. A menu item will be added into mwm's menu as
|
||||
specified by \fImenu_message\fR. Once a new mwm protocol message is
|
||||
added to a toplevel, it can be catched by the TK \fBwm protocol\fR
|
||||
command. Here is an example:
|
||||
.CS
|
||||
tixMwm protocol . add MY_PRINT_HELLO \\
|
||||
{"Print Hello" _H Ctrl<Key>H}
|
||||
wm protocol . MY_PRINT_HELLO {puts Hello}
|
||||
.CE
|
||||
'\"
|
||||
.TP
|
||||
\fBtixMwm protocol \fIpathName \fBdeactivate\fI protocol_name\fR
|
||||
'\"
|
||||
Deactivate the mwm protocol message in mwm's menu.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixMwm protocol \fIpathName \fBdelete\fI protocol_name\fR
|
||||
'\"
|
||||
Delete the mwm protocol message from mwm's menu. Please note that the
|
||||
window manager protocol handler associated with this protocol (by the
|
||||
\fBwm protocol\fR command) is not deleted automatically. You have to
|
||||
delete the protocol handle explicitly. E.g.:
|
||||
.CS
|
||||
tixMwm protocol . delete MY_PRINT_HELLO
|
||||
wm protocol . MY_PRINT_HELLO {}
|
||||
.CE
|
||||
'\"
|
||||
.PP
|
||||
.SH BUGS
|
||||
'\"
|
||||
On some versions of Mwm, the \fB-border\fR will not disappear unless
|
||||
\fB-resizeh\fR is turned off. Also, the -title will not disappear
|
||||
unless all of \fB-title\fR, \fB-menu\fR, \fB-maximize\fR and
|
||||
\fB-minimize\fR are turned off.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.PP
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
109
man/tixNBFrame.n
Normal file
109
man/tixNBFrame.n
Normal file
@@ -0,0 +1,109 @@
|
||||
'\"
|
||||
'\" $Id: tixNBFrame.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixNBFrame n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixNBFrame \- Create and manipulate Tix NoteBook Frame widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixNBFrame \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-background \-borderWidth \-cursor \-disabledForeground
|
||||
\-foreground \-font \-height \-highlightColor
|
||||
\-highlightThickness \-relief \-takeFocus
|
||||
\-width
|
||||
.SE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-backpagecolor backPageColor BackPageColor
|
||||
Specifies the color for the extra space on the row of tabs which is
|
||||
not covered by any page tabs.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-focuscolor focusColor FocusColor
|
||||
Specifies the color for the focus highlight.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-inactivebackground inactiveBackground InactiveBackground
|
||||
Specifies the color for the inactive tabs (the active tab always have
|
||||
the same background color as the notebook).
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-tabpadx tabPadX Pad
|
||||
The horizontal padding around the text labels on the page tabs.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-tabpady tabPadY Pad
|
||||
The vertical padding around the text labels on the page tabs.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
'\"
|
||||
The NBFrame widget is used privately inside the \fBTixNoteBook(n)\fR
|
||||
widget to display the page tabs. The application programmer should
|
||||
never create a NBFrame widget directly. The sole purpose of this maual
|
||||
page is to describe the options that can be used to configure the
|
||||
appearance of the TixNoteBook widget.
|
||||
.PP
|
||||
The name of the NBFrame subwidget inside the TixNoteBook widget is
|
||||
called \fBnbframe\fR. It can be accessed using the \fBsubwidget\fR
|
||||
command of the TixNoteBook widget or the \fB\-options\fR switch. See
|
||||
below for an example.
|
||||
.PP
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH EXAMPLE
|
||||
'\"
|
||||
.CS
|
||||
set nb [tixNoteBook .nb -options {
|
||||
nbframe.BackPageColor gray60
|
||||
}]
|
||||
$nb subwidget nbframe config -font fixed
|
||||
|
||||
$nb add page1 -label "Page1"
|
||||
set page [$nb subwidget page1]
|
||||
button $page.b1
|
||||
pack $page.b1
|
||||
|
||||
pack $nb -expand yes -fill both
|
||||
.CE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), tixNoteBook(n)
|
||||
|
||||
|
||||
317
man/tixNoteBook.n
Normal file
317
man/tixNoteBook.n
Normal file
@@ -0,0 +1,317 @@
|
||||
'\"
|
||||
'\" $Id: tixNoteBook.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixNoteBook n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixNoteBook - Create and manipulate tixNoteBook widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixNoteBook \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The NoteBook widget supports all the standard options of a frame widget.
|
||||
See the options(n) manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dynamicgeometry dynamicGeometry DynamicGeometry
|
||||
If set to false, the size of the Notebook will match the size of the
|
||||
largest page. If set to true, the size of the Notebook will match the
|
||||
size of the current page (therefore, the size may change when the user
|
||||
selects different pages). The default value is false. A setting of true
|
||||
is discouraged.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-ipadx ipadX Pad
|
||||
The amount of internal horizontal paddings around the sides of the
|
||||
page subwidgets.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-ipady ipadY Pad
|
||||
The amount of internal vertical paddings around the sides of the
|
||||
page subwidgets.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBnbframe\fR
|
||||
Class: \fBtixNoteBookFrame\fR
|
||||
.fi
|
||||
.IP
|
||||
The "note book frame" widget that displays ths tabs of the notebook.
|
||||
Most of the display options of the page tabs are controlled by this
|
||||
subwidget. For example, if you need to choose a different font to
|
||||
display the tab names of the pages, the color of the inactive tabs or
|
||||
the color behind the tabs, you can configure the options of the
|
||||
\fBnbframe\fR subwidget. See the manual page of
|
||||
\fBtixNoteBookFrame(n)\fR for more details.
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
.LP
|
||||
In addition, all the page subwidgets created as a result of the
|
||||
\fBadd\fR command can be accessed by the \fBsubwidget\fR command. They
|
||||
are identified by the \fBpageName\fR parameter to the \fBadd\fR
|
||||
command.
|
||||
'\"
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixNoteBook\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a NoteBook widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
NoteBook widget such as its cursor and relief.
|
||||
|
||||
The NoteBook widget can be used to display many windows in a
|
||||
limited space using a "notebook" metaphore. The notebook is divided
|
||||
into a stack of pages (windows). At one time only one of these pages
|
||||
can be shown. The user can navigate through these pages by choosing
|
||||
the visual "tabs" at the top of the NoteBook widget.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixNoteBook\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the NoteBook widget's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
NoteBook widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for NoteBook widgets:
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBadd\fI pageName \fR?\fIoption value ...\fR?
|
||||
'\"
|
||||
Adds a new notebook page subwidget into the NoteBook widget.
|
||||
Additional parameters may be supplied to configure this page
|
||||
subwidget. Possible options are:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fB\-anchor\fR
|
||||
'\"
|
||||
Specifies how the information in a tab (e.g. text or a bitmap) is to
|
||||
be displayed in the widget. Must be one of the values \fBn\fR,
|
||||
\fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or
|
||||
\fBcenter\fR. For example, nw means display the information such that
|
||||
its top-left corner is at the top-left corner of the widget.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-bitmap\fR
|
||||
'\"
|
||||
Specifies a bitmap to display on the tab of this page. The bitmap is
|
||||
displayed only if none of the \fB-label\fR or \fB-image\fR options are
|
||||
specified.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-createcmd\fR
|
||||
'\"
|
||||
Specifies a TCL command to be called the first time a page is shown on
|
||||
the screen. This option can be used to delay the creation of the
|
||||
contents of a page until necessary. Therefore, it can be used to speed
|
||||
up interface creation process especially when there are a large number
|
||||
of pages in a NoteBook widget.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-image\fR
|
||||
'\"
|
||||
Specifies an image to display on the tab of this page. The image is
|
||||
displayed only if the \fB-label\fR options is not specified.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-justify\fR
|
||||
'\"
|
||||
When there are multiple lines of text displayed in a tab, this option
|
||||
determines how the lines line up with each other. Must be one of left,
|
||||
center, or right. \fBLeft\fR means that the lines' left edges all
|
||||
line up, \fBcenter\fR means that the lines' centers are aligned, and
|
||||
\fBright\fR means that the lines' right edges line up.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-label\fR
|
||||
'\"
|
||||
Specifies a text label string to display on the tab of this page subwidget.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-raisecmd\fR
|
||||
'\"
|
||||
Specifies a TCL command to be called whenever this page is raised by
|
||||
the user.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-state\fR
|
||||
'\"
|
||||
Specifies whether this page can be raised by the user. Must be either
|
||||
\fBnormal\fR or \fBdisabled\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-underline\fR
|
||||
'\"
|
||||
Specifies the integer index of a character to underline in the tab.
|
||||
This option is used by the default bindings to implement keyboard
|
||||
traversal for menu buttons and menu entries. 0 corresponds to the
|
||||
first character of the text displayed in the widget, 1 to the next
|
||||
character, and so on.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-wraplength\fR
|
||||
'\"
|
||||
This option specifies the maximum line length of the label string on
|
||||
this tab. If the line length of the label string exceeds this length,
|
||||
it is wrapped onto the next line, so that no line is longer than the
|
||||
specified length. The value may be specified in any of the standard
|
||||
forms for screen distances. If this value is less than or equal to 0
|
||||
then no wrapping is done: lines will break only at newline characters
|
||||
in the text.
|
||||
'\"
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR.\fIOption\fR may have any of the values accepted by the
|
||||
\fBtixNoteBook\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixNoteBook\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdelete\fI pageName\fR?
|
||||
'\"
|
||||
Deletes the page identified by \fIpageName\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpagecget\fR \fIpageName option\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR in the page given by \fIpageName\fR. \fIOption\fR may
|
||||
have any of the values accepted by the \fBadd\fR widget command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpageconfigure\fI pageName \fR?\fIoption\fR? ?\fIvalue ...\fR?
|
||||
'\"
|
||||
'\"
|
||||
When no option is given, prints out the values of all options of this
|
||||
page. If \fIoption\fR is specified with no \fIvalue\fR, then the
|
||||
command returns the current value of that option. If one or more
|
||||
\fIoption\-value\fR pairs are specified, then the command modifies the
|
||||
given page's option(s) to have the given value(s); in this case the
|
||||
command returns an empty string. \fIOption\fR may be any of options
|
||||
accepted by the \fBadd\fR widget command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpages\fR
|
||||
'\"
|
||||
Returns a list of the names of all the pages.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBraise \fIpageName\fR
|
||||
'\"
|
||||
Raise the page identified by \fIpageName\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBraised\fR
|
||||
'\"
|
||||
Returns the name of the currently raised page.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
.IP [1]
|
||||
When the user pressed the left mouse button over a notebook tab, the
|
||||
notebook page associated with that tab will be raised to the top of
|
||||
the stack of pages.
|
||||
'\"
|
||||
.PP
|
||||
.IP [2]
|
||||
The pages can also be selected using the keyboard. The user can type
|
||||
the \fB<Tab>\fR key to cycle among the set of pages. When the focus
|
||||
appears on the desired page, the user can type \fB<Return>\fR or
|
||||
\fB<space>\fR to select that page. Or, if the user wants to cancel the
|
||||
selection, he/she can type the \fB<Escape>\fR key.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
263
man/tixOptionMenu.n
Normal file
263
man/tixOptionMenu.n
Normal file
@@ -0,0 +1,263 @@
|
||||
'\"
|
||||
'\" $Id: tixOptionMenu.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixOptionMenu n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixOptionMenu \- Create and manipulate tixOptionMenu widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixOptionMenu \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixOptionMenu\fR class is derived from the \fBTixLabelWidget\fR
|
||||
class and inherits all the commands, options and
|
||||
subwidgets of its super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The OptionMenu widget supports all the standard Tix widget
|
||||
options. See the \fBTix-Options(n)\fR manual entry for details on the
|
||||
standard Tix widget options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the \fB\-value\fR option of
|
||||
the OptionMenu is changed. The command will be called with one
|
||||
arguments -- the new value of the OptionMenu widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the OptionMenu widget
|
||||
changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dynamicgeometry dynamicGeometry DynamicGeometry
|
||||
A boolean value indicating whether the size of the \fBmenubutton\fR
|
||||
subwidget should change dynamically to match the width of the
|
||||
currently selected menu entry. If set to false (the default), the the
|
||||
size of the menubutton subwidget will be wide enough to display every
|
||||
menu entry fully and does not change when the user selects different
|
||||
entries.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-label label Label
|
||||
Specifies the string to display as the label of this OptionMenu widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-labelside labelSide LabelSide
|
||||
Specifies where the label should be displayed relative to the entry
|
||||
subwidget. Valid options are: \fBtop\fR, \fBleft\fR, \fBright\fR,
|
||||
\fBbottom\fR, \fBnone\fR or \fBacrosstop\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the whether the OptionMenu widget is normal or disabled. Only
|
||||
the values "normal" and "disabled" are recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-value value Value
|
||||
Specifies the value of the OptionMenu. The value of the OptionMenu
|
||||
widget is the name of the item currently displayed by its
|
||||
\fBmenubutton\fR subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-variable variable Variable
|
||||
Specifies the global variable in which the value of the OptionMenu
|
||||
should be stored. The value of the OptionMenu will be automatically
|
||||
updated when this variable is changed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBmenu\fR
|
||||
Class: \fBMenu\fR
|
||||
.fi
|
||||
.IP
|
||||
The menu subwidget, which is popped up when the user press the
|
||||
\fBmenubutton\fR subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBmenubutton\fR
|
||||
Class: \fBMenubutton\fR
|
||||
.fi
|
||||
.IP
|
||||
The menubutton subwidget.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixOptionMenu\fR command creates a new window (given by
|
||||
the \fIpathName\fR argument) and makes it into a OptionMenu
|
||||
widget. Additional options, described above, may be specified on the
|
||||
command line or in the option database to configure aspects of the
|
||||
OptionMenu such as its cursor and relief.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixOptionMenu\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the OptionMenu's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
OptionMenu widget's path name. \fIOption\fR and the
|
||||
\fIarg\fRs determine the exact behavior of the command. The following
|
||||
commands are possible for OptionMenu widgets:
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBadd\fR \fItype name \fR?\fIoption value ...\fR?
|
||||
'\"
|
||||
Adds a new item into the OptionMenu widget. \fItype\fR must be either
|
||||
\fBcommand\fR or \fBseparator\fR. The \fIoptions\fR may be any of the
|
||||
valid options for the \fBcommand\fR or \fBseparator\fR menu entry
|
||||
types for the TK \fBmenu\fR widget class, except \fB\-command\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixOptionMenu\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixOptionMenu\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdelete\fR \fIname\fR
|
||||
'\"
|
||||
Deletes the menu entry identified by \fIname\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdisable\fR \fIname\fR
|
||||
'\"
|
||||
Disables the menu entry identified by \fIname\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBenable\fR \fIname\fR
|
||||
'\"
|
||||
Enables the menu entry identified by \fIname\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBentrycget\fR \fIname option\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR in the menu entry identified by \fIname\fR. \fIOption\fR
|
||||
may have any of the values accepted by the \fBadd\fR widget command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBentryconfigure\fI name\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the menu entry identified
|
||||
by \fIname\fR. If no \fIoption\fR is specified, returns a list
|
||||
describing all of the available options for the menu entry (see
|
||||
\fBTk_ConfigureInfo\fR for information on the format of this list).
|
||||
If \fIoption\fR is specified with no \fIvalue\fR, then the command
|
||||
returns a list describing the one named option (this list will be
|
||||
identical to the corresponding sublist of the value returned if no
|
||||
\fIoption\fR is specified). If one or more \fIoption\-value\fR pairs
|
||||
are specified, then the command modifies the given option(s) to
|
||||
have the given value(s); in this case the command returns an empty
|
||||
string. \fIOption\fR may have any of the values accepted by the
|
||||
\fBadd\fR widget command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBentries\fR
|
||||
'\"
|
||||
Returns the names of all the entries currently in the OptionMenu
|
||||
widget.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fIname ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
334
man/tixPanedWindow.n
Normal file
334
man/tixPanedWindow.n
Normal file
@@ -0,0 +1,334 @@
|
||||
'\"
|
||||
'\" $Id: tixPanedWindow.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixPanedWindow n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixPanedWindow \- Create and manipulate tixPanedWindow widgets
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixPanedWindow \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The PanedWindow widget supports all the standard options of a frame
|
||||
widget. See the \fBoptions(n)\fR manual entry for details on the
|
||||
standard options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
'\"
|
||||
Name: \fBcommand\fR
|
||||
Class: \fBCommand\fR
|
||||
Switch: \fB\-command\fR
|
||||
'\"
|
||||
.fi
|
||||
.IP
|
||||
'\"
|
||||
Specifies the command to invoke when the panes change their sizes.
|
||||
This command is called with a list of integers that record the new
|
||||
sizes of the panes. The sizes of the panes are listed in the order of
|
||||
the panes' creation.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-dynamicgeometry dynamicGeometry DynamicGeometry
|
||||
'\"
|
||||
If set to true, the size of the PanedWindow will dynamically change
|
||||
if the size of any of its panes changes. Otherwise, the size of the
|
||||
PanedWindow will only increase when size of any of its panes changes
|
||||
and will not decrease. The default value is true.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-handleactivebg handleActiveBg HandleActiveBg
|
||||
'\"
|
||||
Specifies the active background color of the resize handles. When the
|
||||
mouse cursor enters a resize handle, the resize handle will adopt
|
||||
the active background color.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-handlebg handleBg Background
|
||||
'\"
|
||||
Specifies the normal background color of the resize handles.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-height height Height
|
||||
Specifies the desired height for the window.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-orientation orientation Orientation
|
||||
Specifies the orientation of the panes. Must be either \fBvertical\fR
|
||||
or \fBhorizontal\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP "-paneborderwidth or -panebd" paneBorderWidth PaneBorderWidth
|
||||
Specifies the border width of the panes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-panerelief paneRelief PaneRelief
|
||||
Specifies the border relief of the panes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-separatoractivebg separatorActiveBg SeparatorActiveBg
|
||||
Specifies the active background color of the separators. When the user
|
||||
grabs a resize handle, the separators
|
||||
will adopt the active background color.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-separatorbg separatorBg Background
|
||||
'\"
|
||||
Specifies the normal background color of the separators.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-width width Width
|
||||
Specifies the desired width for the window.
|
||||
'\"----------END
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
.PP
|
||||
'\"
|
||||
All the pane subwidgets created as a result of the \fBadd\fR command
|
||||
can be accessed by the \fBsubwidget\fR command. They are identified by
|
||||
the \fBpaneName\fR parameter to the \fBadd\fR command.
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixPanedWindow\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a PanedWindow widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
PanedWindow widget such as its cursor and relief.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The PanedWindow widget allows the user to interactively manipulate the
|
||||
sizes of several panes. The panes can be arranged either vertically or
|
||||
horizontally. Each individual pane may have upper and lower limits of
|
||||
its size. The user changes the sizes of the panes by dragging the
|
||||
resize handle between two panes.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET COMMAND"
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixPanedWindow\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the PanedWindow widget's window. This
|
||||
command may be used to invoke various operations on the widget. It
|
||||
has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
frame widget's path name. \fIOption\fR and the \fIarg\fRs determine
|
||||
the exact behavior of the command. The following commands are
|
||||
possible for PanedWindow widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBadd\fI paneName \fR?\fIoption value ...\fR?
|
||||
'\"
|
||||
Adds a new pane subwidget with the name \fIpaneName\fR into the
|
||||
PanedWindow widget. Additional configuration options can be
|
||||
given to configure the new button subwidget. Three configuration
|
||||
options are supported:
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fB\-after\fR \fIpane\fR
|
||||
'\"
|
||||
Specifies that the new pane should be placed after \fIpane\fR in the
|
||||
list of panes in this PanedWindow widget.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-at\fR \fIinteger\fR
|
||||
'\"
|
||||
Specifies the position of the new pane in the list of panes in this
|
||||
PanedWindow widget. \fB0\fR means the first position, \fB1\fR means
|
||||
the second, and so on. In addition, \fBend\fR means the end of the
|
||||
list.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-before\fR \fIpane\fR
|
||||
'\"
|
||||
Specifies that the new pane should be placed before \fIpane\fR in the
|
||||
list of panes in this PanedWindow widget.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-expand\fR \fIfactor\fR
|
||||
'\"
|
||||
Specifies the \fBexpand/shrink factor\fR of this pane. \fIFactor\fR
|
||||
must be a non-negative floating point number. The default value is
|
||||
0.0. The expand/shrink factor is used to calculate how much each pane
|
||||
should grow or shrink when the size of the PanedWindow main window is
|
||||
changed. When the main window expands/shrinks by \fIn\fR pixels, then
|
||||
pane \fIi\fR will grow/shrink by about \fIn * factor(i) /
|
||||
summation(factors)\fR, where \fIfactor(i)\fR is the expand/shrink
|
||||
factor of pane i and \fIsummation(factors)\fR is the summation of the
|
||||
expand/shrink factors of all the panes. If \fIsummation(factors)\fR is
|
||||
0.0, however, only the last visible pane will be grown or shrunk.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-min\fR \fIinteger\fR
|
||||
'\"
|
||||
Specifies the minimum size, in pixels, of the new pane; the default is 0.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-max\fR \fIinteger\fR
|
||||
Specifies the maximum size, in pixels, of the new pane; the default is 10000.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-size\fR \fIinteger\fR
|
||||
Specifies the size, in pixels, of the new pane; if the \fB\-size\fR
|
||||
option is not given, or set to the empty string, the PanedWindow
|
||||
widget will use the natural size of the pane subwidget.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may be \fB\-min\fR, \fB\-max\fR and/or
|
||||
\fB\-size\fR, or any option accepted by the Tk frame widget.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may be any
|
||||
of the non-static options of the PanedWindow widget.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdelete\fR \fIpaneName\fR
|
||||
'\"
|
||||
Removes the pane given by \fIpaneName\fR and deletes its contents.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBforget\fR \fIpaneName\fR
|
||||
'\"
|
||||
Removes the pane given by \fIpaneName\fR but does not delete its
|
||||
contents. This pane can be later added back to the PanedWindow widget
|
||||
by the \fBmanage\fR method.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBmanage\fR \fIpaneName \fR?\fIoption value ...\fR?
|
||||
'\"
|
||||
Adds the pane given by \fIpaneName\fR back to the PanedWindow widget.
|
||||
\fIPaneName\fR must be already forgotten by the \fBforget\fR
|
||||
method. Additional \fIoption-value\fR pairs, same as those accepted by
|
||||
the \fBadd\fR method, can be given to control the appearance and
|
||||
position of the pane.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpanecget\fR \fIpaneName option\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR in the pane given by \fIpaneName\fR. \fIOption\fR may
|
||||
have any of the values accepted by the \fBadd\fR widget command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpaneconfigure\fI paneName \fR?\fIoption\fR? ?\fIvalue ...\fR?
|
||||
'\"
|
||||
'\"
|
||||
When no option is given, prints out the values of all options of this
|
||||
pane. If \fIoption\fR is specified with no \fIvalue\fR, then the
|
||||
command returns the current value of that option. If one or more
|
||||
\fIoption\-value\fR pairs are specified, then the command modifies the
|
||||
given pane's option(s) to have the given value(s); in this case the
|
||||
command returns an empty string. \fIOption\fR may be \fB\-min\fR,
|
||||
\fB\-max\fR and/or \fB\-size\fR, or any option accepted by the Tk
|
||||
frame widget. The sizes of the panes may be changed as a result of
|
||||
calling the \fBpaneconfigure\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpanes\fR
|
||||
'\"
|
||||
Returns a list of the names of all panes.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsetsize\fR \fIpaneName newSize\fR ?\fIdirection\fR?
|
||||
'\"
|
||||
Sets the size of the pane specified by \fIpaneName\fR to
|
||||
\fInewSize\fR. The \fIdirection\fR parameter specifies in which
|
||||
direction the pane should grow/shrink. Possible values are \fBnext\fR:
|
||||
the pane will grow or shrink by moving the boundary between itself and
|
||||
the pane to its right or bottom; \fBprev\fR: the pane will grow or
|
||||
shrink by moving the boundary between itself and the pane to its left
|
||||
or top.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fIname ?args?\fR
|
||||
'\"
|
||||
When no options are given, returns the pathname of the subwidget of
|
||||
the specified name.
|
||||
.LP
|
||||
When options are given, the widget command of the specified subwidget will
|
||||
be called with these options.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
'\"
|
||||
The panes' sizes will be changed when the user drags the handles. The
|
||||
change in the panes' sizes may be subjected to the \fB\-min\fR,
|
||||
\fB\-max\fR and \fB\-size\fR options of the panes.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
'\"
|
||||
TIX, Container Widget
|
||||
|
||||
|
||||
|
||||
|
||||
222
man/tixPopupMenu.n
Normal file
222
man/tixPopupMenu.n
Normal file
@@ -0,0 +1,222 @@
|
||||
'\"
|
||||
'\" $Id: tixPopupMenu.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixPopupMenu n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixPopupMenu \- Create and manipulate tixPopupMenu widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixPopupMenu \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBtixPopupMenu\fR class is derived from the \fBTixShell\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The PopupMenu widget supports all the standard options of a frame widget.
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-buttons buttons Buttons
|
||||
A Tcl list that specifies the mouse button(s) and key modifier(s) that
|
||||
bring up the popup menu. Each element of this list is in turn a list
|
||||
that contains two elements: the first element is an integer that
|
||||
indicates the
|
||||
mouse button that brings up the popup menu; the second element
|
||||
specifies the key modifiers that should be used in conjunction with
|
||||
the mouse button. For example, the value \fB{{1 {Control Meta}} {3
|
||||
{Any}}}\fR specifies that the popup menu can be popped up by (a)
|
||||
pressing mouse button 1 with either the Control or the Meta key or (b)
|
||||
pressing mouse button 3 with any key modifier. The default value is
|
||||
\fB{{3 {Any}}}\fR: only mouse button 3 brings up the popup menu.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-postcmd postCmd PostCmd
|
||||
Specifies a command to be evaluated just before the menu is about to
|
||||
pop-up. This command is called with two default arguments: the root
|
||||
x-y coordinates where the user has pressed the mouse button. This
|
||||
command must return a boolean value: a false indicates that the menu
|
||||
shouldn't be popped up at this point; a true indicates that the menu
|
||||
should be popped up. This option can be used to find out where the
|
||||
user has pressed the mouse-button and optionally disable the popup
|
||||
menu over certain screen areas.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-spring spring Spring
|
||||
When set to \fBtrue\fR, the menu will be automatically popped down if
|
||||
the user releases the mouse button outside of the menu and no menu
|
||||
commands will be invoked. This makes it easy for the user to cancel
|
||||
the popup menu without pressing the Escape key. The default value is
|
||||
\fBtrue\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Must be either \fBdisabled\fR or \fBnormal\fR. The PopupMenu widget will not
|
||||
pop up unless its \fB\-state\fR is set to \fBnormal\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-title title Title
|
||||
Specifies a text string to display inside the \fBmenubutton\fR
|
||||
subwidget, as the title of this PopupMenu.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBmenu\fR
|
||||
Class: \fBMenu\fR
|
||||
.fi
|
||||
.IP
|
||||
The menu subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBmenubutton\fR
|
||||
Class: \fBMenubutton\fR
|
||||
.fi
|
||||
.IP
|
||||
The menubutton subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixPopupMenu\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a PopupMenu widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
PopupMenu widget such as its cursor and relief.
|
||||
|
||||
The Tix PopupMenu widget can be used as a replacement of the
|
||||
\fBtk_popup\fR command. The advantage of the Tix PopupMenu widget is
|
||||
it requires less application code to manipulate. Also, it provides a
|
||||
title for the popup menu, which is not available from \fBtk_popup\fR.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixPopupMenu\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the PopupMenu widget's window. This
|
||||
command may be used to invoke various operations on the widget. It has
|
||||
the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
PopupMenu widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for PopupMenu widgets:
|
||||
.TP
|
||||
\fIpathName \fBbind \fIwidget \fR?\fIwidget ...\fR?
|
||||
'\"
|
||||
Binds this PopupMenu to one or more \fIwidgets\fR. The PopupMenu
|
||||
will be activated when the user presses the right mouse button over
|
||||
these \fIwidgets\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixPopupMenu\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixPopupMenu\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBpost \fIwidget x y\fR
|
||||
'\"
|
||||
Posts the PopupMenu inside the \fIwidget\fR at the coordinate
|
||||
\fIx\fR,\fIy\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBunbind \fIwidget \fR?\fIwidget ...\fR?
|
||||
'\"
|
||||
Cancels the PopupMenu's binding with the \fIwidget(s)\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\".SH BINDINGS
|
||||
'\".PP
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
193
man/tixScrolledHList.n
Normal file
193
man/tixScrolledHList.n
Normal file
@@ -0,0 +1,193 @@
|
||||
'\"
|
||||
'\" $Id: tixScrolledHList.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixScrolledHList n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixScrolledHList \- Create and manipulate Tix ScrolledHList widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixScrolledHList \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-anchor \-background \-cursor
|
||||
\-relief \-borderWidth
|
||||
.SE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -height height Height
|
||||
Specifies the desired height for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-scrollbar scrollbar Scrollbar
|
||||
Specifies the display policy of the scrollbars. The following
|
||||
values are recognized:
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fBauto \fR?\fI+x\fR? ?\fI\-x\fR? ?\fI+y\fR? ?\fI\-y\fR?
|
||||
'\"
|
||||
When \fB\-scrollbar\fR is set to "\fBauto\fR", the scrollbars are
|
||||
shown only when needed. Additional modifiers can be used to force a
|
||||
scrollbar to be shown or hidden. For example, "\fBauto \-y\fR" means
|
||||
the horizontal scrollbar should be shown when needed but the vertical
|
||||
scrollbar should always be hidden; "\fBauto +x\fR" means the vertical
|
||||
scrollbar should be shown when needed but the horizontal scrollbar
|
||||
should always be shown, and so on.
|
||||
'\"
|
||||
.TP
|
||||
\fBboth\fR
|
||||
Both scrollbars are shown
|
||||
'\"
|
||||
.TP
|
||||
\fBnone\fR
|
||||
The scrollbars are never shown.
|
||||
'\"
|
||||
.TP
|
||||
\fBx\fR
|
||||
Only the horizontal scrollbar is shown;
|
||||
'\"
|
||||
.TP
|
||||
\fBy\fR
|
||||
Only the vertical scrollbar is shown.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -width width Width
|
||||
Specifies the desired width for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhlist\fR
|
||||
Class: \fBHlist\fR
|
||||
.fi
|
||||
.IP
|
||||
The tixHList subwidget inside the ScrolledHList widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledHList\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a ScrolledHList widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
ScrolledHList widget such as its cursor and relief.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledHList\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the ScrolledHList widget's window. This
|
||||
command may be used to invoke various
|
||||
operations on the widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as
|
||||
the ScrolledHList widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for ScrolledHList widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixScrolledHList\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If
|
||||
no \fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixScrolledHList\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no additional arguments are given, returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When no additional arguments are given, the widget command of the
|
||||
specified subwidget will be called with these parameters.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
244
man/tixScrolledListBox.n
Normal file
244
man/tixScrolledListBox.n
Normal file
@@ -0,0 +1,244 @@
|
||||
'\"
|
||||
'\" $Id: tixScrolledListBox.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixScrolledListBox n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixScrolledListBox \- Create and manipulate Tix ScrolledListBox widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixScrolledListBox \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-anchor \-background \-cursor
|
||||
\-relief \-borderWidth
|
||||
.SE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"----------BEGIN
|
||||
.OP \-anchor anchor Anchor
|
||||
Specifies the alignment of the items inside the listbox subwidget.
|
||||
Only the values \fBw\fR and \fBe\fR are allowed. When set to \fBw\fR,
|
||||
the listbox is automatically aligned to the beginning of the items.
|
||||
When set to \fBe\fR, the listbox is automatically aligned to the end
|
||||
of the items. Automatically alignment only happens when the
|
||||
ScrolledListBox widget changes its size.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browsecmd BrowseCmd
|
||||
Specifies the command to be called when the user browses the elements
|
||||
inside the \fBlistbox\fR subwidget (see the BINDINGS section below).
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the command to be called when the user invokes the \fBlistbox\fR
|
||||
subwidget (see the BINDINGS section below).
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-height height Height
|
||||
Specifies the desired height for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-scrollbar scrollbar Scrollbar
|
||||
Specifies the display policy of the scrollbars. The following
|
||||
values are recognized:
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fBauto \fR?\fI+x\fR? ?\fI\-x\fR? ?\fI+y\fR? ?\fI\-y\fR?
|
||||
'\"
|
||||
When \fB\-scrollbar\fR is set to "\fBauto\fR", the scrollbars are
|
||||
shown only when needed. Additional modifiers can be used to force a
|
||||
scrollbar to be shown or hidden. For example, "\fBauto \-y\fR" means
|
||||
the horizontal scrollbar should be shown when needed but the vertical
|
||||
scrollbar should always be hidden; "\fBauto +x\fR" means the vertical
|
||||
scrollbar should be shown when needed but the horizontal scrollbar
|
||||
should always be shown, and so on.
|
||||
'\"
|
||||
.TP
|
||||
\fBboth\fR
|
||||
Both scrollbars are shown
|
||||
'\"
|
||||
.TP
|
||||
\fBnone\fR
|
||||
The scrollbars are never shown.
|
||||
'\"
|
||||
.TP
|
||||
\fBx\fR
|
||||
Only the horizontal scrollbar is shown;
|
||||
'\"
|
||||
.TP
|
||||
\fBy\fR
|
||||
Only the vertical scrollbar is shown.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -width width Width
|
||||
Specifies the desired width for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlistbox\fR
|
||||
Class: \fBListbox\fR
|
||||
.fi
|
||||
.IP
|
||||
The listbox subwidget inside the ScrolledListBox widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledListBox\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a ScrolledListBox widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
ScrolledListBox widget such as its cursor and relief.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledListBox\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the ScrolledListBox widget's
|
||||
window. This command may be used to invoke various operations on the
|
||||
widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
ScrolledListBox widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for ScrolledListBox widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixScrolledListBox\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If
|
||||
no \fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixScrolledListBox\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no additional arguments are given, returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When no additional arguments are given, the widget command of the
|
||||
specified subwidget will be called with these parameters.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\"
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
.IP [1]
|
||||
'\"
|
||||
If the \fB\-browsecmd\fR option is set, the command which it referes
|
||||
to is called whenever a <ButtonPress\-1> or a <Motion\-1> event occurrs
|
||||
inside the \fBlistbox\fR subwidget.
|
||||
'\"
|
||||
.PP
|
||||
.IP [2]
|
||||
'\"
|
||||
The command specified by the \fB\-command\fR option is invoked when a
|
||||
<Double\-1> event occurrs inside the \fBlistbox\fR subwidget.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
'\"
|
||||
.SH BUGS
|
||||
'\"
|
||||
The capitalization of some of the commands names in Tix 3.x has been
|
||||
changed in Tix 4.0. All commands that ended with \fBbox\fR have been
|
||||
changed to a capitalized \fBBox\fR. Hence, the command
|
||||
\fBtixScrolledListbox\fR in Tix 3.x has been changed to
|
||||
\fBtixScrolledListBox\fR in Tix 4.0
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
197
man/tixScrolledText.n
Normal file
197
man/tixScrolledText.n
Normal file
@@ -0,0 +1,197 @@
|
||||
'\"
|
||||
'\" $Id: tixScrolledText.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixScrolledText n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixScrolledText \- Create and manipulate Tix ScrolledText widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixScrolledText \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-anchor \-background \-cursor
|
||||
\-relief \-borderWidth
|
||||
.SE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -height height Height
|
||||
Specifies the desired height for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-scrollbar scrollbar Scrollbar
|
||||
Specifies the display policy of the scrollbars. The following
|
||||
values are recognized:
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fBauto \fR?\fI+x\fR? ?\fI\-x\fR? ?\fI+y\fR? ?\fI\-y\fR?
|
||||
'\"
|
||||
When \fB\-scrollbar\fR is set to "\fBauto\fR", the scrollbars are
|
||||
shown only when needed. Additional modifiers can be used to force a
|
||||
scrollbar to be shown or hidden. For example, "\fBauto \-y\fR" means
|
||||
the horizontal scrollbar should be shown when needed but the vertical
|
||||
scrollbar should always be hidden; "\fBauto +x\fR" means the vertical
|
||||
scrollbar should be shown when needed but the horizontal scrollbar
|
||||
should always be shown, and so on.
|
||||
'\"
|
||||
.TP
|
||||
\fBboth\fR
|
||||
Both scrollbars are shown
|
||||
'\"
|
||||
.TP
|
||||
\fBnone\fR
|
||||
The scrollbars are never shown.
|
||||
'\"
|
||||
.TP
|
||||
\fBx\fR
|
||||
Only the horizontal scrollbar is shown;
|
||||
'\"
|
||||
.TP
|
||||
\fBy\fR
|
||||
Only the vertical scrollbar is shown.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -width width Width
|
||||
Specifies the desired width for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBtext\fR
|
||||
Class: \fBText\fR
|
||||
.fi
|
||||
.IP
|
||||
The Text subwidget inside the ScrolledText widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledText\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a ScrolledText widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
ScrolledText widget such as its cursor and relief.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledText\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the ScrolledText widget's window. This
|
||||
command may be used to invoke various
|
||||
operations on the widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as
|
||||
the ScrolledText widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for ScrolledText widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixScrolledText\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If
|
||||
no \fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixScrolledText\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no additional arguments are given, returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When no additional arguments are given, the widget command of the
|
||||
specified subwidget will be called with these parameters.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
237
man/tixScrolledWindow.n
Normal file
237
man/tixScrolledWindow.n
Normal file
@@ -0,0 +1,237 @@
|
||||
'\"
|
||||
'\" $Id: tixScrolledWindow.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixScrolledWindow n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixScrolledWindow \- Create and manipulate Tix ScrolledWindow widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixScrolledWindow \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-anchor \-background \-cursor
|
||||
\-relief \-borderWidth
|
||||
.SE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -height height Height
|
||||
Specifies the desired height for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-scrollbar scrollbar Scrollbar
|
||||
Specifies the display policy of the scrollbars. The following
|
||||
values are recognized:
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fBauto \fR?\fI+x\fR? ?\fI\-x\fR? ?\fI+y\fR? ?\fI\-y\fR?
|
||||
'\"
|
||||
When \fB\-scrollbar\fR is set to "\fBauto\fR", the scrollbars are
|
||||
shown only when needed. Additional modifiers can be used to force a
|
||||
scrollbar to be shown or hidden. For example, "\fBauto \-y\fR" means
|
||||
the horizontal scrollbar should be shown when needed but the vertical
|
||||
scrollbar should always be hidden; "\fBauto +x\fR" means the vertical
|
||||
scrollbar should be shown when needed but the horizontal scrollbar
|
||||
should always be shown, and so on.
|
||||
'\"
|
||||
.TP
|
||||
\fBboth\fR
|
||||
Both scrollbars are shown
|
||||
'\"
|
||||
.TP
|
||||
\fBnone\fR
|
||||
The scrollbars are never shown.
|
||||
'\"
|
||||
.TP
|
||||
\fBx\fR
|
||||
Only the horizontal scrollbar is shown;
|
||||
'\"
|
||||
.TP
|
||||
\fBy\fR
|
||||
Only the vertical scrollbar is shown.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -width width Width
|
||||
Specifies the desired width for the window, in pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -xscrollincrement xScrollIncrement ScrollIncrement
|
||||
Specifies by how much the window should be scrolled in the horizontal
|
||||
direction when the user presses the arrows in the horizontal
|
||||
scrollbar. In Pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -yscrollincrement yScrollIncrement ScrollIncrement
|
||||
Specifies by how much the window should be scrolled in the vertical
|
||||
direction when the user presses the arrows in the horizontal
|
||||
scrollbar. In pixels.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBwindow\fR
|
||||
Class: \fBFrame\fR
|
||||
.fi
|
||||
.IP
|
||||
The frame subwidget which is scrolled by the ScrolledWindow widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledWindow\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a ScrolledWindow widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
ScrolledWindow widget such as its cursor and relief.
|
||||
'\"
|
||||
.SH CREATING WIDGETS INSIDE A SCROLLEDWINDOW WIDGET
|
||||
.PP
|
||||
'\"
|
||||
To create widgets inside a ScrolledWindow widget, one must create the
|
||||
new widgets relative to the \fBwindow\fR subwidget and manage them
|
||||
inside the \fBwindow\fR subwidget. An error will be generated if one
|
||||
tries to create widgets as immediate children of the ScrolledWindow.
|
||||
For example: the following is correct code, which creates new widgets
|
||||
inside the window subwidget:
|
||||
.PP
|
||||
.nf
|
||||
tixScrolledWindow .w; pack .w
|
||||
set f [.w subwidget window]
|
||||
button $f.b \-text hi \-width 40 \-height 40
|
||||
pack $f.b
|
||||
.fi
|
||||
.PP
|
||||
The following example code is \fIincorrect\fR because it tries to
|
||||
create immediate children of the ScrolledWindow \fB\.w\fR:
|
||||
.PP
|
||||
.nf
|
||||
tixScrolledWindow .w; pack .w
|
||||
button .w.b \-text hi \-width 40 \-height 40
|
||||
pack .w.b
|
||||
.fi
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixScrolledWindow\fR command creates a new Tcl command whose
|
||||
name is the same as the path name of the ScrolledWindow widget's window. This
|
||||
command may be used to invoke various
|
||||
operations on the widget. It has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as
|
||||
the ScrolledWindow widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for ScrolledWindow widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixScrolledWindow\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If
|
||||
no \fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixScrolledWindow\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no additional arguments are given, returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When no additional arguments are given, the widget command of the
|
||||
specified subwidget will be called with these parameters.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n)
|
||||
|
||||
|
||||
|
||||
321
man/tixSelect.n
Normal file
321
man/tixSelect.n
Normal file
@@ -0,0 +1,321 @@
|
||||
'\"
|
||||
'\" $Id: tixSelect.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixSelect n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixSelect \- Create and manipulate tixSelect widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixSelect \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixSelect\fR class is derived from the \fBTixLabelWidget\fR
|
||||
class and inherits all the commands, options and
|
||||
subwidgets of its super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
The Select widget supports all the standard options of a frame widget.
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-allowzero allowZero AllowZero
|
||||
A boolean value that specifies whether the selection can be empty.
|
||||
When set to false, at least one button subwidget must be selected at
|
||||
any time.
|
||||
|
||||
\fBNote\fR: When the Select widget is first constructed, the default
|
||||
selection is always empty, even if \fB\-allowzero\fR is set to
|
||||
\fBfalse\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-buttontype buttonType ButtonType
|
||||
The type of buttons to be used as subwidgets inside the Select widget.
|
||||
By default, the standard Tk \fBbutton\fR widget class is used.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the TCL command to be executed when the \fB\-value\fR of the
|
||||
Select widget is changed. This command will be invoked with
|
||||
two arguments. The first is the name of the button subwidget that has
|
||||
toggled. The second is a boolean value indicating whether the button
|
||||
subwidget is selected. This command is executed only when the
|
||||
\fB\-disableCallback\fR option is set to false.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-disablecallback disableCallback DisableCallback
|
||||
A boolean value indicating whether callbacks should be disabled. When
|
||||
set to true, the TCL command specified by the \fB\-command\fR option
|
||||
is not executed when the \fB\-value\fR of the Select widget
|
||||
changes.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBorientation\fR
|
||||
Class: \fBOrientation\fR
|
||||
Switch: \fB\-orientation\fR
|
||||
Alias: \fB\-orient\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the orientation of the button subwidgets. Only the values
|
||||
\fBhorizontal\fR and \fBvertical\fR are recognized. This is a
|
||||
\fIstatic option\fR and it can only be assigned during the creation of
|
||||
the widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-label label Label
|
||||
Specifies the string to display as the label of this Select widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-labelside labelSide LabelSide
|
||||
Specifies where the label should be displayed relative to the Select
|
||||
widget. Valid options are: \fBtop\fR, \fBleft\fR, \fBright\fR,
|
||||
\fBbottom\fR, \fBnone\fR or \fBacrosstop\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padX Pad
|
||||
Specifies the horizontal padding between two neighboring button
|
||||
subwidgets. This is a \fIstatic option\fR and it can only be assigned
|
||||
during the creation of the widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padY Pad
|
||||
Specifies the vertical padding between two neighboring button
|
||||
subwidgets. This is a \fIstatic option\fR and it can only be assigned
|
||||
during the creation of the widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-radio radio Radio
|
||||
A boolean value that specifies whether the Select widget
|
||||
should act as a radio-box. When set to true, at most one button
|
||||
subwidget can be selected at any time. This is a \fIstatic option\fR
|
||||
and it can only be assigned during the creation of the widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selectedbg selectedBg SelectedBg
|
||||
Specifies the background color of all the selected button subwidgets.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the state of all the buttons inside the Select widget. Only
|
||||
the values \fBnormal\fR and \fBdisabled\fR are recognized. When the
|
||||
state is set to \fBdisabled\fR, all user actions on this Select widget
|
||||
are ignore.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-validatecmd validateCmd ValidateCmd
|
||||
Specifies a TCL command to be called when the -value of the
|
||||
Select widget is about to change. This command is called with
|
||||
one parameter -- the new \fB\-value\fR entered by the user. This
|
||||
command is to validate this new value by returning a value it deems
|
||||
valid.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-value value Value
|
||||
The value of a Select widget is a list of the names of the
|
||||
button subwidgets that have been selected by the user.
|
||||
|
||||
When you assign the value of a Select widget using the "config -value"
|
||||
widget command, the TCL command specified by the \fB\-command\fR
|
||||
option will be invoked if some button subwidgets are toggled.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-variable variable Variable
|
||||
Specifies the global variable in which the value of the Select widget
|
||||
should be stored. The value of a Select widget is stored as a list of
|
||||
the names of the button subwidgets that have been selected by the
|
||||
user. The value of the Select widget will be automatically updated
|
||||
when this variable is changed.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
.PP
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBlabel\fR
|
||||
Class: \fBLabel\fR
|
||||
.fi
|
||||
.IP
|
||||
The label subwidget.
|
||||
'\"----------END
|
||||
.PP
|
||||
In addition, all the button subwidgets created as a result of the
|
||||
\fBadd\fR widget command can be accessed by the \fBsubwidget\fR
|
||||
command. They are identified by the \fIbuttonName\fR parameter to the
|
||||
\fBadd\fR widget command. Here is an example:
|
||||
.PP
|
||||
.CS
|
||||
set s [tixSelect .s]
|
||||
pack $s
|
||||
$s add eat -text Eat
|
||||
$s add sleep -text Sleep
|
||||
$s subwidget eat config -fg green
|
||||
$s subwidget sleep config -fg red
|
||||
.CE
|
||||
'\"
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixSelect\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a Select widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
Select widget such as its cursor and relief.
|
||||
|
||||
The Select widget is a container of button subwidgets. It can
|
||||
be used to provide radio-box or check-box style of selection options
|
||||
for the user.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixSelect\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the Select widget's window. This
|
||||
command may be used to invoke various operations on the widget. It
|
||||
has the following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
Select widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for Select widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBadd\fI buttonName \fR?\fIoption value ... \fR?
|
||||
'\"
|
||||
Adds a new button subwidget with the name \fIbuttonName\fR into the
|
||||
Select widget. Additional configuration options can be given
|
||||
to configure the new button subwidget.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixSelect\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixSelect\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinvoke\fI buttonName\fR
|
||||
'\"
|
||||
Invokes the button subwidget with the name \fIbuttonName\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget\fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, returns the pathname of the subwidget of
|
||||
the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget will
|
||||
be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
'\"
|
||||
When the user presses the left mouse button over the a button
|
||||
subwidget, it will be toggled and the \fB\-value\fR option of the
|
||||
tixSelect widget will be changed.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
'\"
|
||||
The following example creates a radio-box style iconbar for the user
|
||||
to choose one value among \fBeat\fR, \fBwork\fR or \fBsleep\fR.
|
||||
.PP
|
||||
.CS
|
||||
set s [tixSelect .s \-radio true \-allowzero false]
|
||||
$s add eat \-bitmap [tix getbitmap eat]
|
||||
$s add work \-bitmap [tix getbitmap work]
|
||||
$s add sleep \-bitmap [tix getbitmap sleep]
|
||||
.CE
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), Container Widget
|
||||
|
||||
|
||||
|
||||
210
man/tixStdButtonBox.n
Normal file
210
man/tixStdButtonBox.n
Normal file
@@ -0,0 +1,210 @@
|
||||
'\"
|
||||
'\" $Id: tixStdButtonBox.n,v 1.1 2001/01/22 07:59:14 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixStdButtonBox n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixStdButtonBox \- Create and manipulate Tix StdButtonBox widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixStdButtonBox \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
\-anchor \-background \-cursor
|
||||
\-relief \-borderWidth
|
||||
.SE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -orientation orientation Orientation
|
||||
\fBStatic Option\fR. Specifies the orientation of the button
|
||||
subwidgets. Only the values "horizontal" and "vertical" are recognized.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padx Pad
|
||||
Specifies the horizontal padding between two neighboring button
|
||||
subwidgets in the StdButtonBox widget.
|
||||
'\"----------END
|
||||
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padx Pad
|
||||
Specifies the vertical padding between two neighboring button
|
||||
subwidgets in the StdButtonBox widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies the state of all the buttons inside the StdButtonBox widget.
|
||||
|
||||
\fINote\fR:
|
||||
Setting this option using the \fIconfig\fR widget command will enable
|
||||
or disable all the buttons subwidgets. Original states of the
|
||||
individual buttons are \fInot\fR saved.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
.PP
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBok\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The first button subwidget. By default it displays the text string "Ok"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBapply\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The second button subwidget. By default it displays the text string "Apply"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBcancel\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The third button subwidget. By default it displays the text string "Cancel"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhelp\fR
|
||||
Class: \fBButton\fR
|
||||
.fi
|
||||
.IP
|
||||
The fourth button subwidget. By default it displays the text string "Help"
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixStdButtonBox\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a StdButtonBox widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the StdButtonBox
|
||||
such as its cursor and relief.
|
||||
'\"
|
||||
.PP
|
||||
The StdButtonBox widget is a group of Standard buttons for Motif-like
|
||||
dialog boxes.
|
||||
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET COMMAND"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixStdButtonBox\fR command creates a new Tcl command whose name is
|
||||
the same as the path name of the StdButtonBox's window. This command may
|
||||
be used to invoke various operations on the widget. It has the
|
||||
following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as
|
||||
the StdButtonBox widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for StdButtonBox widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixStdButtonBox\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixStdButtonBox\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinvoke \fIbuttonName\fR
|
||||
'\"
|
||||
Invoke the button subwidget with the name \fIbuttonName\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no additional arguments are given, returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
.PP
|
||||
When no additional arguments are given, the widget command of the
|
||||
specified subwidget will be called with these parameters.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
TixStdButtonBox widgets have no default bindings. The button subwidgets
|
||||
retain their default Tk bindings.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), Container Widgets
|
||||
|
||||
|
||||
|
||||
583
man/tixTList.n
Normal file
583
man/tixTList.n
Normal file
@@ -0,0 +1,583 @@
|
||||
'\"
|
||||
'\" $Id: tixTList.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixTList n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixTList \- Create and manipulate Tix Tabular List widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixTList \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SO
|
||||
'\"
|
||||
\-background \-borderWidth \-cursor \-foreground
|
||||
\-font \-height \-highlightColor \-highlightThickness
|
||||
\-relief \-selectBackground \-selectForeground
|
||||
\-xScrollCommand \-yScrollCommand \-width
|
||||
.SE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browsecmd BrowseCmd
|
||||
Specifies a TCL command to be executed when the user browses through the
|
||||
entries in the TList widget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies the TCL command to be executed when the user invokes a list
|
||||
entry in the TList widget. Normally the user invokes a list
|
||||
entry by double-clicking it or pressing the Return key.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP -foreground foreground Foreground
|
||||
Specifies the default foreground color for the list entries.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-height height Height
|
||||
Specifies the desired height for the window in number of characters.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-itemtype itemType ItemType
|
||||
Specifies the default type of display item for this TList widget. When
|
||||
you call the \fBinsert\fR widget commands, display items of this
|
||||
type will be created if the \fB\-itemtype\fR option is not specified .
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-orient orient Orient
|
||||
Specifies the order of tabularizing the list entries. When set to
|
||||
"\fBvertical\fR", the entries are arranged in a column, from top to
|
||||
bottom. If the entries cannot be contained in one column, the
|
||||
remaining entries will go to the next column, and so on. When set to
|
||||
"\fBhorizontal\fR", the entries are arranged in a row, from left to
|
||||
right. If the entries cannot be contained in one row, the remaining
|
||||
entries will go to the next row, and so on.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padX Pad
|
||||
The default horizontal padding for list entries.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-padx padY Pad
|
||||
The default vertical padding for list entries.
|
||||
'\"----------END
|
||||
'\"----------BEGIN
|
||||
.OP \-selectbackground selectBackground SelectBackground
|
||||
Specifies the background color for the selected list entries.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selectborderwidth selectBorderWidth BorderWidth
|
||||
Specifies a non-negative value indicating the width of the 3-D border
|
||||
to draw around selected items. The value may have any of the forms
|
||||
acceptable to \fBTk_GetPixels\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selectforeground selectForeground SelectForeground
|
||||
Specifies the foreground color for the selected list entries.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-selectmode selectMode SelectMode
|
||||
Specifies one of several styles for manipulating the selection. The
|
||||
value of the option may be arbitrary, but the default bindings expect
|
||||
it to be either \fBsingle\fR, \fBbrowse\fR, \fBmultiple\fR, or
|
||||
\fBextended\fR; the default value is \fBsingle\fR.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-sizecmd sizeCmd SizeCmd
|
||||
Specifies a TCL script to be called whenever the TList widget
|
||||
changes its size. This command can be useful to implement "user scroll
|
||||
bars when needed" features.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-state state State
|
||||
Specifies whether the TList command should react to user actions. When
|
||||
set to "\fBnormal\fR", the TList reacts to user actions in the normal
|
||||
way. When set to "\fBdisabled\fR", the TList can only be scrolled, but
|
||||
its entries cannot be selected or activated.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-width width Width
|
||||
Specifies the desired width for the window in characters.
|
||||
'\"----------END
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixTList\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a TList widget.
|
||||
Additional options, described above, may be specified on the command
|
||||
line or in the option database to configure aspects of the
|
||||
TList widget such as its cursor and relief.
|
||||
'\"
|
||||
.PP
|
||||
The TList widget can be used to display data in a tabular format. The
|
||||
list entries of a TList widget are similar to the entries in the Tk
|
||||
listbox widget. The main differences are (1) the TList widget can
|
||||
display the list entries in a two dimensional format and (2) you can
|
||||
use graphical images as well as multiple colors and fonts for
|
||||
the list entries.
|
||||
'\"
|
||||
.PP
|
||||
Each list entry is identified by an \fBindex\fR, which can be in the
|
||||
following forms:
|
||||
.RS
|
||||
.TP
|
||||
\fInumber\fR
|
||||
'\"
|
||||
An integer that indicates the position of the entry in the list. 0
|
||||
means the first position, 1 means the second position, and so on.
|
||||
'\"
|
||||
.TP
|
||||
\fBend\fR
|
||||
'\"
|
||||
Indicates the end of the listbox. For some commands this means just
|
||||
after the last entry; for other commands it means the last entry.
|
||||
'\"
|
||||
.TP
|
||||
\fB@\fR\fIx\fR,\fIy\fR
|
||||
'\"
|
||||
Indicates the element that covers the point in the listbox window
|
||||
specified by x and y (in pixel coordinates). If no element covers that
|
||||
point, then the closest element to that point is used.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
.SH "DISPLAY ITEMS"
|
||||
.PP
|
||||
Each list entry in an TList widget is associated with a \fBdisplay
|
||||
item\fR. The display item determines what visual information should
|
||||
be displayed for this list entry. Please see the \fBtixDisplayStyle\fR manual
|
||||
page for a list of all display items.
|
||||
'\"
|
||||
.PP
|
||||
When a list entry is created by the \fBinsert\fR command, the type of
|
||||
its display item is determined by the \fB\-itemtype\fR option passed
|
||||
to these commands. If the \fB\-itemtype\fR is omitted, then by default
|
||||
the type specified by this TList widget's \fB\-itemtype\fR option is
|
||||
used.
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET COMMAND"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixTList\fR command creates a new Tcl command whose name is the
|
||||
same as the path name of the TList widget's window. This command
|
||||
may be used to invoke various operations on the widget. It has the
|
||||
following general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as
|
||||
the TList widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following
|
||||
commands are possible for TList widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBanchor set \fIindex\fR
|
||||
'\"
|
||||
Sets the anchor to the list entry identified by \fIindex\fR. The
|
||||
anchor is the end of the selection that is fixed while dragging out a
|
||||
selection with the mouse.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBanchor clear\fR
|
||||
'\"
|
||||
Removes the anchor, if any, from this TList widget. This only removes
|
||||
the surrounding highlights of the anchor entry and does not affect its
|
||||
selection status.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixTList\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixTList\fR command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdelete\fR \fIfrom\fR ?\fIto\fR?
|
||||
Deletes one or more list entries between the two entries specified by
|
||||
the indices \fIfrom\fR and \fIto\fR. If \fIto\fR is not specified, deletes
|
||||
the single entry specified by \fIfrom\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdragsite set \fIindex\fR
|
||||
'\"
|
||||
Sets the dragsite to the list entry identified by
|
||||
\fIindex\fR. The dragsite is used to indicate the source of a
|
||||
drag-and-drop action. Currently drag-and-drop functionality has not
|
||||
been implemented in Tix yet.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdragsite clear\fR
|
||||
Remove the dragsite, if any, from the this TList widget. This only
|
||||
removes the surrounding highlights of the dragsite entry and does not
|
||||
affect its selection status.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdropsite set \fIindex\fR
|
||||
'\"
|
||||
Sets the dropsite to the list entry identified by \fIindex\fR. The
|
||||
dropsite is used to indicate the target of a grag-and-drop
|
||||
action. Currently drag-and-drop functionality has not been implemented
|
||||
in Tix yet.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBdropsite clear\fR
|
||||
'\"
|
||||
Remove the dropsite, if any, from the this TList widget. This only
|
||||
removes the surrounding highlights of the dropsite entry and does not
|
||||
affect its selection status.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBentrycget\fR \fIindex option\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR for the entry indentfied by \fIindex\fR. \fIOption\fR may
|
||||
have any of the values accepted by the \fBinsert\fR widget command.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBentryconfigure\fI index \fR?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the list entry indentfied
|
||||
by \fIindex\fR. If no \fIoption\fR is specified, returns a list
|
||||
describing all of the available options for \fIindex\fR (see
|
||||
\fBTk_ConfigureInfo\fR for information on the format of this list). If
|
||||
\fIoption\fR is specified with no \fIvalue\fR, then the command
|
||||
returns a list describing the one named option (this list will be
|
||||
identical to the corresponding sublist of the value returned if no
|
||||
\fIoption\fR is specified). If one or more \fIoption\-value\fR pairs
|
||||
are specified, then the command modifies the given option(s) to have
|
||||
the given value(s); in this case the command returns an empty string.
|
||||
\fIOption\fR may have any of the values accepted by the \fBinsert\fR
|
||||
widget command. The exact set of options depends on the
|
||||
value of the \fB\-itemtype\fR option passed to the the \fBinsert\fR
|
||||
widget command when this list entry is created.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinsert\fI index \fR?\fIoption value ...\fR?
|
||||
'\"
|
||||
Creates a new list entry at the position indicated by \fIindex\fR. The
|
||||
following configuration options can be given to configure the list
|
||||
entry:
|
||||
'\"
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fB\-itemtype\fI type\fR
|
||||
'\"
|
||||
Specifies the type of display item to be display for the new list
|
||||
entry. \fItype\fR must be a valid display item type. Currently the
|
||||
available display item types are \fBimage\fR, \fBimagetext\fR,
|
||||
\fBtext\fR, and \fBwindow\fR. If this option is not specified, then by
|
||||
default the type specified by this TList widget's \fB\-itemtype\fR
|
||||
option is used.
|
||||
'\"
|
||||
.TP
|
||||
\fB\-state\fR
|
||||
'\"
|
||||
Specifies whether this entry can be selected or invoked by the user.
|
||||
Must be either \fBnormal\fR or \fBdisabled\fR.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
The \fBinsert\fR widget command accepts additional configuration options
|
||||
to configure the display item associated with this list entry. The set
|
||||
of additional configuration options depends on the type of the display
|
||||
item given by the \fB\-itemtype\fR option. Please see the
|
||||
\fBtixDisplayStyle\fR manual page for a list of the configuration options for
|
||||
each of the display item types.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinfo \fIoption\fR \fIarg ...\fR
|
||||
'\"
|
||||
Query information about the TList widget. \fIoption\fR can be one
|
||||
of the following:
|
||||
.RS
|
||||
.TP
|
||||
\fIpathName \fBinfo anchor\fR \fIindex\fR
|
||||
;
|
||||
Returns the index of the current anchor, if any, of the TList
|
||||
widget. If the anchor is not set, returns the empty string.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinfo dragsite\fR \fIindex\fR
|
||||
Returns the index of the current dragsite, if any, of the TList
|
||||
widget. If the dragsite is not set, returns the empty string.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinfo dropsite\fR \fIindex\fR
|
||||
Returns the index of the current dropsite, if any, of the TList
|
||||
widget. If the dropsite is not set, returns the empty string.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBinfo selection\fR
|
||||
'\"
|
||||
Returns a list of selected elements in the TList widget. If no entries
|
||||
are selectd, returns an empty string.
|
||||
.RE
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBnearest \fIx y\fR
|
||||
'\"
|
||||
Given an (x,y) coordinate within the TList window, this command
|
||||
returns the index of the TList element nearest to that coordinate.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsee \fIindex\fR
|
||||
'\"
|
||||
Adjust the view in the TList so that the entry given by \fIindex\fR is
|
||||
visible. If the entry is already visible then the command has no
|
||||
effect; if the entry is near one edge of the window then the TList
|
||||
scrolls to bring the element into view at the edge; otherwise the
|
||||
TList widget scrolls to center the entry.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBselection \fIoption\fR \fIarg ...\fR
|
||||
'\"
|
||||
This command is used to adjust the selection within a TList widget. It
|
||||
has several forms, depending on \fIoption\fR:
|
||||
.RS
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBselection clear \fR?\fIfrom\fR? ?\fIto\fR?
|
||||
'\"
|
||||
When no extra arguments are given, deselects all of the list entrie(s)
|
||||
in this TList widget. When only \fIfrom\fR is given, only the list
|
||||
entry identified by \fIfrom\fR is deselected. When both \fIfrom\fR and
|
||||
\fIto\fR are given, deselects all of the list entrie(s) between
|
||||
between \fIfrom\fR and \fIto\fR, inclusive, without affecting the
|
||||
selection state of entries outside that range.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBselection includes \fIindex\fR
|
||||
'\"
|
||||
Returns 1 if the list entry indicated by \fIindex\fR is currently
|
||||
selected; returns 0 otherwise.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBselection set \fIfrom\fR ?\fIto\fR?
|
||||
'\"
|
||||
Selects all of the list entrie(s) between between \fIfrom\fR and
|
||||
\fIto\fR, inclusive, without affecting the selection state of entries
|
||||
outside that range. When only \fIfrom\fR is given, only the list entry
|
||||
identified by \fIfrom\fR is selected.
|
||||
.RE
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBxview \fIargs\fR
|
||||
This command is used to query and change the horizontal position of the
|
||||
information in the widget's window. It can take any of the following
|
||||
forms:
|
||||
.RS
|
||||
.TP
|
||||
\fIpathName \fBxview\fR
|
||||
'\"
|
||||
Returns a list containing two elements. Each element is a real
|
||||
fraction between 0 and 1; together they describe the horizontal span
|
||||
that is visible in the window. For example, if the first element is .2
|
||||
and the second element is .6, 20% of the TList entry is
|
||||
off-screen to the left, the middle 40% is visible in the window, and
|
||||
40% of the entry is off-screen to the right. These are the same values
|
||||
passed to scrollbars via the \fB\-xscrollcommand\fR option.
|
||||
.TP
|
||||
\fIpathName \fBxview\fR \fIindex\fR
|
||||
'\"
|
||||
Adjusts the view in the window so that the list entry identified by
|
||||
\fIindex\fR is aligned to the left edge of the window.
|
||||
.TP
|
||||
\fIpathName \fBxview moveto\fI fraction\fR
|
||||
'\"
|
||||
Adjusts the view in the window so that \fIfraction\fR of the total
|
||||
width of the TList is off-screen to the left. \fIfraction\fR must be
|
||||
a fraction between 0 and 1.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBxview scroll \fInumber what\fR
|
||||
'\"
|
||||
This command shifts the view in the window left or right according to
|
||||
\fInumber\fR and \fIwhat\fR. \fINumber\fR must be an integer.
|
||||
\fIWhat\fR must be either \fBunits\fR or \fBpages\fR or an
|
||||
abbreviation of one of these. If \fIwhat\fR is \fBunits\fR, the view
|
||||
adjusts left or right by \fInumber\fR character units (the width of
|
||||
the \fB0\fR character) on the display; if it is \fBpages\fR then the
|
||||
view adjusts by \fInumber\fR screenfuls. If \fInumber\fR is negative
|
||||
then characters farther to the left become visible; if it is positive
|
||||
then characters farther to the right become visible.
|
||||
'\"
|
||||
.RE
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fByview \fI?args\fR?
|
||||
'\"
|
||||
This command is used to query and change the vertical position of the
|
||||
entries in the widget's window. It can take any of the following forms:
|
||||
'\"
|
||||
.RS
|
||||
.TP
|
||||
\fIpathName \fByview\fR
|
||||
'\"
|
||||
Returns a list containing two elements, both of which are real
|
||||
fractions between 0 and 1. The first element gives the position of
|
||||
the list element at the top of the window, relative to the TList as a
|
||||
whole (0.5 means it is halfway through the TList, for example). The
|
||||
second element gives the position of the list entry just after the
|
||||
last one in the window, relative to the TList as a whole. These are
|
||||
the same values passed to scrollbars via the \fB\-yscrollcommand\fR
|
||||
option.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fByview\fR \fIindex\fR
|
||||
'\"
|
||||
Adjusts the view in the window so that the list entry given by
|
||||
\fIindex\fR is displayed at the top of the window.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fByview moveto\fI fraction\fR
|
||||
'\"
|
||||
Adjusts the view in the window so that the list entry given by
|
||||
\fIfraction\fR appears at the top of the window. \fIFraction\fR is a
|
||||
fraction between 0 and 1; 0 indicates the first entry in the TList,
|
||||
0.33 indicates the entry one-third the way through the TList, and so
|
||||
on.
|
||||
.TP
|
||||
\fIpathName \fByview scroll \fInumber what\fR
|
||||
'\"
|
||||
This command adjust the view in the window up or down according to
|
||||
\fInumber\fR and \fIwhat\fR. \fINumber\fR must be an integer.
|
||||
\fIWhat\fR must be either \fBunits\fR or \fBpages\fR. If \fIwhat\fR
|
||||
is \fBunits\fR, the view adjusts up or down by \fInumber\fR lines; if
|
||||
it is \fBpages\fR then the view adjusts by \fInumber\fR screenfuls.
|
||||
If \fInumber\fR is negative then earlier entries become visible; if
|
||||
it is positive then later entries become visible.
|
||||
.RE
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
.IP [1]
|
||||
If the \fB\-selectmode\fR is "browse", when the user drags the mouse
|
||||
pointer over the list entries, the entry under the pointer will be
|
||||
highlighted and the \fB\-browsecmd\fR procedure will be called with
|
||||
one parameter, the index of the highlighted entry. Only one entry
|
||||
can be highlighted at a time. The \fB\-command\fR procedure will be
|
||||
called when the user double-clicks on a list entry.
|
||||
'\"
|
||||
.IP [2]
|
||||
If the \fB\-selectmode\fR is "single", the entries will only be
|
||||
highlighted by mouse <ButtonRelease-1> events. When a new list entry
|
||||
is highlighted, the \fB\-browsecmd\fR procedure will be called with
|
||||
one parameter indicating the highlighted list entry. The
|
||||
\fB\-command\fR procedure will be called when the user double-clicks
|
||||
on a list entry.
|
||||
'\"
|
||||
'\"
|
||||
.IP [3]
|
||||
If the \fB\-selectmode\fR is "multiple", when the user drags the mouse
|
||||
pointer over the list entries, all the entries under the pointer will
|
||||
be highlighted. However, only a contiguous region of list entries can
|
||||
be selected. When the highlighted area is changed, the
|
||||
\fB\-browsecmd\fR procedure will be called with an undefined
|
||||
parameter. It is the responsibility of the \fB\-browsecmd\fR procedure
|
||||
to find out the exact highlighted selection in the TList. The
|
||||
\fB\-command\fR procedure will be called when the user double-clicks
|
||||
on a list entry.
|
||||
'\"
|
||||
.IP [4]
|
||||
'\"
|
||||
If the \fB\-selectmode\fR is "extended", when the user drags the mouse
|
||||
pointer over the list entries, all the entries under the pointer will
|
||||
be highlighted. The user can also make disjointed selections using
|
||||
<Control-ButtonPress-1>. When the highlighted area is changed, the
|
||||
\fB\-browsecmd\fR procedure will be called with an undefined
|
||||
parameter. It is the responsibility of the \fB\-browsecmd\fR procedure
|
||||
to find out the exact highlighted selection in the TList. The
|
||||
\fB\-command\fR procedure will be called when the user double-clicks
|
||||
on a list entry.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH EXAMPLE
|
||||
.PP
|
||||
This example demonstrates how to use an TList to store a list of
|
||||
numbers:
|
||||
.PP
|
||||
.CS
|
||||
set image [tix getimage folder]
|
||||
set t [tixTList .t -orient vertical]
|
||||
$t insert end -itemtype imagetext -image $image -text one
|
||||
$t insert end -itemtype imagetext -image $image -text two
|
||||
$t insert end -itemtype imagetext -image $image -text three
|
||||
$t insert end -itemtype imagetext -image $image -text four
|
||||
$t insert end -itemtype imagetext -image $image -text five
|
||||
$t insert end -itemtype imagetext -image $image -text six
|
||||
pack $t -expand yes -fill both
|
||||
.CE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n), Tabular Listbox, Display Items
|
||||
|
||||
|
||||
|
||||
282
man/tixTree.n
Normal file
282
man/tixTree.n
Normal file
@@ -0,0 +1,282 @@
|
||||
'\"
|
||||
'\" $Id: tixTree.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH tixTree n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH NAME
|
||||
tixTree \- Create and manipulate tixTree widgets
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SYNOPSIS
|
||||
\fBtixTree \fIpathName \fR?\fIoptions\fR?
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUPER-CLASS
|
||||
The \fBTixTree\fR class is derived from the \fBTixScrolledHList\fR
|
||||
class and inherits all the commands, options and subwidgets of its
|
||||
super-class.
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "STANDARD OPTIONS"
|
||||
'\"
|
||||
\fBTixTree\fR supports all the standard options of a frame widget.
|
||||
See the \fBoptions(n)\fR manual entry for details on the standard options.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH "WIDGET-SPECIFIC OPTIONS"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-browsecmd browseCmd BrowseCmd
|
||||
Specifies a command to call whenever the user browses on an entry
|
||||
(usually by single-clicking on the entry). The command is called with
|
||||
one argument, the pathname of the entry.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-closecmd closeCmd CloseCmd
|
||||
Specifies a command to call whenever an entry needs to be closed (See
|
||||
the BINDINGS section below). This command is called with one argument,
|
||||
the pathname of the entry. This command should perform appropriate
|
||||
actions to close the specified entry. If the \fB\-closecmd\fR option
|
||||
is not specified, the default closing action is to hide all child
|
||||
entries of the specified entry.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-command command Command
|
||||
Specifies a command to call whenever the user activates an entry
|
||||
(usually by double-clicking on the entry). The command
|
||||
is called with one argument, the pathname of the entry.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.OP \-ignoreinvoke ignoreInvoke IgnoreInvoke
|
||||
A Boolean value that specifies when a branch should be opened or
|
||||
closed. A branch will always be opened or closed when the user presses
|
||||
the (+) and (-) indicators. However, when the user invokes a branch
|
||||
(by doublc-clicking or pressing <Return>), the branch will be opened
|
||||
or closed only if \fB\-ignoreinvoke\fR is set to false (the default
|
||||
setting).
|
||||
'\"----------END
|
||||
'\"
|
||||
|
||||
'\"----------BEGIN
|
||||
.OP \-opencmd openCmd OpenCmd
|
||||
Specifies a command to call whenever an entry needs to be opened (See
|
||||
the BINDINGS section below). This command is called with one argument,
|
||||
the pathname of the entry. This command should perform appropriate
|
||||
actions to open the specified entry. If the \fB\-opencmd\fR option
|
||||
is not specified, the default opening action is to show all the child
|
||||
entries of the specified entry.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH SUBWIDGETS
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhlist\fR
|
||||
Class: \fBTixHList\fR
|
||||
.fi
|
||||
.IP
|
||||
The hierarchical listbox that displays the tree.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBhsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The horizontal scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBvsb\fR
|
||||
Class: \fBScrollbar\fR
|
||||
.fi
|
||||
.IP
|
||||
The vertical scrollbar subwidget.
|
||||
'\"----------END
|
||||
'\"
|
||||
.BE
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH DESCRIPTION
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixTree\fR command creates a new window (given by the
|
||||
\fIpathName\fR argument) and makes it into a Tree widget. Additional
|
||||
options, described above, may be specified on the command line or in
|
||||
the option database to configure aspects of the Tree widget such as its
|
||||
cursor and relief.
|
||||
.PP
|
||||
The Tree widget can be used to display hierachical data in a tree
|
||||
form. The user can adjust the view of the tree by opening or closing
|
||||
parts of the tree.
|
||||
.PP
|
||||
To display a static tree structure, you can add the entries into the
|
||||
\fBhlist\fR subwidget and hide any entries as desired. Then you can
|
||||
call the \fBautosetmode\fR method. This will set up the Tree widget so
|
||||
that it handles all the \fIopen\fR and \fIclose\fR events
|
||||
automatically.
|
||||
'\"(TODO add an example).
|
||||
.PP
|
||||
The above method is not applicable if you want to maintain a dynamic
|
||||
tree structure, i.e, you do not know all the entries in the tree and
|
||||
you need to add or delete entries subsequently. To do this, you should
|
||||
first create the entries in the \fBhlist\fR subwidget. Then, use the
|
||||
setmode method to indicate the entries that can be opened or closed,
|
||||
and use the \fB\-opencmd\fR and \fB \-closecmd\fR options to handle
|
||||
the opening and closing events.
|
||||
'\"(TODO add an example).
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH WIDGET COMMANDS
|
||||
.PP
|
||||
'\"
|
||||
The \fBtixTree\fR command creates a new Tcl command whose name is the
|
||||
same as the path name of the Tree's window. This command may be used
|
||||
to invoke various operations on the widget. It has the following
|
||||
general form:
|
||||
'\"
|
||||
.RS
|
||||
.CS
|
||||
'\"
|
||||
\fIpathName option \fR?\fIarg arg ...\fR?
|
||||
.CE
|
||||
.RE
|
||||
'\"
|
||||
\fIPathName\fR is the name of the command, which is the same as the
|
||||
Tree widget's path name. \fIOption\fR and the \fIarg\fRs
|
||||
determine the exact behavior of the command. The following commands
|
||||
are possible for Tree widgets:
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBautosetmode\fR
|
||||
'\"
|
||||
This command calls the \fBsetmode\fR method for all the entries in
|
||||
this Tree widget: if an entry has no child entries, its mode is set to
|
||||
\fBnone\fR. Otherwise, if the entry has any hidden child entries, its
|
||||
mode is set to \fBopen\fR; otherwise its mode is set to \fBclose\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBcget\fR \fIoption\fR
|
||||
'\"
|
||||
Returns the current value of the configuration option given by
|
||||
\fIoption\fR. \fIOption\fR may have any of the values accepted by the
|
||||
\fBtixTree\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBclose \fIentryPath\fR
|
||||
'\"
|
||||
Close the entry given by \fIentryPath\fR if its \fImode\fR is \fBclose\fR.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
||||
'\"
|
||||
Query or modify the configuration options of the widget. If no
|
||||
\fIoption\fR is specified, returns a list describing all of the
|
||||
available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
||||
information on the format of this list). If \fIoption\fR is specified
|
||||
with no \fIvalue\fR, then the command returns a list describing the
|
||||
one named option (this list will be identical to the corresponding
|
||||
sublist of the value returned if no \fIoption\fR is specified). If
|
||||
one or more \fIoption\-value\fR pairs are specified, then the command
|
||||
modifies the given widget option(s) to have the given value(s); in
|
||||
this case the command returns an empty string. \fIOption\fR may have
|
||||
any of the values accepted by the \fBtixTree\fR command.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBgetmode \fIentryPath\fR
|
||||
'\"
|
||||
Returns the current \fImode\fR of the entry given by \fIentryPath\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBopen \fIentryPath\fR
|
||||
'\"
|
||||
Open the entry givaen by \fIentryPath\fR if its \fImode\fR is \fBopen\fR.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsetmode \fI entryPath mode\fR
|
||||
'\"
|
||||
This command is used to indicate whether the entry given by
|
||||
\fIentryPath\fR has children entries and whether the children are
|
||||
visible. \fImode\fR must be one of \fBopen\fR,
|
||||
\fBclose\fR or \fBnone\fR. If \fImode\fR is set to \fBopen\fR, a (+)
|
||||
indicator is drawn next the the entry. If \fImode\fR is set to
|
||||
\fBclose\fR, a (-) indicator is drawn next the the entry. If
|
||||
\fImode\fR is set to \fBnone\fR, no indicators will be drawn for this
|
||||
entry. The default \fImode\fR is none. The \fBopen\fR mode indicates
|
||||
the entry has hidden children and this entry can be opened by the
|
||||
user. The \fBclose\fR mode indicates that all the children of the entry
|
||||
are now visible and the entry can be closed by the user.
|
||||
'\"
|
||||
.TP
|
||||
\fIpathName \fBsubwidget \fI name ?args?\fR
|
||||
'\"
|
||||
When no options are given, this command returns the pathname of the
|
||||
subwidget of the specified name.
|
||||
|
||||
When options are given, the widget command of the specified subwidget
|
||||
will be called with these options.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH BINDINGS
|
||||
.PP
|
||||
'\"
|
||||
The basic mouse and keyboard bindings of the Tree widget are the same
|
||||
as the bindings of the HList widget.
|
||||
|
||||
In addition, the entries can be opened or closed under the following
|
||||
conditions:
|
||||
'\"
|
||||
.IP [1]
|
||||
If the \fImode\fR of the entry is \fBopen\fR, it can be opened by clicking
|
||||
on its (+) indicator or double-clicking on the entry.
|
||||
'\"
|
||||
.IP [2]
|
||||
If the \fImode\fR of the entry is \fBclose\fR, it can be closed by clicking
|
||||
on its (-) indicator or double-clicking on the entry.
|
||||
'\"
|
||||
'\"
|
||||
'\"----------------------------------------------------------------------
|
||||
.SH KEYWORDS
|
||||
Tix(n),tixHList(n)
|
||||
|
||||
|
||||
|
||||
83
man/tixUtils.n
Normal file
83
man/tixUtils.n
Normal file
@@ -0,0 +1,83 @@
|
||||
'\"
|
||||
'\" $Id: tixUtils.n,v 1.2 2001/01/22 08:02:45 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
'\"----------------------------------------------------------------------
|
||||
.TH Utils n 4.0 Tix "Tix Built-In Commands"
|
||||
.BS
|
||||
'\"
|
||||
'\"
|
||||
.SH NAME
|
||||
tixUtils \- Utility commands in Tix.
|
||||
'\"
|
||||
'\"
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
.nf
|
||||
\fBtixDescendants \fIpathName\fR
|
||||
\fBtixDisableAll \fIpathName\fR
|
||||
\fBtixEnableAll \fIpathName\fR
|
||||
\fBtixPushGrab\fR ?\fI-global\fR? \fIwindow\fR
|
||||
\fBtixPopGrab\fR
|
||||
.fi
|
||||
.BE
|
||||
.PP
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
.TP
|
||||
\fBtixDescendants\fR \fIpathName\fR
|
||||
'\"
|
||||
Returns a list of all the descendant widgets of \fIpathName\fR plus
|
||||
\fIpathName\fR itself.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixDisableAll\fR \fIpathName\fR
|
||||
'\"
|
||||
Disables \fIpathName\fR and all its descendants.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fBtixEnableAll\fR \fIpathName\fR
|
||||
'\"
|
||||
Enables \fIpathName\fR and all its descendants.
|
||||
'\"
|
||||
'\"
|
||||
.TP
|
||||
\fBtixPushGrab\fR ?\fI-global\fR? \fIwindow\fR
|
||||
'\"
|
||||
The \fBtixPushGrab\fR and \fBtixPopGrab\fR commands allows you to
|
||||
perform "cascade-grabbing". \fBtixPushGrab\fR calls the \fBgrab(n)\fR
|
||||
command on \fIwindow\fR and saves \fIwindow\fR on a grabbing
|
||||
stack.
|
||||
'\"
|
||||
.TP
|
||||
\fBtixPopGrab\fR
|
||||
'\"
|
||||
\fBtixPopGrab\fR pops the top-most element from the grabbing stack and
|
||||
release its grab. If the grabbing stack is not empty, then
|
||||
\fBtixPopGrab\fR will execute grab(n) on the current top-most element
|
||||
in the grabbing stack.
|
||||
'\"
|
||||
.SH NOTES
|
||||
.PP
|
||||
Some Tix widgets (for example, tixComboBox and tixPanedWindow) grabs
|
||||
the screen on certain occasions using \fBtixPushGrab\fR and
|
||||
\fBtixPopGrab\fR. Therefore, if you need to grab the screen when these
|
||||
widgets are present, you should also call \fBtixPushGrab\fR and
|
||||
\fBtixPopGrab\fR in place of the Tk \fBgrab\fR and \fBgrab release\fR
|
||||
commands. Otherwise, the behavior of these widgets may be undefined.
|
||||
'\"
|
||||
.SH KEYWORDS
|
||||
Tix(n), grab(n)
|
||||
198
man/tixwish.1
Normal file
198
man/tixwish.1
Normal file
@@ -0,0 +1,198 @@
|
||||
'\"
|
||||
'\" $Id: tixwish.1,v 1.2 2001/01/22 00:33:19 ioilam Exp $
|
||||
'\"
|
||||
'\"
|
||||
'\" Copyright (c) 1993-1999 Ioi Kim Lam.
|
||||
'\" Copyright (c) 2000-2001 Tix Project Group.
|
||||
'\"
|
||||
'\" See the file "license.terms" for information on usage and redistribution
|
||||
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
||||
'\"
|
||||
'\" The file man.macros and some of the macros used by this file are
|
||||
'\" copyrighted: (c) 1990 The Regents of the University of California.
|
||||
'\" (c) 1994-1995 Sun Microsystems, Inc.
|
||||
'\" The license terms of the Tcl/Tk distrobution are in the file
|
||||
'\" license.tcl.
|
||||
.so man.macros
|
||||
.TH tixwish 1 8.0 Tix "Tix Applications"
|
||||
.BS
|
||||
'\"
|
||||
.SH NAME
|
||||
tixwish \- Windowing shell for interpreting Tix commands.
|
||||
'\"
|
||||
.SH SYNOPSIS
|
||||
\fBtixwish\fR ?\fIfileName arg arg ...\fR?
|
||||
'\"
|
||||
.SH OPTIONS
|
||||
'\"
|
||||
.IP "\fB\-display \fIdisplay\fR" 20
|
||||
Display (and screen) on which to display window.
|
||||
'\"
|
||||
.IP "\fB\-geometry \fIgeometry\fR" 20
|
||||
Initial geometry to use for window. If this option is specified, its
|
||||
value is stored in the \fBgeometry\fR global variable of the application's
|
||||
Tcl interpreter.
|
||||
'\"
|
||||
.IP "\fB\-name \fIname\fR" 20
|
||||
'\"
|
||||
Use \fIname\fR as the title to be displayed in the window, and
|
||||
as the name of the interpreter for \fBsend\fR commands.
|
||||
'\"
|
||||
.IP "\fB\-sync\fR" 20
|
||||
'\"
|
||||
Execute all X server commands synchronously, so that errors are
|
||||
reported immediately. This will result in much slower execution, but
|
||||
it is useful for debugging.
|
||||
.BE
|
||||
|
||||
.SH DESCRIPTION
|
||||
.PP
|
||||
\fBTixwish\fR is a simple program consisting of the Tcl command
|
||||
language, the Tk toolkit, and a main program that reads commands from
|
||||
standard input or from a file. It creates a main window and then
|
||||
processes Tcl commands.
|
||||
'\"
|
||||
If \fBtixwish\fR is invoked with no arguments, or with a first
|
||||
argument that starts with ``\-'', then it reads Tcl commands
|
||||
interactively from standard input.
|
||||
'\"
|
||||
It will continue processing commands until all windows have been
|
||||
deleted or until end-of-file is reached on standard input. If there
|
||||
exists a file \fB.tixwishrc\fR in the home directory of the user,
|
||||
\fBtixwish\fR evaluates the file as a Tcl script just before reading
|
||||
the first command from standard input.
|
||||
'\"
|
||||
.PP
|
||||
'\"
|
||||
If \fBtixwish\fR is invoked with an initial \fIfileName\fR argument,
|
||||
then \fIfileName\fR is treated as the name of a script file.
|
||||
\fBTixwish\fR will evaluate the script in \fIfileName\fR (which
|
||||
presumably creates a user interface), then it will respond to events
|
||||
until all windows have been deleted. Commands will not be read from
|
||||
standard input. There is no automatic evaluation of \fB.tixwishrc\fR
|
||||
in this case, but the script file can always \fBsource\fR it if
|
||||
desired.
|
||||
|
||||
.SH "OPTIONS"
|
||||
.PP
|
||||
\fBTixwish\fR automatically processes all of the command-line options
|
||||
described in the \fBOPTIONS\fR summary above. Any other command-line
|
||||
arguments besides these are passed through to the application using
|
||||
the \fBargc\fR and \fBargv\fR variables described later.
|
||||
|
||||
.SH "APPLICATION NAME AND CLASS"
|
||||
.PP
|
||||
.VS
|
||||
The name of the application, which is used for purposes such as
|
||||
\fBsend\fR commands, is taken from the \fB\-name\fR option,
|
||||
if it is specified; otherwise it is taken from \fIfileName\fR,
|
||||
if it is specified, or from the command name by which
|
||||
\fBtixwish\fR was invoked. In the last two cases, if the name contains a ``/''
|
||||
character, then only the characters after the last slash are used
|
||||
as the application name.
|
||||
.PP
|
||||
The class of the application, which is used for purposes such as
|
||||
specifying options with a \fBRESOURCE_MANAGER\fR property or .Xdefaults
|
||||
file, is the same as its name except that the first letter is
|
||||
capitalized.
|
||||
.VE
|
||||
|
||||
.SH "VARIABLES"
|
||||
.PP
|
||||
\fBTixwish\fR sets the following Tcl variables:
|
||||
.TP 15
|
||||
\fBargc\fR
|
||||
Contains a count of the number of \fIarg\fR arguments (0 if none),
|
||||
not including the options described above.
|
||||
.TP 15
|
||||
\fBargv\fR
|
||||
Contains a Tcl list whose elements are the \fIarg\fR arguments (not
|
||||
including the options described above), in order, or an empty string
|
||||
if there are no \fIarg\fR arguments.
|
||||
.TP 15
|
||||
\fBargv0\fR
|
||||
Contains \fIfileName\fR if it was specified.
|
||||
Otherwise, contains the name by which \fBtixwish\fR was invoked.
|
||||
.TP 15
|
||||
\fBgeometry\fR
|
||||
If the \fB\-geometry\fR option is specified, \fBtixwish\fR copies its
|
||||
value into this variable. If the variable still exists after
|
||||
\fIfileName\fR has been evaluated, \fBtixwish\fR uses the value of
|
||||
the variable in a \fBwm geometry\fR command to set the main
|
||||
window's geometry.
|
||||
.TP 15
|
||||
\fBtcl_interactive\fR
|
||||
'\"
|
||||
Contains 1 if \fBtixwish\fR is reading commands interactively
|
||||
(\fBfileName\fR was not specified and standard input is a
|
||||
terminal-like device), 0 otherwise.
|
||||
'\"
|
||||
.SH "X RESOURCES"
|
||||
'\"
|
||||
\fBTixwish\fR makes use of several X Resources to determine the
|
||||
\fBToolkit Options\fR for the Tix library. These X resources must be
|
||||
set using \fBRESOURCE_MANAGER\fR properties or .Xdefaults files
|
||||
\fBbefore\fR \fBtixwish\fR starts running. These resources must be
|
||||
associated with the main window of the \fBtixwish\fR application.
|
||||
These options include:
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBtixScheme\fR
|
||||
Class: \fBTixScheme\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the color scheme to use for the Tix application. Currently
|
||||
only these schemes are supported: Blue, Gray, SGIGray, TixGray, and
|
||||
TK.
|
||||
'\"----------END
|
||||
'\"
|
||||
'\"----------BEGIN
|
||||
.LP
|
||||
.nf
|
||||
Name: \fBtixFontSet\fR
|
||||
Class: \fBTixFontSet\fR
|
||||
.fi
|
||||
.IP
|
||||
Specifies the FontSet to use for the Tix application. A FontSet
|
||||
designates the fonts to use for different types of widgets. Currently
|
||||
only these FontSets are supported: 12Point, 14Point and TK.
|
||||
'\"----------END
|
||||
.PP
|
||||
For example, you may put these two lines in your .Xdefaults file
|
||||
.nf
|
||||
*tixwish.tixScheme: Gray
|
||||
*tixwish.tixFontSet: 12Point
|
||||
.fi
|
||||
.SH "SCRIPT FILES"
|
||||
.PP
|
||||
If you create a Tcl script in a file whose first line is
|
||||
.RS
|
||||
.CS
|
||||
\fB#!/usr/local/bin/tixwish\fR
|
||||
.CE
|
||||
.RE
|
||||
then you can invoke the script file directly from your shell if you
|
||||
mark it as executable. This assumes that \fBtixwish\fR has been
|
||||
installed in the default location in /usr/local/bin; if it's installed
|
||||
somewhere else then you'll have to modify the above line to match.
|
||||
Many UNIX systems do not allow the \fB#!\fR line to exceed about 30
|
||||
characters in length, so be sure that the \fBtixwish\fR executable can be
|
||||
accessed with a short file name.
|
||||
|
||||
.SH PROMPTS
|
||||
.PP
|
||||
When \fBtixwish\fR is invoked interactively it normally prompts for each
|
||||
command with ``\fB% \fR''. You can change the prompt by setting the
|
||||
variables \fBtcl_prompt1\fR and \fBtcl_prompt2\fR. If variable
|
||||
\fBtcl_prompt1\fR exists then it must consist of a Tcl script to
|
||||
output a prompt; instead of outputting a prompt \fBtixwish\fR will
|
||||
evaluate the script in \fBtcl_prompt1\fR. The variable
|
||||
\fBtcl_prompt2\fR is used in a similar way when a newline is typed but
|
||||
the current command isn't yet complete; if \fBtcl_prompt2\fR isn't set
|
||||
then no prompt is output for incomplete commands.
|
||||
|
||||
.SH KEYWORDS
|
||||
shell, wish, Tk, toolkit
|
||||
|
||||
Reference in New Issue
Block a user