arkui-sys 0.3.3

Bindings to the native ArkUI API of OpenHarmony
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

// automatically generated by rust-bindgen 0.71.1

#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::native_type::*;

/// Defines formatted string data objects supported by the text component.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct ArkUI_StyledString {
    _unused: [u8; 0],
}
extern "C" {
    /// Free the memory occupied by the ArkUI_StyledString object.
    ///
    /// # Arguments
    ///
    /// * `handle` - A pointer to the ArkUI_StyledString object.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_ArkUI_StyledString_Destroy(handle: *mut ArkUI_StyledString);
    /// Sets the corresponding text content based on the current format string style.
    ///
    /// # Arguments
    ///
    /// * `handle` - A pointer to the ArkUI_StyledString object.
    ///
    /// * `content` - A pointer to the text content.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_ArkUI_StyledString_AddText(
        handle: *mut ArkUI_StyledString,
        content: *const ::core::ffi::c_char,
    );
    /// Removes the top style from the stack in the current format string object.
    ///
    /// # Arguments
    ///
    /// * `handle` - A pointer to the ArkUI_StyledString object.
    ///
    /// Available since API-level: 12
    #[cfg(feature = "api-12")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
    pub fn OH_ArkUI_StyledString_PopTextStyle(handle: *mut ArkUI_StyledString);
    /// Creates an <b>ArkUI_StyledString_Descriptor</b> object.
    ///
    ///
    /// # Returns
    ///
    /// * Returns the pointer to the <b>ArkUI_StyledString_Descriptor</b> object created.
    ///
    /// Available since API-level: 14
    #[cfg(feature = "api-14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
    pub fn OH_ArkUI_StyledString_Descriptor_Create() -> *mut ArkUI_StyledString_Descriptor;
    /// Destroys an <b>ArkUI_StyledString_Descriptor</b> object and reclaims the memory occupied by the object.
    ///
    /// # Arguments
    ///
    /// * `descriptor` - Pointer to an <b>ArkUI_StyledString_Descriptor</b> object.
    ///
    /// Available since API-level: 14
    #[cfg(feature = "api-14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
    pub fn OH_ArkUI_StyledString_Descriptor_Destroy(descriptor: *mut ArkUI_StyledString_Descriptor);
    /// Converts styled string information into HTML.
    ///
    /// # Arguments
    ///
    /// * `descriptor` - Pointer to an <b>ArkUI_StyledString_Descriptor</b> object.
    ///
    /// # Returns
    ///
    /// * Returns the pointer to the resulting HTML string. This pointer is managed internally and should be destroyed
    /// by calling <b>OH_ArkUI_StyledString_Descriptor_Destroy()</b> when no longer needed to free the memory.
    ///
    /// Available since API-level: 14
    #[cfg(feature = "api-14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
    pub fn OH_ArkUI_ConvertToHtml(
        descriptor: *mut ArkUI_StyledString_Descriptor,
    ) -> *const ::core::ffi::c_char;
    /// Deserializes a byte array containing styled string information into a styled string.
    ///
    /// # Arguments
    ///
    /// * `buffer` - Byte array to be deserialized.
    ///
    /// * `bufferSize` - Length of the byte array.
    ///
    /// * `descriptor` - Pointer to an <b>ArkUI_StyledString_Descriptor</b> object.
    ///
    /// # Returns
    ///
    /// * Returns the result code.
    /// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
    /// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
    ///
    /// Available since API-level: 14
    #[cfg(feature = "api-14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
    pub fn OH_ArkUI_UnmarshallStyledStringDescriptor(
        buffer: *mut u8,
        bufferSize: usize,
        descriptor: *mut ArkUI_StyledString_Descriptor,
    ) -> i32;
    /// Serializes the styled string information into a byte array.
    ///
    /// # Arguments
    ///
    /// * `buffer` - Byte array where the serialized data will be stored.
    ///
    /// * `bufferSize` - Length of the byte array.
    ///
    /// * `descriptor` - Pointer to an <b>ArkUI_StyledString_Descriptor</b> object.
    ///
    /// * `resultSize` - Actual length of the byte array.
    ///
    /// # Returns
    ///
    /// * Returns the result code.
    /// Returns [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
    /// Returns [`ARKUI_ERROR_CODE_PARAM_INVALID`] if a parameter error occurs.
    /// Returns [`ARKUI_ERROR_CODE_INVALID_STYLED_STRING`] if the styled string is invalid.
    ///
    /// Available since API-level: 14
    #[cfg(feature = "api-14")]
    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
    pub fn OH_ArkUI_MarshallStyledStringDescriptor(
        buffer: *mut u8,
        bufferSize: usize,
        descriptor: *mut ArkUI_StyledString_Descriptor,
        resultSize: *mut usize,
    ) -> i32;
}