|
2 | 2 | title: Chapter 4 - Description of GUIX Services
|
3 | 3 | description: This chapter contains a description of all GUIX services (listed below) in alphabetic order.
|
4 | 4 | ---
|
| 5 | + |
5 | 6 | # Chapter 4 - Description of GUIX Services
|
6 | 7 |
|
7 | 8 | This chapter contains a description of all GUIX services (listed below) in alphabetic order.
|
@@ -3745,7 +3746,7 @@ This service draws text on the canvas. This API, while still supported, is depre
|
3745 | 3746 | - *x_start*: Starting x-coordinate for text.
|
3746 | 3747 | - *y_start*: Starting y-coordinate for text.
|
3747 | 3748 | - *string*: Pointer to string to draw.
|
3748 |
| -- *length*: If length >= 0, limits the number of characters drawn to length. If length < 0, the entire string until NULL terminator is drawn. |
| 3749 | +- *length*: If length >= 0, limits the number of characters drawn to length. If length \< 0, the entire string until NULL terminator is drawn. |
3749 | 3750 |
|
3750 | 3751 | ### Return Values
|
3751 | 3752 |
|
@@ -17812,7 +17813,7 @@ The GX_STUDIO_WIDGET structure is defined in the application specifications head
|
17812 | 17813 |
|
17813 | 17814 | For statically allocated widgets, the widget control block is defined in the generated specifications.c file, and given the widget name defined within GUIX Studio. For dynamically allocated widgets, the application should pass GX_NULL as the widget control block address and the function will attempt to dynamically allocate the widget control block using the `gx_system_memory_allocate()` function, which is also defined by and provided by the application.
|
17814 | 17815 |
|
17815 |
| -For an application to directly reference the GUIX Studio widget definition within the generated specifications file, it is necessary to follow the naming convention utilized by the GUI Studio code generator. The GX_STUDIO_WIDGET structure generated within the specifications.c file is always named according to this convention: <widget_name>_define, where the <widget_name> field may be repeated multiple times if the widget is child of a child widget. |
| 17816 | +For an application to directly reference the GUIX Studio widget definition within the generated specifications file, it is necessary to follow the naming convention utilized by the GUI Studio code generator. The GX_STUDIO_WIDGET structure generated within the specifications.c file is always named according to this convention: `<widget_name>_define`, where the `<widget_name>` field may be repeated multiple times if the widget is child of a child widget. |
17816 | 17817 |
|
17817 | 17818 | ### Parameters
|
17818 | 17819 |
|
@@ -18766,7 +18767,7 @@ This service sets pen configuration to control the pen speed and distance parame
|
18766 | 18767 | The gx_pen_configuration_min_drag_dist member of GX_PEN_CONFIGURATION is a fixed point data type, and you should use GX_FIXED_VAL_MAKE(value) to convert from INT to GX_FIXED_VAL. For example, if you want to set minimum drag distance to 0.5 pixel per tick, you have to set the
|
18767 | 18768 | gx_pen_configuration_min_drag_dist to `GX_FIXED_VAL_MAKE(1) / 2`.
|
18768 | 18769 |
|
18769 |
| -In GUIX releases 5.4.0 and older, the gx_pen_configuration_min_drag_dist member of GX_PEN_CONFIGURATION was of (INT << 8) type rather than GX_FIXED_VAL type. If your project with 5.4.0 version GUIX library is using this API, you will need to modify the min_drag_dist parameter or #define GUIX_5_4_0_COMPATIBILITY when building the GUIX library. |
| 18770 | +In GUIX releases 5.4.0 and older, the gx_pen_configuration_min_drag_dist member of GX_PEN_CONFIGURATION was of (INT \<\< 8) type rather than GX_FIXED_VAL type. If your project with 5.4.0 version GUIX library is using this API, you will need to modify the min_drag_dist parameter or #define GUIX_5_4_0_COMPATIBILITY when building the GUIX library. |
18770 | 18771 |
|
18771 | 18772 | ### Parameters
|
18772 | 18773 |
|
@@ -21466,7 +21467,7 @@ The gradient type flags include GX_GRADIENT_TYPE_ALPHA and GX_GRADIENT_TYPE_MIRR
|
21466 | 21467 | - **GX_NOT_SUPPORTED** (0x28) Gradient is not type GX_GRADIENT_TYPE_ALPHA.
|
21467 | 21468 | - **GX_FAILURE** (0x10) Memory allocator is not defined or memory allocation is failed.
|
21468 | 21469 | - GX_CALLER_ERROR (0x11) Invalid caller of this function.
|
21469 |
| -- GX_PTR_ERROR (0x07) Gradient pointer not valid<. |
| 21470 | +- GX_PTR_ERROR (0x07) Gradient pointer not valid. |
21470 | 21471 |
|
21471 | 21472 | ### Allowed From
|
21472 | 21473 |
|
@@ -24685,7 +24686,7 @@ This service searches through the children of the specified parent looking for a
|
24685 | 24686 |
|
24686 | 24687 | - *parent*: Pointer to parent widget from which search is started.
|
24687 | 24688 | - *widget_id*: Widget ID to search for.
|
24688 |
| -- *search_depth*: Defines the recursive nesting level into which the function will search child widgets. If this value is <= 0, only immediate children of the parent widget are searched. If this value is GX_SEARCH_DEPTH_INFINITE, all children of all child widgets are exhaustively searched. For any other value > 0, this value limits how deeply nested this function will search through child widgets looked for the requested widget ID. |
| 24689 | +- *search_depth*: Defines the recursive nesting level into which the function will search child widgets. If this value is \<= 0, only immediate children of the parent widget are searched. If this value is GX_SEARCH_DEPTH_INFINITE, all children of all child widgets are exhaustively searched. For any other value \> 0, this value limits how deeply nested this function will search through child widgets looked for the requested widget ID. |
24689 | 24690 | - *return_widget*: Pointer to destination for found widget.
|
24690 | 24691 |
|
24691 | 24692 | ### Return Values
|
|
0 commit comments