source: trunk/include/helpers/gpih.h@ 166

Last change on this file since 166 was 164, checked in by umoeller, 23 years ago

Massive pager rework.
  • Property svn:eol-style set to CRLF
  • Property svn:keywords set to Author Date Id Revision
File size: 15.4 KB
Line 
1
2/*
3 *@@sourcefile gpih.h:
4 * header file for gpih.c (GPI helper functions). See remarks there.
5 *
6 * Note: Version numbering in this file relates to XWorkplace version
7 * numbering.
8 *
9 *@@include #define INCL_GPILOGCOLORTABLE // for some funcs
10 *@@include #include <os2.h>
11 *@@include #include "helpers\gpih.h"
12 */
13
14/*
15 * Copyright (C) 1997-2000 Ulrich M”ller.
16 * This file is part of the "XWorkplace helpers" source package.
17 * This is free software; you can redistribute it and/or modify
18 * it under the terms of the GNU General Public License as published
19 * by the Free Software Foundation, in version 2 as it comes in the
20 * "COPYING" file of the XWorkplace main distribution.
21 * This program is distributed in the hope that it will be useful,
22 * but WITHOUT ANY WARRANTY; without even the implied warranty of
23 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
24 * GNU General Public License for more details.
25 */
26
27#if __cplusplus
28extern "C" {
29#endif
30
31#ifndef GPIH_HEADER_INCLUDED
32 #define GPIH_HEADER_INCLUDED
33
34 /* ******************************************************************
35 *
36 * Rectangle helpers
37 *
38 ********************************************************************/
39
40 BOOL gpihIsPointInRect(PRECTL prcl,
41 LONG x,
42 LONG y);
43
44 VOID gpihInflateRect(PRECTL prcl,
45 LONG l);
46
47 /* ******************************************************************
48 *
49 * Device helpers
50 *
51 ********************************************************************/
52
53 ULONG gpihQueryDisplayCaps(ULONG ulIndex);
54
55 /* ******************************************************************
56 *
57 * Color helpers
58 *
59 ********************************************************************/
60
61 // common RGB colors
62 #define RGBCOL_BLACK 0x00000000
63 #define RGBCOL_WHITE 0x00FFFFFF
64
65 #define RGBCOL_RED 0x00FF0000
66 #define RGBCOL_PINK 0x00FF00FF
67 #define RGBCOL_BLUE 0x000000FF
68 #define RGBCOL_CYAN 0x0000FFFF
69 #define RGBCOL_GREEN 0x0000FF00
70 #define RGBCOL_YELLOW 0x00FFFF00
71 #define RGBCOL_GRAY 0x00CCCCCC
72
73 #define RGBCOL_DARKRED 0x00800000
74 #define RGBCOL_DARKPINK 0x00800080
75 #define RGBCOL_DARKBLUE 0x00000080
76 #define RGBCOL_DARKCYAN 0x00008080
77 #define RGBCOL_DARKGREEN 0x00008000
78 #define RGBCOL_DARKYELLOW 0x00808000
79 #define RGBCOL_DARKGRAY 0x00808080
80
81 /*
82 *@@ GET_BLUE:
83 * gets the BLUE (first) byte from a
84 * LONG RGB value.
85 *
86 *@@added V0.9.14 (2001-08-03) [umoeller]
87 */
88
89 #define GET_BLUE(lcol) *( ((PBYTE)(&(lcol))) )
90
91 /*
92 *@@ GET_GREEN:
93 * gets the GREEN (second) byte from a
94 * LONG RGB value.
95 *
96 *@@added V0.9.14 (2001-08-03) [umoeller]
97 */
98
99 #define GET_GREEN(lcol) *( ((PBYTE)(&(lcol))) + 1 )
100
101 /*
102 *@@ GET_RED:
103 * gets the RED (third) byte from a
104 * LONG RGB value.
105 *
106 *@@added V0.9.14 (2001-08-03) [umoeller]
107 */
108
109 #define GET_RED(lcol) *( ((PBYTE)(&(lcol))) + 2 )
110
111 /*
112 *@@ MAKE_RGB:
113 * composes a LONG color value from
114 * three BYTE values for red, green,
115 * and blue.
116 *
117 *@@added V0.9.14 (2001-08-03) [umoeller]
118 */
119
120 #define MAKE_RGB(r, g, b) (LONG)((BYTE)(b)) + (((LONG)((BYTE)(g))) << 8) + (((LONG)((BYTE)(r))) << 16)
121
122 VOID XWPENTRY gpihManipulateRGB(PLONG plColor, double dFactor);
123 typedef VOID XWPENTRY GPIHMANIPULATERGB(PLONG plColor, double dFactor);
124 typedef GPIHMANIPULATERGB *PGPIHMANIPULATERGB;
125
126 BOOL XWPENTRY gpihSwitchToRGB(HPS hps);
127 typedef BOOL XWPENTRY GPIHSWITCHTORGB(HPS hps);
128 typedef GPIHSWITCHTORGB *PGPIHSWITCHTORGB;
129
130 /* ******************************************************************
131 *
132 * Drawing primitives helpers
133 *
134 ********************************************************************/
135
136 VOID XWPENTRY gpihDrawRect(HPS hps, PRECTL prcl);
137 typedef VOID XWPENTRY GPIHDRAWRECT(HPS hps, PRECTL prcl);
138 typedef GPIHDRAWRECT *PGPIHDRAWRECT;
139
140 VOID XWPENTRY gpihBox(HPS hps, LONG lControl, PRECTL prcl);
141 typedef VOID XWPENTRY GPIHBOX(HPS hps, LONG lControl, PRECTL prcl);
142 typedef GPIHBOX *PGPIHBOX;
143
144 VOID XWPENTRY gpihMarker(HPS hps, LONG x, LONG y, ULONG ulWidth);
145 typedef VOID XWPENTRY GPIHMARKER(HPS hps, LONG x, LONG y, ULONG ulWidth);
146 typedef GPIHMARKER *PGPIHMARKER;
147
148 VOID XWPENTRY gpihDrawThickFrame(HPS hps, PRECTL prcl, ULONG ulWidth);
149 typedef VOID XWPENTRY GPIHDRAWTHICKFRAME(HPS hps, PRECTL prcl, ULONG ulWidth);
150 typedef GPIHDRAWTHICKFRAME *PGPIHDRAWTHICKFRAME;
151
152 VOID XWPENTRY gpihDraw3DFrame(HPS hps,
153 PRECTL prcl,
154 USHORT usWidth,
155 LONG lColorLeft,
156 LONG lColorRight);
157 typedef VOID XWPENTRY GPIHDRAW3DFRAME(HPS hps,
158 PRECTL prcl,
159 USHORT usWidth,
160 LONG lColorLeft,
161 LONG lColorRight);
162 typedef GPIHDRAW3DFRAME *PGPIHDRAW3DFRAME;
163
164 LONG XWPENTRY gpihCharStringPosAt(HPS hps,
165 PPOINTL pptlStart,
166 PRECTL prclRect,
167 ULONG flOptions,
168 LONG lCount,
169 PCH pchString);
170 typedef LONG XWPENTRY GPIHCHARSTRINGPOSAT(HPS hps,
171 PPOINTL pptlStart,
172 PRECTL prclRect,
173 ULONG flOptions,
174 LONG lCount,
175 PCH pchString);
176 typedef GPIHCHARSTRINGPOSAT *PGPIHCHARSTRINGPOSAT;
177
178 /*
179 *@@ BKGNDINFO:
180 * background information passed into
181 * gpihFillBackground.
182 *
183 * The color flags apply always. The
184 * bitmap flags apply only if hbm is
185 * not NULLHANDLE.
186 *
187 *@@added V0.9.19 (2002-05-07) [umoeller]
188 */
189
190 typedef struct _BKGNDINFO
191 {
192 ULONG flPaintMode;
193 // a combination of one of the color
194 // flags and one of the bitmap flags:
195 // a) color flags
196 #define PMOD_COLORMASK 0x000F
197 #define PMOD_SOLID 0x0000 // solid color, use lcol1
198 #define PMOD_TOPBOTTOM 0x0001 // spectrum, lcol1 = top, lcol2 = bottom
199 #define PMOD_LEFTRIGHT 0x0002 // spectrum, lcol1 = left, lcol2 = right
200 // b) bitmap flags
201 #define PMOD_BMPMASK 0x00F0
202 #define PMOD_BMP_CENTER 0x0000 // center the bitmap
203 #define PMOD_BMP_SCALE_X 0x0002 // scale the bitmap to size in prcl,
204 // respect lScale
205 #define PMOD_BMP_TILE 0x0004 // tile the bitmap
206
207 LONG lcol1, // color 1 (RGB)
208 lcol2; // color 2 (RGB)
209
210 HBITMAP hbm; // bitmap or NULLHANDLE if none
211 ULONG lScale; // only with PMOD_BMP_SCALE_X: how many times
212 // the bmp should be scaled (as with WPS
213 // folder "Background" page); this cannot
214 // be zero then
215
216 } BKGNDINFO, *PBKGNDINFO;
217
218 VOID gpihFillBackground(HPS hps,
219 PRECTL prcl,
220 PBKGNDINFO pInfo);
221
222 /* ******************************************************************
223 *
224 * Font helpers
225 *
226 ********************************************************************/
227
228 BOOL XWPENTRY gpihMatchFont(HPS hps,
229 LONG lSize,
230 BOOL fFamily,
231 const char *pcszName,
232 USHORT usFormat,
233 FATTRS *pfa,
234 PFONTMETRICS pFontMetrics);
235 typedef BOOL XWPENTRY GPIHMATCHFONT(HPS hps,
236 LONG lSize,
237 BOOL fFamily,
238 const char *pcszName,
239 USHORT usFormat,
240 FATTRS *pfa,
241 PFONTMETRICS pFontMetrics);
242 typedef GPIHMATCHFONT *PGPIHMATCHFONT;
243
244 BOOL XWPENTRY gpihSplitPresFont(PSZ pszFontNameSize,
245 PULONG pulSize,
246 PSZ *ppszFaceName);
247 typedef BOOL XWPENTRY GPIHSPLITPRESFONT(PSZ pszFontNameSize,
248 PULONG pulSize,
249 PSZ *ppszFaceName);
250 typedef GPIHSPLITPRESFONT *PGPIHSPLITPRESFONT;
251
252 BOOL XWPENTRY gpihLockLCIDs(VOID);
253 typedef BOOL XWPENTRY GPIHLOCKLCIDS(VOID);
254 typedef GPIHLOCKLCIDS *PGPIHLOCKLCIDS;
255
256 VOID XWPENTRY gpihUnlockLCIDs(VOID);
257 typedef VOID XWPENTRY GPIHUNLOCKLCIDS(VOID);
258 typedef GPIHUNLOCKLCIDS *PGPIHUNLOCKLCIDS;
259
260 LONG XWPENTRY gpihCreateFont(HPS hps, FATTRS *pfa);
261 typedef LONG XWPENTRY GPIHCREATEFONT(HPS hps, FATTRS *pfa);
262 typedef GPIHCREATEFONT *PGPIHCREATEFONT;
263
264 LONG XWPENTRY gpihFindFont(HPS hps,
265 LONG lSize,
266 BOOL fFamily,
267 const char *pcszName,
268 USHORT usFormat,
269 PFONTMETRICS pFontMetrics);
270 typedef LONG XWPENTRY GPIHFINDFONT(HPS hps,
271 LONG lSize,
272 BOOL fFamily,
273 const char *pcszName,
274 USHORT usFormat,
275 PFONTMETRICS pFontMetrics);
276 typedef GPIHFINDFONT *PGPIHFINDFONT;
277
278 LONG XWPENTRY gpihFindPresFont(HWND hwnd,
279 BOOL fInherit,
280 HPS hps,
281 const char *pcszDefaultFont,
282 PFONTMETRICS pFontMetrics,
283 PLONG plSize);
284 typedef LONG XWPENTRY GPIHFINDPRESFONT(HWND hwnd,
285 BOOL fInherit,
286 HPS hps,
287 const char *pcszDefaultFont,
288 PFONTMETRICS pFontMetrics,
289 PLONG plSize);
290 typedef GPIHFINDPRESFONT *PGPIHFINDPRESFONT;
291
292 BOOL XWPENTRY gpihSetPointSize(HPS hps, LONG lPointSize);
293 typedef BOOL XWPENTRY GPIHSETPOINTSIZE(HPS hps, LONG lPointSize);
294 typedef GPIHSETPOINTSIZE *PGPIHSETPOINTSIZE;
295
296 LONG XWPENTRY gpihQueryLineSpacing(HPS hps);
297 typedef LONG XWPENTRY GPIHQUERYLINESPACING(HPS hps);
298 typedef GPIHQUERYLINESPACING *PGPIHQUERYLINESPACING;
299
300 /* ******************************************************************
301 *
302 * Bitmap helpers
303 *
304 ********************************************************************/
305
306 BOOL XWPENTRY gpihCreateMemPS(HAB hab, PSIZEL psizlPage, HDC *hdcMem, HPS *hpsMem);
307 typedef BOOL XWPENTRY GPIHCREATEMEMPS(HAB hab, PSIZEL psizlPage, HDC *hdcMem, HPS *hpsMem);
308 typedef GPIHCREATEMEMPS *PGPIHCREATEMEMPS;
309
310 HBITMAP XWPENTRY gpihCreateBitmap(HPS hpsMem, ULONG cx, ULONG cy);
311 typedef HBITMAP XWPENTRY GPIHCREATEBITMAP(HPS hpsMem, ULONG cx, ULONG cy);
312 typedef GPIHCREATEBITMAP *PGPIHCREATEBITMAP;
313
314 HBITMAP XWPENTRY gpihCreateBitmap2(HPS hpsMem, ULONG cx, ULONG cy, ULONG cPlanes, ULONG cBitCount);
315
316 HBITMAP XWPENTRY gpihCreateHalftonedBitmap(HAB hab, HBITMAP hbmSource, LONG lColorGray);
317 typedef HBITMAP XWPENTRY GPIHCREATEHALFTONEDBITMAP(HAB hab, HBITMAP hbmSource, LONG lColorGray);
318 typedef GPIHCREATEHALFTONEDBITMAP *PGPIHCREATEHALFTONEDBITMAP;
319
320 APIRET XWPENTRY gpihLoadBitmapFile(HBITMAP *phbm, HPS hps, PCSZ pcszBmpFile);
321 typedef APIRET XWPENTRY GPIHLOADBITMAPFILE(HBITMAP *phbm, HPS hps, PCSZ pcszBmpFile);
322 typedef GPIHLOADBITMAPFILE *PGPIHLOADBITMAPFILE;
323
324 LONG XWPENTRY gpihStretchBitmap(HPS hpsTarget,
325 HBITMAP hbmSource,
326 PRECTL prclSource,
327 PRECTL prclTarget,
328 BOOL fProportional);
329 typedef LONG XWPENTRY GPIHSTRETCHBITMAP(HPS hpsTarget,
330 HBITMAP hbmSource,
331 PRECTL prclSource,
332 PRECTL prclTarget,
333 BOOL fProportional);
334 typedef GPIHSTRETCHBITMAP *PGPIHSTRETCHBITMAP;
335
336 BOOL XWPENTRY gpihIcon2Bitmap(HPS hpsMem,
337 HPOINTER hptr,
338 LONG lBkgndColor,
339 PPOINTL pptlLowerLeft,
340 ULONG ulIconSize);
341
342 /* ******************************************************************
343 *
344 * XBitmap functions
345 *
346 ********************************************************************/
347
348 /*
349 *@@ XBITMAP:
350 * representation of an XBitmap, which is created
351 * with gpihCreateXBitmap and destroyed with
352 * gpihDestroyXBitmap.
353 *
354 * An XBitmap is essentially a set of a memory
355 * device context, a memory presentation space,
356 * and a bitmap which is selected into that
357 * HPS.
358 *
359 *@@added V0.9.12 (2001-05-20) [umoeller]
360 */
361
362 typedef struct _XBITMAP
363 {
364 HDC hdcMem; // memory DC
365 HPS hpsMem; // memory PS
366 HBITMAP hbm; // bitmap handle
367 SIZEL szl; // size of bitmap
368 } XBITMAP, *PXBITMAP;
369
370 PXBITMAP XWPENTRY gpihCreateXBitmap(HAB hab, LONG cx, LONG cy);
371 typedef PXBITMAP XWPENTRY GPIHCREATEXBITMAP(HAB hab, LONG cx, LONG cy);
372 typedef GPIHCREATEXBITMAP *PGPIHCREATEXBITMAP;
373
374 PXBITMAP gpihCreateXBitmap2(HAB hab,
375 LONG cx,
376 LONG cy,
377 ULONG cPlanes,
378 ULONG cBitCount);
379
380 HBITMAP XWPENTRY gpihDetachBitmap(PXBITMAP pbmp);
381
382 VOID XWPENTRY gpihDestroyXBitmap(PXBITMAP *ppbmp);
383 typedef VOID XWPENTRY GPIHDESTROYXBITMAP(PXBITMAP *ppbmp);
384 typedef GPIHDESTROYXBITMAP *PGPIHDESTROYXBITMAP;
385
386 PXBITMAP gpihCreateBmpFromPS(HAB hab,
387 HPS hpsScreen,
388 PRECTL prcl);
389
390#endif
391
392#if __cplusplus
393}
394#endif
395
Note: See TracBrowser for help on using the repository browser.