$window-col(5)

NAME

$window-col - Window cursor column (no expansion)
$window-line - Window cursor line (with narrows)
$window-acol - Window cursor actual column (expansion)
$window-aline - Window cursor actual line (ignore narrows)
$window-eline - Window end line
$window-mark-col - Window mark column
$window-mark-line - Window mark line

SYNOPSIS

$window-col integer [0 <= integer <= 65535]
$window-line integer [1 <= integer <= n]
$window-acol integer [0 <= integer <= n]
$window-aline integer [1 <= integer <= n]
$window-eline integer [1 <= integer <= n]
$window-mark-col integer [0 <= integer <= 65535]
$window-mark-line integer [1 <= integer <= n]

DESCRIPTION

$window-col is defined as the current position of the cursor in the current line in the current window. Column zero is the left hand edge. This differs from $window-acol in that TAB and special characters only count for 1 character. $window-col is valid in the range 0 - n.

$window-acol is defined as the current column of the cursor in the current window. Column zero is the left hand edge. This differs from $window-col in that tab and special characters may not count for 1 character.

$window-line is defined as the current buffer line number the cursor is on in the current window. Line numbering starts from 1. $window-line is valid in the range 1 - n.

$window-aline is identical to $window-line except when the current buffer contains narrowed out sections before the current line. In this case $window-line will be set to the line number without counting the number of lines in the narrow, whereas $window-aline will return the current line number including all lines narrowed out before it. When this variable is set, the line required may lie in a narrowed out section in which case the narrow is automatically removed. See narrow-buffer(2) for more information on narrowing.

$window-eline is the end line of the window, that is the line number of the last line of the buffer showing in the window. This is a useful value for mouse operations when the position of the mouse may be tested to ensure that the mouse position is within the valid text region of the buffer.

$window-mark-line is the current buffer line number of the mark position of set-mark(2) in the current window. Line numbering starts from 1. $window-mark-line is valid in the range 1 - n.

$window-mark-col is the current buffer column of the mark position of set-mark(2) in the current window. Note that this is the actual column position in the line which may be different from the window column position as TAB and special characters only count as a single character.

NOTES

Variable $window-wcol was renamed to $window-acol in June 2000. Variable $window-wline was also removed and a new variable $window-y-scroll introduced at this time. The following macro code can be used to calculate the value of the original $window-wline variable:

$window-mark-line and $window-mark-col first appeared in the 2006 release of MicroEmacs.

&sub &sub $window-line $window-y-scroll 1 

SEE ALSO

$frame-depth(5), $window-depth(5), $window-width(5), $window-y-scroll(5), narrow-buffer(2).

(c) Copyright JASSPA 2009
Last Modified: 2009/08/29
Generated On: 2009/10/12