git.chise.org Git - chise/xemacs-chise.git.1/blob - lisp/objects.el

   1 ;;; objects.el --- Lisp interface to C window-system objects
   2
   3 ;; Copyright (C) 1994, 1997 Free Software Foundation, Inc.
   4 ;; Copyright (C) 1995 Ben Wing
   5
   6 ;; Author: Chuck Thompson <cthomp@xemacs.org>
   7 ;; Author: Ben Wing <ben@xemacs.org>
   8 ;; Maintainer: XEmacs Development Team
   9 ;; Keywords: faces, internal, dumped
  10
  11 ;; This file is part of XEmacs.
  12
  13 ;; XEmacs is free software; you can redistribute it and/or modify it
  14 ;; under the terms of the GNU General Public License as published by
  15 ;; the Free Software Foundation; either version 2, or (at your option)
  16 ;; any later version.
  17
  18 ;; XEmacs is distributed in the hope that it will be useful, but
  19 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
  20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  21 ;; General Public License for more details.
  22
  23 ;; You should have received a copy of the GNU General Public License
  24 ;; along with XEmacs; see the file COPYING.  If not, write to the
  25 ;; Free Software Foundation, 59 Temple Place - Suite 330,
  26 ;; Boston, MA 02111-1307, USA.
  27
  28 ;;; Synched up with: Not in FSF.
  29
  30 ;;; Commentary:
  31
  32 ;; This file is dumped with XEmacs.
  33
  34 ;;; Code:
  35
  36 (defun ws-object-property-1 (function object domain &optional matchspec)
  37   (let ((instance (if matchspec
  38                       (specifier-matching-instance object matchspec domain)
  39                     (specifier-instance object domain))))
  40     (and instance (funcall function instance))))
  41
  42 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; font specifiers
  43
  44 (defun make-font-specifier (spec-list)
  45   "Return a new `font' specifier object with the given specification list.
  46 SPEC-LIST can be a list of specifications (each of which is a cons of a
  47 locale and a list of instantiators), a single instantiator, or a list
  48 of instantiators.  See `make-specifier' for more information about
  49 specifiers."
  50   (make-specifier-and-init 'font spec-list))
  51
  52 (defun font-name (font &optional domain charset)
  53   "Return the name of the FONT in the specified DOMAIN, if any.
  54 FONT should be a font specifier object and DOMAIN is normally a window
  55 and defaults to the selected window if omitted.  This is equivalent
  56 to using `specifier-instance' and applying `font-instance-name' to
  57 the result.  See `make-specifier' for more information about specifiers."
  58   (ws-object-property-1 'font-instance-name font domain charset))
  59
  60 (defun font-ascent (font &optional domain charset)
  61   "Return the ascent of the FONT in the specified DOMAIN, if any.
  62 FONT should be a font specifier object and DOMAIN is normally a window
  63 and defaults to the selected window if omitted.  This is equivalent
  64 to using `specifier-instance' and applying `font-instance-ascent' to
  65 the result.  See `make-specifier' for more information about specifiers."
  66   (ws-object-property-1 'font-instance-ascent font domain charset))
  67
  68 (defun font-descent (font &optional domain charset)
  69   "Return the descent of the FONT in the specified DOMAIN, if any.
  70 FONT should be a font specifier object and DOMAIN is normally a window
  71 and defaults to the selected window if omitted.  This is equivalent
  72 to using `specifier-instance' and applying `font-instance-descent' to
  73 the result.  See `make-specifier' for more information about specifiers."
  74   (ws-object-property-1 'font-instance-descent font domain charset))
  75
  76 (defun font-width (font &optional domain charset)
  77   "Return the width of the FONT in the specified DOMAIN, if any.
  78 FONT should be a font specifier object and DOMAIN is normally a window
  79 and defaults to the selected window if omitted.  This is equivalent
  80 to using `specifier-instance' and applying `font-instance-width' to
  81 the result.  See `make-specifier' for more information about specifiers."
  82   (ws-object-property-1 'font-instance-width font domain charset))
  83
  84 (defun font-height (font &optional domain charset)
  85   "Return the height of the FONT in the specified DOMAIN, if any.
  86 FONT should be a font specifier object and DOMAIN is normally a window
  87 and defaults to the selected window if omitted.  This is equivalent
  88 to using `specifier-instance' and applying `font-instance-height' to
  89 the result.  See `make-specifier' for more information about specifiers."
  90   (ws-object-property-1 'font-instance-height font domain charset))
  91
  92 (defun font-proportional-p (font &optional domain charset)
  93   "Return whether FONT is proportional in the specified DOMAIN, if known.
  94 FONT should be a font specifier object and DOMAIN is normally a window
  95 and defaults to the selected window if omitted.  This is equivalent
  96 to using `specifier-instance' and applying `font-instance-proportional-p' to
  97 the result.  See `make-specifier' for more information about specifiers."
  98   (ws-object-property-1 'font-instance-proportional-p font domain charset))
  99
 100 (defun font-properties (font &optional domain charset)
 101   "Return the properties of the FONT in the specified DOMAIN, if any.
 102 FONT should be a font specifier object and DOMAIN is normally a window
 103 and defaults to the selected window if omitted.  This is equivalent
 104 to using `specifier-instance' and applying `font-instance-properties'
 105 to the result.  See `make-specifier' for more information about specifiers."
 106   (ws-object-property-1 'font-instance-properties font domain charset))
 107
 108 (defun font-truename (font &optional domain charset)
 109   "Return the truename of the FONT in the specified DOMAIN, if any.
 110 FONT should be a font specifier object and DOMAIN is normally a window
 111 and defaults to the selected window if omitted.  This is equivalent
 112 to using `specifier-instance' and applying `font-instance-truename'
 113 to the result.  See `make-specifier' for more information about specifiers."
 114   (ws-object-property-1 'font-instance-truename font domain charset))
 115
 116 (defun font-instance-height (font-instance)
 117   "Return the height in pixels of FONT-INSTANCE.
 118 The returned value is the maximum height for all characters in the font,\n\
 119 and is equivalent to the sum of the font instance's ascent and descent."
 120   (+ (font-instance-ascent font-instance)
 121      (font-instance-descent font-instance)))
 122
 123 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; color specifiers
 124
 125 (defun make-color-specifier (spec-list)
 126   "Return a new `color' specifier object with the given specification list.
 127 SPEC-LIST can be a list of specifications (each of which is a cons of a
 128 locale and a list of instantiators), a single instantiator, or a list
 129 of instantiators.  See `make-specifier' for a detailed description of
 130 how specifiers work."
 131   (make-specifier-and-init 'color spec-list))
 132
 133 (defun color-name (color &optional domain)
 134   "Return the name of the COLOR in the specified DOMAIN, if any.
 135 COLOR should be a color specifier object and DOMAIN is normally a window
 136 and defaults to the selected window if omitted.  This is equivalent
 137 to using `specifier-instance' and applying `color-instance-name' to
 138 the result.  See `make-specifier' for more information about specifiers."
 139   (ws-object-property-1 'color-instance-name color domain))
 140
 141 (defun color-rgb-components (color &optional domain)
 142   "Return the RGB components of the COLOR in the specified DOMAIN, if any.
 143 COLOR should be a color specifier object and DOMAIN is normally a window
 144 and defaults to the selected window if omitted.  This is equivalent
 145 to using `specifier-instance' and applying `color-instance-rgb-components'
 146 to the result.  See `make-specifier' for more information about specifiers."
 147   (ws-object-property-1 'color-instance-rgb-components color domain))
 148
 149 ;;; objects.el ends here.