|
428
|
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
|
|
442
|
49 specifiers.
|
|
|
50
|
|
|
51 Valid instantiators for font specifiers are:
|
|
|
52
|
|
3111
|
53 -- a string naming a font; syntax is platform dependent. Some examples for
|
|
|
54 a 14-point upright medium-weight Courier font:
|
|
|
55 X11 (and GTK1): \"-*-courier-medium-r-*-*-*-140-*-*-*-*-iso8859-*\"
|
|
|
56 Xft (and GTK2): \"Courier-14\"
|
|
|
57 MS-Windows: \"Courier:14:Western\"
|
|
442
|
58 -- a font instance (use that instance directly if the device matches,
|
|
|
59 or use the string that generated it)
|
|
|
60 -- a vector of no elements (only on TTY's; this means to set no font
|
|
|
61 at all, thus using the \"natural\" font of the terminal's text)
|
|
|
62 -- a vector of one element (a face to inherit from)
|
|
|
63 "
|
|
428
|
64 (make-specifier-and-init 'font spec-list))
|
|
|
65
|
|
|
66 (defun font-name (font &optional domain charset)
|
|
|
67 "Return the name of the FONT in the specified DOMAIN, if any.
|
|
|
68 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
69 and defaults to the selected window if omitted. This is equivalent
|
|
|
70 to using `specifier-instance' and applying `font-instance-name' to
|
|
|
71 the result. See `make-specifier' for more information about specifiers."
|
|
|
72 (ws-object-property-1 'font-instance-name font domain charset))
|
|
|
73
|
|
|
74 (defun font-ascent (font &optional domain charset)
|
|
|
75 "Return the ascent of the FONT in the specified DOMAIN, if any.
|
|
|
76 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
77 and defaults to the selected window if omitted. This is equivalent
|
|
|
78 to using `specifier-instance' and applying `font-instance-ascent' to
|
|
|
79 the result. See `make-specifier' for more information about specifiers."
|
|
|
80 (ws-object-property-1 'font-instance-ascent font domain charset))
|
|
|
81
|
|
|
82 (defun font-descent (font &optional domain charset)
|
|
|
83 "Return the descent of the FONT in the specified DOMAIN, if any.
|
|
|
84 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
85 and defaults to the selected window if omitted. This is equivalent
|
|
|
86 to using `specifier-instance' and applying `font-instance-descent' to
|
|
|
87 the result. See `make-specifier' for more information about specifiers."
|
|
|
88 (ws-object-property-1 'font-instance-descent font domain charset))
|
|
|
89
|
|
|
90 (defun font-width (font &optional domain charset)
|
|
|
91 "Return the width of the FONT in the specified DOMAIN, if any.
|
|
|
92 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
93 and defaults to the selected window if omitted. This is equivalent
|
|
|
94 to using `specifier-instance' and applying `font-instance-width' to
|
|
|
95 the result. See `make-specifier' for more information about specifiers."
|
|
|
96 (ws-object-property-1 'font-instance-width font domain charset))
|
|
|
97
|
|
|
98 (defun font-height (font &optional domain charset)
|
|
|
99 "Return the height of the FONT in the specified DOMAIN, if any.
|
|
|
100 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
101 and defaults to the selected window if omitted. This is equivalent
|
|
|
102 to using `specifier-instance' and applying `font-instance-height' to
|
|
|
103 the result. See `make-specifier' for more information about specifiers."
|
|
|
104 (ws-object-property-1 'font-instance-height font domain charset))
|
|
|
105
|
|
|
106 (defun font-proportional-p (font &optional domain charset)
|
|
|
107 "Return whether FONT is proportional in the specified DOMAIN, if known.
|
|
|
108 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
109 and defaults to the selected window if omitted. This is equivalent
|
|
|
110 to using `specifier-instance' and applying `font-instance-proportional-p' to
|
|
|
111 the result. See `make-specifier' for more information about specifiers."
|
|
|
112 (ws-object-property-1 'font-instance-proportional-p font domain charset))
|
|
|
113
|
|
|
114 (defun font-properties (font &optional domain charset)
|
|
|
115 "Return the properties of the FONT in the specified DOMAIN, if any.
|
|
|
116 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
117 and defaults to the selected window if omitted. This is equivalent
|
|
|
118 to using `specifier-instance' and applying `font-instance-properties'
|
|
|
119 to the result. See `make-specifier' for more information about specifiers."
|
|
|
120 (ws-object-property-1 'font-instance-properties font domain charset))
|
|
|
121
|
|
|
122 (defun font-truename (font &optional domain charset)
|
|
|
123 "Return the truename of the FONT in the specified DOMAIN, if any.
|
|
|
124 FONT should be a font specifier object and DOMAIN is normally a window
|
|
|
125 and defaults to the selected window if omitted. This is equivalent
|
|
|
126 to using `specifier-instance' and applying `font-instance-truename'
|
|
|
127 to the result. See `make-specifier' for more information about specifiers."
|
|
|
128 (ws-object-property-1 'font-instance-truename font domain charset))
|
|
|
129
|
|
|
130 (defun font-instance-height (font-instance)
|
|
|
131 "Return the height in pixels of FONT-INSTANCE.
|
|
|
132 The returned value is the maximum height for all characters in the font,\n\
|
|
|
133 and is equivalent to the sum of the font instance's ascent and descent."
|
|
|
134 (+ (font-instance-ascent font-instance)
|
|
|
135 (font-instance-descent font-instance)))
|
|
|
136
|
|
|
137 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; color specifiers
|
|
|
138
|
|
|
139 (defun make-color-specifier (spec-list)
|
|
|
140 "Return a new `color' specifier object with the given specification list.
|
|
|
141 SPEC-LIST can be a list of specifications (each of which is a cons of a
|
|
|
142 locale and a list of instantiators), a single instantiator, or a list
|
|
|
143 of instantiators. See `make-specifier' for a detailed description of
|
|
442
|
144 how specifiers work.
|
|
|
145
|
|
|
146 Valid instantiators for color specifiers are:
|
|
|
147
|
|
|
148 -- a string naming a color (e.g. under X this might be \"lightseagreen2\"
|
|
|
149 or \"#F534B2\")
|
|
|
150 -- a color instance (use that instance directly if the device matches,
|
|
|
151 or use the string that generated it)
|
|
|
152 -- a vector of no elements (only on TTY's; this means to set no color
|
|
|
153 at all, thus using the \"natural\" color of the terminal's text)
|
|
|
154 -- a vector of one or two elements: a face to inherit from, and
|
|
|
155 optionally a symbol naming which property of that face to inherit,
|
|
|
156 either `foreground' or `background' (if omitted, defaults to the same
|
|
|
157 property that this color specifier is used for; if this specifier is
|
|
|
158 not part of a face, the instantiator would not be valid)."
|
|
428
|
159 (make-specifier-and-init 'color spec-list))
|
|
|
160
|
|
|
161 (defun color-name (color &optional domain)
|
|
|
162 "Return the name of the COLOR in the specified DOMAIN, if any.
|
|
|
163 COLOR should be a color specifier object and DOMAIN is normally a window
|
|
|
164 and defaults to the selected window if omitted. This is equivalent
|
|
|
165 to using `specifier-instance' and applying `color-instance-name' to
|
|
|
166 the result. See `make-specifier' for more information about specifiers."
|
|
|
167 (ws-object-property-1 'color-instance-name color domain))
|
|
|
168
|
|
|
169 (defun color-rgb-components (color &optional domain)
|
|
|
170 "Return the RGB components of the COLOR in the specified DOMAIN, if any.
|
|
|
171 COLOR should be a color specifier object and DOMAIN is normally a window
|
|
|
172 and defaults to the selected window if omitted. This is equivalent
|
|
|
173 to using `specifier-instance' and applying `color-instance-rgb-components'
|
|
|
174 to the result. See `make-specifier' for more information about specifiers."
|
|
|
175 (ws-object-property-1 'color-instance-rgb-components color domain))
|
|
|
176
|
|
442
|
177 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; face-boolean specifiers
|
|
|
178
|
|
|
179 (defun make-face-boolean-specifier (spec-list)
|
|
|
180 "Return a new `face-boolean' specifier object with the given spec list.
|
|
|
181 SPEC-LIST can be a list of specifications (each of which is a cons of a
|
|
|
182 locale and a list of instantiators), a single instantiator, or a list
|
|
|
183 of instantiators. See `make-specifier' for a detailed description of
|
|
|
184 how specifiers work.
|
|
|
185
|
|
|
186 Valid instantiators for face-boolean specifiers are
|
|
|
187
|
|
|
188 -- t or nil
|
|
4201
|
189 -- a vector of one, two or three elements: a face to inherit from,
|
|
442
|
190 optionally a symbol naming the property of that face to inherit from
|
|
|
191 (if omitted, defaults to the same property that this face-boolean
|
|
|
192 specifier is used for; if this specifier is not part of a face,
|
|
|
193 the instantiator would not be valid), and optionally a value which,
|
|
|
194 if non-nil, means to invert the sense of the inherited property."
|
|
4201
|
195 (make-specifier-and-init 'face-boolean spec-list))
|
|
442
|
196
|
|
428
|
197 ;;; objects.el ends here.
|
