summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorhobbs <hobbs>2000-01-21 03:54:20 (GMT)
committerhobbs <hobbs>2000-01-21 03:54:20 (GMT)
commit45572469ec5bc7b41c213ee56f0a7db17bfc8cb8 (patch)
treeaff1f187fd92c0aad4eaeb0efb5785b290c3d701 /doc
parent626a47c02bd9e449005723dddc9d4f732b591711 (diff)
downloadtk-45572469ec5bc7b41c213ee56f0a7db17bfc8cb8.zip
tk-45572469ec5bc7b41c213ee56f0a7db17bfc8cb8.tar.gz
tk-45572469ec5bc7b41c213ee56f0a7db17bfc8cb8.tar.bz2
* doc/WindowId.3: added docs for Tk_IsContainer and Tk_IsEmbedded
* doc/text.n: clarified mark gravity definition and usage of ``word'' in binding definitions. [Bug: 2004 2277 1388]
Diffstat (limited to 'doc')
-rw-r--r--doc/WindowId.318
-rw-r--r--doc/canvas.n17
-rw-r--r--doc/text.n22
3 files changed, 37 insertions, 20 deletions
diff --git a/doc/WindowId.3 b/doc/WindowId.3
index 020d02a..533a638 100644
--- a/doc/WindowId.3
+++ b/doc/WindowId.3
@@ -5,13 +5,13 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: WindowId.3,v 1.4 1999/04/21 21:53:22 rjohnson Exp $
+'\" RCS: @(#) $Id: WindowId.3,v 1.5 2000/01/21 03:54:20 hobbs Exp $
'\"
.so man.macros
.TH Tk_WindowId 3 "" Tk "Tk Library Procedures"
.BS
.SH NAME
-Tk_WindowId, Tk_Parent, Tk_Display, Tk_DisplayName, Tk_ScreenNumber, Tk_Screen, Tk_X, Tk_Y, Tk_Width, Tk_Height, Tk_Changes, Tk_Attributes, Tk_IsMapped, Tk_IsTopLevel, Tk_ReqWidth, Tk_ReqHeight, Tk_InternalBorderWidth, Tk_Visual, Tk_Depth, Tk_Colormap \- retrieve information from Tk's local data structure
+Tk_WindowId, Tk_Parent, Tk_Display, Tk_DisplayName, Tk_ScreenNumber, Tk_Screen, Tk_X, Tk_Y, Tk_Width, Tk_Height, Tk_Changes, Tk_Attributes, Tk_IsContainer, Tk_IsEmbedded, Tk_IsMapped, Tk_IsTopLevel, Tk_ReqWidth, Tk_ReqHeight, Tk_InternalBorderWidth, Tk_Visual, Tk_Depth, Tk_Colormap \- retrieve information from Tk's local data structure
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
@@ -53,6 +53,12 @@ XSetWindowAttributes *
\fBTk_Attributes\fR(\fItkwin\fR)
.sp
int
+\fBTk_IsContainer\fR(\fItkwin\fR)
+.sp
+int
+\fBTk_IsEmbedded\fR(\fItkwin\fR)
+.sp
+int
\fBTk_IsMapped\fR(\fItkwin\fR)
.sp
int
@@ -120,6 +126,14 @@ applications use Tk procedures like \fBTk_ResizeWindow\fR instead
of X procedures like \fBXResizeWindow\fR, so that Tk can keep its
data structures up-to-date.
.PP
+\fBTk_IsContainer\fR returns a non-zero value if \fItkwin\fR
+is a container, and that some other application may be embedding
+itself inside \fItkwin\fR.
+.PP
+\fBTk_IsEmbedded\fR returns a non-zero value if \fItkwin\fR
+is is not a free-standing window, but rather is embedded in some
+other application.
+.PP
\fBTk_IsMapped\fR returns a non-zero value if \fItkwin\fR
is mapped and zero if \fItkwin\fR isn't mapped.
.PP
diff --git a/doc/canvas.n b/doc/canvas.n
index a07f507..4b2d720 100644
--- a/doc/canvas.n
+++ b/doc/canvas.n
@@ -6,7 +6,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: canvas.n,v 1.5 1999/12/22 23:01:33 hobbs Exp $
+'\" RCS: @(#) $Id: canvas.n,v 1.6 2000/01/21 03:54:20 hobbs Exp $
'\"
.so man.macros
.TH canvas n 8.3 Tk "Tk Built-In Commands"
@@ -47,13 +47,14 @@ Each of the coordinates may be specified
in any of the forms given in the COORDINATES section below.
.OP \-state state State
Modifies the default state of the canvas where \fIstate\fR may be set to
-one of: normal, disabled, or hidden. Individual canvas objects all have
-their own state option, which overrides the default state. Many options can
-take separate specifications such that the appearance of the item can be
-different in different situations. The options that start with "active"
-control the appearence when the mouse pointer is over it, while the option
-starting with "disabled" controls the appearence when the state is
-disabled.
+one of: \fBnormal\fR, \fBdisabled\fR, or \fBhidden\fR. Individual canvas
+objects all have their own state option which may override the default
+state. Many options can take separate specifications such that the
+appearance of the item can be different in different situations. The
+options that start with \fBactive\fR control the appearence when the mouse
+pointer is over it, while the option starting with \fBdisabled\fR controls
+the appearence when the state is disabled. Canvas items which are
+\fBdisabled\fR will not react to canvas bindings.
.OP \-width width width
Specifies a desired window width that the canvas widget should request from
its geometry manager. The value may be specified in any
diff --git a/doc/text.n b/doc/text.n
index 1f43823..d20f070 100644
--- a/doc/text.n
+++ b/doc/text.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: text.n,v 1.4 2000/01/06 02:18:54 hobbs Exp $
+'\" RCS: @(#) $Id: text.n,v 1.5 2000/01/21 03:54:21 hobbs Exp $
'\"
.so man.macros
.TH text n 4.0 Tk "Tk Built-In Commands"
@@ -506,8 +506,8 @@ If a mark has left gravity, then the mark is treated as if it
were attached to the character on its left, so the mark will
remain to the left of any text inserted at the mark position.
If the mark has right gravity, new text inserted at the mark
-position will appear to the right of the mark. The gravity
-for a mark defaults to \fBright\fR.
+position will appear to the left of the mark (so that the mark
+remains rightmost). The gravity for a mark defaults to \fBright\fR.
.PP
The name space for marks is different from that for tags: the
same name may be used for both a mark and a tag, but they will refer
@@ -825,7 +825,7 @@ One or more of the following switches (or abbreviations thereof)
may be specified to control the dump:
.TP
\fB\-all\fR
-Return information about all elements: text, marks, tags, and windows.
+Return information about all elements: text, marks, tags, images and windows.
This is the default.
.TP
\fB\-command \fIcommand\fR
@@ -834,13 +834,16 @@ invoke the \fIcommand\fR on each element of the text widget within the range.
The command has three arguments appended to it before it is evaluated:
the \fIkey\fP, \fIvalue\fP, and \fIindex\fP.
.TP
+\fB\-image\fR
+Include information about images in the dump results.
+.TP
\fB\-mark\fR
Include information about marks in the dump results.
.TP
\fB\-tag\fR
-Include information about tag transitions in the dump results. Tag information is
-returned as \fBtagon\fP and \fBtagoff\fP elements that indicate the
-begin and end of each range of each tag, respectively.
+Include information about tag transitions in the dump results. Tag
+information is returned as \fBtagon\fP and \fBtagoff\fP elements that
+indicate the begin and end of each range of each tag, respectively.
.TP
\fB\-text\fR
Include information about text in the dump results. The value is the
@@ -1438,9 +1441,8 @@ This command used to be used for scrolling, but now it is obsolete.
.PP
Tk automatically creates class bindings for texts that give them
the following default behavior.
-In the descriptions below, ``word'' refers to a contiguous group
-of letters, digits, or ``_'' characters, or any single character
-other than these.
+In the descriptions below, ``word'' is dependent on the value of
+the \fBtcl_wordchars\fR variable. See tclvars(n).
.IP [1]
Clicking mouse button 1 positions the insertion cursor
just before the character underneath the mouse cursor, sets the