Add documentation. Let ttk use the new Tk_SendVirtualEvent

3 files changed, 34 insertions, 3 deletions

diff --git a/doc/EventHndlr.3 b/doc/EventHndlr.3
index a2cbf8d..cbc5b79 100644
--- a/doc/EventHndlr.3
+++ b/doc/EventHndlr.3
@@ -9,7 +9,7 @@
 .so man.macros
 .BS
 .SH NAME
-Tk_CreateEventHandler, Tk_DeleteEventHandler \- associate procedure callback with an X event
+Tk_CreateEventHandler, Tk_DeleteEventHandler, Tk_GetButtonMask, Tk_SendVirtualEvent \- associate procedure callback with an X event
 .SH SYNOPSIS
 .nf
 \fB#include <tk.h>\fR
@@ -17,8 +17,18 @@ Tk_CreateEventHandler, Tk_DeleteEventHandler \- associate procedure callback wit
 \fBTk_CreateEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
 .sp
 \fBTk_DeleteEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
+.sp
+\fBTk_GetButtonMask\fR(\fIbutton\fR)
+.sp
+\fBTk_SendVirtualEvent\fR(\fItkwin, eventName, detail\fR)
 .SH ARGUMENTS
 .AS "unsigned long" clientData
+.AP unsigned button in
+Button number.
+.AP "const char" *eventName in
+The name of the virtual event.
+.AP Tcl_Obj *detail in
+Detail information for the virtual event.
 .AP Tk_Window tkwin in
 Token for window in which events may occur.
 .AP "unsigned long" mask in
@@ -71,5 +81,10 @@ automatically;  in this case there is no need to call
 If multiple handlers are declared for the same type of X event
 on the same window, then the handlers will be invoked in the
 order they were created.
+.PP
+\fBTk_GetButtonMask\fR returns the button mask corresponding to
+the button. E.g it will return \fIButton1Mask\fR for button \fIButton1\fR.
+.PP
+\fBTk_SendVirtualEvent\fR sends a virtual event to Tk's event queue.
 .SH KEYWORDS
 bind, callback, event, handler
diff --git a/doc/GetPixels.3 b/doc/GetPixels.3
index 6c31af9..568c601 100644
--- a/doc/GetPixels.3
+++ b/doc/GetPixels.3
@@ -9,7 +9,7 @@
 .so man.macros
 .BS
 .SH NAME
-Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM \- translate between strings and screen units
+Tk_GetPixelsFromObj, Tk_GetPixels, Tk_GetMMFromObj, Tk_GetScreenMM, Tk_GetDoublePixelsFromObj \- translate between strings and screen units
 .SH SYNOPSIS
 .nf
 \fB#include <tk.h>\fR
@@ -18,6 +18,9 @@ int
 \fBTk_GetPixelsFromObj(\fIinterp, tkwin, objPtr, intPtr\fB)\fR
 .sp
 int
+\fBTk_GetDoublePixelsFromObj(\fIinterp, tkwin, objPtr, doublePtr\fB)\fR
+.sp
+int
 \fBTk_GetPixels(\fIinterp, tkwin, string, intPtr\fB)\fR
 .sp
 int
@@ -81,6 +84,9 @@ in \fIinterp\fR's result if \fIinterp\fR is not NULL.
 value in \fIobjPtr\fR, which speeds up future calls to
 \fBTk_GetPixelsFromObj\fR with the same \fIobjPtr\fR.
 .PP
+\fBTk_GetDoublePixelsFromObj\fR is identical to \fBTk_GetPixelsFromObj\fR
+except it returns a double not rounded to the nearest integer.
+.PP
 \fBTk_GetPixels\fR is identical to \fBTk_GetPixelsFromObj\fR except
 that the screen distance is specified with a string instead
 of an object.  This prevents \fBTk_GetPixels\fR from caching the
diff --git a/doc/WindowId.3 b/doc/WindowId.3
index f937963..477efe1 100644
--- a/doc/WindowId.3
+++ b/doc/WindowId.3
@@ -9,7 +9,7 @@
 .so man.macros
 .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_IsContainer, Tk_IsEmbedded, Tk_IsMapped, Tk_IsTopLevel, Tk_ReqWidth, Tk_ReqHeight, Tk_MinReqWidth, Tk_MinReqHeight, Tk_InternalBorderLeft, Tk_InternalBorderRight, Tk_InternalBorderTop, Tk_InternalBorderBottom, Tk_Visual, Tk_Depth, Tk_Colormap, Tk_Interp  \- retrieve information from Tk's local data structure
+Tk_WindowId, Tk_Parent, Tk_Display, Tk_DisplayName, Tk_ScreenNumber, Tk_AlwaysShowSelection, 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_MinReqWidth, Tk_MinReqHeight, Tk_InternalBorderLeft, Tk_InternalBorderRight, Tk_InternalBorderTop, Tk_InternalBorderBottom, Tk_Visual, Tk_Depth, Tk_Colormap, Tk_Interp, Tk_NewWindowObj  \- retrieve information from Tk's local data structure
 .SH SYNOPSIS
 .nf
 \fB#include <tk.h>\fR
@@ -29,6 +29,9 @@ const char *
 int
 \fBTk_ScreenNumber\fR(\fItkwin\fR)
 .sp
+int
+\fBTk_AlwaysShowSelection\fR(\fItkwin\fR)
+.sp
 Screen *
 \fBTk_Screen\fR(\fItkwin\fR)
 .sp
@@ -97,6 +100,9 @@ Colormap
 .sp
 Tcl_Interp *
 \fBTk_Interp\fR(\fItkwin\fR)
+.sp
+Tcl_Obj *
+\fBTk_NewWindowObj\fR(\fItkwin\fR)
 .SH ARGUMENTS
 .AS Tk_Window tkwin
 .AP Tk_Window tkwin in
@@ -127,6 +133,8 @@ ASCII string identifying \fItkwin\fR's display.  \fBTk_ScreenNumber\fR
 returns the index of \fItkwin\fR's screen among all the screens
 of \fItkwin\fR's display.  \fBTk_Screen\fR returns a pointer to
 the Xlib structure corresponding to \fItkwin\fR's screen.
+\fBTk_AlwaysShowSelection\fR indicates whether text/entry widgets
+should always display their selection, regardless of window focus.
 .PP
 \fBTk_X\fR, \fBTk_Y\fR, \fBTk_Width\fR, and \fBTk_Height\fR
 return information about \fItkwin's\fR location within its
@@ -182,6 +190,8 @@ and \fBTk_Colormap\fR returns the current
 colormap for the window.  The visual characteristics are
 normally set from the defaults for the window's screen, but
 they may be overridden by calling \fBTk_SetWindowVisual\fR.
+.PP
+\fBTk_NewWindowObj\fR creates a new \fBTcl_Obj\fR from the window.
 .SH KEYWORDS
 attributes, colormap, depth, display, height, geometry manager,
 identifier, mapped, requested size, screen, top-level,