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 /**   Accordion Menu Management (Menu)                                    */
18 /**                                                                       */
19 /**************************************************************************/
20 
21 #define GX_SOURCE_CODE
22 
23 
24 /* Include necessary system files.  */
25 
26 #include "gx_api.h"
27 #include "gx_menu.h"
28 
29 /* Bring in externs for caller checking code.  */
30 GX_CALLER_CHECKING_EXTERNS
31 
32 /**************************************************************************/
33 /*                                                                        */
34 /*  FUNCTION                                               RELEASE        */
35 /*                                                                        */
36 /*    _gxe_accordion_menu_create                          PORTABLE C      */
37 /*                                                           6.1          */
38 /*  AUTHOR                                                                */
39 /*                                                                        */
40 /*    Kenneth Maxwell, Microsoft Corporation                              */
41 /*                                                                        */
42 /*  DESCRIPTION                                                           */
43 /*                                                                        */
44 /*    This function checks for errors in accordion menu create function   */
45 /*    call.                                                               */
46 /*                                                                        */
47 /*  INPUT                                                                 */
48 /*                                                                        */
49 /*    menu                                  Pointer to the accordion menu */
50 /*                                            control block               */
51 /*    name                                  Name of the menu              */
52 /*    parent                                Parent widget control block   */
53 /*    style                                 Style of the widget           */
54 /*    tree_menu_id                          Application-defined ID of     */
55 /*                                          the accordion menu            */
56 /*    size                                  Accordion menu size           */
57 /*    control_block_size                    Control block size            */
58 /*                                                                        */
59 /*  OUTPUT                                                                */
60 /*                                                                        */
61 /*    status                                Completion status             */
62 /*                                                                        */
63 /*  CALLS                                                                 */
64 /*                                                                        */
65 /*    _gx_accordion_menu_create             Actual accordion menu create  */
66 /*                                            function call               */
67 /*                                                                        */
68 /*  CALLED BY                                                             */
69 /*                                                                        */
70 /*    Application Code                                                    */
71 /*                                                                        */
72 /*  RELEASE HISTORY                                                       */
73 /*                                                                        */
74 /*    DATE              NAME                      DESCRIPTION             */
75 /*                                                                        */
76 /*  05-19-2020     Kenneth Maxwell          Initial Version 6.0           */
77 /*  09-30-2020     Kenneth Maxwell          Modified comment(s),          */
78 /*                                            resulting in version 6.1    */
79 /*                                                                        */
80 /**************************************************************************/
_gxe_accordion_menu_create(GX_ACCORDION_MENU * accordion,GX_CONST GX_CHAR * name,GX_WIDGET * parent,ULONG style,USHORT accordion_menu_id,GX_CONST GX_RECTANGLE * size,UINT control_block_size)81 UINT  _gxe_accordion_menu_create(GX_ACCORDION_MENU *accordion, GX_CONST GX_CHAR *name, GX_WIDGET *parent,
82                                  ULONG style, USHORT accordion_menu_id, GX_CONST GX_RECTANGLE *size, UINT control_block_size)
83 {
84 UINT status;
85 
86     /* Check for appropriate caller.  */
87     GX_INIT_AND_THREADS_CALLER_CHECKING
88 
89     /* Check for invalid input pointers.  */
90     if ((!accordion) || (!size))
91     {
92         return(GX_PTR_ERROR);
93     }
94 
95     /* Check for widget already created.  */
96     if (accordion -> gx_widget_type != 0)
97     {
98         return(GX_ALREADY_CREATED);
99     }
100 
101     /* Check for invalid control block size. */
102     if (control_block_size != sizeof(GX_ACCORDION_MENU))
103     {
104         return(GX_INVALID_SIZE);
105     }
106 
107     /* Call actual accordion menu create function.  */
108     status = _gx_accordion_menu_create(accordion, name, parent, style, accordion_menu_id, size);
109 
110     return(status);
111 }
112 
113