summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorjan.nijtmans <nijtmans@users.sourceforge.net>2023-12-13 10:38:39 (GMT)
committerjan.nijtmans <nijtmans@users.sourceforge.net>2023-12-13 10:38:39 (GMT)
commit276c5f4cc8912519eb23f0720ecb614ff59c3c39 (patch)
tree6e43ae1e906095f99151a3e40045231f0d54ff55 /doc
parent43b775d29369a1dc3315abb9521b3d697069433b (diff)
parentd6bb3158bccb27b30547d3df16e75948b646b280 (diff)
downloadtk-276c5f4cc8912519eb23f0720ecb614ff59c3c39.zip
tk-276c5f4cc8912519eb23f0720ecb614ff59c3c39.tar.gz
tk-276c5f4cc8912519eb23f0720ecb614ff59c3c39.tar.bz2
(Cherry-pick): Fix Tk_CharBbox/Tk_DrawTextLayout signature (int -> Tcl_Size). Update documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/CrtErrHdlr.34
-rw-r--r--doc/CrtGenHdlr.34
-rw-r--r--doc/CrtImgType.318
-rw-r--r--doc/CrtSelHdlr.34
-rw-r--r--doc/EventHndlr.34
-rw-r--r--doc/GetImage.34
-rw-r--r--doc/GetSelect.34
-rw-r--r--doc/ManageGeom.36
-rw-r--r--doc/OwnSelect.34
-rw-r--r--doc/RestrictEv.36
-rw-r--r--doc/SetClassProcs.32
-rw-r--r--doc/SetOptions.310
12 files changed, 35 insertions, 35 deletions
diff --git a/doc/CrtErrHdlr.3 b/doc/CrtErrHdlr.3
index e6ebafe..09dcf8b 100644
--- a/doc/CrtErrHdlr.3
+++ b/doc/CrtErrHdlr.3
@@ -35,7 +35,7 @@ field. If \-1, then match any \fIminor_code\fR value.
Procedure to invoke whenever an error event is received for
\fIdisplay\fR and matches \fIerror\fR, \fIrequest\fR, and \fIminor\fR.
NULL means ignore any matching errors.
-.AP ClientData clientData in
+.AP void *clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.AP Tk_ErrorHandler handler in
Token for error handler to delete (return value from a previous
@@ -73,7 +73,7 @@ made when the handler was active (see below for more information).
following type:
.CS
typedef int \fBTk_ErrorProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
XErrorEvent *\fIerrEventPtr\fR);
.CE
The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
diff --git a/doc/CrtGenHdlr.3 b/doc/CrtGenHdlr.3
index 1d6f3d5..aaf3285 100644
--- a/doc/CrtGenHdlr.3
+++ b/doc/CrtGenHdlr.3
@@ -21,7 +21,7 @@ Tk_CreateGenericHandler, Tk_DeleteGenericHandler \- associate procedure callback
.AS "Tk_GenericProc" clientData
.AP Tk_GenericProc *proc in
Procedure to invoke whenever any X event occurs on any display.
-.AP ClientData clientData in
+.AP void *clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.BE
.SH DESCRIPTION
@@ -45,7 +45,7 @@ call \fBTk_HandleEvent\fR, such as \fBTcl_DoOneEvent\fR or
type \fBTk_GenericProc\fR:
.CS
typedef int \fBTk_GenericProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
XEvent *\fIeventPtr\fR);
.CE
The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
diff --git a/doc/CrtImgType.3 b/doc/CrtImgType.3
index b0a14fc..b15a851 100644
--- a/doc/CrtImgType.3
+++ b/doc/CrtImgType.3
@@ -16,7 +16,7 @@ Tk_CreateImageType, Tk_GetImageModelData, Tk_InitImageArgs \- define new kind of
.sp
\fBTk_CreateImageType\fR(\fItypePtr\fR)
.sp
-ClientData
+void *
\fBTk_GetImageModelData\fR(\fIinterp, name, typePtrPtr\fR)
.sp
\fBTk_InitImageArgs\fR(\fIinterp, argc, argvPtr\fR)
@@ -114,7 +114,7 @@ typedef int \fBTk_ImageCreateProc\fR(
Tcl_Obj *const \fIobjv\fR[],
const Tk_ImageType *\fItypePtr\fR,
Tk_ImageModel \fImodel\fR,
- ClientData *\fImodelDataPtr\fR);
+ void **\fImodelDataPtr\fR);
.CE
The \fIinterp\fR argument is the interpreter in which the \fBimage\fR
command was invoked, and \fIname\fR is the name for the new image,
@@ -146,9 +146,9 @@ size of the image and request an initial redisplay.
calls \fBTk_GetImage\fR to use a particular image.
This procedure must match the following prototype:
.CS
-typedef ClientData \fBTk_ImageGetProc\fR(
+typedef void *\fBTk_ImageGetProc\fR(
Tk_Window \fItkwin\fR,
- ClientData \fImodelData\fR);
+ void *\fImodelData\fR);
.CE
The \fItkwin\fR argument identifies the window in which the
image will be used and \fImodelData\fR is the value
@@ -167,7 +167,7 @@ to be displayed (i.e., whenever a widget calls \fBTk_RedrawImage\fR).
\fIdisplayProc\fR must match the following prototype:
.CS
typedef void \fBTk_ImageDisplayProc\fR(
- ClientData \fIinstanceData\fR,
+ void *\fIinstanceData\fR,
Display *\fIdisplay\fR,
Drawable \fIdrawable\fR,
int \fIimageX\fR,
@@ -203,7 +203,7 @@ canvas item is changed.
\fIfreeProc\fR must match the following prototype:
.CS
typedef void \fBTk_ImageFreeProc\fR(
- ClientData \fIinstanceData\fR,
+ void *\fIinstanceData\fR,
Display *\fIdisplay\fR);
.CE
The \fIinstanceData\fR will be the same as the value returned by
@@ -221,7 +221,7 @@ each of the image's instances.
\fIdeleteProc\fR must match the following prototype:
.CS
typedef void \fBTk_ImageDeleteProc\fR(
- ClientData \fImodelData\fR);
+ void *\fImodelData\fR);
.CE
The \fImodelData\fR argument will be the same as the value
stored in \fI*modelDataPtr\fR by \fIcreateProc\fR when the
@@ -237,7 +237,7 @@ If there exists an image named \fIname\fR
in the interpreter given by \fIinterp\fR, then \fI*typePtrPtr\fR is
filled in with type information for the image (the \fItypePtr\fR value
passed to \fBTk_CreateImageType\fR when the image type was registered)
-and the return value is the ClientData value returned by the
+and the return value is the clientData value returned by the
\fIcreateProc\fR when the image was created (this is typically a
pointer to the image model data structure). If no such image exists
then NULL is returned and NULL is stored at \fI*typePtrPtr\fR.
@@ -253,7 +253,7 @@ typedef int \fBTk_ImageCreateProc\fR(
char **\fIargv\fR,
Tk_ImageType *\fItypePtr\fR,
Tk_ImageModel \fImodel\fR,
- ClientData *\fImodelDataPtr\fR);
+ void **\fImodelDataPtr\fR);
.CE
Legacy programs and libraries dating from those days may still
contain code that defines extended Tk image types using the old
diff --git a/doc/CrtSelHdlr.3 b/doc/CrtSelHdlr.3
index 2292ccc..b3c749c 100644
--- a/doc/CrtSelHdlr.3
+++ b/doc/CrtSelHdlr.3
@@ -32,7 +32,7 @@ commands.
Procedure to invoke whenever the selection is owned by \fItkwin\fR
and the selection contents are requested in the format given by
\fItarget\fR.
-.AP ClientData clientData in
+.AP void *clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.AP Atom format in
If the selection requestor is not in this process, \fIformat\fR determines
@@ -55,7 +55,7 @@ the selection. The most common form is STRING.
type \fBTk_SelectionProc\fR:
.CS
typedef int \fBTk_SelectionProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
int \fIoffset\fR,
char *\fIbuffer\fR,
int \fImaxBytes\fR);
diff --git a/doc/EventHndlr.3 b/doc/EventHndlr.3
index cbc5b79..128f8ee 100644
--- a/doc/EventHndlr.3
+++ b/doc/EventHndlr.3
@@ -37,7 +37,7 @@ for which \fIproc\fR should be called.
.AP Tk_EventProc *proc in
Procedure to invoke whenever an event in \fImask\fR occurs
in the window given by \fItkwin\fR.
-.AP ClientData clientData in
+.AP void *clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.BE
.SH DESCRIPTION
@@ -55,7 +55,7 @@ call \fBTk_HandleEvent\fR, such as \fBTcl_DoOneEvent\fR or
type \fBTk_EventProc\fR:
.CS
typedef void \fBTk_EventProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
XEvent *\fIeventPtr\fR);
.CE
The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
diff --git a/doc/GetImage.3 b/doc/GetImage.3
index 744f9ac..c437db7 100644
--- a/doc/GetImage.3
+++ b/doc/GetImage.3
@@ -32,7 +32,7 @@ Window in which image will be used.
Name of image.
.AP Tk_ImageChangedProc *changeProc in
Procedure for Tk to invoke whenever image content or size changes.
-.AP ClientData clientData in
+.AP void *clientData in
One-word value for Tk to pass to \fIchangeProc\fR.
.AP Tk_Image image in
Token for image instance; must have been returned by a previous
@@ -106,7 +106,7 @@ The \fIchangeProc\fR and \fIclientData\fR arguments to
in the image; it must match the following prototype:
.CS
typedef void \fBTk_ImageChangedProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
int \fIx\fR,
int \fIy\fR,
int \fIwidth\fR,
diff --git a/doc/GetSelect.3 b/doc/GetSelect.3
index 11e837e..455b142 100644
--- a/doc/GetSelect.3
+++ b/doc/GetSelect.3
@@ -30,7 +30,7 @@ Form in which to retrieve selection.
.AP Tk_GetSelProc *proc in
Procedure to invoke to process pieces of the selection as they
are retrieved.
-.AP ClientData clientData in
+.AP void *clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.BE
.SH DESCRIPTION
@@ -44,7 +44,7 @@ should have arguments and result that match the type
.PP
.CS
typedef int \fBTk_GetSelProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
Tcl_Interp *\fIinterp\fR,
char *\fIportion\fR);
.CE
diff --git a/doc/ManageGeom.3 b/doc/ManageGeom.3
index 0c72d69..dd69273 100644
--- a/doc/ManageGeom.3
+++ b/doc/ManageGeom.3
@@ -25,7 +25,7 @@ geometry manager, or NULL to indicate that \fItkwin\fR's geometry
should not be managed anymore.
The data structure pointed to by \fImgrPtr\fR must be static:
Tk keeps a reference to it as long as the window is managed.
-.AP ClientData clientData in
+.AP void *clientData in
Arbitrary one-word value to pass to geometry manager callbacks.
.BE
.SH DESCRIPTION
@@ -58,7 +58,7 @@ content window to change its desired geometry.
type \fBTk_GeomRequestProc\fR:
.CS
typedef void \fBTk_GeomRequestProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
Tk_Window \fItkwin\fR);
.CE
The parameters to \fIrequestProc\fR will be identical to the
@@ -81,7 +81,7 @@ is the same as the window's current geometry manager.
arguments and results that match the following prototype:
.CS
typedef void \fBTk_GeomLostContentProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
Tk_Window \fItkwin\fR);
.CE
The parameters to \fIlostContentProc\fR will be identical to the
diff --git a/doc/OwnSelect.3 b/doc/OwnSelect.3
index 0e16eac..67bac55 100644
--- a/doc/OwnSelect.3
+++ b/doc/OwnSelect.3
@@ -23,7 +23,7 @@ Window that is to become new selection owner.
The name of the selection to be owned, such as XA_PRIMARY.
.AP Tk_LostSelProc *proc in
Procedure to invoke when \fItkwin\fR loses selection ownership later.
-.AP ClientData clientData in
+.AP void *clientData in
Arbitrary one-word value to pass to \fIproc\fR.
.BE
.SH DESCRIPTION
@@ -39,7 +39,7 @@ unhighlighting the selection). \fIProc\fR should have arguments and
result that match the type \fBTk_LostSelProc\fR:
.CS
typedef void \fBTk_LostSelProc\fR(
- ClientData \fIclientData\fR);
+ void *\fIclientData\fR);
.CE
The \fIclientData\fR parameter to \fIproc\fR is a copy of the
\fIclientData\fR argument given to \fBTk_OwnSelection\fR, and is
diff --git a/doc/RestrictEv.3 b/doc/RestrictEv.3
index 8b3af07..f61e764 100644
--- a/doc/RestrictEv.3
+++ b/doc/RestrictEv.3
@@ -21,9 +21,9 @@ Tk_RestrictProc *
.AP Tk_RestrictProc *proc in
Predicate procedure to call to filter incoming X events.
NULL means do not restrict events at all.
-.AP ClientData arg in
+.AP void *arg in
Arbitrary argument to pass to \fIproc\fR.
-.AP ClientData *prevArgPtr out
+.AP void **prevArgPtr out
Pointer to place to save argument to previous restrict procedure.
.BE
.SH DESCRIPTION
@@ -40,7 +40,7 @@ is a procedure with arguments and result that match
the type \fBTk_RestrictProc\fR:
.CS
typedef Tk_RestrictAction \fBTk_RestrictProc\fR(
- ClientData \fIarg\fR,
+ void *\fIarg\fR,
XEvent *\fIeventPtr\fR);
.CE
The \fIarg\fR argument is a copy of the \fIarg\fR passed
diff --git a/doc/SetClassProcs.3 b/doc/SetClassProcs.3
index 53f7cce..d3666cd 100644
--- a/doc/SetClassProcs.3
+++ b/doc/SetClassProcs.3
@@ -22,7 +22,7 @@ Token for window to modify.
Pointer to data structure containing widget specific procedures.
The data structure pointed to by \fIprocs\fR must be static:
Tk keeps a reference to it as long as the window exists.
-.AP ClientData instanceData in
+.AP void *instanceData in
Arbitrary one-word value to pass to widget callbacks.
.BE
.SH DESCRIPTION
diff --git a/doc/SetOptions.3 b/doc/SetOptions.3
index c568dd6..bdf502f 100644
--- a/doc/SetOptions.3
+++ b/doc/SetOptions.3
@@ -550,11 +550,11 @@ typedef struct Tk_ObjCustomOption {
Tk_CustomOptionGetProc *\fIgetProc\fR;
Tk_CustomOptionRestoreProc *\fIrestoreProc\fR;
Tk_CustomOptionFreeProc *\fIfreeProc\fR;
- ClientData \fIclientData\fR;
+ void *\fIclientData\fR;
} \fBTk_ObjCustomOption\fR;
typedef int \fBTk_CustomOptionSetProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
Tcl_Interp *\fIinterp\fR,
Tk_Window \fItkwin\fR,
Tcl_Obj **\fIvaluePtr\fR,
@@ -564,19 +564,19 @@ typedef int \fBTk_CustomOptionSetProc\fR(
int \fIflags\fR);
typedef Tcl_Obj *\fBTk_CustomOptionGetProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
Tk_Window \fItkwin\fR,
char *\fIrecordPtr\fR,
int \fIinternalOffset\fR);
typedef void \fBTk_CustomOptionRestoreProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
Tk_Window \fItkwin\fR,
char *\fIinternalPtr\fR,
char *\fIsaveInternalPtr\fR);
typedef void \fBTk_CustomOptionFreeProc\fR(
- ClientData \fIclientData\fR,
+ void *\fIclientData\fR,
Tk_Window \fItkwin\fR,
char *\fIinternalPtr\fR);
.CE