diff options
author | Glenn Morris <rgm@gnu.org> | 2009-10-10 23:50:10 +0000 |
---|---|---|
committer | Glenn Morris <rgm@gnu.org> | 2009-10-10 23:50:10 +0000 |
commit | 4619ff5e681cea8b6967375425eb85c0a2ff78bf (patch) | |
tree | 94f7ceb4dba8702129515d92d8f35071ab8a02df /lisp/frame.el | |
parent | 9976fe82bd943cc8877c9615a6c1dcac37cde2ed (diff) | |
download | emacs-4619ff5e681cea8b6967375425eb85c0a2ff78bf.tar.gz |
(frame-height): Doc fix.
Diffstat (limited to 'lisp/frame.el')
-rw-r--r-- | lisp/frame.el | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/lisp/frame.el b/lisp/frame.el index e5d92fa1df3..91619ce62fd 100644 --- a/lisp/frame.el +++ b/lisp/frame.el @@ -1,7 +1,7 @@ ;;; frame.el --- multi-frame management independent of window systems ;; Copyright (C) 1993, 1994, 1996, 1997, 2000, 2001, 2002, 2003, -;; 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. +;; 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. ;; Maintainer: FSF ;; Keywords: internal @@ -1027,7 +1027,16 @@ is given and non-nil, the unwanted frames are iconified instead." (defun frame-height (&optional frame) "Return number of lines available for display on FRAME. -If FRAME is omitted, describe the currently selected frame." +If FRAME is omitted, describe the currently selected frame. +Exactly what is included in the return value depends on the +window-system and toolkit in use - see `frame-pixel-height' for +more details. The lines are in units of the default font height. + +The result is roughly related to the frame pixel height via +height in pixels = height in lines * `frame-char-height'. +However, this is only approximate, and is complicated e.g. by the +fact that individual window lines and menu bar lines can have +differing font heights." (cdr (assq 'height (frame-parameters frame)))) (defun frame-width (&optional frame) |