Mercurial > hg > xemacs-beta

comparison lisp/prim/objects.el @ 0:376386a54a3c r19-14

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r19-14
author cvs
date Mon, 13 Aug 2007 08:45:50 +0200
parents
children 0293115a14e9
comparison
equal deleted inserted replaced
-1:000000000000 0:376386a54a3c
1 ;;; objects.el --- Lisp interface to C window-system objects
2 ;; Keywords: faces internal
3
4 ;; Copyright (C) 1994 Board of Trustees, University of Illinois
5 ;; Copyright (C) 1995 Ben Wing
6
7 ;; Author: Chuck Thompson <cthomp@cs.uiuc.edu>,
8 ;; Ben Wing <wing@666.com>
9
10 ;; This file is part of XEmacs.
11
12 ;; XEmacs is free software; you can redistribute it and/or modify it
13 ;; under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; any later version.
16
17 ;; XEmacs is distributed in the hope that it will be useful, but
18 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 ;; General Public License for more details.
21
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with XEmacs; see the file COPYING. If not, write to the Free
24 ;; Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
25
26 ;;; Synched up with: Not in FSF.
27
28 (defun ws-object-property-1 (function object domain &optional matchspec)
29 (let ((instance (if matchspec
30 (specifier-matching-instance object matchspec domain)
31 (specifier-instance object domain))))
32 (and instance (funcall function instance))))
33
34 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; font specifiers
35
36 (defun make-font-specifier (spec-list)
37 "Create a new `font' specifier object with the given specification list.
38 SPEC-LIST can be a list of specifications (each of which is a cons of a
39 locale and a list of instantiators), a single instantiator, or a list
40 of instantiators. See `make-specifier' for more information about
41 specifiers."
42 (make-specifier-and-init 'font spec-list))
43
44 (defun font-name (font &optional domain charset)
45 "Return the name of the FONT in the specified DOMAIN, if any.
46 FONT should be a font specifier object and DOMAIN is normally a window
47 and defaults to the selected window if omitted. This is equivalent
48 to using `specifier-instance' and applying `font-instance-name' to
49 the result. See `make-specifier' for more information about specifiers."
50 (ws-object-property-1 'font-instance-name font domain charset))
51
52 (defun font-ascent (font &optional domain charset)
53 "Return the ascent 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-ascent' to
57 the result. See `make-specifier' for more information about specifiers."
58 (ws-object-property-1 'font-instance-ascent font domain charset))
59
60 (defun font-descent (font &optional domain charset)
61 "Return the descent 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-descent' to
65 the result. See `make-specifier' for more information about specifiers."
66 (ws-object-property-1 'font-instance-descent font domain charset))
67
68 (defun font-width (font &optional domain charset)
69 "Return the width 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-width' to
73 the result. See `make-specifier' for more information about specifiers."
74 (ws-object-property-1 'font-instance-width font domain charset))
75
76 (defun font-height (font &optional domain charset)
77 "Return the height 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-height' to
81 the result. See `make-specifier' for more information about specifiers."
82 (ws-object-property-1 'font-instance-height font domain charset))
83
84 (defun font-proportional-p (font &optional domain charset)
85 "Return whether FONT is proportional in the specified DOMAIN, if known.
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-proportional-p' to
89 the result. See `make-specifier' for more information about specifiers."
90 (ws-object-property-1 'font-instance-proportional-p font domain charset))
91
92 (defun font-properties (font &optional domain charset)
93 "Return the properties of the FONT in the specified DOMAIN, if any.
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-properties'
97 to the result. See `make-specifier' for more information about specifiers."
98 (ws-object-property-1 'font-instance-properties font domain charset))
99
100 (defun font-truename (font &optional domain charset)
101 "Return the truename 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-truename'
105 to the result. See `make-specifier' for more information about specifiers."
106 (ws-object-property-1 'font-instance-truename font domain charset))
107
108 (defun font-instance-height (font-instance)
109 "Return the height in pixels of FONT-INSTANCE.
110 The returned value is the maximum height for all characters in the font,\n\
111 and is equivalent to the sum of the font instance's ascent and descent."
112 (+ (font-instance-ascent font-instance)
113 (font-instance-descent font-instance)))
114
115 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; color specifiers
116
117 (defun make-color-specifier (spec-list)
118 "Create a new `color' specifier object with the given specification list.
119 SPEC-LIST can be a list of specifications (each of which is a cons of a
120 locale and a list of instantiators), a single instantiator, or a list
121 of instantiators. See `make-specifier' for a detailed description of
122 how specifiers work."
123 (make-specifier-and-init 'color spec-list))
124
125 (defun color-name (color &optional domain)
126 "Return the name of the COLOR in the specified DOMAIN, if any.
127 COLOR should be a color specifier object and DOMAIN is normally a window
128 and defaults to the selected window if omitted. This is equivalent
129 to using `specifier-instance' and applying `color-instance-name' to
130 the result. See `make-specifier' for more information about specifiers."
131 (ws-object-property-1 'color-instance-name color domain))
132
133 (defun color-rgb-components (color &optional domain)
134 "Return the RGB components 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-rgb-components'
138 to the result. See `make-specifier' for more information about specifiers."
139 (ws-object-property-1 'color-instance-rgb-components color domain))
140
141 ;;; objects.el ends here.
142