changeset 105545:c9f6575e6f19

(Fframe_pixel_height): Doc fix. (Bug#4535)
author Glenn Morris <rgm@gnu.org>
date Sun, 11 Oct 2009 00:01:11 +0000
parents b051de749ce4
children 2ee9eaa0490b
files src/ChangeLog src/frame.c
diffstat 2 files changed, 20 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/src/ChangeLog	Sat Oct 10 23:50:10 2009 +0000
+++ b/src/ChangeLog	Sun Oct 11 00:01:11 2009 +0000
@@ -1,3 +1,7 @@
+2009-10-11  Glenn Morris  <rgm@gnu.org>
+
+	* frame.c (Fframe_pixel_height): Doc fix.  (Bug#4535)
+
 2009-10-08  Jan Djärv  <jan.h.d@swipnet.se>
 
 	* gtkutil.c (create_menus): Call gtk_widget_set_size_request for
--- a/src/frame.c	Sat Oct 10 23:50:10 2009 +0000
+++ b/src/frame.c	Sun Oct 11 00:01:11 2009 +0000
@@ -2643,10 +2643,22 @@
 DEFUN ("frame-pixel-height", Fframe_pixel_height,
        Sframe_pixel_height, 0, 1, 0,
        doc: /* Return a FRAME's height in pixels.
-This counts only the height available for text lines,
-not menu bars on window-system Emacs frames.
-For a terminal frame, the result really gives the height in characters.
-If FRAME is omitted, the selected frame is used.  */)
+If FRAME is omitted, the selected frame is used.  The exact value
+of the result depends on the window-system and toolkit in use:
+
+In the Gtk+ version of Emacs, it includes only any window (including
+the minibuffer or eacho area), mode line, and header line.  It does not
+include the tool bar or menu bar.
+
+With the Motif or Lucid toolkits, it also includes the tool bar (but
+not the menu bar).
+
+In a graphical version with no toolkit, it includes both the tool bar
+and menu bar.
+
+For a text-only terminal, it includes the menu bar.  In this case, the
+result is really in characters rather than pixels (i.e., is identical
+to `frame-height'). */)
      (frame)
      Lisp_Object frame;
 {