1 /***************************************************************************
2  * Copyright (c) 2024 Microsoft Corporation
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the MIT License which is available at
6  * https://opensource.org/licenses/MIT.
7  *
8  * SPDX-License-Identifier: MIT
9  **************************************************************************/
10 
11 
12 /**************************************************************************/
13 /**************************************************************************/
14 /**                                                                       */
15 /** GUIX Component                                                        */
16 /**                                                                       */
17 /**   Numeric Pixelmap Prompt Management (Prompt)                         */
18 /**                                                                       */
19 /**************************************************************************/
20 /**************************************************************************/
21 
22 
23 /**************************************************************************/
24 /*                                                                        */
25 /*  COMPONENT DEFINITION                                   RELEASE        */
26 /*                                                                        */
27 /*    gx_numeric_pixelmap_prompt.h                        PORTABLE C      */
28 /*                                                           6.1          */
29 /*  AUTHOR                                                                */
30 /*                                                                        */
31 /*    Kenneth Maxwell, Microsoft Corporation                              */
32 /*                                                                        */
33 /*  DESCRIPTION                                                           */
34 /*                                                                        */
35 /*    This file defines the GUIX numeric pixelmap prompt management       */
36 /*    component, including all data types and external references.  It is */
37 /*    assumed that gx_api.h and gx_port.h have already been included.     */
38 /*                                                                        */
39 /*  RELEASE HISTORY                                                       */
40 /*                                                                        */
41 /*    DATE              NAME                      DESCRIPTION             */
42 /*                                                                        */
43 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
44 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
45 /*                                            resulting in version 6.1    */
46 /*                                                                        */
47 /**************************************************************************/
48 
49 #ifndef GX_NUMERIC_PIXELMAP_PROMPT_H
50 #define GX_NUMERIC_PIXELMAP_PROMPT_H
51 
52 
53 /* Define numeric pixelmap prompt management function prototypes.  */
54 
55 UINT _gx_numeric_pixelmap_prompt_create(GX_NUMERIC_PIXELMAP_PROMPT *prompt,
56                                         GX_CONST GX_CHAR *name, GX_WIDGET *parent,
57                                         GX_RESOURCE_ID text_id, GX_RESOURCE_ID fill_id,
58                                         ULONG style, USHORT pixelmap_prompt_id,
59                                         GX_CONST GX_RECTANGLE *size);
60 VOID _gx_numeric_pixelmap_prompt_format(GX_NUMERIC_PIXELMAP_PROMPT *prompt, INT value);
61 UINT _gx_numeric_pixelmap_prompt_format_function_set(GX_NUMERIC_PIXELMAP_PROMPT *prompt, VOID (*format_func)(GX_NUMERIC_PIXELMAP_PROMPT *, INT));
62 UINT _gx_numeric_pixelmap_prompt_value_set(GX_NUMERIC_PIXELMAP_PROMPT *prompt, INT value);
63 
64 /* Define error checking shells for API services.  These are only referenced by the
65    application.  */
66 
67 UINT _gxe_numeric_pixelmap_prompt_create(GX_NUMERIC_PIXELMAP_PROMPT *prompt,
68                                          GX_CONST GX_CHAR *name, GX_WIDGET *parent,
69                                          GX_RESOURCE_ID text_id, GX_RESOURCE_ID fill_id,
70                                          ULONG style, USHORT pixelmap_prompt_id,
71                                          GX_CONST GX_RECTANGLE *size,
72                                          UINT control_block_size);
73 UINT _gxe_numeric_pixelmap_prompt_format_function_set(GX_NUMERIC_PIXELMAP_PROMPT *prompt, VOID (*format_func)(GX_NUMERIC_PIXELMAP_PROMPT *, INT));
74 UINT _gxe_numeric_pixelmap_prompt_value_set(GX_NUMERIC_PIXELMAP_PROMPT *prompt, INT value);
75 #endif
76 
77