comparison doc/lispref/commands.texi @ 111733:3a6d978e6636

Fix and document components of mouse event position. src/keyboard.c (make_lispy_position): Put a meaningful value in yret when the click is on the header or mode line. doc/lispref/commands.texi (Click Events): Document the values of X, Y and COL, ROW in the event's position, when the click is on the header or mode line, on the fringes, or in the margins.

111732:6098376da331

@item @var{x}, @var{y}
These are the pixel coordinates of the click, relative to
the top left corner of @var{window}, which is @code{(0 . 0)}.
For the mode or header line, @var{y} does not have meaningful data.
For the vertical line, @var{x} does not have meaningful data.

@item @var{timestamp}
This is the time at which the event occurred, in milliseconds.

@item @var{object}

the window.

@item @var{col}, @var{row}
These are the actual coordinates of the glyph under the @var{x},
@var{y} position, possibly padded with default character width
glyphs if @var{x} is beyond the last glyph on the line.

@item @var{image}
This is the image object on which the click occurred.  It is either
@code{nil} if there is no image at the position clicked on, or it is
an image object as returned by @code{find-image} if click was in an image.

@item @var{width}, @var{height}
These are the pixel width and height of @var{object} or, if this is
@code{nil}, those of the character glyph clicked on.
@end table
 
@sp 1
For mouse clicks on a scroll-bar, @var{position} has this form:

@example
(@var{window} @var{area} (@var{portion} . @var{whole}) @var{timestamp} @var{part})

111733:3a6d978e6636

@item @var{x}, @var{y}
These are the pixel coordinates of the click, relative to
the top left corner of @var{window}, which is @code{(0 . 0)}.
For a click on text, these are relative to the top left corner of
the window's text area.  For the mode or header line, they are
relative to the top left window edge.  For fringes, margins, and the
vertical border, @var{x} does not have meaningful data.  For fringes
and margins, @var{y} is relative to the bottom edge of the header
line.

@item @var{timestamp}
This is the time at which the event occurred, in milliseconds.

@item @var{object}

the window.

@item @var{col}, @var{row}
These are the actual coordinates of the glyph under the @var{x},
@var{y} position, possibly padded with default character width
glyphs if @var{x} is beyond the last glyph on the line.  For clicks on
the header or mode line, these are measured from the top left edge of
the header or mode line.  For clicks on the fringes and on the
vertical border, these have no meaningful data.  For clicks on the
margins, @var{col} is measured from the left edge of the margin area
and @var{row} is measured from the top of the margin area.

@item @var{image}
This is the image object on which the click occurred.  It is either
@code{nil} if there is no image at the position clicked on, or it is
an image object as returned by @code{find-image} if click was in an image.

@item @var{width}, @var{height}
These are the pixel width and height of @var{object} or, if this is
@code{nil}, those of the character glyph clicked on.
@end table

@sp 1
For mouse clicks on a scroll-bar, @var{position} has this form:

@example
(@var{window} @var{area} (@var{portion} . @var{whole}) @var{timestamp} @var{part})