gx_scroll_wheel.h 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171
  1. /**************************************************************************/
  2. /* */
  3. /* Copyright (c) Microsoft Corporation. All rights reserved. */
  4. /* */
  5. /* This software is licensed under the Microsoft Software License */
  6. /* Terms for Microsoft Azure RTOS. Full text of the license can be */
  7. /* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
  8. /* and in the root directory of this software. */
  9. /* */
  10. /**************************************************************************/
  11. /**************************************************************************/
  12. /**************************************************************************/
  13. /** */
  14. /** GUIX Component */
  15. /** */
  16. /** Scroll Wheel Management (Scroll Wheel) */
  17. /** */
  18. /**************************************************************************/
  19. /**************************************************************************/
  20. /**************************************************************************/
  21. /* */
  22. /* COMPONENT DEFINITION RELEASE */
  23. /* */
  24. /* gx_scroll_wheel.h PORTABLE C */
  25. /* 6.0 */
  26. /* AUTHOR */
  27. /* */
  28. /* Kenneth Maxwell, Microsoft Corporation */
  29. /* */
  30. /* DESCRIPTION */
  31. /* */
  32. /* This file defines the GUIX scroll wheel management component, */
  33. /* including all data types and external references. It is assumed */
  34. /* that gx_api.h and gx_port.h have already been included. */
  35. /* */
  36. /* RELEASE HISTORY */
  37. /* */
  38. /* DATE NAME DESCRIPTION */
  39. /* */
  40. /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
  41. /* */
  42. /**************************************************************************/
  43. #ifndef GX_SCROLL_WHEEL_H
  44. #define GX_SCROLL_WHEEL_H
  45. #define GX_ANIMATION_TIMER 0x1100
  46. /* Define scroll wheel management function prototypes. */
  47. UINT _gx_numeric_scroll_wheel_create(GX_NUMERIC_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent,
  48. INT start_val, INT end_val,
  49. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size);
  50. UINT _gx_numeric_scroll_wheel_range_set(GX_NUMERIC_SCROLL_WHEEL *wheel, INT start_val, INT end_val);
  51. UINT _gx_numeric_scroll_wheel_text_get(GX_NUMERIC_SCROLL_WHEEL *wheel, INT row, GX_STRING *);
  52. UINT _gx_scroll_wheel_create(GX_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  53. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size);
  54. UINT _gx_scroll_wheel_event_process(GX_SCROLL_WHEEL *wheel, GX_EVENT *event_ptr);
  55. VOID _gx_scroll_wheel_gradient_create(GX_SCROLL_WHEEL *wheel);
  56. UINT _gx_scroll_wheel_gradient_alpha_set(GX_SCROLL_WHEEL *wheel, GX_UBYTE start_alpha, GX_UBYTE end_alpha);
  57. UINT _gx_scroll_wheel_row_height_set(GX_SCROLL_WHEEL *wheel, GX_VALUE row_height);
  58. UINT _gx_scroll_wheel_selected_row_calculate(GX_SCROLL_WHEEL *wheel);
  59. UINT _gx_scroll_wheel_scroll(GX_SCROLL_WHEEL *wheel, GX_VALUE shift);
  60. UINT _gx_scroll_wheel_selected_background_set(GX_SCROLL_WHEEL *wheel, GX_RESOURCE_ID selected_bg);
  61. UINT _gx_scroll_wheel_selected_get(GX_SCROLL_WHEEL *wheel, INT *row);
  62. UINT _gx_scroll_wheel_selected_set(GX_SCROLL_WHEEL *wheel, INT row);
  63. UINT _gx_scroll_wheel_speed_set(GX_SCROLL_WHEEL *wheel, GX_FIXED_VAL start_speed_rate, GX_FIXED_VAL end_speed_rate,
  64. GX_VALUE max_steps, GX_VALUE delay);
  65. UINT _gx_scroll_wheel_total_rows_set(GX_SCROLL_WHEEL *wheel, INT total_rows);
  66. #if defined(GX_ENABLE_DEPRECATED_STRING_API)
  67. UINT _gx_string_scroll_wheel_create(GX_STRING_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  68. GX_CONST GX_CHAR **string_list,
  69. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size);
  70. #endif
  71. UINT _gx_string_scroll_wheel_create_ext(GX_STRING_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  72. GX_CONST GX_STRING *string_list,
  73. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size);
  74. UINT _gx_string_scroll_wheel_string_id_list_set(GX_STRING_SCROLL_WHEEL *wheel,
  75. GX_CONST GX_RESOURCE_ID *string_id_list,
  76. INT id_count);
  77. #if defined(GX_ENABLE_DEPRECATED_STRING_API)
  78. UINT _gx_string_scroll_wheel_string_list_set(GX_STRING_SCROLL_WHEEL *wheel,
  79. GX_CONST GX_CHAR **string_list,
  80. INT string_count);
  81. #endif
  82. UINT _gx_string_scroll_wheel_string_list_set_ext(GX_STRING_SCROLL_WHEEL *wheel,
  83. GX_CONST GX_STRING *string_list,
  84. INT string_count);
  85. UINT _gx_string_scroll_wheel_text_get(GX_STRING_SCROLL_WHEEL *wheel, INT row, GX_STRING *string);
  86. /* Define text scroll wheel management function prototypes. */
  87. #if defined(GX_ENABLE_DEPRECATED_STRING_API)
  88. UINT _gx_text_scroll_wheel_callback_set(GX_TEXT_SCROLL_WHEEL * wheel, GX_CONST GX_CHAR * (*callback)(GX_TEXT_SCROLL_WHEEL *, INT));
  89. #endif
  90. UINT _gx_text_scroll_wheel_callback_set_ext(GX_TEXT_SCROLL_WHEEL* wheel, UINT (*callback)(GX_TEXT_SCROLL_WHEEL*, INT, GX_STRING *));
  91. UINT _gx_text_scroll_wheel_create(GX_TEXT_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  92. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size);
  93. VOID _gx_text_scroll_wheel_draw(GX_TEXT_SCROLL_WHEEL *wheel);
  94. UINT _gx_text_scroll_wheel_font_set(GX_TEXT_SCROLL_WHEEL *wheel, GX_RESOURCE_ID normal_font, GX_RESOURCE_ID selected_font);
  95. UINT _gx_text_scroll_wheel_text_color_set(GX_TEXT_SCROLL_WHEEL *wheel,
  96. GX_RESOURCE_ID normal_text_color,
  97. GX_RESOURCE_ID selected_text_color,
  98. GX_RESOURCE_ID disabled_text_color);
  99. /* Define error checking shells for API services. These are only referenced by the
  100. application. */
  101. UINT _gxe_numeric_scroll_wheel_create(GX_NUMERIC_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent,
  102. INT start_val, INT end_val,
  103. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size, UINT control_block_size);
  104. UINT _gxe_numeric_scroll_wheel_range_set(GX_NUMERIC_SCROLL_WHEEL *wheel, INT start_val, INT end_val);
  105. UINT _gxe_scroll_wheel_create(GX_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  106. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size, UINT control_block_size);
  107. UINT _gxe_scroll_wheel_event_process(GX_SCROLL_WHEEL *wheel, GX_EVENT *event_ptr);
  108. UINT _gxe_scroll_wheel_gradient_alpha_set(GX_SCROLL_WHEEL *wheel, GX_UBYTE start_alpha, GX_UBYTE end_alpha);
  109. UINT _gxe_scroll_wheel_row_height_set(GX_SCROLL_WHEEL *wheel, GX_VALUE row_height);
  110. UINT _gxe_scroll_wheel_selected_background_set(GX_SCROLL_WHEEL *wheel, GX_RESOURCE_ID selected_bg);
  111. UINT _gxe_scroll_wheel_selected_get(GX_SCROLL_WHEEL *wheel, INT *row);
  112. UINT _gxe_scroll_wheel_selected_set(GX_SCROLL_WHEEL *wheel, INT row);
  113. UINT _gxe_scroll_wheel_speed_set(GX_SCROLL_WHEEL *wheel, GX_FIXED_VAL start_speed_rate, GX_FIXED_VAL end_speed_rate,
  114. GX_VALUE max_steps, GX_VALUE delay);
  115. UINT _gxe_scroll_wheel_total_rows_set(GX_SCROLL_WHEEL *wheel, INT total_rows);
  116. #if defined(GX_ENABLE_DEPRECATED_STRING_API)
  117. UINT _gxe_string_scroll_wheel_create(GX_STRING_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  118. GX_CONST GX_CHAR **string_list,
  119. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size, UINT control_block_size);
  120. #endif
  121. UINT _gxe_string_scroll_wheel_create_ext(GX_STRING_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  122. GX_CONST GX_STRING *string_list,
  123. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size, UINT control_block_size);
  124. UINT _gxe_string_scroll_wheel_string_id_list_set(GX_STRING_SCROLL_WHEEL *wheel,
  125. GX_CONST GX_RESOURCE_ID *string_id_list,
  126. INT id_count);
  127. #if defined(GX_ENABLE_DEPRECATED_STRING_API)
  128. UINT _gxe_string_scroll_wheel_string_list_set(GX_STRING_SCROLL_WHEEL *wheel,
  129. GX_CONST GX_CHAR **string_list,
  130. INT string_count);
  131. #endif
  132. UINT _gxe_string_scroll_wheel_string_list_set_ext(GX_STRING_SCROLL_WHEEL *wheel,
  133. GX_CONST GX_STRING *string_list,
  134. INT string_count);
  135. #if defined(GX_ENABLE_DEPRECATED_STRING_API)
  136. UINT _gxe_text_scroll_wheel_callback_set(GX_TEXT_SCROLL_WHEEL * wheel, GX_CONST GX_CHAR * (*callback)(GX_TEXT_SCROLL_WHEEL *, INT));
  137. #endif
  138. UINT _gxe_text_scroll_wheel_callback_set_ext(GX_TEXT_SCROLL_WHEEL* wheel, UINT (*callback)(GX_TEXT_SCROLL_WHEEL*, INT, GX_STRING *));
  139. UINT _gxe_text_scroll_wheel_create(GX_TEXT_SCROLL_WHEEL *wheel, GX_CONST GX_CHAR *name, GX_WIDGET *parent, INT total_rows,
  140. ULONG style, USHORT Id, GX_CONST GX_RECTANGLE *size, UINT control_block_size);
  141. UINT _gxe_text_scroll_wheel_font_set(GX_TEXT_SCROLL_WHEEL *wheel, GX_RESOURCE_ID normal_font, GX_RESOURCE_ID selected_font);
  142. UINT _gxe_text_scroll_wheel_text_color_set(GX_TEXT_SCROLL_WHEEL *wheel,
  143. GX_RESOURCE_ID normal_text_color,
  144. GX_RESOURCE_ID selected_text_color,
  145. GX_RESOURCE_ID disabled_text_color);
  146. #endif