arkui_sys/native_dialog/native_dialog_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
// 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::*;
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
impl ArkUI_DismissReason {
/// Touching the system-defined Back button or pressing the Esc key.
pub const DIALOG_DISMISS_BACK_PRESS: ArkUI_DismissReason = ArkUI_DismissReason(0);
}
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
impl ArkUI_DismissReason {
/// Touching the mask.
pub const DIALOG_DISMISS_TOUCH_OUTSIDE: ArkUI_DismissReason = ArkUI_DismissReason(1);
}
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
impl ArkUI_DismissReason {
/// Touching the Close button.
pub const DIALOG_DISMISS_CLOSE_BUTTON: ArkUI_DismissReason = ArkUI_DismissReason(2);
}
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
impl ArkUI_DismissReason {
/// Sliding down.
pub const DIALOG_DISMISS_SLIDE_DOWN: ArkUI_DismissReason = ArkUI_DismissReason(3);
}
#[repr(transparent)]
/// Enumerates the actions for triggering closure of the dialog box.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[derive(Clone, Hash, PartialEq, Eq)]
pub struct ArkUI_DismissReason(pub ::core::ffi::c_uint);
/// Invoked when the dialog box is closed.
///
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub type ArkUI_OnWillDismissEvent =
::core::option::Option<unsafe extern "C" fn(reason: i32) -> bool>;
#[repr(C)]
pub struct ArkUI_DialogDismissEvent {
_unused: [u8; 0],
}
/// Provides the custom dialog box APIs for the native side.
///
///
/// Version: 1
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
#[repr(C)]
pub struct ArkUI_NativeDialogAPI_1 {
/// Creates a custom dialog box and returns the pointer to the created dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
///
/// # Returns
///
/// * Returns the pointer to the created custom dialog box; returns a null pointer if the creation fails.
pub create: ::core::option::Option<unsafe extern "C" fn() -> ArkUI_NativeDialogHandle>,
/// Destroys a custom dialog box.
///
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
pub dispose: ::core::option::Option<unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle)>,
/// Attaches the content of a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `content` - Indicates the pointer to the root node of the custom dialog box content.
///
/// # 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.
pub setContent: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, content: ArkUI_NodeHandle) -> i32,
>,
/// Detaches the content of a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// # 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.
pub removeContent:
::core::option::Option<unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle) -> i32>,
/// Sets the alignment mode for a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `alignment` - Indicates the alignment mode. The parameter type is [`ArkUI_Alignment`].
///
/// * `offsetX` - Indicates the horizontal offset of the custom dialog box. The value is a floating point number.
///
/// * `offsetY` - Indicates the vertical offset of the custom dialog box. The value is a floating point number.
///
/// # 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.
pub setContentAlignment: ::core::option::Option<
unsafe extern "C" fn(
handle: ArkUI_NativeDialogHandle,
alignment: i32,
offsetX: f32,
offsetY: f32,
) -> i32,
>,
/// Resets the alignment mode of a custom dialog box to its default settings.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// # 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.
pub resetContentAlignment:
::core::option::Option<unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle) -> i32>,
/// Sets the modal mode for a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `isModal` - Specifies whether the custom dialog box is a modal, which has a mask applied. The value
/// <b>true</b> means that the custom dialog box is a modal, and <b>false</b> means the opposite.
///
/// # 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.
pub setModalMode: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, isModal: bool) -> i32,
>,
/// Specifies whether to allow users to touch the mask to dismiss the custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `autoCancel` - Specifies whether to allow users to touch the mask to dismiss the dialog box.
/// The value <b>true</b> means to allow users to do so, and <b>false</b> means the opposite.
///
/// # 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.
pub setAutoCancel: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, autoCancel: bool) -> i32,
>,
/// Sets the mask for a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `maskColor` - Indicates the mask color, in 0xARGB format.
///
/// * `maskRect` - Indicates the pointer to the mask area. Events outside the mask area are transparently
/// transmitted, and events within the mask area are not. The parameter type is [`ArkUI_Rect`].
///
/// # 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.
pub setMask: ::core::option::Option<
unsafe extern "C" fn(
handle: ArkUI_NativeDialogHandle,
maskColor: u32,
maskRect: *const ArkUI_Rect,
) -> i32,
>,
/// Sets the background color for a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `backgroundColor` - Indicates the background color of the custom dialog box, in 0xARGB format.
///
/// # 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.
pub setBackgroundColor: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, backgroundColor: u32) -> i32,
>,
/// Sets the background corner radius for a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `topLeft` - Indicates the radius of the upper left corner of the custom dialog box background.
///
/// * `topRight` - Indicates the radius of the upper right corner of the custom dialog box background.
///
/// * `bottomLeft` - Indicates the radius of the lower left corner of the custom dialog box background.
///
/// * `bottomRight` - Indicates the radius of the lower right corner of the custom dialog box background.
///
/// # 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.
pub setCornerRadius: ::core::option::Option<
unsafe extern "C" fn(
handle: ArkUI_NativeDialogHandle,
topLeft: f32,
topRight: f32,
bottomLeft: f32,
bottomRight: f32,
) -> i32,
>,
/// Sets the number of grid columns occupied by a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `gridCount` - Indicates the number of grid columns occupied by the dialog box. The default value is subject to
/// the window size, and the maximum value is the maximum number of columns supported by the system.
///
/// # 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.
pub setGridColumnCount: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, gridCount: i32) -> i32,
>,
/// Specifies whether to use a custom style for the custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `enableCustomStyle` - Specifies whether to use a custom style for the dialog box.
/// <b>true</b>: The dialog box automatically adapts its width to the child components; the rounded corner is 0;
/// the background color is transparent.
/// <b>false</b>: The dialog box automatically adapts its width to the grid system and its height to the child
/// components; the rounded corner is 24 vp.
///
/// # 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.
pub enableCustomStyle: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, enableCustomStyle: bool) -> i32,
>,
/// Specifies whether to use a custom animation for a custom dialog box.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `enableCustomAnimation` - Specifies whether to use a custom animation. The value <b>true</b> means to use a
/// custom animation, and <b>false</b> means to use the default animation.
///
/// # 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.
pub enableCustomAnimation: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, enableCustomAnimation: bool) -> i32,
>,
/// Registers a callback for a custom dialog box so that the user can decide whether to close the dialog box
/// after they touch the Back button or press the Esc key.
///
///
/// **Note:** This method must be called before the <b>show</b> method.
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `eventHandler` - Indicates the callback to register. The parameter type is [`ArkUI_OnWillDismissEvent`].
///
/// # 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.
pub registerOnWillDismiss: ::core::option::Option<
unsafe extern "C" fn(
handle: ArkUI_NativeDialogHandle,
eventHandler: ArkUI_OnWillDismissEvent,
) -> i32,
>,
/// Shows a custom dialog box.
///
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `showInSubWindow` - Specifies whether to show the dialog box in a sub-window.
///
/// # 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.
pub show: ::core::option::Option<
unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle, showInSubWindow: bool) -> i32,
>,
/// Closes a custom dialog box. If the dialog box has been closed, this API does not take effect.
///
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// # 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.
pub close:
::core::option::Option<unsafe extern "C" fn(handle: ArkUI_NativeDialogHandle) -> i32>,
/// Registers a listener for the dismiss event of the custom dialog box.
///
/// # Arguments
///
/// * `handle` - Indicates the pointer to the custom dialog box controller.
///
/// * `userData` - Indicates the pointer to the custom data.
///
/// * `callback` - Indicates the callback for the dismiss event of the custom dialog box.
///
/// # 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.
pub registerOnWillDismissWithUserData: ::core::option::Option<
unsafe extern "C" fn(
handle: ArkUI_NativeDialogHandle,
userData: *mut ::core::ffi::c_void,
callback: ::core::option::Option<
unsafe extern "C" fn(event: *mut ArkUI_DialogDismissEvent),
>,
) -> i32,
>,
}
extern "C" {
/// Sets whether to block the system behavior of dismissing a dialog box.
///
/// # Arguments
///
/// * `event` - Indicates the pointer to a dialog box dismiss event object.
///
/// * `shouldBlockDismiss` - Indicates whether to block the system behavior of dismissing the dialog box. The value
/// <b>true</b> means to block the system behavior, and <b>false</b> means the opposite.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss(
event: *mut ArkUI_DialogDismissEvent,
shouldBlockDismiss: bool,
);
/// Obtains the pointer to user data in a dialog box dismiss event object.
///
/// # Arguments
///
/// * `event` - Indicates the pointer to a dialog box dismiss event object.
///
///
/// # Returns
///
/// * Returns the pointer to user data.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_DialogDismissEvent_GetUserData(
event: *mut ArkUI_DialogDismissEvent,
) -> *mut ::core::ffi::c_void;
/// Obtains the c from a dialog box dismiss event object.
///
/// # Arguments
///
/// * `event` - Indicates the pointer to a dialog box dismiss event object.
///
///
/// # Returns
///
/// * Returns the dismissal reason. Returns <b>-1</b> if an exception occurs.
/// [`DIALOG_DISMISS_BACK_PRESS`]: touching the Back button, swiping left or right on the screen, or
/// pressing the Esc key.
/// [`DIALOG_DISMISS_TOUCH_OUTSIDE`]: touching the mask.
/// [`DIALOG_DISMISS_CLOSE_BUTTON`]: touching the Close button.
/// [`DIALOG_DISMISS_SLIDE_DOWN`]: sliding down.
///
/// Available since API-level: 12
#[cfg(feature = "api-12")]
#[cfg_attr(docsrs, doc(cfg(feature = "api-12")))]
pub fn OH_ArkUI_DialogDismissEvent_GetDismissReason(
event: *mut ArkUI_DialogDismissEvent,
) -> i32;
}