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 |
|
|
/** Veritical List (List) */ |
18 |
|
|
/** */ |
19 |
|
|
/**************************************************************************/ |
20 |
|
|
|
21 |
|
|
#define GX_SOURCE_CODE |
22 |
|
|
|
23 |
|
|
|
24 |
|
|
/* Include necessary system files. */ |
25 |
|
|
|
26 |
|
|
#include "gx_api.h" |
27 |
|
|
#include "gx_window.h" |
28 |
|
|
|
29 |
|
|
GX_CALLER_CHECKING_EXTERNS |
30 |
|
|
|
31 |
|
|
/**************************************************************************/ |
32 |
|
|
/* */ |
33 |
|
|
/* FUNCTION RELEASE */ |
34 |
|
|
/* */ |
35 |
|
|
/* _gxe_vertical_list_page_index_set PORTABLE C */ |
36 |
|
|
/* 6.1 */ |
37 |
|
|
/* AUTHOR */ |
38 |
|
|
/* */ |
39 |
|
|
/* Kenneth Maxwell, Microsoft Corporation */ |
40 |
|
|
/* */ |
41 |
|
|
/* DESCRIPTION */ |
42 |
|
|
/* */ |
43 |
|
|
/* This function checks for errors in the vertical list index set */ |
44 |
|
|
/* function call. */ |
45 |
|
|
/* */ |
46 |
|
|
/* INPUT */ |
47 |
|
|
/* */ |
48 |
|
|
/* vertical_list Vertical list widget control */ |
49 |
|
|
/* block */ |
50 |
|
|
/* index The new top index */ |
51 |
|
|
/* */ |
52 |
|
|
/* OUTPUT */ |
53 |
|
|
/* */ |
54 |
|
|
/* status Completion status */ |
55 |
|
|
/* */ |
56 |
|
|
/* CALLS */ |
57 |
|
|
/* */ |
58 |
|
|
/* _gx_vertical_list_page_index_set Actual vertial list page */ |
59 |
|
|
/* index set function */ |
60 |
|
|
/* */ |
61 |
|
|
/* CALLED BY */ |
62 |
|
|
/* */ |
63 |
|
|
/* Application Code */ |
64 |
|
|
/* */ |
65 |
|
|
/* RELEASE HISTORY */ |
66 |
|
|
/* */ |
67 |
|
|
/* DATE NAME DESCRIPTION */ |
68 |
|
|
/* */ |
69 |
|
|
/* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */ |
70 |
|
|
/* 09-30-2020 Kenneth Maxwell Modified comment(s), */ |
71 |
|
|
/* resulting in version 6.1 */ |
72 |
|
|
/* */ |
73 |
|
|
/**************************************************************************/ |
74 |
|
32 |
UINT _gxe_vertical_list_page_index_set(GX_VERTICAL_LIST *vertical_list, INT index) |
75 |
|
|
{ |
76 |
|
|
|
77 |
|
|
/* Check for appropriate caller. */ |
78 |
✓✓✓✓
✓✓ |
32 |
GX_INIT_AND_THREADS_CALLER_CHECKING |
79 |
|
|
|
80 |
|
|
/* Check for invalid input pointers. */ |
81 |
✓✓ |
30 |
if (vertical_list == GX_NULL) |
82 |
|
|
{ |
83 |
|
2 |
return GX_PTR_ERROR; |
84 |
|
|
} |
85 |
|
|
|
86 |
|
|
/* Check for invalid widget. */ |
87 |
✓✓ |
28 |
if (vertical_list -> gx_widget_type == 0) |
88 |
|
|
{ |
89 |
|
1 |
return GX_INVALID_WIDGET; |
90 |
|
|
} |
91 |
|
|
|
92 |
|
|
/* Check for invalid list entry. */ |
93 |
✓✓ |
27 |
if ((index < 0) || |
94 |
✓✓ |
26 |
(index >= vertical_list -> gx_vertical_list_total_rows)) |
95 |
|
|
{ |
96 |
|
6 |
return GX_INVALID_VALUE; |
97 |
|
|
} |
98 |
|
|
|
99 |
|
|
/* Call the actual vertical list page index set function. */ |
100 |
|
21 |
_gx_vertical_list_page_index_set(vertical_list, index); |
101 |
|
|
|
102 |
|
|
/* Return completion status. */ |
103 |
|
21 |
return GX_SUCCESS; |
104 |
|
|
} |
105 |
|
|
|