aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-04-12 18:05:05 +0100
committerPaul LeoNerd Evans <leonerd@leonerd.org.uk>2012-04-12 18:05:05 +0100
commitfedda1bdd4dde2e2750a67e740c3ab64b436ae8b (patch)
tree41ed3ee7fcda00e8e23acda373529a45f733c00f /man
parent7d6a41eabaeb4f28298cb9a3ab14e0eec876a5fd (diff)
downloadtermo-fedda1bdd4dde2e2750a67e740c3ab64b436ae8b.tar.gz
termo-fedda1bdd4dde2e2750a67e740c3ab64b436ae8b.tar.xz
termo-fedda1bdd4dde2e2750a67e740c3ab64b436ae8b.zip
Note the limited range of mouse line/column number
Diffstat (limited to 'man')
-rw-r--r--man/termkey_interpret_mouse.32
1 files changed, 1 insertions, 1 deletions
diff --git a/man/termkey_interpret_mouse.3 b/man/termkey_interpret_mouse.3
index 91a600d..dbc0c74 100644
--- a/man/termkey_interpret_mouse.3
+++ b/man/termkey_interpret_mouse.3
@@ -30,7 +30,7 @@ the mouse was moved while holding a button; \fIbutton\fP will contain its number
.B TERMKEY_MOUSE_RELEASE
a mouse button was released, or the mouse was moved while no button was pressed. If known, \fIbutton\fP will contain the number of the button released. Not all terminals can report this, so it may be 0 instead.
.PP
-The \fIline\fP and \fIcol\fP variables will be filled in with the mouse position, indexed from 1.
+The \fIline\fP and \fIcol\fP variables will be filled in with the mouse position, indexed from 1. Note that due to the limited number of bytes in the \fBTermKeyKey\fP structure, the line and column numbers are limited to 2047 and 4095 respectively.
.SH "RETURN VALUE"
If passed a \fIkey\fP event of the type \fBTERMKEY_TYPE_MOUSE\fP, this function will return \fBTERMKEY_RES_KEY\fP and will affect the variables whose pointers were passed in, as described above.
.PP