arkui_sys/native_node_napi/native_node_napi_ffi.rs
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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504
// automatically generated by rust-bindgen 0.71.1
#![allow(non_upper_case_globals)]
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
use crate::drawable_descriptor::ArkUI_DrawableDescriptor;
use crate::native_type::*;
use ohos_sys_opaque_types::{napi_env, napi_value};
extern "C" {
/// Obtains a <b>FrameNode</b> object on the ArkTS side and maps it to an <b>ArkUI_NodeHandle</b> object on the
/// native side.
///
/// # Arguments
///
/// * `env` - Indicates the NAPI environment pointer.
///
/// * `frameNode` - Indicates the <b>FrameNode</b> object created on the ArkTS side.
///
/// * `handle` - Indicates the pointer to the <b>ArkUI_NodeHandle</b> object.
///
/// # Returns
///
/// * Returns the error 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: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNodeHandleFromNapiValue(
env: napi_env,
frameNode: napi_value,
handle: *mut ArkUI_NodeHandle,
) -> i32;
/// Obtains a <b>UIContext</b> object on the ArkTS side and maps it to an <b>ArkUI_ContextHandle</b> object on the
/// native side.
///
/// # Arguments
///
/// * `env` - ndicates the NAPI environment pointer.
///
/// * `value` - Indicates the <b>UIContext</b> object created on the ArkTS side.
///
/// * `context` - Indicates the pointer to the <b>ArkUI_ContextHandle</b> object.
///
/// # Returns
///
/// * Returns the error 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: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetContextFromNapiValue(
env: napi_env,
value: napi_value,
context: *mut ArkUI_ContextHandle,
) -> i32;
/// Obtains a <b>NodeContent</b> object on the ArkTS side and maps it to an <b>ArkUI_NodeContentHandle</b>
/// object on the native side.
///
/// # Arguments
///
/// * `env` - ndicates the NAPI environment pointer.
///
/// * `value` - Indicates the <b>NodeContent</b> object created on the ArkTS side.
///
/// * `content` - Indicates the pointer to the <b>ArkUI_NodeContentHandle</b> object.
///
/// # Returns
///
/// * Returns the error 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: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNodeContentFromNapiValue(
env: napi_env,
value: napi_value,
content: *mut ArkUI_NodeContentHandle,
) -> i32;
/// Obtains a <b>DrawableDescriptor</b> object on the ArkTS side and maps it to an
/// <b>ArkUI_DrawableDescriptro</b> object on the native side.
///
/// # Arguments
///
/// * `env` - Indicates the NAPI environment pointer.
///
/// * `value` - Indicates the <b>DrawableDescriptor</b> object created on the ArkTS side.
///
/// * `drawableDescriptor` - Indicates the pointer to the <b>ArkUI_DrawableDescriptro</b> object.
///
/// # Returns
///
/// * Returns the error 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: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetDrawableDescriptorFromNapiValue(
env: napi_env,
value: napi_value,
drawableDescriptor: *mut *mut ArkUI_DrawableDescriptor,
) -> i32;
/// Obtains a <b>Resource</b> object on the ArkTS side and maps it to an
/// <b>ArkUI_DrawableDescriptro</b> object on the native side.
///
/// # Arguments
///
/// * `env` - Indicates the NAPI environment pointer.
///
/// * `value` - Indicates the <b>Resource</b> object created on the ArkTS side.
///
/// * `drawableDescriptor` - Indicates the pointer to the <b>ArkUI_DrawableDescriptro</b> object.
///
/// # Returns
///
/// * Returns the error 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: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetDrawableDescriptorFromResourceNapiValue(
env: napi_env,
value: napi_value,
drawableDescriptor: *mut *mut ArkUI_DrawableDescriptor,
) -> i32;
/// Obtain the ID of the Navigation component where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `buffer` - The buffer to which NavigationID writes to the memory,
/// memory space needs to be allocated by the developer.
///
/// * `bufferSize` - The buffer size
///
/// * `writeLength` - Indicates the string length actually written to the buffer
/// when returning [`ARKUI_ERROR_CODE_NO_ERROR`].
/// Indicates the minimum buffer size that can accommodate the target
/// when [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] is returned.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node, buffer or writeLength is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in Navigation.
/// [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] If the buffer size is less than the minimum buffer size.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavigationId(
node: ArkUI_NodeHandle,
buffer: *mut ::core::ffi::c_char,
bufferSize: i32,
writeLength: *mut i32,
) -> ArkUI_ErrorCode;
/// Obtain the name of the NavDestination component where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `buffer` - The buffer to which NavDestination name writes to the memory,
/// memory space needs to be allocated by the developer.
///
/// * `bufferSize` - The buffer size
///
/// * `writeLength` - Indicates the string length actually written to the buffer
/// when returning [`ARKUI_ERROR_CODE_NO_ERROR`].
/// Indicates the minimum buffer size that can accommodate the target
/// when [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] is returned.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node, buffer or writeLength is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in Navigation.
/// [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] If the buffer size is less than the minimum buffer size.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavDestinationName(
node: ArkUI_NodeHandle,
buffer: *mut ::core::ffi::c_char,
bufferSize: i32,
writeLength: *mut i32,
) -> ArkUI_ErrorCode;
/// Based on the given index value, obtain the length of the Navigation stack where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `length` - The length of the stack. After the operation succeeds, the result is written back to this parameter.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node or length is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in Navigation.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavStackLength(node: ArkUI_NodeHandle, length: *mut i32) -> ArkUI_ErrorCode;
/// Based on the given index value, obtain the page name of the corresponding position
/// in the navigation stack where the node is located.
/// Index values are counted from 0, with 0 being the bottom of the stack.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `index` - The index of the NavDestination in the stack is queried.
///
/// * `buffer` - The buffer to which NavDestination index writes to the memory,
/// memory space needs to be allocated by the developer.
///
/// * `bufferSize` - The buffer size
///
/// * `writeLength` - Indicates the string length actually written to the buffer
/// when returning [`ARKUI_ERROR_CODE_NO_ERROR`].
/// Indicates the minimum buffer size that can accommodate the target
/// when [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] is returned.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node, buffer or writeLength is null.
/// [`ARKUI_ERROR_CODE_NODE_INDEX_INVALID`] if index is an invalid value.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in Navigation.
/// [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] If the buffer size is less than the minimum buffer size.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavDestinationNameByIndex(
node: ArkUI_NodeHandle,
index: i32,
buffer: *mut ::core::ffi::c_char,
bufferSize: i32,
writeLength: *mut i32,
) -> ArkUI_ErrorCode;
/// Obtain the ID of the NavDestination component where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `buffer` - The buffer to which NavDestination ID writes to the memory,
/// memory space needs to be allocated by the developer.
///
/// * `bufferSize` - The buffer size
///
/// * `writeLength` - Indicates the string length actually written to the buffer
/// when returning [`ARKUI_ERROR_CODE_NO_ERROR`].
/// Indicates the minimum buffer size that can accommodate the target
/// when [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] is returned.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node, buffer or writeLength is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in Navigation.
/// [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] If the buffer size is less than the minimum buffer size.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavDestinationId(
node: ArkUI_NodeHandle,
buffer: *mut ::core::ffi::c_char,
bufferSize: i32,
writeLength: *mut i32,
) -> ArkUI_ErrorCode;
/// Obtain the state of the NavDestination component where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `state` - The state value of NavDestination is written back into this parameter.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node or state is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in Navigation.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavDestinationState(
node: ArkUI_NodeHandle,
state: *mut ArkUI_NavDestinationState,
) -> ArkUI_ErrorCode;
/// Obtain the index of the NavDestination component on the Navigation stack where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `index` - Index value, counted from 0.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node or index is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in Navigation.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavDestinationIndex(
node: ArkUI_NodeHandle,
index: *mut i32,
) -> ArkUI_ErrorCode;
/// Obtain the parameters of the NavDestination component where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// # Returns
///
/// * The parameters.
/// If a null pointer is returned, it may be because the node is empty or the parameters does not exist.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetNavDestinationParam(node: ArkUI_NodeHandle) -> napi_value;
/// Obtain the index of the page where the node resides in the Router page stack.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `index` - Index value, counted from 1.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node or index is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in RouterPage.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetRouterPageIndex(node: ArkUI_NodeHandle, index: *mut i32) -> ArkUI_ErrorCode;
/// Obtain the name of the page where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `buffer` - The buffer to which page name writes to the memory,
/// memory space needs to be allocated by the developer.
///
/// * `bufferSize` - The buffer size
///
/// * `writeLength` - Indicates the string length actually written to the buffer
/// when returning [`ARKUI_ERROR_CODE_NO_ERROR`].
/// Indicates the minimum buffer size that can accommodate the target
/// when [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] is returned.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node, buffer or writeLength is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in RouterPage.
/// [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] If the buffer size is less than the minimum buffer size.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetRouterPageName(
node: ArkUI_NodeHandle,
buffer: *mut ::core::ffi::c_char,
bufferSize: i32,
writeLength: *mut i32,
) -> ArkUI_ErrorCode;
/// Obtain the path of the page where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `buffer` - The buffer to which page path writes to the memory,
/// memory space needs to be allocated by the developer.
///
/// * `bufferSize` - The buffer size
///
/// * `writeLength` - Indicates the string length actually written to the buffer
/// when returning [`ARKUI_ERROR_CODE_NO_ERROR`].
/// Indicates the minimum buffer size that can accommodate the target
/// when [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] is returned.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node, buffer or writeLength is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in RouterPage.
/// [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] If the buffer size is less than the minimum buffer size.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetRouterPagePath(
node: ArkUI_NodeHandle,
buffer: *mut ::core::ffi::c_char,
bufferSize: i32,
writeLength: *mut i32,
) -> ArkUI_ErrorCode;
/// Obtain the state of the page where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `state` - The state value of the page is written back to this parameter.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node or state is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in RouterPage.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetRouterPageState(
node: ArkUI_NodeHandle,
state: *mut ArkUI_RouterPageState,
) -> ArkUI_ErrorCode;
/// Obtain the ID of the page where the node is located.
///
/// # Arguments
///
/// * `node` - The node.
///
/// * `buffer` - The buffer to which page ID writes to the memory,
/// memory space needs to be allocated by the developer.
///
/// * `bufferSize` - The buffer size
///
/// * `writeLength` - Indicates the string length actually written to the buffer
/// when returning [`ARKUI_ERROR_CODE_NO_ERROR`].
/// Indicates the minimum buffer size that can accommodate the target
/// when [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] is returned.
///
/// # Returns
///
/// * The error code.
/// [`ARKUI_ERROR_CODE_NO_ERROR`] if the operation is successful.
/// [`ARKUI_ERROR_CODE_PARAM_INVALID`] if the node, buffer or writeLength is null.
/// [`ARKUI_ERROR_CODE_GET_INFO_FAILED`] if query information failed,
/// this may be because the node is not in RouterPage.
/// [`ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR`] If the buffer size is less than the minimum buffer size.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_GetRouterPageId(
node: ArkUI_NodeHandle,
buffer: *mut ::core::ffi::c_char,
bufferSize: i32,
writeLength: *mut i32,
) -> ArkUI_ErrorCode;
}