annotate lwlib/xlwgcs.h @ 4917:fce43cb76a1c

xlike cleanup, documentation -------------------- ChangeLog entries follow: -------------------- man/ChangeLog addition: 2010-02-03 Ben Wing <ben@xemacs.org> * internals/internals.texi (Top): * internals/internals.texi (Evaluation; Stack Frames; Bindings): * internals/internals.texi (Ben's README): * internals/internals.texi (Consoles; Devices; Frames; Windows): * internals/internals.texi (Window Hierarchy): * internals/internals.texi (The Window Object): * internals/internals.texi (Modules for the Basic Displayable Lisp Objects): * internals/internals.texi (Window-System Support): * internals/internals.texi (Creating a Window-System Type): * internals/internals.texi (Discussion -- Garbage Collection): Update the part at the top about how to maintain the file with more tips. Add a chapter on "window-system support" describing in a general way how the support for different window systems/device types works, including the separation between device-independent and device-dependent parts, device methods, the specific device types and the "xlike" pseudo-type. src/ChangeLog addition: 2010-02-03 Ben Wing <ben@xemacs.org> * Makefile.in.in: * Makefile.in.in (x_objs): * Makefile.in.in (gtk_gui_objs): * console-xlike-inc.h: * depend: * device-x.c: * emacs.c: * gccache-gtk.h: * gccache-gtk.h (gc_cache_lookup): * gccache-x.c: * gccache-x.c (GCCACHE_HASH): * gccache-x.h: * toolbar-gtk.c: * toolbar-gtk.c (gtk_initialize_frame_toolbars): * toolbar-x.c: * toolbar-x.c (x_initialize_frame_toolbars): * toolbar-xlike.c: * toolbar-xlike.c (xlike_draw_blank_toolbar_button): * toolbar-xlike.c (xlike_output_toolbar_button): * toolbar-xlike.c (xlike_get_button_size): * toolbar-xlike.c (XLIKE_OUTPUT_BUTTONS_LOOP): * toolbar-xlike.c (xlike_output_toolbar): * toolbar-xlike.c (xlike_clear_toolbar): * toolbar-xlike.c (xlike_output_frame_toolbars): * toolbar-xlike.c (xlike_clear_frame_toolbars): * toolbar-xlike.c (xlike_redraw_exposed_toolbar): * toolbar-xlike.c (xlike_redraw_exposed_toolbars): * toolbar-xlike.c (xlike_redraw_frame_toolbars): * toolbar-xlike.h: * toolbar-xlike.h (xlike_clear_frame_toolbars): Rename some files to make them consistent with general naming rules: xgccache.c -> gccache-x.c xgccache.h -> gccache-x.h toolbar-common.c -> toolbar-xlike.c toolbar-common.h -> toolbar-xlike.h Fix include-file references. Also change the names of functions in now-named toolbar-xlike.c to be xlike_foo() instead of common_foo(). Add a longish comment in console-xlike-inc.h describing the "xlike" system, how it works and what the various files are used for.
author Ben Wing <ben@xemacs.org>
date Wed, 03 Feb 2010 02:46:50 -0600
parents 5460287a3327
children 308d34e9f07d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
1 /* Tabs Widget for XEmacs.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
2 Copyright (C) 1999 Edward A. Falk
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 398
diff changeset
3
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
4 This file is part of XEmacs.
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 398
diff changeset
5
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
9 later version.
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 398
diff changeset
10
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
14 for more details.
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 398
diff changeset
15
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 398
diff changeset
20
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
21 /* Synched up with: Gcs 1.7 */
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 398
diff changeset
22
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
23
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
24 #ifndef GCS_H
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
25 #define GCS_H
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
26
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
27 /* Overview of functions provided here:
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
28 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
29 * AllocFgGC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
30 * Given a foreground pixel & a font, return an appropriate GC
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
31 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
32 * AllocBackgroundGC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
33 * Given a widget, return a GC for painting the background color
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
34 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
35 * AllocShadeGC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
36 * Given foreground, background, a contrast value & be_nice_to_colormap
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
37 * flag, return a GC suitable for rendering in an intermediate color,
442
abe6d1db359e Import from CVS: tag r21-2-36
cvs
parents: 398
diff changeset
38 * as determined by contrast. May return a dither pattern or a
398
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
39 * solid color, as appropriate.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
40 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
41 * Contrast 0 = background color, 100 = foreground color. It is legal
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
42 * for contrast to be more than 100 or less than 0.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
43 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
44 * AllocGreyGC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
45 * Given widget, foreground, font, contrast & be_nice_to_colormap,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
46 * return a shade GC (see above) based on foreground and widget
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
47 * background.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
48 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
49 * AllocTopShadowGC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
50 * Given widget, contrast & be_nice_to_colormap, return a GC suitable
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
51 * for rendering the top shadow.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
52 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
53 * Contrast 0 = use background pixel. Contrast > 0 = use brighter
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
54 * colors.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
55 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
56 * AllocBotShadowGC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
57 * Given widget, contrast & be_nice_to_colormap, return a GC suitable
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
58 * for rendering the bottom shadow.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
59 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
60 * Contrast 0 = use background pixel. Contrast > 0 = use darker
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
61 * colors.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
62 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
63 * AllocArmShadowGC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
64 * Given widget, contrast & be_nice_to_colormap, return a GC suitable
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
65 * for rendering the "armed" shadow.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
66 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
67 * Contrast 0 = use background pixel. Contrast > 0 = use darker
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
68 * colors.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
69 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
70 * AllocShadowPixel()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
71 * Given a widget & scale factor, allocate & return a color darker
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
72 * or lighter than the background pixel, as determined by scale.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
73 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
74 * Scale 100 = use background pixel. Scale > 100 = brighter color,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
75 * Scale < 100 = darker color.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
76 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
77 * AllocGreyPixel()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
78 * Given two pixel values and scale factor, allocate & return a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
79 * pixel value between them, according to scale.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
80 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
81 * Scale == 0: background color
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
82 * Scale == 100: foreground color
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
83 * 0<Scale<100: intermediate color
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
84 * Scale > 100: more foreground
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
85 * Scale < 0: more background
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
86 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
87 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
88 * AllocGreyPixelC()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
89 * Given two color values and scale factor, allocate & return a
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
90 * pixel value between them, according to scale.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
91 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
92 * Scale == 0: background color
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
93 * Scale == 100: foreground color
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
94 * 0<Scale<100: intermediate color
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
95 * Scale > 100: more foreground
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
96 * Scale < 0: more background
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
97 *
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
98 * Draw3dBox()
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
99 * Given box dimensions, shadow width, top shadow GC & bottom shadow GC,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
100 * draw a 3-d box.
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
101 */
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
102
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
103 #if NeedFunctionPrototypes
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
104
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
105 extern GC AllocFgGC( Widget w, Pixel fg, Font font) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
106 extern GC AllocBackgroundGC( Widget w, Font font) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
107 extern GC AllocShadeGC( Widget w, Pixel fg, Pixel bg, Font,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
108 int contrast, Bool ) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
109 extern GC AllocGreyGC( Widget w, Pixel fg, Font, int, Bool ) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
110 extern GC AllocTopShadowGC( Widget w, int contrast, int ) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
111 extern GC AllocBotShadowGC( Widget w, int contrast, int ) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
112 extern GC AllocArmGC( Widget w, int contrast, int) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
113 extern Pixel AllocShadowPixel(Widget, int scale) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
114 extern Pixel AllocGreyPixel(Widget, Pixel fg, Pixel bg, int scale) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
115 extern Pixel AllocGreyPixelC(Widget, XColor *fg, XColor *bg, int scale) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
116 extern void Draw3dBox(Widget w, int x, int y, int wid, int hgt, int s,
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
117 GC topgc, GC botgc) ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
118
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
119 #else
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
120
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
121 extern GC AllocFgGC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
122 extern GC AllocBackgroundGC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
123 extern GC AllocShadeGC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
124 extern GC AllocGreyGC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
125 extern GC AllocTopShadowGC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
126 extern GC AllocBotShadowGC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
127 extern GC AllocArmGC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
128 extern Pixel AllocShadowPixel() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
129 extern Pixel AllocGreyPixel() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
130 extern Pixel AllocGreyPixelC() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
131 extern void Draw3dBox() ;
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
132
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
133 #endif
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
134
74fd4e045ea6 Import from CVS: tag r21-2-29
cvs
parents:
diff changeset
135 #endif /* GCS_H */