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

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

First attempt at new container contol.
  • Property svn:eol-style set to CRLF
  • Property svn:keywords set to Author Date Id Revision
File size: 17.6 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 VOID gpihCopyRectIncl(PRECTL prclGpi,
48 PRECTL prclWin);
49
50 /* ******************************************************************
51 *
52 * Device helpers
53 *
54 ********************************************************************/
55
56 ULONG gpihQueryDisplayCaps(ULONG ulIndex);
57
58 /* ******************************************************************
59 *
60 * Color helpers
61 *
62 ********************************************************************/
63
64 // common RGB colors
65 #define RGBCOL_BLACK 0x00000000
66 #define RGBCOL_WHITE 0x00FFFFFF
67
68 #define RGBCOL_RED 0x00FF0000
69 #define RGBCOL_PINK 0x00FF00FF
70 #define RGBCOL_BLUE 0x000000FF
71 #define RGBCOL_CYAN 0x0000FFFF
72 #define RGBCOL_GREEN 0x0000FF00
73 #define RGBCOL_YELLOW 0x00FFFF00
74 #define RGBCOL_GRAY 0x00CCCCCC
75
76 #define RGBCOL_DARKRED 0x00800000
77 #define RGBCOL_DARKPINK 0x00800080
78 #define RGBCOL_DARKBLUE 0x00000080
79 #define RGBCOL_DARKCYAN 0x00008080
80 #define RGBCOL_DARKGREEN 0x00008000
81 #define RGBCOL_DARKYELLOW 0x00808000
82 #define RGBCOL_DARKGRAY 0x00808080
83
84 /*
85 *@@ GET_BLUE:
86 * gets the BLUE (first) byte from a
87 * LONG RGB value.
88 *
89 *@@added V0.9.14 (2001-08-03) [umoeller]
90 */
91
92 #define GET_BLUE(lcol) *( ((PBYTE)(&(lcol))) )
93
94 /*
95 *@@ GET_GREEN:
96 * gets the GREEN (second) byte from a
97 * LONG RGB value.
98 *
99 *@@added V0.9.14 (2001-08-03) [umoeller]
100 */
101
102 #define GET_GREEN(lcol) *( ((PBYTE)(&(lcol))) + 1 )
103
104 /*
105 *@@ GET_RED:
106 * gets the RED (third) byte from a
107 * LONG RGB value.
108 *
109 *@@added V0.9.14 (2001-08-03) [umoeller]
110 */
111
112 #define GET_RED(lcol) *( ((PBYTE)(&(lcol))) + 2 )
113
114 /*
115 *@@ MAKE_RGB:
116 * composes a LONG color value from
117 * three BYTE values for red, green,
118 * and blue.
119 *
120 *@@added V0.9.14 (2001-08-03) [umoeller]
121 */
122
123 #define MAKE_RGB(r, g, b) (LONG)((BYTE)(b)) + (((LONG)((BYTE)(g))) << 8) + (((LONG)((BYTE)(r))) << 16)
124
125 VOID XWPENTRY gpihManipulateRGB(PLONG plColor, double dFactor);
126 typedef VOID XWPENTRY GPIHMANIPULATERGB(PLONG plColor, double dFactor);
127 typedef GPIHMANIPULATERGB *PGPIHMANIPULATERGB;
128
129 LONG XWPENTRY gpihMediumRGB(LONG lcol1, LONG lcol2);
130 typedef LONG XWPENTRY GPIHMEDIUMRGB(LONG lcol1, LONG lcol2);
131 typedef GPIHMEDIUMRGB *PGPIHMEDIUMRGB;
132
133 BOOL XWPENTRY gpihSwitchToRGB(HPS hps);
134 typedef BOOL XWPENTRY GPIHSWITCHTORGB(HPS hps);
135 typedef GPIHSWITCHTORGB *PGPIHSWITCHTORGB;
136
137 /* ******************************************************************
138 *
139 * Drawing primitives helpers
140 *
141 ********************************************************************/
142
143 VOID XWPENTRY gpihDrawRect(HPS hps, PRECTL prcl);
144 typedef VOID XWPENTRY GPIHDRAWRECT(HPS hps, PRECTL prcl);
145 typedef GPIHDRAWRECT *PGPIHDRAWRECT;
146
147 VOID XWPENTRY gpihBox(HPS hps, LONG lControl, PRECTL prcl);
148 typedef VOID XWPENTRY GPIHBOX(HPS hps, LONG lControl, PRECTL prcl);
149 typedef GPIHBOX *PGPIHBOX;
150
151 VOID XWPENTRY gpihMarker(HPS hps, LONG x, LONG y, ULONG ulWidth);
152 typedef VOID XWPENTRY GPIHMARKER(HPS hps, LONG x, LONG y, ULONG ulWidth);
153 typedef GPIHMARKER *PGPIHMARKER;
154
155 VOID XWPENTRY gpihDrawThickFrame(HPS hps, PRECTL prcl, ULONG ulWidth);
156 typedef VOID XWPENTRY GPIHDRAWTHICKFRAME(HPS hps, PRECTL prcl, ULONG ulWidth);
157 typedef GPIHDRAWTHICKFRAME *PGPIHDRAWTHICKFRAME;
158
159 VOID XWPENTRY gpihDraw3DFrame2(HPS hps,
160 PRECTL prcl,
161 USHORT usWidth,
162 LONG lColorLeft,
163 LONG lColorRight);
164 typedef VOID XWPENTRY GPIHDRAW3DFRAME2(HPS hps,
165 PRECTL prcl,
166 USHORT usWidth,
167 LONG lColorLeft,
168 LONG lColorRight);
169 typedef GPIHDRAW3DFRAME2 *PGPIHDRAW3DFRAME2;
170
171 VOID XWPENTRY gpihDraw3DFrame(HPS hps,
172 PRECTL prcl,
173 USHORT usWidth,
174 LONG lColorLeft,
175 LONG lColorRight);
176 typedef VOID XWPENTRY GPIHDRAW3DFRAME(HPS hps,
177 PRECTL prcl,
178 USHORT usWidth,
179 LONG lColorLeft,
180 LONG lColorRight);
181 typedef GPIHDRAW3DFRAME *PGPIHDRAW3DFRAME;
182
183 LONG XWPENTRY gpihCharStringPosAt(HPS hps,
184 PPOINTL pptlStart,
185 PRECTL prclRect,
186 ULONG flOptions,
187 LONG lCount,
188 PCH pchString);
189 typedef LONG XWPENTRY GPIHCHARSTRINGPOSAT(HPS hps,
190 PPOINTL pptlStart,
191 PRECTL prclRect,
192 ULONG flOptions,
193 LONG lCount,
194 PCH pchString);
195 typedef GPIHCHARSTRINGPOSAT *PGPIHCHARSTRINGPOSAT;
196
197 VOID XWPENTRY gpihCalcTextExtent(HPS hps,
198 PCSZ pcsz,
199 PLONG pcx,
200 PULONG pcLines);
201
202 VOID XWPENTRY gpihDrawString(HPS hps,
203 PCSZ pcsz,
204 PRECTL prcl,
205 ULONG fl,
206 PFONTMETRICS pfm);
207
208 /*
209 *@@ BKGNDINFO:
210 * background information passed into
211 * gpihFillBackground.
212 *
213 * The color flags apply always. The
214 * bitmap flags apply only if hbm is
215 * not NULLHANDLE.
216 *
217 *@@added V0.9.19 (2002-05-07) [umoeller]
218 */
219
220 typedef struct _BKGNDINFO
221 {
222 ULONG flPaintMode;
223 // a combination of one of the color
224 // flags and one of the bitmap flags:
225 // a) color flags
226 #define PMOD_COLORMASK 0x000F
227 #define PMOD_SOLID 0x0000 // solid color, use lcol1
228 #define PMOD_TOPBOTTOM 0x0001 // spectrum, lcol1 = top, lcol2 = bottom
229 #define PMOD_LEFTRIGHT 0x0002 // spectrum, lcol1 = left, lcol2 = right
230 // b) bitmap flags
231 #define PMOD_BMPMASK 0x00F0
232 #define PMOD_BMP_CENTER 0x0000 // center the bitmap
233 #define PMOD_BMP_SCALE_X 0x0002 // scale the bitmap to size in prcl,
234 // respect lScale
235 #define PMOD_BMP_TILE 0x0004 // tile the bitmap
236
237 LONG lcol1, // color 1 (RGB)
238 lcol2; // color 2 (RGB)
239
240 HBITMAP hbm; // bitmap or NULLHANDLE if none
241 ULONG lScale; // only with PMOD_BMP_SCALE_X: how many times
242 // the bmp should be scaled (as with WPS
243 // folder "Background" page); this cannot
244 // be zero then
245
246 } BKGNDINFO, *PBKGNDINFO;
247
248 VOID gpihFillBackground(HPS hps,
249 PRECTL prcl,
250 PBKGNDINFO pInfo);
251
252 /* ******************************************************************
253 *
254 * Font helpers
255 *
256 ********************************************************************/
257
258 BOOL XWPENTRY gpihMatchFont(HPS hps,
259 LONG lSize,
260 BOOL fFamily,
261 const char *pcszName,
262 USHORT usFormat,
263 FATTRS *pfa,
264 PFONTMETRICS pFontMetrics);
265 typedef BOOL XWPENTRY GPIHMATCHFONT(HPS hps,
266 LONG lSize,
267 BOOL fFamily,
268 const char *pcszName,
269 USHORT usFormat,
270 FATTRS *pfa,
271 PFONTMETRICS pFontMetrics);
272 typedef GPIHMATCHFONT *PGPIHMATCHFONT;
273
274 BOOL XWPENTRY gpihSplitPresFont(PSZ pszFontNameSize,
275 PULONG pulSize,
276 PSZ *ppszFaceName);
277 typedef BOOL XWPENTRY GPIHSPLITPRESFONT(PSZ pszFontNameSize,
278 PULONG pulSize,
279 PSZ *ppszFaceName);
280 typedef GPIHSPLITPRESFONT *PGPIHSPLITPRESFONT;
281
282 BOOL XWPENTRY gpihLockLCIDs(VOID);
283 typedef BOOL XWPENTRY GPIHLOCKLCIDS(VOID);
284 typedef GPIHLOCKLCIDS *PGPIHLOCKLCIDS;
285
286 VOID XWPENTRY gpihUnlockLCIDs(VOID);
287 typedef VOID XWPENTRY GPIHUNLOCKLCIDS(VOID);
288 typedef GPIHUNLOCKLCIDS *PGPIHUNLOCKLCIDS;
289
290 LONG XWPENTRY gpihCreateFont(HPS hps, FATTRS *pfa);
291 typedef LONG XWPENTRY GPIHCREATEFONT(HPS hps, FATTRS *pfa);
292 typedef GPIHCREATEFONT *PGPIHCREATEFONT;
293
294 LONG XWPENTRY gpihFindFont(HPS hps,
295 LONG lSize,
296 BOOL fFamily,
297 const char *pcszName,
298 USHORT usFormat,
299 PFONTMETRICS pFontMetrics);
300 typedef LONG XWPENTRY GPIHFINDFONT(HPS hps,
301 LONG lSize,
302 BOOL fFamily,
303 const char *pcszName,
304 USHORT usFormat,
305 PFONTMETRICS pFontMetrics);
306 typedef GPIHFINDFONT *PGPIHFINDFONT;
307
308 LONG XWPENTRY gpihFindPresFont(HWND hwnd,
309 BOOL fInherit,
310 HPS hps,
311 const char *pcszDefaultFont,
312 PFONTMETRICS pFontMetrics,
313 PLONG plSize);
314 typedef LONG XWPENTRY GPIHFINDPRESFONT(HWND hwnd,
315 BOOL fInherit,
316 HPS hps,
317 const char *pcszDefaultFont,
318 PFONTMETRICS pFontMetrics,
319 PLONG plSize);
320 typedef GPIHFINDPRESFONT *PGPIHFINDPRESFONT;
321
322 BOOL XWPENTRY gpihSetPointSize(HPS hps, LONG lPointSize);
323 typedef BOOL XWPENTRY GPIHSETPOINTSIZE(HPS hps, LONG lPointSize);
324 typedef GPIHSETPOINTSIZE *PGPIHSETPOINTSIZE;
325
326 LONG XWPENTRY gpihQueryLineSpacing(HPS hps);
327 typedef LONG XWPENTRY GPIHQUERYLINESPACING(HPS hps);
328 typedef GPIHQUERYLINESPACING *PGPIHQUERYLINESPACING;
329
330 /* ******************************************************************
331 *
332 * Bitmap helpers
333 *
334 ********************************************************************/
335
336 BOOL XWPENTRY gpihCreateMemPS(HAB hab, PSIZEL psizlPage, HDC *hdcMem, HPS *hpsMem);
337 typedef BOOL XWPENTRY GPIHCREATEMEMPS(HAB hab, PSIZEL psizlPage, HDC *hdcMem, HPS *hpsMem);
338 typedef GPIHCREATEMEMPS *PGPIHCREATEMEMPS;
339
340 HBITMAP XWPENTRY gpihCreateBitmap(HPS hpsMem, ULONG cx, ULONG cy);
341 typedef HBITMAP XWPENTRY GPIHCREATEBITMAP(HPS hpsMem, ULONG cx, ULONG cy);
342 typedef GPIHCREATEBITMAP *PGPIHCREATEBITMAP;
343
344 HBITMAP XWPENTRY gpihCreateBitmap2(HPS hpsMem, ULONG cx, ULONG cy, ULONG cPlanes, ULONG cBitCount);
345
346 HBITMAP XWPENTRY gpihCreateHalftonedBitmap(HAB hab, HBITMAP hbmSource, LONG lColorGray);
347 typedef HBITMAP XWPENTRY GPIHCREATEHALFTONEDBITMAP(HAB hab, HBITMAP hbmSource, LONG lColorGray);
348 typedef GPIHCREATEHALFTONEDBITMAP *PGPIHCREATEHALFTONEDBITMAP;
349
350 APIRET gpihLoadBitmap(HBITMAP *phbm,
351 HPS hps,
352 HMODULE hmodResource,
353 ULONG idBitmap);
354
355 APIRET XWPENTRY gpihLoadBitmapFile(HBITMAP *phbm, HPS hps, PCSZ pcszBmpFile);
356 typedef APIRET XWPENTRY GPIHLOADBITMAPFILE(HBITMAP *phbm, HPS hps, PCSZ pcszBmpFile);
357 typedef GPIHLOADBITMAPFILE *PGPIHLOADBITMAPFILE;
358
359 LONG XWPENTRY gpihStretchBitmap(HPS hpsTarget,
360 HBITMAP hbmSource,
361 PRECTL prclSource,
362 PRECTL prclTarget,
363 BOOL fProportional);
364 typedef LONG XWPENTRY GPIHSTRETCHBITMAP(HPS hpsTarget,
365 HBITMAP hbmSource,
366 PRECTL prclSource,
367 PRECTL prclTarget,
368 BOOL fProportional);
369 typedef GPIHSTRETCHBITMAP *PGPIHSTRETCHBITMAP;
370
371 /* BOOL XWPENTRY gpihIcon2Bitmap(HPS hpsMem,
372 HPOINTER hptr,
373 LONG lBkgndColor,
374 PPOINTL pptlLowerLeft,
375 ULONG ulIconSize); */
376
377 BOOL XWPENTRY gpihDrawPointer(HPS hps,
378 LONG x,
379 LONG y,
380 HPOINTER hptr,
381 PSIZEL pszlIcon,
382 PRECTL prclClip,
383 ULONG fl);
384 typedef BOOL XWPENTRY GPIHDRAWPOINTER(HPS hps,
385 LONG x,
386 LONG y,
387 HPOINTER hptr,
388 PSIZEL pszlIcon,
389 PRECTL prclClip,
390 ULONG fl);
391 typedef GPIHDRAWPOINTER *PGPIHDRAWPOINTER;
392
393 /* ******************************************************************
394 *
395 * XBitmap functions
396 *
397 ********************************************************************/
398
399 /*
400 *@@ XBITMAP:
401 * representation of an XBitmap, which is created
402 * with gpihCreateXBitmap and destroyed with
403 * gpihDestroyXBitmap.
404 *
405 * An XBitmap is essentially a set of a memory
406 * device context, a memory presentation space,
407 * and a bitmap which is selected into that
408 * HPS.
409 *
410 *@@added V0.9.12 (2001-05-20) [umoeller]
411 */
412
413 typedef struct _XBITMAP
414 {
415 HDC hdcMem; // memory DC
416 HPS hpsMem; // memory PS
417 HBITMAP hbm; // bitmap handle
418 SIZEL szl; // size of bitmap
419 } XBITMAP, *PXBITMAP;
420
421 PXBITMAP XWPENTRY gpihCreateXBitmap(HAB hab, LONG cx, LONG cy);
422 typedef PXBITMAP XWPENTRY GPIHCREATEXBITMAP(HAB hab, LONG cx, LONG cy);
423 typedef GPIHCREATEXBITMAP *PGPIHCREATEXBITMAP;
424
425 PXBITMAP gpihCreateXBitmap2(HAB hab,
426 LONG cx,
427 LONG cy,
428 ULONG cPlanes,
429 ULONG cBitCount);
430
431 HBITMAP XWPENTRY gpihDetachBitmap(PXBITMAP pbmp);
432
433 VOID XWPENTRY gpihDestroyXBitmap(PXBITMAP *ppbmp);
434 typedef VOID XWPENTRY GPIHDESTROYXBITMAP(PXBITMAP *ppbmp);
435 typedef GPIHDESTROYXBITMAP *PGPIHDESTROYXBITMAP;
436
437 PXBITMAP gpihCreateBmpFromPS(HAB hab,
438 HPS hpsScreen,
439 PRECTL prcl);
440
441#endif
442
443#if __cplusplus
444}
445#endif
446
Note: See TracBrowser for help on using the repository browser.