diff --git a/AbilityKit/ability_base/libability_base_want.json b/AbilityKit/ability_base/libability_base_want.json index 03133ce9184f429df9ec3fc7b412b27df94ab10f..96066b3d46506f54f5f97d19ecae2b0df4047807 100644 --- a/AbilityKit/ability_base/libability_base_want.json +++ b/AbilityKit/ability_base/libability_base_want.json @@ -32,35 +32,35 @@ "name": "OH_AbilityBase_GetWantFd" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_SetWantUri" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_GetWantUri" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_SetWantInt32Param" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_GetWantInt32Param" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_SetWantBoolParam" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_GetWantBoolParam" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_SetWantDoubleParam" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AbilityBase_GetWantDoubleParam" } ] \ No newline at end of file diff --git a/AbilityKit/ability_base/want.h b/AbilityKit/ability_base/want.h index e688836ec681e9ca2d66da0424513bf1d458a135..09355501285c417a6c3f94813b3f693f53bfd6fd 100644 --- a/AbilityKit/ability_base/want.h +++ b/AbilityKit/ability_base/want.h @@ -169,7 +169,7 @@ AbilityBase_ErrorCode OH_AbilityBase_GetWantFd(AbilityBase_Want* want, const cha * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_SetWantUri(AbilityBase_Want* want, const char* uri); @@ -182,7 +182,7 @@ AbilityBase_ErrorCode OH_AbilityBase_SetWantUri(AbilityBase_Want* want, const ch * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_GetWantUri(AbilityBase_Want* want, char* uri, size_t uriSize); @@ -195,7 +195,7 @@ AbilityBase_ErrorCode OH_AbilityBase_GetWantUri(AbilityBase_Want* want, char* ur * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_SetWantInt32Param(AbilityBase_Want* want, const char* key, int32_t value); @@ -208,7 +208,7 @@ AbilityBase_ErrorCode OH_AbilityBase_SetWantInt32Param(AbilityBase_Want* want, c * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_GetWantInt32Param(AbilityBase_Want* want, const char* key, int32_t* value); @@ -221,7 +221,7 @@ AbilityBase_ErrorCode OH_AbilityBase_GetWantInt32Param(AbilityBase_Want* want, c * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_SetWantBoolParam(AbilityBase_Want* want, const char* key, bool value); @@ -234,7 +234,7 @@ AbilityBase_ErrorCode OH_AbilityBase_SetWantBoolParam(AbilityBase_Want* want, co * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_GetWantBoolParam(AbilityBase_Want* want, const char* key, bool* value); @@ -247,7 +247,7 @@ AbilityBase_ErrorCode OH_AbilityBase_GetWantBoolParam(AbilityBase_Want* want, co * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_SetWantDoubleParam(AbilityBase_Want* want, const char* key, double value); @@ -260,7 +260,7 @@ AbilityBase_ErrorCode OH_AbilityBase_SetWantDoubleParam(AbilityBase_Want* want, * @return The error code. * {@link ABILITY_BASE_ERROR_CODE_NO_ERROR} if the operation is successful. * {@link ABILITY_BASE_ERROR_CODE_PARAM_INVALID} if the input parameters are invalid. - * @since 18 + * @since 17 */ AbilityBase_ErrorCode OH_AbilityBase_GetWantDoubleParam(AbilityBase_Want* want, const char* key, double* value); diff --git a/ability/ability_runtime/child_process/libchild_process.ndk.json b/ability/ability_runtime/child_process/libchild_process.ndk.json index d812f5a08bc7ac6471ed7a2a96290acdc0faec5e..6f6bdcebf52d519ab862738a444bbdc8ae0a2a04 100644 --- a/ability/ability_runtime/child_process/libchild_process.ndk.json +++ b/ability/ability_runtime/child_process/libchild_process.ndk.json @@ -8,7 +8,7 @@ "name": "OH_Ability_StartNativeChildProcess" }, { - "first_introduced": "16", + "first_introduced": "17", "name": "OH_Ability_GetCurrentChildProcessArgs" } ] \ No newline at end of file diff --git a/ability/ability_runtime/child_process/native_child_process.h b/ability/ability_runtime/child_process/native_child_process.h index 2837104000d588409635bf594b085559ed1da42c..ca195fdefad29793d3711a5fc3b03084cf25f7d1 100644 --- a/ability/ability_runtime/child_process/native_child_process.h +++ b/ability/ability_runtime/child_process/native_child_process.h @@ -284,7 +284,7 @@ Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcess( * * @return Returns a pointer to the arguments passed to current child process.\n * For details, see {@link NativeChildProcess_Args}. - * @since 16 + * @since 17 */ NativeChildProcess_Args* OH_Ability_GetCurrentChildProcessArgs(); diff --git a/arkui/ace_engine/native/drag_and_drop.h b/arkui/ace_engine/native/drag_and_drop.h index 38e49caad1f19bd895f11cf455359a9c4ea2cf44..45e0281ab43646cab9af885e7204008e93ebaa88 100644 --- a/arkui/ace_engine/native/drag_and_drop.h +++ b/arkui/ace_engine/native/drag_and_drop.h @@ -841,49 +841,6 @@ ArkUI_DragEvent* OH_ArkUI_DragAndDropInfo_GetDragEvent(ArkUI_DragAndDropInfo* dr */ int32_t OH_ArkUI_StartDrag(ArkUI_DragAction* dragAction); -/** - * @brief Request to delay the drop end handling for a while to wait until the process result - * is really conformed by application, the result need to be notified back to system through - * {@link OH_ArkUI_NotifyDragResult} interface. And when all the handling done, the - * {@link OH_ArkUI_NotifyDragEndPendingDone} should be called. - * Please be aware, the maximum pending time is 2 seconds; - * - * @param event Indicates the pointer to an ArkUI_DragEvent object. - * @param requestIdentify Indicates the Identify for the request initiated by this method, it's a number generated - by system automatically, and it's an out parameter too, so one valid address needed. - * @return Returns the result code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * Returns {@link ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED} if current is not during the drop handing. - * @since 18 - */ -int32_t OH_ArkUI_DragEvent_RequestDragEndPending(ArkUI_DragEvent* event, int32_t* requestIdentify); - -/** - * @brief Notify the system final drag result, the request identify will be checked, it should be the same - * as the one returned by {@link OH_ArkUI_DragEvent_RequestDragEndPending} interface, if it's not, - * the calling will be ignored. - * - * @param requestIdentify The identify returned by {@link OH_ArkUI_DragEvent_RequestDragEndPending} interface. - * @param result Indicates the drag result. - * @return Returns the result code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_NotifyDragResult(int32_t requestIdentify, ArkUI_DragResult result); - -/** - * @brief Notify the system all handling done, the drag end pending can be finished. - * - * @param requestIdentify The identify returned by {@link OH_ArkUI_DragEvent_RequestDragEndPending} interface. - * @return Returns the result code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_NotifyDragEndPendingDone(int32_t requestIdentify); - #ifdef __cplusplus }; #endif diff --git a/arkui/ace_engine/native/libace.ndk.json b/arkui/ace_engine/native/libace.ndk.json index c80fc0750649e90dbc180d82275ce63ba87c42dc..39f0ea6e6cc10b361377c43278485bc3ef6b7204 100644 --- a/arkui/ace_engine/native/libace.ndk.json +++ b/arkui/ace_engine/native/libace.ndk.json @@ -119,58 +119,6 @@ "first_introduced": "12", "name": "OH_ArkUI_GetNativeAPI" }, - { - "first_introduced": "12", - "name": "OH_NativeXComponent_RegisterUIInputEventCallback" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_UIInputEvent_GetType" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_UIInputEvent_GetEventTime" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_PointerEvent_GetX" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_PointerEvent_GetY" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_PointerEvent_GetWindowX" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_PointerEvent_GetWindowY" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_PointerEvent_GetDisplayX" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_PointerEvent_GetDisplayY" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_AxisEvent_GetVerticalAxisValue" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_AxisEvent_GetHorizontalAxisValue" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_AxisEvent_GetPinchAxisScaleValue" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_AxisEvent_GetAxisAction" - }, { "first_introduced": "12", "name": "OH_ArkUI_GetNodeHandleFromNapiValue" @@ -252,15 +200,15 @@ "name": "OH_ArkUI_GestureInterruptInfo_GetSystemRecognizerType" }, { - "first_introduced": "18", + "first_introduced": "15", "name": "OH_ArkUI_GestureInterruptInfo_GetTouchRecognizers" }, { - "first_introduced": "18", + "first_introduced": "15", "name": "OH_ArkUI_TouchRecognizer_GetNodeHandle" }, { - "first_introduced": "18", + "first_introduced": "15", "name": "OH_ArkUI_TouchRecognizer_CancelTouch" }, { @@ -331,6 +279,22 @@ "first_introduced": "12", "name": "OH_ArkUI_SetArkUIGestureRecognizerDisposeNotify" }, + { + "first_introduced": "12", + "name": "OH_ArkUI_AxisEvent_GetVerticalAxisValue" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_AxisEvent_GetHorizontalAxisValue" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_AxisEvent_GetPinchAxisScaleValue" + }, + { + "first_introduced": "15", + "name": "OH_ArkUI_AxisEvent_GetAxisAction" + }, { "first_introduced": "12", "name": "OH_NativeXComponent_SetNeedSoftKeyboard" @@ -343,6 +307,42 @@ "first_introduced": "12", "name": "OH_NativeXComponent_RegisterSurfaceHideCallback" }, + { + "first_introduced": "12", + "name": "OH_NativeXComponent_RegisterUIInputEventCallback" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_UIInputEvent_GetType" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_UIInputEvent_GetEventTime" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_PointerEvent_GetX" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_PointerEvent_GetY" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_PointerEvent_GetWindowX" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_PointerEvent_GetWindowY" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_PointerEvent_GetDisplayX" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_PointerEvent_GetDisplayY" + }, { "first_introduced": "12", "name": "OH_NativeXComponent_RegisterOnTouchInterceptCallback" @@ -508,7 +508,7 @@ "name": "OH_ArkUI_PointerEvent_GetTiltY" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_PointerEvent_GetRollAngle" }, { @@ -1159,174 +1159,6 @@ "first_introduced": "12", "name": "OH_ArkUI_SwiperIndicator_GetMaxDisplayCount" }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperIndicator_SetIgnoreSizeOfBottom" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperIndicator_GetIgnoreSizeOfBottom" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperIndicator_SetSpace" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperIndicator_GetSpace" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_Create" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetStartPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetStartPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetTopPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetTopPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetEndPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetEndPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetBottomPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetBottomPosition" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetFontColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetFontColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetFontSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetFontSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetFontWeight" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetFontWeight" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_Destroy" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_SetIgnoreSizeOfBottom" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperDigitIndicator_GetIgnoreSizeOfBottom" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_Create" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_SetShowBackground" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_GetShowBackground" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_SetBackgroundSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_GetBackgroundSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_SetBackgroundColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_GetBackgroundColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_SetArrowSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_GetArrowSize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_SetArrowColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_GetArrowColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SwiperArrowStyle_Destroy" - }, { "first_introduced": "12", "name": "OH_ArkUI_DrawableDescriptor_CreateFromPixelMap" @@ -1799,6 +1631,18 @@ "first_introduced": "12", "name": "OH_ArkUI_AccessibilityValue_GetText" }, + { + "first_introduced": "12", + "name": "OH_ArkUI_NodeEvent_GetNumberValue" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_NodeEvent_GetStringValue" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_NodeEvent_SetReturnNumberValue" + }, { "first_introduced": "12", "name": "OH_ArkUI_AnimateOption_SetICurve" @@ -2045,27 +1889,15 @@ }, { "first_introduced": "12", - "name": "OH_ArkUI_NodeEvent_GetNumberValue" + "name": "OH_ArkUI_CreateOpacityTransitionEffect" }, { "first_introduced": "12", - "name": "OH_ArkUI_NodeEvent_GetStringValue" + "name": "OH_ArkUI_CreateTranslationTransitionEffect" }, { "first_introduced": "12", - "name": "OH_ArkUI_NodeEvent_SetReturnNumberValue" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_CreateOpacityTransitionEffect" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_CreateTranslationTransitionEffect" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_CreateScaleTransitionEffect" + "name": "OH_ArkUI_CreateScaleTransitionEffect" }, { "first_introduced": "12", @@ -2361,15 +2193,27 @@ }, { "first_introduced": "12", - "name": "OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss" + "name": "OH_ArkUI_RegisterSystemColorModeChangeEvent" }, { "first_introduced": "12", - "name": "OH_ArkUI_DialogDismissEvent_GetUserData" + "name": "OH_ArkUI_UnregisterSystemColorModeChangeEvent" }, { "first_introduced": "12", - "name": "OH_ArkUI_DialogDismissEvent_GetDismissReason" + "name": "OH_ArkUI_RegisterSystemFontStyleChangeEvent" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_UnregisterSystemFontStyleChangeEvent" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale" + }, + { + "first_introduced": "12", + "name": "OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale" }, { "first_introduced": "12", @@ -2437,27 +2281,15 @@ }, { "first_introduced": "12", - "name": "OH_ArkUI_RegisterSystemColorModeChangeEvent" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_UnregisterSystemColorModeChangeEvent" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_RegisterSystemFontStyleChangeEvent" - }, - { - "first_introduced": "12", - "name": "OH_ArkUI_UnregisterSystemFontStyleChangeEvent" + "name": "OH_ArkUI_DialogDismissEvent_SetShouldBlockDismiss" }, { "first_introduced": "12", - "name": "OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale" + "name": "OH_ArkUI_DialogDismissEvent_GetUserData" }, { "first_introduced": "12", - "name": "OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale" + "name": "OH_ArkUI_DialogDismissEvent_GetDismissReason" }, { "first_introduced": "13", @@ -2755,6 +2587,14 @@ "first_introduced": "15", "name": "OH_ArkUI_AccessibilityProviderRegisterCallbackWithInstance" }, + { + "first_introduced": "15", + "name": "OH_ArkUI_KeyEvent_Dispatch" + }, + { + "first_introduced": "15", + "name": "OH_ArkUI_NodeEvent_GetTextChangeEvent" + }, { "first_introduced": "15", "name": "OH_ArkUI_PointerEvent_GetChangedPointerId" @@ -2797,7 +2637,19 @@ }, { "first_introduced": "15", - "name": "OH_ArkUI_KeyEvent_Dispatch" + "name": "OH_ArkUI_FocusRequest" + }, + { + "first_introduced": "15", + "name": "OH_ArkUI_FocusClear" + }, + { + "first_introduced": "15", + "name": "OH_ArkUI_FocusActivate" + }, + { + "first_introduced": "15", + "name": "OH_ArkUI_FocusSetAutoTransfer" }, { "first_introduced": "15", @@ -2839,10 +2691,6 @@ "first_introduced": "15", "name": "OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius" }, - { - "first_introduced": "15", - "name": "OH_ArkUI_NodeEvent_GetTextChangeEvent" - }, { "first_introduced": "18", "name": "OH_ArkUI_PostFrameCallback" @@ -2871,34 +2719,6 @@ "first_introduced": "15", "name": "OH_ArkUI_UnregisterDrawCallbackOnNodeHandle" }, - { - "first_introduced": "15", - "name": "OH_ArkUI_DragEvent_StartDataLoading" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_CancelDataLoading" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_DisableDropDataPrefetchOnNode" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_FocusRequest" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_FocusClear" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_FocusActivate" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_FocusSetAutoTransfer" - }, { "first_introduced": "15", "name": "OH_ArkUI_CreateSnapshotOptions" @@ -2935,6 +2755,14 @@ "first_introduced": "15", "name": "OH_ArkUI_UIInputEvent_GetTargetDisplayId" }, + { + "first_introduced": "18", + "name": "OH_ArkUI_GestureInterrupter_GetUserData" + }, + { + "first_introduced": "15", + "name": "OH_ArkUI_FocusSetKeyProcessingMode" + }, { "first_introduced": "18", "name": "OH_ArkUI_XComponent_StartImageAnalyzer" @@ -2944,97 +2772,81 @@ "name": "OH_ArkUI_XComponent_StopImageAnalyzer" }, { - "first_introduced": "18", - "name": "OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate" + "first_introduced": "15", + "name": "OH_ArkUI_DragEvent_StartDataLoading" }, { - "first_introduced": "18", - "name": "OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate" + "first_introduced": "15", + "name": "OH_ArkUI_CancelDataLoading" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_VisibleAreaEventOptions_Create" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_VisibleAreaEventOptions_Dispose" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_VisibleAreaEventOptions_SetRatios" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_VisibleAreaEventOptions_GetRatios" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval" }, { - "first_introduced": "18", + "first_introduced": "15", + "name": "OH_ArkUI_DisableDropDataPrefetchOnNode" + }, + { + "first_introduced": "17", "name": "OH_ArkUI_UIInputEvent_GetEventTargetWidth" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_UIInputEvent_GetEventTargetHeight" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_UIInputEvent_GetEventTargetPositionX" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_UIInputEvent_GetEventTargetPositionY" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_HoverEvent_IsHovered" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_UIInputEvent_GetModifierKeyStates" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_AxisEvent_SetPropagation" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_ArkUI_AxisEvent_GetScrollStep" }, - { - "first_introduced": "18", - "name": "OH_ArkUI_DragEvent_RequestDragEndPending" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_NotifyDragResult" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_NotifyDragEndPendingDone" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_GestureInterrupter_GetUserData" - }, - { - "first_introduced": "15", - "name": "OH_ArkUI_FocusSetKeyProcessingMode" - }, { "first_introduced": "15", "name": "OH_ArkUI_PointerEvent_CreateClonedEvent" @@ -3070,225 +2882,5 @@ { "first_introduced": "15", "name": "OH_ArkUI_NodeUtils_GetPositionToParent" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_CreateOptions" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_DisposeOptions" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetLevelMode" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetLevelUniqueId" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetImmersiveMode" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_OpenDialog" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_UpdateDialog" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_CloseDialog" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetBackgroundColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetCornerRadius" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetBorderWidth" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetBorderColor" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetBorderStyle" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetWidth" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetHeight" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetShadow" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetCustomShadow" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetBackgroundBlurStyle" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetAlignment" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetModalMode" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetAutoCancel" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetSubwindowMode" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetMask" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetKeyboardAvoidMode" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetHoverModeEnabled" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_SetHoverModeArea" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextPickerRangeContentArray_Create" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextPickerRangeContentArray_SetIconAtIndex" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextPickerRangeContentArray_Destroy" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextCascadePickerRangeContentArray_Create" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextCascadePickerRangeContentArray_SetChildAtIndex" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_TextCascadePickerRangeContentArray_Destroy" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceHolder_Create" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceHolder_Dispose" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceHolder_SetUserData" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceHolder_GetUserData" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceCallback_Create" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceCallback_Dispose" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceCallback_SetSurfaceCreatedEvent" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceCallback_SetSurfaceChangedEvent" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceCallback_SetSurfaceDestroyedEvent" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceHolder_AddSurfaceCallback" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_SurfaceHolder_RemoveSurfaceCallback" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_XComponent_GetNativeWindow" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_XComponent_SetAutoInitialize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_XComponent_Initialize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_XComponent_Finalize" - }, - { - "first_introduced": "18", - "name": "OH_ArkUI_XComponent_IsInitialized" } ] \ No newline at end of file diff --git a/arkui/ace_engine/native/native_animate.h b/arkui/ace_engine/native/native_animate.h index 0fbbe8c88d8b89165117856812868a993c6d4c08..858ccfa39625f84a066130152632315aaee3c1d9 100644 --- a/arkui/ace_engine/native/native_animate.h +++ b/arkui/ace_engine/native/native_animate.h @@ -413,19 +413,6 @@ int32_t OH_ArkUI_KeyframeAnimateOption_SetIterations(ArkUI_KeyframeAnimateOption int32_t OH_ArkUI_KeyframeAnimateOption_RegisterOnFinishCallback( ArkUI_KeyframeAnimateOption* option, void* userData, void (*onFinish)(void* userData)); -/** - * @brief Sets the expected frame rate range of a keyframe animation. - * - * @param option Indicates the pointer to a keyframe animation configuration. - * @param frameRate Indicates the expected frame rate range. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_KeyframeAnimateOption_SetExpectedFrameRate( - ArkUI_KeyframeAnimateOption* option, ArkUI_ExpectedFrameRateRange* frameRate); - /** * @brief Sets the duration of a keyframe animation, in milliseconds. * @@ -489,15 +476,6 @@ int32_t OH_ArkUI_KeyframeAnimateOption_GetDelay(ArkUI_KeyframeAnimateOption* opt */ int32_t OH_ArkUI_KeyframeAnimateOption_GetIterations(ArkUI_KeyframeAnimateOption* option); -/** - * @brief Obtains the expected frame rate range of a keyframe animation configuration. - * - * @param option Indicates the pointer to a keyframe animation configuration. - * @return Returns the expected frame rate range of the keyframe animation. - * @since 18 - */ -ArkUI_ExpectedFrameRateRange* OH_ArkUI_KeyframeAnimateOption_GetExpectedFrameRate(ArkUI_KeyframeAnimateOption* option); - /** * @brief Obtains the duration of a specific state in a keyframe animation. * diff --git a/arkui/ace_engine/native/native_dialog.h b/arkui/ace_engine/native/native_dialog.h index 5de204ab42866f32ea1afae3fbb04128333ff732..72d1e3ba0ac26786c52a8df2578ee0d47036c256 100644 --- a/arkui/ace_engine/native/native_dialog.h +++ b/arkui/ace_engine/native/native_dialog.h @@ -39,7 +39,6 @@ #include #include "native_type.h" -#include "native_node.h" #ifdef __cplusplus extern "C" { @@ -99,13 +98,6 @@ typedef bool (*ArkUI_OnWillDismissEvent)(int32_t reason); */ typedef struct ArkUI_DialogDismissEvent ArkUI_DialogDismissEvent; -/** - * @brief Defines a struct for the content object of a custom dialog box. - * - * @since 18 - */ -typedef struct ArkUI_CustomDialogOptions ArkUI_CustomDialogOptions; - /** * @brief Provides the custom dialog box APIs for the native side. * @@ -385,265 +377,6 @@ typedef struct { int32_t (*setImmersiveMode)(ArkUI_NativeDialogHandle handle, ArkUI_ImmersiveMode immersiveMode); } ArkUI_NativeDialogAPI_2; -/** - * @brief Provides the custom dialog box APIs for the native side. - * - * @version 3 - * @since 18 - */ -typedef struct { - /** - * @brief Provides the custom dialog box APIs for the native side. The API scope is {@link ArkUI_NativeDialogAPI_1} - * - * @since 18 - */ - ArkUI_NativeDialogAPI_1 nativeDialogAPI1; - /** - * @brief Provides the custom dialog box APIs for the native side. The API scope is {@link ArkUI_NativeDialogAPI_2} - * - * @since 18 - */ - ArkUI_NativeDialogAPI_2 nativeDialogAPI2; - /** - * @brief Sets the display order for a custom dialog box. - * - * @note This method must be called before the show method. - * @param handle Indicates the pointer to the custom dialog box controller. - * @param levelOrder Indicates the display order. The valid range is [-100000.0, 100000.0]. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ - int32_t (*setLevelOrder)(ArkUI_NativeDialogHandle handle, double levelOrder); - /** - * @brief Registers a listener callback before the dialog openAnimation starts. - * - * @param handle Indicates the pointer to the custom dialog box controller. - * @param userData Indicates the pointer to the custom data. - * @param callback Indicates the callback before the dialog openAnimation starts. - * @return Returns the result code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ - - int32_t (*registerOnWillAppear)( - ArkUI_NativeDialogHandle handle, void* userData, void (*callback)(void* userData)); - - /** - * @brief Registers a listener callback when the dialog appears. - * - * @param handle Indicates the pointer to the custom dialog box controller. - * @param userData Indicates the pointer to the custom data. - * @param callback Indicates the callback when the dialog appears. - * @return Returns the result code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ - int32_t (*registerOnDidAppear)( - ArkUI_NativeDialogHandle handle, void* userData, void (*callback)(void* userData)); - - /** - * @brief Registers a listener callback before the dialog closeAnimation starts. - * - * @param handle Indicates the pointer to the custom dialog box controller. - * @param userData Indicates the pointer to the custom data. - * @param callback Indicates the callback before the dialog closeAnimation starts. - * @return Returns the result code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ - int32_t (*registerOnWillDisappear)( - ArkUI_NativeDialogHandle handle, void* userData, void (*callback)(void* userData)); - - /** - * @brief Registers a listener callback when the dialog disappears. - * - * @param handle Indicates the pointer to the custom dialog box controller. - * @param userData Indicates the pointer to the custom data. - * @param callback Indicates the callback when the dialog disappears. - * @return Returns the result code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ - int32_t (*registerOnDidDisappear)( - ArkUI_NativeDialogHandle handle, void* userData, void (*callback)(void* userData)); - - /** - * @brief Sets the border width of the dialog box. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param top Width of the top border. - * @param right Width of the right border. - * @param bottom Width of the bottom border. - * @param left Width of the left border. - * @param unit Unit of the width. The default value is vp. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setBorderWidth)( - ArkUI_NativeDialogHandle handle, float top, float right, float bottom, float left, ArkUI_LengthMetricUnit unit); - - /** - * @brief Sets the border color of the dialog box. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param top Color of the top border. - * @param right Color of the right border. - * @param bottom Color of the bottom border. - * @param left Color of the left border. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setBorderColor)( - ArkUI_NativeDialogHandle handle, uint32_t top, uint32_t right, uint32_t bottom, uint32_t left); - - /** - * @brief Sets the border style of the dialog box. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param top Style of the top border. - * @param right Style of the right border. - * @param bottom Style of the bottom border. - * @param left Style of the left border. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setBorderStyle)( - ArkUI_NativeDialogHandle handle, int32_t top, int32_t right, int32_t bottom, int32_t left); - - /** - * @brief Sets the width of the dialog box background. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param width Width of the background. - * @param unit Unit of the width. The default value is vp. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setWidth)(ArkUI_NativeDialogHandle handle, float width, ArkUI_LengthMetricUnit unit); - - /** - * @brief Sets the height of the dialog box background. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param height Height of the background. - * @param unit Unit of the height. The default value is vp. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setHeight)(ArkUI_NativeDialogHandle handle, float height, ArkUI_LengthMetricUnit unit); - - /** - * @brief Sets the shadow of the dialog box background. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param shadow Shadow style of the background, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setShadow)(ArkUI_NativeDialogHandle handle, ArkUI_ShadowStyle shadow); - - /** - * @brief Sets the custom shadow of the dialog box background. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param customShadow Custom shadow parameter. The format is the same as that of the NODE_SHADOW property. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setCustomShadow)(ArkUI_NativeDialogHandle handle, const ArkUI_AttributeItem* customShadow); - - /** - * @brief Sets the background blur style of the dialog box. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param blurStyle Background blur style, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setBackgroundBlurStyle)(ArkUI_NativeDialogHandle handle, ArkUI_BlurStyle blurStyle); - - /** - * @brief Sets the keyboard avoidance mode of the dialog box. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param keyboardAvoidMode Keyboard avoidance mode, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*setKeyboardAvoidMode)(ArkUI_NativeDialogHandle handle, ArkUI_KeyboardAvoidMode keyboardAvoidMode); - - /** - * @brief Sets whether to enable the hover mode for the dialog box. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param enableHoverMode Whether to enable the hover mode. The default value is false. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur.. - * @since 18 - */ - int32_t (*enableHoverMode)(ArkUI_NativeDialogHandle handle, bool enableHoverMode); - - /** - * @brief Set the default display area of the dialog box in hover mode. - * - * @note This method must be called before the show method. - * @param handle Pointer to the dialog box controller. - * @param hoverModeAreaType Display area in hover mode, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occur. - * @since 18 - */ - int32_t (*setHoverModeArea)(ArkUI_NativeDialogHandle handle, ArkUI_HoverModeAreaType hoverModeAreaType); - - /** - * @brief Sets whether to get focus when the custom dialog is displayed. - * - * @param handle Indicates the pointer to the custom dialog box controller. - * @param focusable Specifies whether to get focus when the custom dialog is displayed. The default value is true. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ - int32_t (*setFocusable)(ArkUI_NativeDialogHandle handle, bool focusable); -} ArkUI_NativeDialogAPI_3; - /** * @brief Sets whether to block the system behavior of dismissing a dialog box. * @@ -679,414 +412,6 @@ void* OH_ArkUI_DialogDismissEvent_GetUserData(ArkUI_DialogDismissEvent* event); */ int32_t OH_ArkUI_DialogDismissEvent_GetDismissReason(ArkUI_DialogDismissEvent* event); -/** - * @brief Displays a custom dialog box. - * - * @param options Dialog box parameters. - * @param callback Callback to be invoked when the custom dialog box displays. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_OpenDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId)); - -/** - * @brief Updates a custom dialog box. - * - * @param options Dialog box parameters. - * @param callback Callback to be invoked when the custom dialog box updates. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_UpdateDialog(ArkUI_CustomDialogOptions* options, void (*callback)(int32_t dialogId)); - -/** - * @brief Closes a custom dialog box. - * - * @param dialogId Dialog id. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_CloseDialog(int32_t dialogId); - -/** - * @brief Creates custom dialog box options. - * - * @param content Content of the custom dialog box. - * @return Returns the pointer to the custom dialog box options. - * @since 18 - */ -ArkUI_CustomDialogOptions* OH_ArkUI_CustomDialog_CreateOptions(ArkUI_NodeHandle content); - -/** - * @brief Destroys the custom dialog box options. - * - * @param options The pointer to the custom dialog box options. - * @since 18 - */ -void OH_ArkUI_CustomDialog_DisposeOptions(ArkUI_CustomDialogOptions* options); - -/** - * @brief Sets the level mode for a custom dialog box. - * - * @note This method must be called before the OH_ArkUI_CustomDialog_OpenDialog method. - * @param options Indicates the pointer to the custom dialog options. - * @param levelMode Indicates the level mode. The parameter type is {@link ArkUI_LevelMode}. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetLevelMode(ArkUI_CustomDialogOptions* options, ArkUI_LevelMode levelMode); - -/** - * @brief Sets the level uniqueId for a custom dialog box. - * - * @param options Indicates the pointer to the custom dialog options. - * @param uniqueId Indicates the unique id of any nodes in router or navigation pages. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetLevelUniqueId(ArkUI_CustomDialogOptions* options, int32_t uniqueId); - -/** - * @brief Sets the immersive mode for a custom dialog box. - * - * @note This method must be called before the OH_ArkUI_CustomDialog_OpenDialog method. - * @param options Indicates the pointer to the custom dialog options. - * @param immersiveMode Indicates the immersive mode. The parameter type is {@link ArkUI_ImmersiveMode}. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetImmersiveMode(ArkUI_CustomDialogOptions* options, ArkUI_ImmersiveMode immersiveMode); - -/** - * @brief Sets the background color of the dialog box. - * - * @param options Dialog box parameters. - * @param backgroundColor Background color of the dialog box. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetBackgroundColor(ArkUI_CustomDialogOptions* options, uint32_t backgroundColor); - -/** - * @brief Sets the corner radius for a custom dialog box. - * - * @param options Dialog box parameters. - * @param topLeft Corner radius of the upper left corner. - * @param topRight Corner radius of the upper right corner. - * @param bottomLeft Corner radius of the lower left corner. - * @param bottomRight Corner radius of the lower right corner. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetCornerRadius( - ArkUI_CustomDialogOptions* options, float topLeft, float topRight, float bottomLeft, float bottomRight); - -/** - * @brief Sets the border width of the dialog box. - * - * @param options Dialog box parameters. - * @param top Width of the top border. - * @param right Width of the right border. - * @param bottom Width of the bottom border. - * @param left Width of the left border. - * @param unit Unit of the width. The default value is vp. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetBorderWidth( - ArkUI_CustomDialogOptions* options, float top, float right, float bottom, float left, ArkUI_LengthMetricUnit unit); - -/** - * @brief Sets the border color of the dialog box. - * - * @param options Dialog box parameters. - * @param top Color of the top border. - * @param right Color of the right border. - * @param bottom Color of the bottom border. - * @param left Color of the left border. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetBorderColor( - ArkUI_CustomDialogOptions* options, uint32_t top, uint32_t right, uint32_t bottom, uint32_t left); - -/** - * @brief Sets the border style of the dialog box. - * - * @param options Dialog box parameters. - * @param top Style of the top border. - * @param right Style of the right border. - * @param bottom Style of the bottom border. - * @param left Style of the left border. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetBorderStyle( - ArkUI_CustomDialogOptions* options, int32_t top, int32_t right, int32_t bottom, int32_t left); - -/** - * @brief Sets the width of the dialog box background. - * - * @param options Dialog box parameters. - * @param width Width of the background. - * @param unit Unit of the width. The default value is vp. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetWidth(ArkUI_CustomDialogOptions* options, float width, ArkUI_LengthMetricUnit unit); - -/** - * @brief Sets the height of the dialog box background. - * - * @param options Dialog box parameters. - * @param height Height of the background. - * @param unit Unit of the height. The default value is vp. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetHeight(ArkUI_CustomDialogOptions* options, float height, ArkUI_LengthMetricUnit unit); - -/** - * @brief Sets the shadow of the dialog box background. - * - * @param options Dialog box parameters. - * @param shadow Shadow style of the background, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetShadow(ArkUI_CustomDialogOptions* options, ArkUI_ShadowStyle shadow); - -/** - * @brief Sets the custom shadow of the dialog box background. - * - * @param options Dialog box parameters. - * @param customShadow Custom shadow parameter. The format is the same as that of the NODE_SHADOW property. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetCustomShadow( - ArkUI_CustomDialogOptions* options, const ArkUI_AttributeItem* customShadow); - -/** - * @brief Sets the background blur style of the dialog box. - * - * @param options Dialog box parameters. - * @param blurStyle Background blur style, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetBackgroundBlurStyle(ArkUI_CustomDialogOptions* options, ArkUI_BlurStyle blurStyle); - -/** - * @brief Sets the alignment mode of the dialog box. - * - * @param options Dialog box parameters. - * @param alignment Alignment mode of the dialog box. The parameter type is {@link ArkUI_Alignment}. - * @param offsetX Indicates the horizontal offset of the custom dialog box. The value is a floating point number. - * @param offsetY Indicates the vertical offset of the custom dialog box. The value is a floating point number. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetAlignment( - ArkUI_CustomDialogOptions* options, int32_t alignment, float offsetX, float offsetY); - -/** - * @brief Sets the modal mode for a custom dialog box. - * - * @param options Dialog box parameters. - * @param isModal Whether the dialog box is a modal. A modal dialog box has a mask applied, - * while a non-modal dialog box does not. The value true means that the dialog box is a modal. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetModalMode(ArkUI_CustomDialogOptions* options, bool isModal); - -/** - * @brief Specifies whether to allow users to touch the mask to dismiss the custom dialog box. - * - * @param options Dialog box parameters. - * @param autoCancel Specifies whether to allow users to touch the mask to dismiss the dialog box. - * The value true means to allow users to do so, and false means the opposite. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetAutoCancel(ArkUI_CustomDialogOptions* options, bool autoCancel); - -/** - * @brief Sets whether to display the dialog box in a subwindow. - * - * @param options Dialog box parameters. - * @param showInSubwindow Whether to display the dialog box in a subwindow when it is not in the main window. - * The default value is false, meaning the dialog box is displayed within the application, not in a - * separate subwindow. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetSubwindowMode(ArkUI_CustomDialogOptions* options, bool showInSubwindow); - -/** - * @brief Sets the mask for a custom dialog box. - * - * @param options Dialog box parameters. - * @param maskColor Mask color, in 0xargb format. - * @param maskRect 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 {@link ArkUI_Rect}. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetMask( - ArkUI_CustomDialogOptions* options, uint32_t maskColor, const ArkUI_Rect* maskRect); - -/** - * @brief Sets the keyboard avoidance mode of the dialog box. - * - * @param options Dialog box parameters. - * @param keyboardAvoidMode Keyboard avoidance mode, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetKeyboardAvoidMode( - ArkUI_CustomDialogOptions* options, ArkUI_KeyboardAvoidMode keyboardAvoidMode); - -/** - * @brief Sets whether to enable the hover mode for the dialog box. - * - * @param options Dialog box parameters. - * @param enabled Whether to enable the hover mode. The default value is false. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetHoverModeEnabled(ArkUI_CustomDialogOptions* options, bool enabled); - -/** - * @brief Set the default display area of the dialog box in hover mode. - * - * @param options Dialog box parameters. - * @param hoverModeAreaType Display area in hover mode, specified by an enumerated value. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_SetHoverModeArea( - ArkUI_CustomDialogOptions* options, ArkUI_HoverModeAreaType hoverModeAreaType); - -/** - * @brief Registers a callback for the dismissal event of the custom dialog box. - * - * @param options Dialog box parameters. - * @param userData Pointer to the user-defined data. - * @param callback Callback for the dismissal event of the custom dialog box. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_RegisterOnWillDismissCallback( - ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(ArkUI_DialogDismissEvent* event)); - -/** - * @brief Registers a callback to be invoked when the custom dialog box is about to appear. - * - * @param options Dialog box parameters. - * @param userData Pointer to the user-defined data. - * @param callback Callback to be invoked when the dialog box is about to appear. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_RegisterOnWillAppearCallback( - ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)); - -/** - * @brief Registers a callback to be invoked when the custom dialog box appears. - * - * @param options Dialog box parameters. - * @param userData Pointer to the user-defined data. - * @param callback Callback to be invoked when the custom dialog box appears. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_RegisterOnDidAppearCallback( - ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)); - -/** - * @brief Registers a callback to be invoked when the custom dialog box is about to disappear. - * - * @param options Dialog box parameters. - * @param userData Pointer to the user-defined data. - * @param callback Callback to be invoked when the dialog box is about to disappear. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_RegisterOnWillDisappearCallback( - ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)); - -/** - * @brief Registers a callback to be invoked when the custom dialog box disappears. - * - * @param options Dialog box parameters. - * @param userData Pointer to the user-defined data. - * @param callback Callback to be invoked when the custom dialog box disappears. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_CustomDialog_RegisterOnDidDisappearCallback( - ArkUI_CustomDialogOptions* options, void* userData, void (*callback)(void* userData)); - #ifdef __cplusplus }; #endif diff --git a/arkui/ace_engine/native/native_interface_xcomponent.h b/arkui/ace_engine/native/native_interface_xcomponent.h index 851520486679499a38d2f774d4c45995fa4fc5c7..2249dcb464eac32b485e160e716eb04f858ddf65 100644 --- a/arkui/ace_engine/native/native_interface_xcomponent.h +++ b/arkui/ace_engine/native/native_interface_xcomponent.h @@ -895,207 +895,6 @@ int32_t OH_ArkUI_XComponent_StartImageAnalyzer(ArkUI_NodeHandle node, void* user */ int32_t OH_ArkUI_XComponent_StopImageAnalyzer(ArkUI_NodeHandle node); -/** - * @brief Provides an encapsulated OH_ArkUI_SurfaceHolder instance. - * - * @since 18 - */ -typedef struct OH_ArkUI_SurfaceHolder OH_ArkUI_SurfaceHolder; - -/** - * @brief Create a OH_ArkUI_SurfaceHolder object from an XComponent node. - * - * @param node Indicates the pointer to the XComponent node. - * @return Returns the created OH_ArkUI_SurfaceHolder object's pointer. - * @since 18 - */ -OH_ArkUI_SurfaceHolder* OH_ArkUI_SurfaceHolder_Create(ArkUI_NodeHandle node); - -/** - * @brief Disposes of a OH_ArkUI_SurfaceHolder object. - * - * @param node Indicates the pointer to OH_ArkUI_SurfaceHolder object needed to dispose. - * @since 18 - */ -void OH_ArkUI_SurfaceHolder_Dispose(OH_ArkUI_SurfaceHolder* surfaceHolder); - -/** - * @brief Saves custom data on the OH_ArkUI_SurfaceHolder instance. - * - * @param surfaceHolder Indicates the OH_ArkUI_SurfaceHolder instance - * on which the custom data will be saved. - * @param userData Indicates the custom data to be saved. - * @return Returns the error code. - * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_SurfaceHolder_SetUserData(OH_ArkUI_SurfaceHolder* surfaceHolder, void* userData); - -/** - * @brief Obtains the custom data saved on the OH_ArkUI_SurfaceHolder instance. - * - * @param surfaceHolder Indicates the target OH_ArkUI_SurfaceHolder instance. - * @return Returns the custom data. - * @since 18 - */ -void* OH_ArkUI_SurfaceHolder_GetUserData(OH_ArkUI_SurfaceHolder* surfaceHolder); - -/** - * @brief Define the surface lifecycle callback. - * - * @since 18 - */ -typedef struct OH_ArkUI_SurfaceCallback OH_ArkUI_SurfaceCallback; - -/** - * @brief Create a OH_ArkUI_SurfaceCallback object. - * - * @return Returns the created OH_ArkUI_SurfaceCallback object's pointer. - * @since 18 - */ -OH_ArkUI_SurfaceCallback* OH_ArkUI_SurfaceCallback_Create(); - -/** - * @brief Disposes of a OH_ArkUI_SurfaceCallback object. - * - * @param callback Indicates the pointer to OH_ArkUI_SurfaceCallback object needed to dispose. - * @since 18 - */ -void OH_ArkUI_SurfaceCallback_Dispose(OH_ArkUI_SurfaceCallback* callback); - -/** - * @brief Set the surface created event of the surface callback. - * - * @param callback Indicated the pointer to the surface callback. - * @param onSurfaceCreated Indicates the surface created callback event - * which will called when the surface is created. - * @since 18 - */ -void OH_ArkUI_SurfaceCallback_SetSurfaceCreatedEvent( - OH_ArkUI_SurfaceCallback* callback, - void (*onSurfaceCreated)(OH_ArkUI_SurfaceHolder* surfaceHolder)); - -/** - * @brief Set the surface changed event of the surface callback. - * - * @param callback Indicated the pointer to the surface callback. - * @param onSurfaceChanged Indicates the surface changed callback event - * which will called when the surface is changed. - * @since 18 - */ -void OH_ArkUI_SurfaceCallback_SetSurfaceChangedEvent( - OH_ArkUI_SurfaceCallback* callback, - void (*onSurfaceChanged)(OH_ArkUI_SurfaceHolder* surfaceHolder, uint64_t width, uint64_t height)); - -/** - * @brief Set the surface destroyed event of the surface callback. - * - * @param callback Indicated the pointer to the surface callback. - * @param onSurfaceDestroyed Indicates the surface destroyed callback event - * which will called when the surface is destroyed. - * @since 18 - */ -void OH_ArkUI_SurfaceCallback_SetSurfaceDestroyedEvent( - OH_ArkUI_SurfaceCallback* callback, - void (*onSurfaceDestroyed)(OH_ArkUI_SurfaceHolder* surfaceHolder)); - -/** - * @brief Adds a surface lifecycle callback for this OH_ArkUI_SurfaceHolder instance. - * - * @param surfaceHolder Indicates the pointer to this OH_ArkUI_SurfaceHolder instance. - * @param callback Indicates the pointer to this new callback. - * @return Returns the status code of the execution. - * {@link ARKUI_ERROR_CODE_NO_ERROR} the execution is successful. - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_SurfaceHolder_AddSurfaceCallback( - OH_ArkUI_SurfaceHolder* surfaceHolder, - OH_ArkUI_SurfaceCallback* callback); - -/** - * @brief Removes a previously added surface lifecycle callback - * from this OH_ArkUI_SurfaceHolder instance. - * - * @param surfaceHolder Indicates the pointer to this OH_ArkUI_SurfaceHolder instance. - * @param callback Indicates the pointer to the callback needed to remove. - * @return Returns the status code of the execution. - * {@link ARKUI_ERROR_CODE_NO_ERROR} the execution is successful. - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 - */ -int32_t OH_ArkUI_SurfaceHolder_RemoveSurfaceCallback( - OH_ArkUI_SurfaceHolder* surfaceHolder, - OH_ArkUI_SurfaceCallback* callback); - -/** - * @brief Forward declaration of OHNativeWindow. - * - * @since 18 - */ -typedef struct NativeWindow OHNativeWindow; - -/** - * @brief Obtains the nativeWindow associated with a OH_ArkUI_SurfaceHolder instance. - * - * @param surfaceHolder Indicates the pointer to this OH_ArkUI_SurfaceHolder instance. - * @return Returns the nativeWindow associated with this OH_ArkUI_SurfaceHolder instance. - * @since 18 - */ -OHNativeWindow* OH_ArkUI_XComponent_GetNativeWindow(OH_ArkUI_SurfaceHolder* surfaceHolder); - -/** - * @brief Set whether the XComponent node needs to initialize automatically. - * - * @param node Indicates the pointer to the XComponent node. - * @param autoInitialize Indicates whether the XComponent node needs to initialize automatically or not. - * If the value is true, OnSurfaceCreated will be called when the node is mounted and - * OnSurfaceDestroyed will be called when the node is unmounted. - * Default value is true. - * @return Returns the status code of the execution. - * {@link ARKUI_ERROR_CODE_NO_ERROR} the execution is successful. - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} if the node is invalid. - * @since 18 - */ -int32_t OH_ArkUI_XComponent_SetAutoInitialize(ArkUI_NodeHandle node, bool autoInitialize); - -/** - * @brief Initialize the XComponent node. - * - * @param node Indicates the pointer to the XComponent node. - * @return Returns the status code of the execution. - * {@link ARKUI_ERROR_CODE_NO_ERROR} the execution is successful. - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} if the node is invalid. - * {@link ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID} if the node has initialized. - * @since 18 - */ -int32_t OH_ArkUI_XComponent_Initialize(ArkUI_NodeHandle node); - -/** - * @brief Finalize the XComponent node. - * - * @param node Indicates the pointer to the XComponent node. - * @return Returns the status code of the execution. - * {@link ARKUI_ERROR_CODE_NO_ERROR} the execution is successful. - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} if the node is invalid. - * {@link ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID} if the node has finalized. - * @since 18 - */ -int32_t OH_ArkUI_XComponent_Finalize(ArkUI_NodeHandle node); - -/** - * @brief Obtains whether the XComponent node has initalized or not. - * - * @param node Indicates the pointer to the XComponent node. - * @param isInitialized Indicates whether the XComponent node has initalized. - * @return Returns the status code of the execution. - * {@link ARKUI_ERROR_CODE_NO_ERROR} the execution is successful. - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} if the node is invalid. - * @since 18 - */ -int32_t OH_ArkUI_XComponent_IsInitialized(ArkUI_NodeHandle node, bool* isInitialized); - #ifdef __cplusplus }; #endif diff --git a/arkui/ace_engine/native/native_node.h b/arkui/ace_engine/native/native_node.h index c246d755ff67c3e5ce6bcc1f956cc26498ac5f50..0e7359cb4e25500f70b9dd95666f6a2b94f0a6ea 100644 --- a/arkui/ace_engine/native/native_node.h +++ b/arkui/ace_engine/native/native_node.h @@ -39,7 +39,12 @@ #include "native_type.h" #include "ui_input_event.h" + +#ifdef __cplusplus #include +#else +#include +#endif #ifdef __cplusplus extern "C" { @@ -1096,13 +1101,13 @@ typedef enum { * .value[0].i32: blend mode. The parameter type is {@link ArkUI_BlendMode}. The default value is * ARKUI_BLEND_MODE_NONE. \n * .value[1].?i32: how the specified blend mode is applied. The parameter type is {@link ArkUI_BlendApplyType}. - * The default value is BLEND_APPLY_TYPE_FAST. \n + * The default value is ARKUI_BLEND_APPLY_TYPE_FAST. \n * \n * Format of the return value {@link ArkUI_AttributeItem}:\n * .value[0].i32: blend mode. The parameter type is {@link ArkUI_BlendMode}. The default value is * ARKUI_BLEND_MODE_NONE. \n * .value[1].i32: how the specified blend mode is applied. The parameter type is {@link ArkUI_BlendApplyType}. - * The default value is BLEND_APPLY_TYPE_FAST. \n + * The default value is ARKUI_BLEND_APPLY_TYPE_FAST. \n * */ NODE_BLEND_MODE, @@ -1870,26 +1875,6 @@ typedef enum { */ NODE_BACKDROP_BLUR = 99, - /** - * @brief Defines the background image resizable attribute, which can be set, reset, - * and obtained as required through APIs. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].f32: width of the left edge. The unit is vp. \n - * .value[1].f32: width of the top edge. The unit is vp. \n - * .value[2].f32: width of the right edge. The unit is vp. \n - * .value[3].f32: width of the bottom edge. The unit is vp. \n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].f32: width of the left edge. The unit is vp. \n - * .value[1].f32: width of the top edge. The unit is vp. \n - * .value[2].f32: width of the right edge. The unit is vp. \n - * .value[3].f32: width of the bottom edge. The unit is vp. \n - * - * @since 18 - */ - NODE_BACKGROUND_IMAGE_RESIZABLE_WITH_SLICE = 100, - /** * @brief Sets the next focus node. * @@ -1920,7 +1905,7 @@ typedef enum { * .object: parameters for visible area change events. * The parameter type is {@link ArkUI_VisibleAreaEventOptions}. \n * - * @since 18 + * @since 17 */ NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_RATIO = 102, @@ -3484,12 +3469,10 @@ typedef enum { * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n * .value[0].i32: button type. The parameter type is {@link ArkUI_ButtonType}. * The default value is ARKUI_BUTTON_TYPE_CAPSULE. \n - * After api 16 the default value change to ARKUI_BUTTON_ROUNDED_RECTANGLE. * \n * Format of the return value {@link ArkUI_AttributeItem}:\n * .value[0].i32: button type. The parameter type is {@link ArkUI_ButtonType}. * The default value is ARKUI_BUTTON_TYPE_CAPSULE. \n - * After api 16 the default value change to ARKUI_BUTTON_ROUNDED_RECTANGLE. * */ NODE_BUTTON_TYPE, @@ -5212,6 +5195,7 @@ typedef enum { * .value[2]?.i32ļ¼šSpecify the alignment of the sliding element with the current container,The parameter type is * {@link ArkUI_ScrollAlignment}, default value is ARKUI_SCROLL_ALIGNMENT_START. \n * .value[3]?.f32: extra offset, in vp. The default value is 0. + * This parameter is supported since API version 15. \n * */ NODE_LIST_SCROLL_TO_INDEX, @@ -5345,21 +5329,6 @@ typedef enum { */ NODE_LIST_MAINTAIN_VISIBLE_CONTENT_POSITION = 1003013, - /** - * @brief Sets whether the List component starts layout from the end. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].i32: whether the List component starts layout from the end. The value 0 means layout - * starts from the top, and 1 means layout starts from the end. The default value is 0. \n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].i32: whether the List component starts layout from the end. The value 0 means layout - * starts from the top, and 1 means layout starts from the end. The default value is 0. \n - * - * @since 18 - */ - NODE_LIST_STACK_FROM_END = 1003014, - /** * @brief Defines whether to enable loop playback for the swiper. * This attribute can be set, reset, and obtained as required through APIs. @@ -5495,22 +5464,16 @@ typedef enum { NODE_SWIPER_INDEX, /** - * @brief Defines the number of elements to display per page. - * This attribute can be set, reset, and obtained as required through APIs. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].i32: number of elements to display per page. \n - * .value[1]?.i32: whether to turn pages by group. The value 0 means to turn pages by child element, - * and 1 means to turn pages by group. This parameter is supported since API version 16. \n - * .string?: this parameter can only be set to 'auto'. When 'auto' is set, the value[] parameters are ignored. - * This parameter is supported since API version 16. \n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].i32: number of elements to display per page. \n - * .value[1].i32: whether to turn pages by group. This parameter is supported since API version 16. \n - * .string: 'auto' or empty string. - * - */ + * @brief Defines the number of elements to display per page. + * This attribute can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].i32: index value of the child component. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].i32: index value of the child component. \n + * + */ NODE_SWIPER_DISPLAY_COUNT, /** @@ -5529,24 +5492,20 @@ typedef enum { NODE_SWIPER_DISABLE_SWIPE, /** - * @brief Defines whether to show the arrow when the mouse pointer hovers over the navigation point indicator. - * This attribute can be set, reset, and obtained as required through APIs. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].i32: whether to show the arrow when the mouse pointer hovers over the navigation point indicator. - * The parameter type is {@link ArkUI_SwiperArrow}.\n - * The default value is ARKUI_SWIPER_ARROW_HIDE. \n - * .?object: arrow style. The parameter type is {@link ArkUI_SwiperArrowStyle}. \n - * This parameter is supported since API version 16. \n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].i32: whether to show the arrow when the mouse pointer hovers over the navigation point indicator. - * The parameter type is {@link ArkUI_SwiperArrow}.\n - * The default value is ARKUI_SWIPER_ARROW_HIDE. \n - * .object: arrow style. The parameter type is {@link ArkUI_SwiperArrowStyle}. \n - * This parameter is supported since API version 16. \n - * - */ + * @brief Defines whether to show the arrow when the mouse pointer hovers over the navigation point indicator. + * This attribute can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].i32: whether to show the arrow when the mouse pointer hovers over the navigation point indicator. + * The parameter type is {@link ArkUI_SwiperArrow}.\n + * The default value is ARKUI_SWIPER_ARROW_HIDE. \n + * \n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].i32: whether to show the arrow when the mouse pointer hovers over the navigation point indicator. + * The parameter type is {@link ArkUI_SwiperArrow}.\n + * The default value is ARKUI_SWIPER_ARROW_HIDE. \n + * + */ NODE_SWIPER_SHOW_DISPLAY_ARROW, /** @@ -5579,14 +5538,6 @@ typedef enum { * * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n * .value[0].i32: number of cached items in the swiper adapter. \n - * .value[1]?.i32: whether the cached items will be displayed. \n - * The value 0 indicates that cached items will not be displayed, \n - * and 1 indicates that cached nodes will be displayed. The default value is 0. \n - * This parameter is supported from API version 16. \n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].i32: number of cached items in the swiper adapter. \n - * .value[1].i32: whether the cached items will be displayed. This parameter is supported from API version 16. \n */ NODE_SWIPER_CACHED_COUNT, @@ -5621,26 +5572,18 @@ typedef enum { NODE_SWIPER_NEXT_MARGIN, /** - * @brief Defines the navigation indicator type of the swiper. - * The attribute can be set, reset, and obtained as required through APIs. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].i32: navigation indicator type, the parameter type is {@link ArkUI_SwiperIndicatorType}.\n - * .object: The parameter type is {@link ArkUI_SwiperIndicator} when the indicator type \n - * is ARKUI_SWIPER_INDICATOR_TYPE_DOT. The parameter type is {@link ArkUI_SwiperDigitIndicator} - * when the indicator type is ARKUI_SWIPER_INDICATOR_TYPE_DIGIT. \n - * {@link ArkUI_SwiperDigitIndicator} is supported since API version 16. \n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].i32: navigation indicator type, the parameter type is {@link ArkUI_SwiperIndicatorType}.\n - * .object: The parameter type is {@link ArkUI_SwiperIndicator} when the indicator type \n - * is ARKUI_SWIPER_INDICATOR_TYPE_DOT. The parameter type is {@link ArkUI_SwiperDigitIndicator} - * when the indicator type is ARKUI_SWIPER_INDICATOR_TYPE_DIGIT. \n - * {@link ArkUI_SwiperDigitIndicator} is supported since API version 16. \n - * - */ + * @brief Defines the navigation indicator type of the swiper. + * The attribute can be set, reset, and obtained as required through APIs. + * + * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n + * .value[0].i32: navigation indicator type, the parameter type is {@link ArkUI_SwiperIndicatorType}.\n + * .object: The parameter type is {@link ArkUI_SwiperIndicator}.\n + * Format of the return value {@link ArkUI_AttributeItem}:\n + * .value[0].i32: navigation indicator type, the parameter type is {@link ArkUI_SwiperIndicatorType}.\n + * .object: The parameter type is {@link ArkUI_SwiperIndicator}.\n + * + */ NODE_SWIPER_INDICATOR, - /** * @brief Set the nested scrolling mode for the Swiper component and parent component. * @@ -5689,23 +5632,6 @@ typedef enum { */ NODE_SWIPER_PAGE_FLIP_MODE, - /** - * @brief Defines the minimum main axis size of child element for swiper to works out the display count. - * This attribute can be set, reset, and obtained as required through APIs. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .value[0].f32: minimum main axis size of the child element, Unit: vp. \n - * .value[1]?.i32: whether to turn pages by group. The value 0 means to turn pages by child element, - * and 1 means to turn pages by group. The default value is 0. \n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .value[0].f32: minimum main axis size of the child element, Unit: vp. \n - * .value[1].i32: whether to turn pages by group. \n - * - * @since 18 - */ - NODE_SWIPER_AUTO_FILL, - /** * @brief: Set the delineation component of the ListItem, supporting property settings, property resets, and * property acquisition interfaces. @@ -6231,35 +6157,6 @@ typedef enum { * @since 18 */ NODE_TEXT_PICKER_COLUMN_WIDTHS = 15009, - /** - * @brief Defines the disabled date range of the calendar picker. - * This attribute can be set, reset, and obtained as required through APIs. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * .string: A string of dates. The `1st start date`,`1st end date`,`2nd start date`,`2nd end date`, - * ...,`nth start date`,`nth end date` of the disabled date range.\n - * Example: 1910-01-01,1910-12-31,2020-01-01,2020-12-31\n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * .string: A string of dates.\n - * - * @since 18 - */ - NODE_CALENDAR_PICKER_DISABLED_DATE_RANGE = 16006, - - /** - * @brief Defines whether the calendar picker marks today. - * This attribute can be set, reset, and obtained as required through APIs. - * - * Format of the {@link ArkUI_AttributeItem} parameter for setting the attribute:\n - * value[0].i32: whether the calendar picker marks today. The default value is false.\n - * \n - * Format of the return value {@link ArkUI_AttributeItem}:\n - * value[0].i32: whether the calendar picker marks today.\n - * - * @since 18 - */ - NODE_CALENDAR_PICKER_MARK_TODAY = 16007, } ArkUI_NodeAttributeType; #define MAX_COMPONENT_EVENT_ARG_NUM 12 @@ -6306,7 +6203,8 @@ typedef enum { /** * @brief Defines the gesture event type. * - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is {@link ArkUI_UIInputEvent}. + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_UIInputEvent}. */ NODE_TOUCH_EVENT = 0, @@ -6596,7 +6494,7 @@ typedef enum { * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is * {@link ArkUI_UIInputEvent}. \n * - * @since 18 + * @since 17 */ NODE_ON_AXIS = 25, @@ -6617,7 +6515,7 @@ typedef enum { * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is * {@link ArkUI_UIInputEvent}. \n * - *@since 18 + *@since 17 */ NODE_ON_HOVER_EVENT = 27, @@ -6636,7 +6534,7 @@ typedef enum { * ArkUI_NodeComponentEvent.data[1].f32: ratio of the component's visible area to its total area * when this callback is invoked. \n * - * @since 18 + * @since 17 */ NODE_VISIBLE_AREA_APPROXIMATE_CHANGE_EVENT = 28, @@ -7302,6 +7200,22 @@ typedef enum { */ NODE_SWIPER_EVENT_ON_CONTENT_DID_SCROLL, + /** + * @brief Defines the event triggered when content in the swiper component will scroll. + * Instructions: Before page scrolling, the ContentWillScrollCallback callback is invoked. \n \n + * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is + * {@link ArkUI_NodeComponentEvent}. \n + * {@link ArkUI_NodeComponentEvent} contains three parameters:\n + * ArkUI_NodeComponentEvent.data[0].i32: the index value of the current child page. \n + * ArkUI_NodeComponentEvent.data[1].i32: the index value of the child page that will display. \n + * ArkUI_NodeComponentEvent.data[2].f32: the sliding offset of each frame. + * Positive numbers indicating slide backward(e.g. from index=1 to index=0), negative numbers indicating + * slide forward(e.g. from index=0 to index=1). \n + * + * @since 15 + */ + NODE_SWIPER_EVENT_ON_CONTENT_WILL_SCROLL = 1001007, + /** * @brief Defines the event triggered when the selected index of the ARKUI_NODE_SWIPER changed. * @@ -7336,22 +7250,6 @@ typedef enum { */ NODE_SWIPER_EVENT_ON_UNSELECTED = 1001006, - /** - * @brief Defines the event triggered when content in the swiper component will scroll. - * Instructions: Before page scrolling, the ContentWillScrollCallback callback is invoked. \n \n - * When the event callback occurs, the union type in the {@link ArkUI_NodeEvent} object is - * {@link ArkUI_NodeComponentEvent}. \n - * {@link ArkUI_NodeComponentEvent} contains three parameters:\n - * ArkUI_NodeComponentEvent.data[0].i32: the index value of the current child page. \n - * ArkUI_NodeComponentEvent.data[1].i32: the index value of the child page that will display. \n - * ArkUI_NodeComponentEvent.data[2].f32: the sliding offset of each frame. - * Positive numbers indicating slide backward(e.g. from index=1 to index=0), negative numbers indicating - * slide forward(e.g. from index=0 to index=1). \n - * - * @since 15 - */ - NODE_SWIPER_EVENT_ON_CONTENT_WILL_SCROLL = 1001007, - /** * @brief Defines the event triggered when the ARKUI_NODE_SCROLL component scrolls. * @@ -9082,18 +8980,6 @@ float OH_ArkUI_SystemFontStyleEvent_GetFontSizeScale(const ArkUI_SystemFontStyle */ float OH_ArkUI_SystemFontStyleEvent_GetFontWeightScale(const ArkUI_SystemFontStyleEvent* event); -/** - * @brief Get the node handle by id. - * - * @param id The id of the target node handle. - * @param node The handle of target node handle. - * @return Error code. - * {@link ARKUI_ERROR_CODE_NO_ERROR} success. - * {@link ARKUI_ERROR_CODE_PARAM_INVALID} Function parameter exception. - * @since 15 - */ -int32_t OH_ArkUI_NodeUtils_GetAttachedNodeHandleById(const char* id, ArkUI_NodeHandle* node); - /** * @brief Move the node handle to target parent node as child. * @@ -9184,6 +9070,18 @@ int32_t OH_ArkUI_UnregisterLayoutCallbackOnNodeHandle(ArkUI_NodeHandle node); */ int32_t OH_ArkUI_UnregisterDrawCallbackOnNodeHandle(ArkUI_NodeHandle node); +/** + * @brief Get the node handle by id. + * + * @param id The id of the target node handle. + * @param node The handle of target node handle. + * @return Error code. + * {@link ARKUI_ERROR_CODE_NO_ERROR} success. + * {@link ARKUI_ERROR_CODE_PARAM_INVALID} Function parameter exception. + * @since 15 + */ +int32_t OH_ArkUI_NodeUtils_GetAttachedNodeHandleById(const char* id, ArkUI_NodeHandle* node); + /** * @brief Get the snapshot pixelmap for the given node synchronously, will get error if the node is not on the * tree or is not rendered yet. diff --git a/arkui/ace_engine/native/native_type.h b/arkui/ace_engine/native/native_type.h index 64676cb956567bca6b4a76e163dd7889c41599f8..d1a8a77b88ffdb62b2a1c7055158c799ed81c49b 100644 --- a/arkui/ace_engine/native/native_type.h +++ b/arkui/ace_engine/native/native_type.h @@ -136,20 +136,6 @@ typedef struct ArkUI_Context* ArkUI_ContextHandle; */ typedef struct ArkUI_SwiperIndicator ArkUI_SwiperIndicator; -/** - * @brief Defines the digital indicator style for the swiper. - * - * @since 18 - */ -typedef struct ArkUI_SwiperDigitIndicator ArkUI_SwiperDigitIndicator; - -/** - * @brief Defines the arrow style for the swiper. - * - * @since 18 - */ -typedef struct ArkUI_SwiperArrowStyle ArkUI_SwiperArrowStyle; - /** * @brief Define the data objects of styled string supported by text components. * @@ -1883,11 +1869,6 @@ typedef enum { ARKUI_BUTTON_TYPE_CAPSULE, /** Circle button. */ ARKUI_BUTTON_TYPE_CIRCLE, - /** - * Rounded rectangle button. - * @since 18 - */ - ARKUI_BUTTON_ROUNDED_RECTANGLE = 8 } ArkUI_ButtonType; /** @@ -2141,11 +2122,6 @@ typedef enum { * @since 15 */ ARKUI_ERROR_CODE_INTERNAL_ERROR = 100001, - /** - * @error The XComponent is in invalid state. - * @since 18 - */ - ARKUI_ERROR_CODE_XCOMPONENT_STATE_INVALID = 103501, /** @error The component does not support specific properties or events. */ ARKUI_ERROR_CODE_ATTRIBUTE_OR_EVENT_NOT_SUPPORTED = 106102, /** @error The corresponding operation does not support nodes created by ArkTS. */ @@ -2232,11 +2208,6 @@ typedef enum { * @since 18 */ ARKUI_ERROR_CODE_RECOGNIZER_TYPE_NOT_SUPPORTED = 180102, - /** - * @error operation is not allowed for current drag drop pharse. - * @since 18 - */ - ARKUI_ERROR_CODE_DRAG_DROP_OPERATION_NOT_ALLOWED = 190004, } ArkUI_ErrorCode; /** @@ -2287,24 +2258,6 @@ typedef enum { ARKUI_ACCESSIBILITY_CHECKED, } ArkUI_AccessibilityCheckedState; -/** - * @brief Define accessible action types. - * - * @since 12 - */ -typedef enum { - /** click action. */ - ARKUI_ACCESSIBILITY_ACTION_CLICK = 1 << 0, - /** long click action. */ - ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK = 1 << 1, - /** cut action. */ - ARKUI_ACCESSIBILITY_ACTION_CUT = 1 << 2, - /** copy action. */ - ARKUI_ACCESSIBILITY_ACTION_COPY = 1 << 3, - /** paste action. */ - ARKUI_ACCESSIBILITY_ACTION_PASTE = 1 << 4, -} ArkUI_AccessibilityActionType; - /** * @brief Enumerates the animation playback modes. * @@ -2349,6 +2302,24 @@ typedef enum { ARKUI_SCROLL_SOURCE_ANIMATION, } ArkUI_ScrollSource; +/** + * @brief Define accessible action types. + * + * @since 12 + */ +typedef enum { + /** click action. */ + ARKUI_ACCESSIBILITY_ACTION_CLICK = 1 << 0, + /** long click action. */ + ARKUI_ACCESSIBILITY_ACTION_LONG_CLICK = 1 << 1, + /** cut action. */ + ARKUI_ACCESSIBILITY_ACTION_CUT = 1 << 2, + /** copy action. */ + ARKUI_ACCESSIBILITY_ACTION_COPY = 1 << 3, + /** paste action. */ + ARKUI_ACCESSIBILITY_ACTION_PASTE = 1 << 4, +} ArkUI_AccessibilityActionType; + /** * @brief Defines the translation options for component transition. * @@ -2590,20 +2561,6 @@ typedef struct ArkUI_SystemFontStyleEvent ArkUI_SystemFontStyleEvent; */ typedef struct ArkUI_SnapshotOptions ArkUI_SnapshotOptions; -/** - * @brief TextPicker single column selector, supports mixing text and images. - * - * @since 18 - */ -typedef struct ArkUI_TextPickerRangeContentArray ArkUI_TextPickerRangeContentArray; - - /** - * @brief TextPicker multi column selector, supports mixing text and images. - * - * @since 18 - */ -typedef struct ArkUI_TextCascadePickerRangeContentArray ArkUI_TextCascadePickerRangeContentArray; - /** * @brief Creates a size constraint. * @@ -3162,397 +3119,6 @@ int32_t OH_ArkUI_SwiperIndicator_SetMaxDisplayCount(ArkUI_SwiperIndicator* indic */ int32_t OH_ArkUI_SwiperIndicator_GetMaxDisplayCount(ArkUI_SwiperIndicator* indicator); -/** - * @brief Sets whether to ignore the size of the indicator for {@link OH_ArkUI_SwiperIndicator_SetBottomPosition}. - * - * @param indicator Indicates the pointer to the indicator. - * @param ignoreSize Whether to ignore the size of the indicator. The value 1 means to ignore, and 0 means the opposite. - * The default value is 0. - * @since 18 -*/ -void OH_ArkUI_SwiperIndicator_SetIgnoreSizeOfBottom(ArkUI_SwiperIndicator* indicator, int32_t ignoreSize); - -/** - * @brief Obtains whether to ignore the size of the indicator for {@link OH_ArkUI_SwiperIndicator_SetBottomPosition}. - * - * @param indicator Indicates the pointer to the indicator. - * @return Returns whether to ignore the size of the indicator. - * @since 18 -*/ -int32_t OH_ArkUI_SwiperIndicator_GetIgnoreSizeOfBottom(ArkUI_SwiperIndicator* indicator); - -/** - * @brief Sets the space between the dots of the navigation indicator. - * - * @param indicator Indicates the pointer to the indicator. - * @param space the space between the dots of the navigation indicator, the default value is 8vp. - * @since 18 -*/ -void OH_ArkUI_SwiperIndicator_SetSpace(ArkUI_SwiperIndicator* indicator, float space); - -/** - * @brief Obtains the space between the dots of the navigation indicator. - * - * @param indicator Indicates the pointer to the indicator. - * @return the space between the dots of the navigation indicator - * @since 18 -*/ -float OH_ArkUI_SwiperIndicator_GetSpace(ArkUI_SwiperIndicator* indicator); - -/** - * @brief Creates a digital indicator. - * - * @return Returns the pointer to the new indicator. - * @since 18 - */ -ArkUI_SwiperDigitIndicator *OH_ArkUI_SwiperDigitIndicator_Create(); - -/** - * @brief Sets the distance between the digital indicator and the start of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @param value Indicates the distance between the digital indicator and the start of the swiper. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetStartPosition(ArkUI_SwiperDigitIndicator* indicator, float value); - -/** - * @brief Gets the distance between the digital indicator and the start of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @return Returns the distance between the digital indicator and the start of the swiper. - * @since 18 - */ -float OH_ArkUI_SwiperDigitIndicator_GetStartPosition(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the distance between the digital indicator and the top of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @param value Indicates the distance between the digital indicator and the top of the swiper. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetTopPosition(ArkUI_SwiperDigitIndicator* indicator, float value); - -/** - * @brief Gets the distance between the digital indicator and the top of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @return Returns the distance between the digital indicator and the top of the swiper. - * @since 18 - */ -float OH_ArkUI_SwiperDigitIndicator_GetTopPosition(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the distance between the digital indicator and the end of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @param value Indicates the distance between the digital indicator and the end of the swiper. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetEndPosition(ArkUI_SwiperDigitIndicator* indicator, float value); - -/** - * @brief Gets the distance between the digital indicator and the end of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @return Returns the distance between the digital indicator and the end of the swiper. - * @since 18 - */ -float OH_ArkUI_SwiperDigitIndicator_GetEndPosition(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the distance between the digital indicator and the bottom of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @param value Returns the distance between the digital indicator and the bottom of the swiper. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetBottomPosition(ArkUI_SwiperDigitIndicator* indicator, float value); - -/** - * @brief Gets the distance between the digital indicator and the bottom of the swiper. - * - * @param indicator The pointer to the digital indicator. - * @return Returns the distance between the digital indicator and the bottom of the swiper. - * @since 18 - */ -float OH_ArkUI_SwiperDigitIndicator_GetBottomPosition(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the font color of total count in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @param color font color, in 0xARGB format. Default value: 0xFF182431. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t color); - -/** - * @brief Gets the font color of total count in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @return font color, in 0xARGB format. - * @since 18 - */ -uint32_t OH_ArkUI_SwiperDigitIndicator_GetFontColor(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the font color of selected index in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @param selectedColor font color, in 0xARGB format. Default value: 0xFF182431. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator, uint32_t selectedColor); - -/** - * @brief Gets the font color of selected index in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @return font color, in 0xARGB format. - * @since 18 - */ -uint32_t OH_ArkUI_SwiperDigitIndicator_GetSelectedFontColor(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the font size of total count in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @param size font size, in fp. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetFontSize(ArkUI_SwiperDigitIndicator* indicator, float size); - -/** - * @brief Gets the font size of total count in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @return font size, in fp. - * @since 18 - */ -float OH_ArkUI_SwiperDigitIndicator_GetFontSize(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the font size of selected index in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @param size font size, in fp. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator, float size); - -/** - * @brief Gets the font size of selected index in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @return font size, in fp. - * @since 18 - */ -float OH_ArkUI_SwiperDigitIndicator_GetSelectedFontSize(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the font weight of total count in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @param fontWeight font weight {@link ArkUI_FontWeight}. The default value is ARKUI_FONT_WEIGHT_NORMAL. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetFontWeight(ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight fontWeight); - -/** - * @brief Gets the font weight of total count in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @return font weight {@link ArkUI_FontWeight}. - * @since 18 - */ -ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetFontWeight(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Sets the font weight of selected index in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @param selectedFontWeight font weight {@link ArkUI_FontWeight}. The default value is ARKUI_FONT_WEIGHT_NORMAL. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_SetSelectedFontWeight( - ArkUI_SwiperDigitIndicator *indicator, ArkUI_FontWeight selectedFontWeight); - -/** - * @brief Gets the font weight of selected index in the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @return font weight {@link ArkUI_FontWeight}. - * @since 18 - */ -ArkUI_FontWeight OH_ArkUI_SwiperDigitIndicator_GetSelectedFontWeight(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Destroys the digital indicator. - * - * @param indicator The pointer to the digital indicator. - * @since 18 - */ -void OH_ArkUI_SwiperDigitIndicator_Destroy(ArkUI_SwiperDigitIndicator *indicator); - -/** - * @brief Sets whether to ignore the size of the indicator for {@link OH_ArkUI_SwiperDigitIndicator_SetBottomPosition}. - * - * @param indicator The pointer to the digital indicator. - * @param ignoreSize Whether to ignore the size of the indicator. The value 1 means to ignore, and 0 means the opposite. - * The default value is 0. - * @since 18 -*/ -void OH_ArkUI_SwiperDigitIndicator_SetIgnoreSizeOfBottom(ArkUI_SwiperDigitIndicator* indicator, int32_t ignoreSize); - -/** - * @brief Obtains whether to ignore the size of the indicator for {@link OH_ArkUI_SwiperDigitIndicator_SetBottomPosition}. - * - * @param indicator The pointer to the digital indicator. - * @return Returns whether to ignore the size of the indicator. - * @since 18 -*/ -int32_t OH_ArkUI_SwiperDigitIndicator_GetIgnoreSizeOfBottom(ArkUI_SwiperDigitIndicator* indicator); - -/** - * @brief Creates a arrow style for swiper. - * - * @return Returns the pointer to the new arrow style. - * @since 18 - */ -ArkUI_SwiperArrowStyle *OH_ArkUI_SwiperArrowStyle_Create(); - -/** - * @brief Sets whether to show the background for the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @param showBackground whether to show the background for the arrow. - * The value 1 means to show the background, and 0 means the opposite. - * The default value is 0. - * @since 18 - */ -void OH_ArkUI_SwiperArrowStyle_SetShowBackground(ArkUI_SwiperArrowStyle *arrowStyle, int32_t showBackground); - -/** - * @brief Gets whether to show the background for the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @return whether to show the background for the arrow. - * The value 1 means to show the background, and 0 means the opposite. - * @since 18 - */ -int32_t OH_ArkUI_SwiperArrowStyle_GetShowBackground(ArkUI_SwiperArrowStyle* arrowStyle); - -/** - * @brief Sets the display position of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @param showSidebarMiddle the display position of the arrow. - * The value 1 means to display on boths sides of the swiper, - * and 0 means display on boths sides of the swiper indicator. - * The default value is 0. - * @since 18 - */ -void OH_ArkUI_SwiperArrowStyle_SetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle, int32_t showSidebarMiddle); - -/** - * @brief Gets the display position of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @return the display position of the arrow. The value 1 means to display on boths sides of the swiper, - * and 0 means display on boths sides of the swiper indicator. - * @since 18 - */ -int32_t OH_ArkUI_SwiperArrowStyle_GetShowSidebarMiddle(ArkUI_SwiperArrowStyle* arrowStyle); - -/** - * @brief Sets the background size of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @param backgroundSize the background size of the arrow. The unit is vp. - * The default value is 24 when the arrow displays on both sides of the swiper indicator. - * The default value is 32 when the arrow displays on both sides of the swiper. - * @since 18 - */ -void OH_ArkUI_SwiperArrowStyle_SetBackgroundSize(ArkUI_SwiperArrowStyle* arrowStyle, float backgroundSize); - -/** - * @brief Gets the background size of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @return Returns the background size of the arrow. The unit is vp. - * @since 18 - */ -float OH_ArkUI_SwiperArrowStyle_GetBackgroundSize(ArkUI_SwiperArrowStyle *arrowStyle); - -/** - * @brief Destroys the arrow style. - * - * @param arrowStyle The pointer to the arrow style. - * @since 18 - */ -void OH_ArkUI_SwiperArrowStyle_Destroy(ArkUI_SwiperArrowStyle *arrowStyle); - -/** - * @brief Sets the background color of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @param backgroundColor the background color of the arrow, in 0xARGB format. - * The default value is 0x00000000 when the arrow displays on both sides of the swiper indicator. - * The default value is 0x19182431 when the arrow displays on both sides of the swiper. - * @since 18 - */ -void OH_ArkUI_SwiperArrowStyle_SetBackgroundColor(ArkUI_SwiperArrowStyle *arrowStyle, uint32_t backgroundColor); - -/** - * @brief Gets the background color of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @return Returns the background color of the arrow, in 0xARGB format. - * @since 18 - */ -uint32_t OH_ArkUI_SwiperArrowStyle_GetBackgroundColor(ArkUI_SwiperArrowStyle* arrowStyle); - -/** - * @brief Sets the size of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @param arrowSize the size of the arrow. The unit is vp. - * The default value is 18 when the arrow displays on both sides of the swiper indicator. - * The default value is 24 when the arrow displays on both sides of the swiper. - * The arrow size is fixed to 3/4 of the background size when the background is shown. - * @since 18 - */ -void OH_ArkUI_SwiperArrowStyle_SetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle, float arrowSize); - -/** - * @brief Gets the size of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @return the size of the arrow. The unit is vp. - * @since 18 - */ -float OH_ArkUI_SwiperArrowStyle_GetArrowSize(ArkUI_SwiperArrowStyle* arrowStyle); - -/** - * @brief Sets the color of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @param arrowColor the color of the arrow, in 0xARGB format. The default value is 0x00182431. - * @since 18 - */ -void OH_ArkUI_SwiperArrowStyle_SetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle, uint32_t arrowColor); - -/** - * @brief Gets the color of the arrow. - * - * @param arrowStyle The pointer to the arrow style. - * @return Returns the color of the arrow, in 0xARGB format. - * @since 18 - */ -uint32_t OH_ArkUI_SwiperArrowStyle_GetArrowColor(ArkUI_SwiperArrowStyle* arrowStyle); - /** * @brief Create auxiliary line information in the RelativeContaine container. * @@ -4265,7 +3831,7 @@ float OH_ArkUI_ListChildrenMainSizeOption_GetMainSize(ArkUI_ListChildrenMainSize *
If the result returns nullptr, there may be out of memory. * @since 12 */ -ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create(); +ArkUI_CustomSpanMeasureInfo* OH_ArkUI_CustomSpanMeasureInfo_Create(void); /** * @brief Disposes of measurement information of this custom span. @@ -4292,7 +3858,7 @@ float OH_ArkUI_CustomSpanMeasureInfo_GetFontSize(ArkUI_CustomSpanMeasureInfo* in *
If the result returns nullptr, there may be out of memory. * @since 12 */ -ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create(); +ArkUI_CustomSpanMetrics* OH_ArkUI_CustomSpanMetrics_Create(void); /** * @brief Disposes of measurement metrics of this custom span. @@ -4335,7 +3901,7 @@ int32_t OH_ArkUI_CustomSpanMetrics_SetHeight(ArkUI_CustomSpanMetrics* metrics, f *
If the result returns nullptr, there may be out of memory. * @since 12 */ -ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create(); +ArkUI_CustomSpanDrawInfo* OH_ArkUI_CustomSpanDrawInfo_Create(void); /** * @brief Disposes of drawing information for this custom span. @@ -4531,7 +4097,7 @@ void OH_ArkUI_AccessibilityState_Dispose(ArkUI_AccessibilityState* state); * @brief Set accessibility state disabled. * * @param state accessibility state object. - * @param isDisabled accessibility state disabledļ¼Œ Value 1 indicates disabled and 0 indicates enbled. + * @param isDisabled accessibility state disabled, Value 1 indicates disabled and 0 indicates enbled. * @since 12 */ void OH_ArkUI_AccessibilityState_SetDisabled(ArkUI_AccessibilityState* state, int32_t isDisabled); @@ -4540,7 +4106,7 @@ void OH_ArkUI_AccessibilityState_SetDisabled(ArkUI_AccessibilityState* state, in * @brief Get accessibility state disabled. * * @param state accessibility state object. - * @return accessibility state disabledļ¼Œ Value 1 indicates disabled and 0 indicates enbled. The default value is 0. + * @return accessibility state disabled, Value 1 indicates disabled and 0 indicates enbled. The default value is 0. * If the function parameter is abnormal, return the default value. * @since 12 */ @@ -4550,7 +4116,7 @@ int32_t OH_ArkUI_AccessibilityState_IsDisabled(ArkUI_AccessibilityState* state); * @brief Set accessibility state selected. * * @param state accessibility state object. - * @param isSelected accessibility state selectedļ¼Œ Value 1 indicates selectedļ¼Œ and 0 indicates not selected. + * @param isSelected accessibility state selected, Value 1 indicates selected, and 0 indicates not selected. * The default value is 0. * @since 12 */ @@ -4560,7 +4126,7 @@ void OH_ArkUI_AccessibilityState_SetSelected(ArkUI_AccessibilityState* state, in * @brief Get accessibility state selected. * * @param state accessibility state object. - * @return accessibility state selectedļ¼Œ Value 1 indicates selectedļ¼Œ and 0 indicates not selected. + * @return accessibility state selected, Value 1 indicates selected, and 0 indicates not selected. * The default value is 0. * If the function parameter is abnormal, return the default value. * @since 12 @@ -4571,7 +4137,7 @@ int32_t OH_ArkUI_AccessibilityState_IsSelected(ArkUI_AccessibilityState* state); * @brief Set accessibility checked state. * * @param state accessibility state object. - * @param checkedState checked stateļ¼Œand uses the {@link ArkUI_AccessibilityCheckedState} enumeration value, + * @param checkedState checked state, and uses the {@link ArkUI_AccessibilityCheckedState} enumeration value, * The default value is ARKUI_ACCESSIBILITY_UNCHECKED. * @since 12 */ @@ -4581,7 +4147,7 @@ void OH_ArkUI_AccessibilityState_SetCheckedState(ArkUI_AccessibilityState* state * @brief Get accessibility checked state. * * @param state accessibility state object. - * @return checked stateļ¼Œand uses the {@link ArkUI_AccessibilityCheckedState} enumeration value, + * @return checked state, and uses the {@link ArkUI_AccessibilityCheckedState} enumeration value, * The default value is ARKUI_ACCESSIBILITY_UNCHECKED. * If the function parameter is abnormal, return the default value. * @since 12 @@ -4609,7 +4175,7 @@ void OH_ArkUI_AccessibilityValue_Dispose(ArkUI_AccessibilityValue* value); * @brief Set accessibility minimum value. * * @param value accessibility value object. - * @param min minimum value based on range components, The default value is -1怂 + * @param min minimum value based on range components, The default value is -1. * @since 12 */ void OH_ArkUI_AccessibilityValue_SetMin(ArkUI_AccessibilityValue* value, int32_t min); @@ -4618,7 +4184,7 @@ void OH_ArkUI_AccessibilityValue_SetMin(ArkUI_AccessibilityValue* value, int32_t * @brief Get accessibility minimum value. * * @param value accessibility value object. - * @return minimum value based on range components, The default value is -1怂 + * @return minimum value based on range components, The default value is -1. * If the function parameter is abnormal, return -1. * @since 12 */ @@ -4628,7 +4194,7 @@ int32_t OH_ArkUI_AccessibilityValue_GetMin(ArkUI_AccessibilityValue* value); * @brief Set accessibility minimum value. * * @param value accessibility value object. - * @param max maximum value based on range components, The default value is -1怂 + * @param max maximum value based on range components, The default value is -1. * @since 12 */ void OH_ArkUI_AccessibilityValue_SetMax(ArkUI_AccessibilityValue* value, int32_t max); @@ -4637,7 +4203,7 @@ void OH_ArkUI_AccessibilityValue_SetMax(ArkUI_AccessibilityValue* value, int32_t * @brief Get accessibility minimum value. * * @param value accessibility value object. - * @return maximum value based on range components, The default value is -1怂 + * @return maximum value based on range components, The default value is -1. * If the function parameter is abnormal, return -1. * @since 12 */ @@ -4647,7 +4213,7 @@ int32_t OH_ArkUI_AccessibilityValue_GetMax(ArkUI_AccessibilityValue* value); * @brief Set accessibility current value. * * @param value accessibility value object. - * @param current value based on range components, The default value is -1怂 + * @param current value based on range components, The default value is -1. * @since 12 */ void OH_ArkUI_AccessibilityValue_SetCurrent(ArkUI_AccessibilityValue* value, int32_t current); @@ -4656,7 +4222,7 @@ void OH_ArkUI_AccessibilityValue_SetCurrent(ArkUI_AccessibilityValue* value, int * @brief Get accessibility current value. * * @param value accessibility value object. - * @return current value based on range components, The default value is -1怂 + * @return current value based on range components, The default value is -1. * If the function parameter is abnormal, return -1. * @since 12 */ @@ -4723,13 +4289,13 @@ int32_t OH_ArkUI_AccessibilityValue_GetRangeCurrent(ArkUI_AccessibilityValue* va * @brief Set accessibility text value. * * @param value accessibility value object. - * @param text The textual description information of the component, which defaults to an empty string怂 + * @param text The textual description information of the component, which defaults to an empty string. * @since 12 */ void OH_ArkUI_AccessibilityValue_SetText(ArkUI_AccessibilityValue* value, const char* text); /** - * @brief Get accessibility text value怂 + * @brief Get accessibility text value. * * @param value accessibility value object. * @return The textual description information of the component, which defaults to an empty string; @@ -4891,35 +4457,6 @@ float OH_ArkUI_ProgressLinearStyleOption_GetStrokeWidth(ArkUI_ProgressLinearStyl */ float OH_ArkUI_ProgressLinearStyleOption_GetStrokeRadius(ArkUI_ProgressLinearStyleOption* option); -/** - * @brief Creates an option for taking snapshot, the returned value must be released through - * {@link OH_ArkUI_DestroySnapshotOptions} when it's not used anymore. - * - * @return Returns the pointer to the created snapshot options object.If the object returns a null pointer, - * it indicates a creation failure, and the reason for the failure may be that the address space is full. - * @since 15 - */ -ArkUI_SnapshotOptions* OH_ArkUI_CreateSnapshotOptions(); - -/** - * @brief Dispose a snapshot option object. - * - * @param snapshotOptions Indicates the pointer to the snapshot option. - * @since 15 - */ -void OH_ArkUI_DestroySnapshotOptions(ArkUI_SnapshotOptions* snapshotOptions); - -/** - * @brief Config the snapshot option with scale. - * - * @param snapshotOptions Indicates the pointer to the snapshot option. - * @param scale Indicates the scale property to take the snapshot. - * @return Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. - * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 15 - */ -int32_t OH_ArkUI_SnapshotOptions_SetScale(ArkUI_SnapshotOptions* snapshotOptions, float scale); - /** * @brief Create a cross-language option instance. * @@ -4955,10 +4492,39 @@ void OH_ArkUI_CrossLanguageOption_SetAttributeSettingStatus(ArkUI_CrossLanguageO */ bool OH_ArkUI_CrossLanguageOption_GetAttributeSettingStatus(ArkUI_CrossLanguageOption* option); +/** + * @brief Creates an option for taking snapshot, the returned value must be released through + * {@link OH_ArkUI_DestroySnapshotOptions} when it's not used anymore. + * + * @return Returns the pointer to the created snapshot options object.If the object returns a null pointer, + * it indicates a creation failure, and the reason for the failure may be that the address space is full. + * @since 15 + */ +ArkUI_SnapshotOptions* OH_ArkUI_CreateSnapshotOptions(); + +/** + * @brief Dispose a snapshot option object. + * + * @param snapshotOptions Indicates the pointer to the snapshot option. + * @since 15 + */ +void OH_ArkUI_DestroySnapshotOptions(ArkUI_SnapshotOptions* snapshotOptions); + +/** + * @brief Config the snapshot option with scale. + * + * @param snapshotOptions Indicates the pointer to the snapshot option. + * @param scale Indicates the scale property to take the snapshot. + * @return Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. + * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. + * @since 15 + */ +int32_t OH_ArkUI_SnapshotOptions_SetScale(ArkUI_SnapshotOptions* snapshotOptions, float scale); + /** * @brief Defines the parameters for visible area change events. * - * @since 18 + * @since 17 */ typedef struct ArkUI_VisibleAreaEventOptions ArkUI_VisibleAreaEventOptions; @@ -4966,7 +4532,7 @@ typedef struct ArkUI_VisibleAreaEventOptions ArkUI_VisibleAreaEventOptions; * @brief Creates an instance of visible area change event parameters * * @return Returns the created instance of visible area change event parameters. -* @since 18 +* @since 17 */ ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create(); @@ -4974,7 +4540,7 @@ ArkUI_VisibleAreaEventOptions* OH_ArkUI_VisibleAreaEventOptions_Create(); * @brief Disposes of an instance of visible area change event parameters. * * @param option Instance to be destroyed. -* @since 18 +* @since 17 */ void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* option); @@ -4992,7 +4558,7 @@ void OH_ArkUI_VisibleAreaEventOptions_Dispose(ArkUI_VisibleAreaEventOptions* opt * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. * If an error code is returned, it may be due to a failure in parameter validation; * the parameter must not be null. -* @since 18 +* @since 17 */ int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t size); @@ -5006,7 +4572,7 @@ int32_t OH_ArkUI_VisibleAreaEventOptions_SetRatios(ArkUI_VisibleAreaEventOptions * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. * If an error code is returned, it may be due to a failure in parameter validation; * the parameter must not be null. -* @since 18 +* @since 17 */ int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval( ArkUI_VisibleAreaEventOptions *option, int32_t value); @@ -5023,7 +4589,7 @@ int32_t OH_ArkUI_VisibleAreaEventOptions_SetExpectedUpdateInterval( * Returns {@link ARKUI_ERROR_CODE_BUFFER_SIZE_ERROR} if the provided buffer size is insufficient. * If an error code is returned, it may be due to a failure in parameter validation; * the parameter must not be null. - * @since 18 + * @since 17 */ int32_t OH_ArkUI_VisibleAreaEventOptions_GetRatios(ArkUI_VisibleAreaEventOptions* option, float* value, int32_t* size); @@ -5032,87 +4598,9 @@ int32_t OH_ArkUI_VisibleAreaEventOptions_GetRatios(ArkUI_VisibleAreaEventOptions * * @param option Instance of visible area change event parameters. * @return Returns the expected update interval, in ms. Default value: 1000. - * @since 18 + * @since 17 */ int32_t OH_ArkUI_VisibleAreaEventOptions_GetExpectedUpdateInterval(ArkUI_VisibleAreaEventOptions* option); - -/** - *@brief Creates a TextPickerRangeContent instance. - * - *@param length The length of the picker array. - *@return Returns a TextPickerRangeContent instance. - *@since 18 - */ -ArkUI_TextPickerRangeContentArray* OH_ArkUI_TextPickerRangeContentArray_Create(int32_t length); - -/** - *@brief Sets the icon of items in a text picker ranges. - * - *@param handle The TextPickerRangeContent instance for obtaining information. - *@param icon Icon addreass. - *@param index The index position of the value to be obtained. - *@since 18 - */ -void OH_ArkUI_TextPickerRangeContentArray_SetIconAtIndex( - ArkUI_TextPickerRangeContentArray* handle, char* icon, int32_t index); - -/** - *@brief Sets the text of items in a text picker ranges - * - *@param handle The TextPickerRangeContent instance for obtaining information. - *@param text Text content - *@param index The index position of the value to be obtained. - *@since 18 - */ -void OH_ArkUI_TextPickerRangeContentArray_SetTextAtIndex( - ArkUI_TextPickerRangeContentArray* handle, char* text, int32_t index); - -/** - *@brief Destroy the TextPickerRangeContent instance. - * - *@param handle The TextPickerRangeContent instance for obtaining information. - *@since 18 - */ -void OH_ArkUI_TextPickerRangeContentArray_Destroy(ArkUI_TextPickerRangeContentArray* handle); - -/** - *@brief Creates a TextCascadePickerRangeContent instance. - * - *@param length The length of the picker array. - *@return Returns a TextCascadePickerRangeContent instance. - *@since 18 - */ -ArkUI_TextCascadePickerRangeContentArray* OH_ArkUI_TextCascadePickerRangeContentArray_Create(int32_t length); - -/** - *@brief Sets the text of items in a multi text picker ranges. - * - *@param handle The TextCascadePickerRangeContent instance for obtaining information. - *@param text text content - *@param index The index position of the value to be obtained. - *@since 18 - */ -void OH_ArkUI_TextCascadePickerRangeContentArray_SetTextAtIndex( - ArkUI_TextCascadePickerRangeContentArray* handle, char* text, int32_t index); - -/** - *@brief Sets the childs info of items in a multi text picker ranges. - * - *@param handle The TextCascadePickerRangeContent instance for obtaining information. - *@param child The child instance. - *@param index The index position of the value to be obtained. - *@since 18 - */ -void OH_ArkUI_TextCascadePickerRangeContentArray_SetChildAtIndex( - ArkUI_TextCascadePickerRangeContentArray* handle, ArkUI_TextCascadePickerRangeContentArray* child, int32_t index); - -/** - *@brief Destroy the TextCascadePickerRangeContent instance. - * - *@param handle The TextCascadePickerRangeContent instance for obtaining information. - *@since 18 - */ -void OH_ArkUI_TextCascadePickerRangeContentArray_Destroy(ArkUI_TextCascadePickerRangeContentArray* handle); #ifdef __cplusplus }; #endif diff --git a/arkui/ace_engine/native/ui_input_event.h b/arkui/ace_engine/native/ui_input_event.h index 37497b2315d3a27099a8fbddd2551d8fb622b934..300db836d8e24664b1211d9d5da14118786b7a5f 100644 --- a/arkui/ace_engine/native/ui_input_event.h +++ b/arkui/ace_engine/native/ui_input_event.h @@ -36,9 +36,9 @@ #ifndef _ARKUI_UI_INPUT_EVENT_H_ #define _ARKUI_UI_INPUT_EVENT_H_ -#include "native_type.h" #include +#include "native_type.h" #ifdef __cplusplus extern "C" { #endif @@ -513,7 +513,7 @@ float OH_ArkUI_PointerEvent_GetTiltY(const ArkUI_UIInputEvent* event, uint32_t p * @return Returns the result code. * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 + * @since 17 */ int32_t OH_ArkUI_PointerEvent_GetRollAngle(const ArkUI_UIInputEvent* event, double* rollAngle); @@ -888,7 +888,7 @@ int32_t OH_ArkUI_FocusAxisEvent_SetStopPropagation(const ArkUI_UIInputEvent* eve * * @param event Pointer to an ArkUI_UIInputEvent object. * @return Returns the width of the component hit by the event; returns 0.0f if any parameter error occurs. -* @since 18 +* @since 17 */ float OH_ArkUI_UIInputEvent_GetEventTargetWidth(const ArkUI_UIInputEvent* event); @@ -897,7 +897,7 @@ float OH_ArkUI_UIInputEvent_GetEventTargetWidth(const ArkUI_UIInputEvent* event) * * @param event Pointer to an ArkUI_UIInputEvent object. * @return Returns the height of the component hit by the event; returns 0.0f if any parameter error occurs. -* @since 18 +* @since 17 */ float OH_ArkUI_UIInputEvent_GetEventTargetHeight(const ArkUI_UIInputEvent* event); @@ -906,7 +906,7 @@ float OH_ArkUI_UIInputEvent_GetEventTargetHeight(const ArkUI_UIInputEvent* event * * @param event Pointer to an ArkUI_UIInputEvent object. * @return Returns the X coordinate of the component hit by the event; returns 0.0f if any parameter error occurs. -* @since 18 +* @since 17 */ float OH_ArkUI_UIInputEvent_GetEventTargetPositionX(const ArkUI_UIInputEvent* event); @@ -916,7 +916,7 @@ float OH_ArkUI_UIInputEvent_GetEventTargetPositionX(const ArkUI_UIInputEvent* ev * @param event Pointer to an ArkUI_UIInputEvent object. * @return Returns the Y coordinate of the component hit by the event; * returns 0.0f if any parameter error occurs. -* @since 18 +* @since 17 */ float OH_ArkUI_UIInputEvent_GetEventTargetPositionY(const ArkUI_UIInputEvent* event); @@ -926,7 +926,7 @@ float OH_ArkUI_UIInputEvent_GetEventTargetPositionY(const ArkUI_UIInputEvent* ev * @param event Pointer to an ArkUI_UIInputEvent object. * @return Returns the global X coordinate of the component hit by the event; * returns 0.0f if any parameter error occurs. -* @since 18 +* @since 17 */ float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX(const ArkUI_UIInputEvent* event); @@ -936,7 +936,7 @@ float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionX(const ArkUI_UIInputEve * @param event Pointer to an ArkUI_UIInputEvent object. * @return Returns the global Y coordinate of the component hit by the event; * returns 0.0f if any parameter error occurs. -* @since 18 +* @since 17 */ float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY(const ArkUI_UIInputEvent* event); @@ -946,7 +946,7 @@ float OH_ArkUI_UIInputEvent_GetEventTargetGlobalPositionY(const ArkUI_UIInputEve * @param event Pointer to an ArkUI_UIInputEvent object. * @return Returns true if the cursor is hovering over the current component. * Returns false if the cursor is not hovering over the current component. -* @since 18 +* @since 17 */ bool OH_ArkUI_HoverEvent_IsHovered(const ArkUI_UIInputEvent* event); @@ -959,7 +959,7 @@ bool OH_ArkUI_HoverEvent_IsHovered(const ArkUI_UIInputEvent* event); * @return Returns the result code. * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 + * @since 17 */ int32_t OH_ArkUI_UIInputEvent_GetModifierKeyStates(const ArkUI_UIInputEvent* event, uint64_t* keys); @@ -1028,7 +1028,7 @@ int32_t OH_ArkUI_UIInputEvent_GetTargetDisplayId(const ArkUI_UIInputEvent* event * @return Returns the result code. * Returns {@link ARKUI_ERROR_CODE_NO_ERROR} if the operation is successful. * Returns {@link ARKUI_ERROR_CODE_PARAM_INVALID} if a parameter error occurs. - * @since 18 + * @since 17 */ int32_t OH_ArkUI_AxisEvent_SetPropagation(const ArkUI_UIInputEvent* event, bool propagation); @@ -1037,7 +1037,7 @@ int32_t OH_ArkUI_AxisEvent_SetPropagation(const ArkUI_UIInputEvent* event, bool * * @param event Pointer to the UI input event. * @return Returns the scroll step configuration of the mouse wheel axis event. - * @since 18 + * @since 17 */ int32_t OH_ArkUI_AxisEvent_GetScrollStep(const ArkUI_UIInputEvent* event); diff --git a/arkui/window_manager/libwm.ndk.json b/arkui/window_manager/libwm.ndk.json index 0563eba01b9356a9dfa51d828789fc40b54d268c..d3791022bb88f9397ab80c56ba040cb5dce1f8f2 100644 --- a/arkui/window_manager/libwm.ndk.json +++ b/arkui/window_manager/libwm.ndk.json @@ -78,5 +78,13 @@ { "first_instroduced":"15", "name":"OH_WindowManager_SetWindowFocusable" + }, + { + "first_instroduced":"17", + "name":"OH_WindowManager_GetAllWindowLayoutInfoList" + }, + { + "first_instroduced":"17", + "name":"OH_WindowManager_ReleaseAllWindowLayoutInfoList" } ] \ No newline at end of file diff --git a/arkui/window_manager/oh_window.h b/arkui/window_manager/oh_window.h index c747b7b2b7b315a4bc747112fb28c1887f7f3c5c..793f9a758f6d9052c56e0b520dec501acd329e6e 100644 --- a/arkui/window_manager/oh_window.h +++ b/arkui/window_manager/oh_window.h @@ -247,6 +247,31 @@ int32_t OH_WindowManager_GetWindowProperties( */ int32_t OH_WindowManager_Snapshot(int32_t windowId, OH_PixelmapNative* pixelMap); +/** + * @brief Get layout info of all windows on the selected display. + * + * @param displayId Indicate the id of display. + * @param windowLayoutInfoList Pointer to the layout information of the visible windows on the specified screen. + * @param windowLayoutInfoSize Pointer to the size of the array of layout information of the visible windows on the + * specified screen. + * @return Returns the result code. + * {@link OK} the function call is successful, return Window layout info list. + * {@link WINDOW_MANAGER_ERRORCODE_INVALID_PARAM} parameter error. + * {@link WINDOW_MANAGER_ERRORCODE_DEVICE_NOT_SUPPORTED} capability not supported. + * {@link WINDOW_MANAGER_ERRORCODE_SYSTEM_ABNORMAL} the window manager service works abnormally. + * @since 17 + */ +int32_t OH_WindowManager_GetAllWindowLayoutInfoList(int64_t displayId, + WindowManager_Rect** windowLayoutInfoList, size_t* windowLayoutInfoSize); + +/** + * @brief Release the memory of window layout info list. + * + * @param windowLayoutInfoList Pointer to the layout information of the visible windows on the specified screen. + * @since 17 + */ +void OH_WindowManager_ReleaseAllWindowLayoutInfoList(WindowManager_Rect* windowLayoutInfoList); + #ifdef __cplusplus } #endif diff --git a/distributeddatamgr/preferences/libpreferences.ndk.json b/distributeddatamgr/preferences/libpreferences.ndk.json index 9c41566f528e86b05404777fa5528a6c277090af..2869d86519f11e5178b0b28fd75c5115b91f1ccd 100644 --- a/distributeddatamgr/preferences/libpreferences.ndk.json +++ b/distributeddatamgr/preferences/libpreferences.ndk.json @@ -47,6 +47,10 @@ "first_introduced": "13", "name": "OH_Preferences_UnregisterDataObserver" }, + { + "first_introduced": "18", + "name": "OH_Preferences_IsStorageTypeSupported" + }, { "first_introduced": "13", "name": "OH_PreferencesOption_Create" @@ -63,6 +67,10 @@ "first_introduced": "13", "name": "OH_PreferencesOption_SetDataGroupId" }, + { + "first_introduced": "18", + "name": "OH_PreferencesOption_SetStorageType" + }, { "first_introduced": "13", "name": "OH_PreferencesOption_Destroy" diff --git a/distributeddatamgr/relational_store/include/oh_data_value.h b/distributeddatamgr/relational_store/include/oh_data_value.h index 202158324aed23d1bbda6c31204b1f37a7fa66b0..fe1c4eb1b78e673ab26ad5103ec2672547f19627 100644 --- a/distributeddatamgr/relational_store/include/oh_data_value.h +++ b/distributeddatamgr/relational_store/include/oh_data_value.h @@ -55,44 +55,44 @@ extern "C" { typedef enum OH_ColumnType { /** * @brief Indicates the column type is NULL. - * - * @since 10 Moved from oh_cursor.h file. + * Moved from oh_cursor.h file. + * @since 10 */ TYPE_NULL = 0, /** * @brief Indicates the column type is INT64. - * - * @since 10 Moved from oh_cursor.h file. + * Moved from oh_cursor.h file. + * @since 10 */ TYPE_INT64, /** * @brief Indicates the column type is REAL. - * - * @since 10 Moved from oh_cursor.h file. + * Moved from oh_cursor.h file. + * @since 10 */ TYPE_REAL, /** * @brief Indicates the column type is TEXT. - * - * @since 10 Moved from oh_cursor.h file. + * Moved from oh_cursor.h file. + * @since 10 */ TYPE_TEXT, /** * @brief Indicates the column type is BLOB. - * - * @since 10 Moved from oh_cursor.h file. + * Moved from oh_cursor.h file. + * @since 10 */ TYPE_BLOB, /** * @brief Indicates the column type is {@link Data_Asset}. - * - * @since 11 Moved from oh_cursor.h file. + * Moved from oh_cursor.h file. + * @since 11 */ TYPE_ASSET, /** * @brief Indicates the column type is array of {@link Data_Asset}. - * - * @since 11 Moved from oh_cursor.h file. + * Moved from oh_cursor.h file. + * @since 11 */ TYPE_ASSETS, /** @@ -125,7 +125,7 @@ typedef struct OH_Data_Value OH_Data_Value; * @see OH_Value_Destroy. * @since 18 */ -OH_Data_Value *OH_Value_Create(); +OH_Data_Value *OH_Value_Create(void); /** * @brief Destroys an OH_Data_Value instance object. diff --git a/distributeddatamgr/relational_store/include/oh_data_values.h b/distributeddatamgr/relational_store/include/oh_data_values.h index a816d39c5e2975616779cf1d431e0705d1ccfd8e..23435aaa135f1ca7a21c1f3073463946d9884e4c 100644 --- a/distributeddatamgr/relational_store/include/oh_data_values.h +++ b/distributeddatamgr/relational_store/include/oh_data_values.h @@ -62,7 +62,7 @@ typedef struct OH_Data_Values OH_Data_Values; * @see OH_Values_Destroy. * @since 18 */ -OH_Data_Values *OH_Values_Create(); +OH_Data_Values *OH_Values_Create(void); /** * @brief Destroys an OH_Data_Values instance object. diff --git a/distributeddatamgr/relational_store/include/oh_data_values_buckets.h b/distributeddatamgr/relational_store/include/oh_data_values_buckets.h index 1147fb08a1a5813988099bca67ccff95fac96ead..dfde2bfec191efe59d5bb9616e46e20b6da26aec 100644 --- a/distributeddatamgr/relational_store/include/oh_data_values_buckets.h +++ b/distributeddatamgr/relational_store/include/oh_data_values_buckets.h @@ -61,7 +61,7 @@ typedef struct OH_Data_VBuckets OH_Data_VBuckets; * @see OH_VBuckets_Destroy. * @since 18 */ -OH_Data_VBuckets *OH_VBuckets_Create(); +OH_Data_VBuckets *OH_VBuckets_Create(void); /** * @brief Destroys an OH_Data_VBuckets instance object. @@ -99,7 +99,7 @@ int OH_VBuckets_PutRow(OH_Data_VBuckets *buckets, const OH_VBucket *row); int OH_VBuckets_PutRows(OH_Data_VBuckets *buckets, const OH_Data_VBuckets *rows); /** - * @brief Add an OH_Data_VBuckets to OH_Data_VBuckets object. + * @brief Gets the number of rows in OH_Data_VBuckets object. * * @param buckets Represents a pointer to an instance of OH_Data_VBuckets. * @param count Represents the count of OH_VBucket in OH_Data_VBuckets. It is an output parameter. diff --git a/distributeddatamgr/relational_store/include/oh_rdb_transaction.h b/distributeddatamgr/relational_store/include/oh_rdb_transaction.h index aa34f0228ea3a7be3dfa8500cccf0809af3c794b..99cbfe20af4cf9d691168aacb8541477caa20621 100644 --- a/distributeddatamgr/relational_store/include/oh_rdb_transaction.h +++ b/distributeddatamgr/relational_store/include/oh_rdb_transaction.h @@ -100,7 +100,7 @@ typedef struct OH_Rdb_Transaction OH_Rdb_Transaction; * @see OH_RdbTrans_DestroyOptions. * @since 18 */ -OH_RDB_TransOptions *OH_RdbTrans_CreateOptions(); +OH_RDB_TransOptions *OH_RdbTrans_CreateOptions(void); /** * @brief Destroys an OH_RDB_TransOptions instance object. diff --git a/distributeddatamgr/relational_store/include/relational_store.h b/distributeddatamgr/relational_store/include/relational_store.h index 54d2cc405782a27d4028fe17102aeb47872a0e2d..d288e6b2247d3c33accaa02912096eb86cd4abe4 100644 --- a/distributeddatamgr/relational_store/include/relational_store.h +++ b/distributeddatamgr/relational_store/include/relational_store.h @@ -190,19 +190,22 @@ typedef enum Rdb_DBType { /** * @brief Define Rdb_Tokenizer type. * - * @since 18 + * @since 17 */ typedef enum Rdb_Tokenizer { /** * @brief Means not using tokenizer. + * @since 17 */ RDB_NONE_TOKENIZER = 1, /** * @brief Means using native icu tokenizer. + * @since 17 */ RDB_ICU_TOKENIZER = 2, /** * @brief Means using self-developed enhance tokenizer. + * @since 18 */ RDB_CUSTOM_TOKENIZER = 3, } Rdb_Tokenizer; @@ -341,7 +344,7 @@ int OH_Rdb_SetDbType(OH_Rdb_ConfigV2 *config, int dbType); * {@link RDB_OK} - success. * {@link RDB_E_INVALID_ARGS} - The error code for common invalid args. * {@link RDB_E_NOT_SUPPORTED} - The error code for not support tokenizer. - * @since 18 + * @since 17 */ int OH_Rdb_SetTokenizer(OH_Rdb_ConfigV2 *config, Rdb_Tokenizer tokenizer); diff --git a/distributeddatamgr/relational_store/include/relational_store_error_code.h b/distributeddatamgr/relational_store/include/relational_store_error_code.h index c75b849e0a27769b2f621242b7d06217661a2cab..053fb1e1765591cdf296999228dcd38e1540c247 100644 --- a/distributeddatamgr/relational_store/include/relational_store_error_code.h +++ b/distributeddatamgr/relational_store/include/relational_store_error_code.h @@ -415,7 +415,7 @@ typedef enum OH_Rdb_ErrCode { RDB_E_TYPE_MISMATCH = (E_BASE + 64), /** - * @brief Data value type is null. + * @brief SQLite: Abort due to constraint violation. * * @since 18 */ diff --git a/distributeddatamgr/relational_store/libnative_rdb.ndk.json b/distributeddatamgr/relational_store/libnative_rdb.ndk.json index 5d4110e087074620dbbcfdfba17a5a37ba4cda57..bd9e55864906c6a9433e06c2572124d041db43fb 100644 --- a/distributeddatamgr/relational_store/libnative_rdb.ndk.json +++ b/distributeddatamgr/relational_store/libnative_rdb.ndk.json @@ -44,10 +44,18 @@ "first_introduced": "14", "name":"OH_Rdb_SetDbType" }, + { + "first_introduced": "17", + "name":"OH_Rdb_SetTokenizer" + }, { "first_introduced": "18", "name":"OH_Rdb_SetPersistent" }, + { + "first_introduced": "18", + "name":"OH_Rdb_IsTokenizerSupported" + }, { "first_introduced": "14", "name":"OH_Rdb_GetSupportedDbType" diff --git a/drivers/external_device_manager/scsi_peripheral/BUILD.gn b/drivers/external_device_manager/scsi_peripheral/BUILD.gn index a475453507472d9559a3a0e2182b93e43fd0f193..8165df363ee164b12f05d25c409b24f2e8910940 100644 --- a/drivers/external_device_manager/scsi_peripheral/BUILD.gn +++ b/drivers/external_device_manager/scsi_peripheral/BUILD.gn @@ -23,7 +23,7 @@ ohos_ndk_headers("scsi_header") { ohos_ndk_library("libscsi") { ndk_description_file = "./libscsi.ndk.json" - min_compact_version = "16" + min_compact_version = "18" output_name = "scsi" system_capability = "SystemCapability.Driver.SCSI.Extension" system_capability_headers = [ diff --git a/drivers/external_device_manager/usb_serial/BUILD.gn b/drivers/external_device_manager/usb_serial/BUILD.gn index 0e47d0d1b99d3728d0b00e8c1ba9003c045547e3..dda999ca9f950c6d4763ea59484907f4e5536e6f 100644 --- a/drivers/external_device_manager/usb_serial/BUILD.gn +++ b/drivers/external_device_manager/usb_serial/BUILD.gn @@ -23,7 +23,7 @@ ohos_ndk_headers("usb_serial_header") { ohos_ndk_library("libusb_serial") { ndk_description_file = "./libusb_serial.ndk.json" - min_compact_version = "16" + min_compact_version = "18" output_name = "usb_serial_ndk" system_capability = "SystemCapability.Driver.UsbSerial.Extension" system_capability_headers = [ diff --git a/graphic/graphic_2d/native_drawing/drawing_error_code.h b/graphic/graphic_2d/native_drawing/drawing_error_code.h index 5bdc19682c4052b80b3c52d070ef15f78c099ae1..0c6e6e0c8769442fa067a5aa242eee703eabfc9e 100644 --- a/graphic/graphic_2d/native_drawing/drawing_error_code.h +++ b/graphic/graphic_2d/native_drawing/drawing_error_code.h @@ -89,7 +89,7 @@ OH_Drawing_ErrorCode OH_Drawing_ErrorCodeGet(); * @since 18 * @version 1.0 */ -void OH_Drawing_ErrorCodeReset(); +void OH_Drawing_ErrorCodeReset(void); #ifdef __cplusplus } #endif diff --git a/graphic/graphic_2d/native_drawing/drawing_font_collection.h b/graphic/graphic_2d/native_drawing/drawing_font_collection.h index e6ac9f49424f699c6c830f9788619ca8093dec78..f69ef11d2198a0e072ac0c8baeb0576a88b8c5db 100644 --- a/graphic/graphic_2d/native_drawing/drawing_font_collection.h +++ b/graphic/graphic_2d/native_drawing/drawing_font_collection.h @@ -72,6 +72,8 @@ void OH_Drawing_DestroyFontCollection(OH_Drawing_FontCollection* fontCollection) * @param fontCollection Indicates the pointer to an OH_Drawing_FontCollection object. * @since 12 * @version 1.0 + * @deprecated since 18 + * @useinstead OH_Drawing_DisableFontCollectionSystemFont */ void OH_Drawing_DisableFontCollectionFallback(OH_Drawing_FontCollection* fontCollection); diff --git a/graphic/graphic_2d/native_drawing/drawing_gpu_context.h b/graphic/graphic_2d/native_drawing/drawing_gpu_context.h index 1949a5e725f78c553096ebece81194d738b81f27..584e8d9288ddb58fbf2a5aa8d4233fe9a88d6c38 100644 --- a/graphic/graphic_2d/native_drawing/drawing_gpu_context.h +++ b/graphic/graphic_2d/native_drawing/drawing_gpu_context.h @@ -51,6 +51,7 @@ extern "C" { * * @since 12 * @version 1.0 + * @deprecated since 18 */ typedef struct { /** If true this allows path mask textures to be cached */ @@ -65,6 +66,8 @@ typedef struct { * @return Returns the pointer to the OH_Drawing_GpuContext object created. * @since 12 * @version 1.0 + * @deprecated since 18 + * @useinstead OH_Drawing_GpuContextCreate */ OH_Drawing_GpuContext* OH_Drawing_GpuContextCreateFromGL(OH_Drawing_GpuContextOptions gpuContextOptions); diff --git a/graphic/graphic_2d/native_drawing/drawing_text_typography.h b/graphic/graphic_2d/native_drawing/drawing_text_typography.h index 9666217288d549c081114e2ed343c13d6a8f6973..234ceb4c973307a13ed26fb63cded13adaacb114 100644 --- a/graphic/graphic_2d/native_drawing/drawing_text_typography.h +++ b/graphic/graphic_2d/native_drawing/drawing_text_typography.h @@ -1272,6 +1272,8 @@ size_t OH_Drawing_GetSizeOfTextBox(OH_Drawing_TextBox* textBox); * @return Returns the glyphposition at coordinate. * @since 11 * @version 1.0 + * @deprecated since 18 + * @useinstead OH_Drawing_TypographyGetGlyphPositionAtCoordinateWithCluster */ OH_Drawing_PositionAndAffinity* OH_Drawing_TypographyGetGlyphPositionAtCoordinate(OH_Drawing_Typography* typography, double dx, double dy); @@ -1421,6 +1423,8 @@ void OH_Drawing_SetTextStyleHalfLeading(OH_Drawing_TextStyle* style, bool halfLe * @param ellipsis Indicates the pointer to ellipsis style. * @since 11 * @version 1.0 + * @deprecated since 18 + * @useinstead OH_Drawing_SetTypographyTextEllipsis */ void OH_Drawing_SetTextStyleEllipsis(OH_Drawing_TextStyle* style, const char* ellipsis); @@ -1432,6 +1436,8 @@ void OH_Drawing_SetTextStyleEllipsis(OH_Drawing_TextStyle* style, const char* el * @param ellipsisModal Indicates the ellipsis model to set. For details, see the enum OH_Drawing_EllipsisModal. * @since 11 * @version 1.0 + * @deprecated since 18 + * @useinstead OH_Drawing_SetTypographyTextEllipsisModal */ void OH_Drawing_SetTextStyleEllipsisModal(OH_Drawing_TextStyle* style, int ellipsisModal); @@ -1683,6 +1689,8 @@ OH_Drawing_TextStyle* OH_Drawing_TypographyGetTextStyle(OH_Drawing_TypographySty * @return Returns line text align. * @since 12 * @version 1.0 + * @deprecated since 18 + * @useinstead OH_Drawing_TypographyStyleGetEffectiveAlignment */ int OH_Drawing_TypographyGetEffectiveAlignment(OH_Drawing_TypographyStyle* style); diff --git a/graphic/graphic_2d/native_image/libnative_image.ndk.json b/graphic/graphic_2d/native_image/libnative_image.ndk.json index 1b40db3aafe575c466ec47ad9d4c2a83a71e8e2d..0a09bba188067f7d55a6428f842f4330a4cb92d6 100644 --- a/graphic/graphic_2d/native_image/libnative_image.ndk.json +++ b/graphic/graphic_2d/native_image/libnative_image.ndk.json @@ -34,5 +34,9 @@ { "first_introduced": "13", "name": "OH_ConsumerSurface_SetDefaultSize" + }, + { + "first_introduced": "17", + "name": "OH_NativeImage_SetDropBufferMode" } ] \ No newline at end of file diff --git a/graphic/graphic_2d/native_image/native_image.h b/graphic/graphic_2d/native_image/native_image.h index 83d30d81ff180b3b6c41b8106f567a36484f80c3..89935caed27d7a42f21b6baee6ab2d4614df72dc 100644 --- a/graphic/graphic_2d/native_image/native_image.h +++ b/graphic/graphic_2d/native_image/native_image.h @@ -350,6 +350,25 @@ int32_t OH_ConsumerSurface_SetDefaultUsage(OH_NativeImage* image, uint64_t usage * @version 1.0 */ int32_t OH_ConsumerSurface_SetDefaultSize(OH_NativeImage* image, int32_t width, int32_t height); + +/** + * @brief Set the rendering in drop buffer mode of the OH_NativeImage.\n + * In this mode, most of the buffers produced by the producer will be discarded, + * and the latest buffer will be selected for rending.\n + * This mode can not simultaneously guarantee high frame rate requirements.\n + * This interface suggest be called after the OH_NativeImage_Create call immediately.\n + * This interface will only take effect when used together with the OH_NativeImage_UpdateSurfaceImage.\n + * This interface is a non-thread-safe type interface.\n + * + * @syscap SystemCapability.Graphic.Graphic2D.NativeImage + * @param image Indicates the pointer to a OH_NativeImage instance. + * @param isOpen Indicates the switch of drop buffer mode. + * @return {@link NATIVE_ERROR_OK} 0 - Success. + * {@link NATIVE_ERROR_INVALID_ARGUMENTS} 40001000 - image is NULL. + * @since 17 + * @version 1.0 + */ +int32_t OH_NativeImage_SetDropBufferMode(OH_NativeImage* image, bool isOpen); #ifdef __cplusplus } #endif diff --git a/graphic/graphic_2d/native_vsync/native_vsync.h b/graphic/graphic_2d/native_vsync/native_vsync.h index d9ef7562e336b80f72e0cfb492d42ab1587a945b..f7d45c0e753e84ae3892bf4d679e6b7f212402ef 100644 --- a/graphic/graphic_2d/native_vsync/native_vsync.h +++ b/graphic/graphic_2d/native_vsync/native_vsync.h @@ -39,6 +39,8 @@ #ifndef NDK_INCLUDE_NATIVE_VSYNC_H_ #define NDK_INCLUDE_NATIVE_VSYNC_H_ +#include + #ifdef __cplusplus extern "C" { #endif diff --git a/graphic/graphic_2d/native_window/external_window.h b/graphic/graphic_2d/native_window/external_window.h index 41b01ce8d0503a1eb63d77c705c13fb120de7c2e..045da5cd8f1b2298394598d1d5ad84d1ea42a71c 100644 --- a/graphic/graphic_2d/native_window/external_window.h +++ b/graphic/graphic_2d/native_window/external_window.h @@ -868,21 +868,6 @@ int32_t OH_NativeWindow_SetMetadataValue(OHNativeWindow *window, OH_NativeBuffer */ int32_t OH_NativeWindow_GetMetadataValue(OHNativeWindow *window, OH_NativeBuffer_MetadataKey metadataKey, int32_t *size, uint8_t **metadata); - -/** - * @brief Clean all OHNativeWindowBuffer caches of this OHNativeWindow - * This interface is a non-thread-safe type interface.\n - * - * @syscap SystemCapability.Graphic.Graphic2D.NativeWindow - * @param window Indicates the pointer to a OHNativeWindow instance. - * @return {@link NATIVE_ERROR_OK} 0 - Success. - * {@link NATIVE_ERROR_INVALID_ARGUMENTS} 40001000 - window is NULL. - * {@link NATIVE_ERROR_CONSUMER_DISCONNECTED} 41211000 - the consumer is disconnected. - * {@link NATIVE_ERROR_BINDER_ERROR} 50401000 - ipc send failed. - * @since 18 - * @version 1.0 - */ -int32_t OH_NativeWindow_CleanCache(OHNativeWindow *window); #ifdef __cplusplus } #endif diff --git a/graphic/graphic_2d/native_window/libnative_window.ndk.json b/graphic/graphic_2d/native_window/libnative_window.ndk.json index ded24b2e8c3ab737e1f77313164f80f0920b1e59..375d3e034a2f351b1f9964c6a8fef025a40f359a 100644 --- a/graphic/graphic_2d/native_window/libnative_window.ndk.json +++ b/graphic/graphic_2d/native_window/libnative_window.ndk.json @@ -50,10 +50,6 @@ { "first_introduced": "12", "name": "OH_NativeWindow_GetMetadataValue" - }, - { - "first_introduced": "18", - "name": "OH_NativeWindow_CleanCache" } ] \ No newline at end of file diff --git a/hiviewdfx/hiappevent/include/hiappevent/hiappevent.h b/hiviewdfx/hiappevent/include/hiappevent/hiappevent.h index 07333c78149d308030bc3c6c1693cec052915417..817691bb22183f3168098ada8c65f84df7ea96c1 100644 --- a/hiviewdfx/hiappevent/include/hiappevent/hiappevent.h +++ b/hiviewdfx/hiappevent/include/hiappevent/hiappevent.h @@ -95,19 +95,34 @@ extern "C" { typedef enum { /** @error The operation is successful. */ HIAPPEVENT_SUCCESS = 0, - /** @error Invalid param value length */ + /** + * @error Invalid param value length + * @since 18 + */ HIAPPEVENT_INVALID_PARAM_VALUE_LENGTH = 4, - /** @error Processor is null */ + /** + * @error Processor is null + * @since 18 + */ HIAPPEVENT_PROCESSOR_IS_NULL = -7, - /** @error Processor not found */ + /** + * @error Processor not found + * @since 18 + */ HIAPPEVENT_PROCESSOR_NOT_FOUND = -8, /** @error Invalid param value */ HIAPPEVENT_INVALID_PARAM_VALUE = -9, /** @error event config is null */ HIAPPEVENT_EVENT_CONFIG_IS_NULL = -10, - /** @error Operate failed */ + /** + * @error Operate failed + * @since 18 + */ HIAPPEVENT_OPERATE_FAILED = -100, - /** @error Invalid uid */ + /** + * @error Invalid uid + * @since 18 + */ HIAPPEVENT_INVALID_UID = -200 } HiAppEvent_ErrorCode; diff --git a/hiviewdfx/hicollie/libhicollie.ndk.json b/hiviewdfx/hicollie/libhicollie.ndk.json index 095797ad209982f6b9bdf341dcf863d658c4aefd..d4889e6aa75983a01a60e199ce0edd611a3f688f 100644 --- a/hiviewdfx/hicollie/libhicollie.ndk.json +++ b/hiviewdfx/hicollie/libhicollie.ndk.json @@ -3,6 +3,10 @@ "first_introduced": "12", "name": "OH_HiCollie_Init_StuckDetection" }, + { + "first_introduced": "18", + "name": "OH_HiCollie_Init_StuckDetectionWithTimeout" + }, { "first_introduced": "12", "name": "OH_HiCollie_Init_JankDetection" diff --git a/hiviewdfx/hitrace/include/hitrace/trace.h b/hiviewdfx/hitrace/include/hitrace/trace.h index 4dcf2c51e49c98c0e7429582bb95be62900829f3..21c1c6d82406dcb7efd210fe85838f10c6452edf 100644 --- a/hiviewdfx/hitrace/include/hitrace/trace.h +++ b/hiviewdfx/hitrace/include/hitrace/trace.h @@ -293,45 +293,6 @@ typedef enum HiTrace_Communication_Mode { HITRACE_CM_DEVICE = 3, } HiTrace_Communication_Mode; -/** - * @brief Enumerates the HiTrace output levels. The output level threshold system parameter determines - * the minimum output trace. - * - * @since 18 - */ -typedef enum HiTrace_Output_Level { - /** - * @brief Ouput level only for debug usage. - * - * @since 18 - */ - HITRACE_LEVEL_DEBUG = 0, - /** - * @brief Output level for beta version usage. - * - * @since 18 - */ - HITRACE_LEVEL_INFO = 1, - /** - * @brief Output level for beta version usage, with higher priority than HITRACE_LEVEL_INFO. - * - * @since 18 - */ - HITRACE_LEVEL_CRITICAL = 2, - /** - * @brief Output level for commercial version usage. - * - * @since 18 - */ - HITRACE_LEVEL_COMMERCIAL = 3, - /** - * @brief Output level for range limit. - * - * @since 18 - */ - HITRACE_LEVEL_MAX = HITRACE_LEVEL_COMMERCIAL, -} HiTrace_Output_Level; - /** * @brief Defines a HiTraceId instance. * @@ -723,96 +684,6 @@ void OH_HiTrace_FinishAsyncTrace(const char *name, int32_t taskId); */ void OH_HiTrace_CountTrace(const char *name, int64_t count); -/** - * @brief Marks the start of a synchronous trace task with output level control. - * - * The OH_HiTrace_StartTraceEx and OH_HiTrace_FinishTraceEx APIs must be used in pairs. - * The two APIs can be used in nested mode. The stack data structure is used for matching during trace data parsing. - * - * @param level Level of output priority. - * @param name Name of a trace task. - * @param customArgs key=value pair, multiple pairs use comma as seperator. - * @atomicservice - * @since 18 - */ -void OH_HiTrace_StartTraceEx(HiTrace_Output_Level level, const char* name, const char* customArgs); - -/** - * @brief Marks the end of a synchronous trace task with output level control. - * - * This API must be used with OH_HiTrace_StartTraceEx in pairs. During trace data parsing, the system matches - * it with the most recent OH_HiTrace_StartTraceEx API invocation in the service process. - * - * @param level Level of output priority. - * @atomicservice - * @since 18 - */ -void OH_HiTrace_FinishTraceEx(HiTrace_Output_Level level); - -/** - * @brief Marks the start of an asynchronous trace task with output level control. - * - * This API is called to implement performance trace in asynchronous manner. The start and end of an asynchronous - * trace task do not occur in sequence. Therefore, a unique taskId is required to ensure proper data parsing. - * It is passed as an input parameter for the asynchronous API. - * This API is used with OH_HiTrace_FinishAsyncTraceEx in pairs. The two APIs, which have the same level, - * name, and task ID, form an asynchronous timeslice trace task. - * If customCategory is specified, the trace slice will be grouped and displayed together with other trace slices - * with the same customCategory. - * If multiple trace tasks with the same name need to be performed at the same time or a trace task needs to be - * performed multiple times concurrently, different task IDs must be specified in OH_HiTrace_StartAsyncTraceEx. - * If the trace tasks with the same name are not performed at the same time, the same taskId can be used. - * Different processes's taskId do not interfere. - * - * @param level Level of output priority. - * @param name Name of the asynchronous trace task. - * @param taskId ID of the asynchronous trace task. - * @param customCategory Label used to aggregate the asynchronous trace. - * @param customArgs key=value pair, multiple pairs use comma as seperator. - * @atomicservice - * @since 18 - */ -void OH_HiTrace_StartAsyncTraceEx(HiTrace_Output_Level level, const char* name, int32_t taskId, - const char* customCategory, const char* customArgs); - -/** - * @brief Marks the end of an asynchronous trace task with output level control. - * - * This API is called in the callback function after an asynchronous trace is complete. - * It is used with OH_HiTrace_StartAsyncTraceEx in pairs. Its level, name, and task ID must be - * the same as those of OH_HiTrace_StartAsyncTraceEx. - * - * @param level Level of output priority. - * @param name Name of the asynchronous trace task. - * @param taskId ID of the asynchronous trace task. - * @atomicservice - * @since 18 - */ -void OH_HiTrace_FinishAsyncTraceEx(HiTrace_Output_Level level, const char* name, int32_t taskId); - -/** - * @brief Traces the value change of an integer variable based on its name with output level control. - * - * This API can be executed for multiple times to trace the value change of a given integer variable at different - * time points. - * - * @param level Level of output priority. - * @param name Name of the integer variable. It does not need to be the same as the real variable name. - * @param count Integer value. Generally, an integer variable can be passed. - * @atomicservice - * @since 18 - */ -void OH_HiTrace_CountTraceEx(HiTrace_Output_Level level, const char* name, int64_t count); - -/** - * @brief Get the trace output status of the calling process. - * - * @return Returns whether the calling process is allowed to output trace. - * @atomicservice - * @since 18 - */ -bool OH_HiTrace_IsTraceEnabled(); - #ifdef __cplusplus } #endif diff --git a/multimedia/audio_framework/common/native_audio_device_base.h b/multimedia/audio_framework/common/native_audio_device_base.h index 9cee8127fb40dffe18da6a9f14b5175aa23624ec..0e751ac95805c0af7b064bd21a28c3c751f73510 100644 --- a/multimedia/audio_framework/common/native_audio_device_base.h +++ b/multimedia/audio_framework/common/native_audio_device_base.h @@ -150,12 +150,6 @@ typedef enum { */ AUDIO_DEVICE_TYPE_USB_DEVICE = 25, - /** - * @brief HDMI device, such as a device connected through an HDMI, ARC, or eARC interface. - * @since 18 - */ - AUDIO_DEVICE_TYPE_HDMI = 27, - /** * @brief Default device type. */ diff --git a/multimedia/audio_framework/common/native_audiostream_base.h b/multimedia/audio_framework/common/native_audiostream_base.h index aed8e102cfdfcd5ac98fd7dfc71fafaf74f7bc54..2241f66935f74ed38493d46bdb6c7fa3de19a13c 100644 --- a/multimedia/audio_framework/common/native_audiostream_base.h +++ b/multimedia/audio_framework/common/native_audiostream_base.h @@ -136,7 +136,7 @@ typedef enum { /** * Float 32, little endian. * - * @since 18 + * @since 17 */ AUDIOSTREAM_SAMPLE_F32LE = 4, } OH_AudioStream_SampleFormat; @@ -727,28 +727,6 @@ typedef enum { typedef OH_AudioData_Callback_Result (*OH_AudioRenderer_OnWriteDataCallback)(OH_AudioRenderer* renderer, void* userData, void* audioData, int32_t audioDataSize); -/** - * @brief Define the audio stream volume mode. - * - * @since 18 - */ -typedef enum { - /** - * Indicates this audio stream volume will be affected by system volume, also the default behavior. - * - * @since 18 - */ - AUDIOSTREAM_VOLUMEMODE_SYSTEM_GLOBAL = 0, - - /** - * Indicates this audio stream volume will be affected by app's individual volume percentage which set by yourself - * using the app volume api. - * - * @since 18 - */ - AUDIOSTREAM_VOLUMEMODE_APP_INDIVIDUAL = 1 -} OH_AudioStream_VolumeMode; - #ifdef __cplusplus } #endif diff --git a/multimedia/audio_framework/common/native_audiostreambuilder.h b/multimedia/audio_framework/common/native_audiostreambuilder.h index cedc25bdc7dab70ee5593d428c29cde75bef769e..f7e8788f7cd56320494836b0c33ce3bae126ece6 100644 --- a/multimedia/audio_framework/common/native_audiostreambuilder.h +++ b/multimedia/audio_framework/common/native_audiostreambuilder.h @@ -362,22 +362,6 @@ OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererInterruptMode(OH_AudioStr OH_AudioStream_Result OH_AudioStreamBuilder_SetRendererWriteDataCallback(OH_AudioStreamBuilder* builder, OH_AudioRenderer_OnWriteDataCallback callback, void* userData); -/* - * Set the renderer volume mode of the stream client - * - * @since 18 - * - * @param builder Reference provided by OH_AudioStreamBuilder_Create() - * @param volumeMode Set the volume mode for the renderer client. - * @return Function result code: - * {@link AUDIOSTREAM_SUCCESS} If the execution is successful. - * {@link AUDIOSTREAM_ERROR_INVALID_PARAM}: - * 1.The param of builder is nullptr; - * 2.The param of volumeMode invalid. - */ -OH_AudioStream_Result OH_AudioStreamBuilder_SetVolumeMode(OH_AudioStreamBuilder* builder, - OH_AudioStream_VolumeMode volumeMode); - #ifdef __cplusplus } #endif diff --git a/multimedia/audio_framework/ohaudio.ndk.json b/multimedia/audio_framework/ohaudio.ndk.json index 2c8537d6ce6ea01760867b6ef228f3e7800434c3..e6d5a0cd2a5cacb6eeb2a19582af975900a2375e 100644 --- a/multimedia/audio_framework/ohaudio.ndk.json +++ b/multimedia/audio_framework/ohaudio.ndk.json @@ -382,9 +382,5 @@ { "first_introduced": "15", "name": "OH_AudioRenderer_GetAudioTimestampInfo" - }, - { - "first_introduced": "18", - "name": "OH_AudioStreamBuilder_SetVolumeMode" } ] diff --git a/multimedia/av_codec/codec_base/libnative_media_codecbase.ndk.json b/multimedia/av_codec/codec_base/libnative_media_codecbase.ndk.json index c84f06a8764f6b2f2f5c05f440080dd77685a450..8077a4119567a7bc3f9a471c6a9ffd51076c841b 100644 --- a/multimedia/av_codec/codec_base/libnative_media_codecbase.ndk.json +++ b/multimedia/av_codec/codec_base/libnative_media_codecbase.ndk.json @@ -80,13 +80,17 @@ "name": "OH_AVCODEC_MIMETYPE_AUDIO_RAW" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AVCODEC_MIMETYPE_VIDEO_MPEG2" }, { - "first_introduced": "18", + "first_introduced": "17", "name": "OH_AVCODEC_MIMETYPE_VIDEO_MPEG4_PART2" }, + { + "first_introduced": "17", + "name": "OH_AVCODEC_MIMETYPE_VIDEO_H263" + }, { "first_introduced": "9", "name": "OH_ED_KEY_TIME_STAMP" diff --git a/multimedia/av_codec/native_avcodec_base.h b/multimedia/av_codec/native_avcodec_base.h index ce92ddfee08b5c255f721d09c2c138713696c7a9..609dc238e0af050156bd7952e9cbb0237a1cc935 100644 --- a/multimedia/av_codec/native_avcodec_base.h +++ b/multimedia/av_codec/native_avcodec_base.h @@ -366,17 +366,25 @@ extern const char *OH_AVCODEC_MIMETYPE_AUDIO_RAW; * @brief Enumerates the MIME type of video mpeg2 codec. * * @syscap SystemCapability.Multimedia.Media.CodecBase - * @since 18 + * @since 17 */ extern const char *OH_AVCODEC_MIMETYPE_VIDEO_MPEG2; /** * @brief Enumerates the MIME type of video mpeg4 part2 codec. * * @syscap SystemCapability.Multimedia.Media.CodecBase - * @since 18 + * @since 17 */ extern const char *OH_AVCODEC_MIMETYPE_VIDEO_MPEG4_PART2; +/** + * @brief Enumerates the MIME type of video h263 codec. + * + * @syscap SystemCapability.Multimedia.Media.CodecBase + * @since 17 + */ +extern const char *OH_AVCODEC_MIMETYPE_VIDEO_H263; + /** * @brief Key for timeStamp in surface's extraData, value type is int64_t. * @@ -1136,7 +1144,7 @@ typedef enum OH_VVCProfile { * @brief MPEG2 Profile * * @syscap SystemCapability.Multimedia.Media.CodecBase - * @since 18 + * @since 17 */ typedef enum OH_MPEG2Profile { /** Simple profile */ @@ -1157,7 +1165,7 @@ typedef enum OH_MPEG2Profile { * @brief MPEG4 Profile * * @syscap SystemCapability.Multimedia.Media.CodecBase - * @since 18 + * @since 17 */ typedef enum OH_MPEG4Profile { /** Simple profile */ @@ -1192,6 +1200,19 @@ typedef enum OH_MPEG4Profile { MPEG4_PROFILE_ADVANCED_SIMPLE = 17, } OH_MPEG4Profile; +/** + * @brief H263 Profile + * + * @syscap SystemCapability.Multimedia.Media.CodecBase + * @since 17 + */ +typedef enum OH_H263Profile { + /** Baseline profile */ + H263_PROFILE_BASELINE = 0, + /** Version 1 backward compatibility profile */ + H263_PROFILE_VERSION_1_BACKWARD_COMPATIBILITY = 2, +} OH_H263Profile; + /** * @brief Enumerates the muxer output file format * @@ -1444,7 +1465,7 @@ typedef enum OH_VVCLevel { * @brief MPEG2 Level. * * @syscap SystemCapability.Multimedia.Media.CodecBase - * @since 18 + * @since 17 */ typedef enum OH_MPEG2Level { /** Low level */ @@ -1461,7 +1482,7 @@ typedef enum OH_MPEG2Level { * @brief MPEG4 Level. * * @syscap SystemCapability.Multimedia.Media.CodecBase - * @since 18 + * @since 17 */ typedef enum OH_MPEG4Level { /** 0 level */ @@ -1486,6 +1507,31 @@ typedef enum OH_MPEG4Level { MPEG4_LEVEL_6 = 9, } OH_MPEG4Level; +/** + * @brief H263 Level. + * + * @syscap SystemCapability.Multimedia.Media.CodecBase + * @since 17 + */ +typedef enum OH_H263Level { + /** 10 level */ + H263_LEVEL_10 = 0, + /** 20 level */ + H263_LEVEL_20 = 1, + /** 30 level */ + H263_LEVEL_30 = 2, + /** 40 level */ + H263_LEVEL_40 = 3, + /** 45 level */ + H263_LEVEL_45 = 4, + /** 50 level */ + H263_LEVEL_50 = 5, + /** 60 level */ + H263_LEVEL_60 = 6, + /** 70 level */ + H263_LEVEL_70 = 7, +} OH_H263Level; + /** * @brief The reference mode in temporal group of picture. * diff --git a/multimedia/av_session/native_avsession.h b/multimedia/av_session/native_avsession.h index 50b7e64592b3db56afd3b3ec3048e38300203da7..b877c0c88bed22409fd84699ee0556598043ec6e 100644 --- a/multimedia/av_session/native_avsession.h +++ b/multimedia/av_session/native_avsession.h @@ -327,6 +327,7 @@ typedef AVSessionCallback_Result (*OH_AVSessionCallback_OnToggleFavorite)(OH_AVS * @param avsession Pointer to a viriable to receive the OH_AVSession * @return Function result codeļ¼š * {@link AV_SESSION_ERR_SUCCESS} If the execution is successful. + * {@link AV_SESSION_ERR_SERVICE_EXCEPTION} If session already existed or internal server error. * {@link AV_SESSION_ERR_INVALID_PARAMETER}: * 1. The param of sessionType is invalid. * 2. The param of sessionTag is nullptr. diff --git a/multimedia/camera_framework/camera.h b/multimedia/camera_framework/camera.h index eecc0d386bda05a25aab781ca73cc34da243689e..274390abd1f8e5c21d6699f604f0454fb2ccba0f 100644 --- a/multimedia/camera_framework/camera.h +++ b/multimedia/camera_framework/camera.h @@ -1101,6 +1101,57 @@ typedef enum Camera_QualityPrioritization { POWER_BALANCE = 1 } Camera_QualityPrioritization; +/** + * @brief Enum for camera concurrent type. + * + * @since 18 + * @version 1.0 + */ +typedef enum Camera_ConcurrentType { + /** + * Cameras concurrency with limited capability. + */ + CAMERA_CONCURRENT_TYPE_LIMITED_CAPABILITY = 0, + + /** + * Cameras concurrenct with full capability. + */ + CAMERA_CONCURRENT_TYPE_FULL_CAPABILITY = 1 +} Camera_ConcurrentType; + +/** + * @brief Concurrency capability infos. + * + * @since 18 + * @version 1.0 + */ +typedef struct Camera_ConcurrentInfo { + /** + * Camera instance. + */ + Camera_Device camera; + + /** + * Supported concurrent type. + */ + Camera_ConcurrentType type; + + /** + * Supported Modes. + */ + Camera_SceneMode* sceneModes; + + /** + * Supported outputCapabilities + */ + Camera_OutputCapability* outputCapabilities; + + /** + * Supported outputCapabilities size. + */ + uint32_t modeAndCapabilitySize; +} Camera_ConcurrentInfo; + #ifdef __cplusplus } #endif diff --git a/multimedia/camera_framework/camera.ndk.json b/multimedia/camera_framework/camera.ndk.json index 8543be5773013b7d4bd011d456467f2f80692cdc..372fb7615dc74d2ddc2f85c3271c33a5181e03db 100644 --- a/multimedia/camera_framework/camera.ndk.json +++ b/multimedia/camera_framework/camera.ndk.json @@ -489,11 +489,11 @@ }, { "first_introduced": "12", - "name": "OH_PhotoOutput_EnableMovingPhoto" + "name": "OH_PhotoOutput_GetPhotoRotation" }, { "first_introduced": "12", - "name": "OH_PhotoOutput_GetPhotoRotation" + "name": "OH_PhotoOutput_EnableMovingPhoto" }, { "first_introduced": "11", @@ -650,5 +650,17 @@ { "first_introduced": "14", "name": "OH_CaptureSession_SetQualityPrioritization" + }, + { + "first_introduced": "18", + "name": "OH_CameraManager_GetCameraDevice" + }, + { + "first_introduced": "18", + "name": "OH_CameraManager_GetCameraConcurrentInfos" + }, + { + "first_introduced": "18", + "name": "OH_CameraInput_OpenConcurrentCameras" } ] diff --git a/multimedia/camera_framework/camera_input.h b/multimedia/camera_framework/camera_input.h index 1438eda3e638e708da24a7d723f72e2ef7ecee53..a91452d9d46cdef6d27a3e7e68095be23b48bb5e 100644 --- a/multimedia/camera_framework/camera_input.h +++ b/multimedia/camera_framework/camera_input.h @@ -135,6 +135,20 @@ Camera_ErrorCode OH_CameraInput_Open(Camera_Input* cameraInput); */ Camera_ErrorCode OH_CameraInput_OpenSecureCamera(Camera_Input* cameraInput, uint64_t* secureSeqId); +/** + * @brief Open camera with specified concurrent type. + * + * @param cameraInput the {@link Camera_Input} instance to be opened. + * @param type the {@link Camera_ConcurrentType} instance. + * @return {@link #CAMERA_OK} if the method call succeeds. + * {@link #INVALID_ARGUMENT} if parameter missing or parameter type incorrect. + * {@link #CAMERA_CONFLICT_CAMERA} if can not use camera cause of conflict. + * {@link #CAMERA_DEVICE_DISABLED} if camera disabled cause of security reason. + * {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error. + * @since 18 + */ +Camera_ErrorCode OH_CameraInput_OpenConcurrentCameras(Camera_Input* cameraInput, Camera_ConcurrentType type); + /** * @brief Close camera. * diff --git a/multimedia/camera_framework/camera_manager.h b/multimedia/camera_framework/camera_manager.h index 71a8f46166f73fda9dea770d94b460e813e77c5b..68e51c29060f037f89ae8793c02a8d4745431be0 100644 --- a/multimedia/camera_framework/camera_manager.h +++ b/multimedia/camera_framework/camera_manager.h @@ -470,6 +470,39 @@ Camera_ErrorCode OH_CameraManager_IsTorchSupportedByTorchMode(Camera_Manager* ca Camera_ErrorCode OH_CameraManager_SetTorchMode(Camera_Manager* cameraManager, Camera_TorchMode torchMode); +/** + * @brief Queries a specified device based on position and type. + * + * @param cameraManager the {@link Camera_Manager} instance. + * @param position the {@link Camera_Position} instance. + * @param type the {@link Camera_Type} instance. + * @param camera the {@link Camera_Device} to be set. + * @return {@link #CAMERA_OK} if the method call succeeds. + * {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect. + * {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error. + * @since 18 + */ +Camera_ErrorCode OH_CameraManager_GetCameraDevice(Camera_Manager* cameraManager, Camera_Position position, + Camera_Type type, Camera_Device* camera); + +/** + * @brief Obtains the concurrent information of specified cameras, the empty return means concurrency is not supported. + * + * @param cameraManager the {@link Camera_Manager} instance. + * @param camera the {@link Camera_Device} instance. + * @param deviceSize length of the input device array. + * @param cameraConcurrentInfo the {@link Camera_ConcurrentInfo} to be set. + * @param infoSize length of the returned concurrency information array. + * @return {@link #CAMERA_OK} if the method call succeeds. + * {@link #CAMERA_INVALID_ARGUMENT} if parameter missing or parameter type incorrect. + * {@link #CAMERA_SERVICE_FATAL_ERROR} if camera service fatal error. + * @since 18 + */ +Camera_ErrorCode OH_CameraManager_GetCameraConcurrentInfos(Camera_Manager* cameraManager, const Camera_Device* camera, + uint32_t deviceSize, + Camera_ConcurrentInfo** cameraConcurrentInfo, + uint32_t* infoSize); + #ifdef __cplusplus } #endif diff --git a/multimedia/image_framework/include/image/image_common.h b/multimedia/image_framework/include/image/image_common.h index 67d972adf0b506d2c1961fcad25b835fd64e85c6..9edfea08393ad4370fe19995cf296f33dcf58619 100644 --- a/multimedia/image_framework/include/image/image_common.h +++ b/multimedia/image_framework/include/image/image_common.h @@ -166,7 +166,8 @@ typedef enum { IMAGE_UNSUPPORTED_CONVERSION = 7600203, /** invalid region */ IMAGE_INVALID_REGION = 7600204, - /** @error unsupported memory format + /** + * @error unsupported memory format * @since 13 */ IMAGE_UNSUPPORTED_MEMORY_FORMAT = 7600205, diff --git a/multimedia/image_framework/include/image/pixelmap_native.h b/multimedia/image_framework/include/image/pixelmap_native.h index 1fa825babfacc4b023c3723d85738ea176de5e9f..9d3f1075ec4b584992f03308a5933bc5538e137f 100644 --- a/multimedia/image_framework/include/image/pixelmap_native.h +++ b/multimedia/image_framework/include/image/pixelmap_native.h @@ -99,11 +99,6 @@ typedef enum { */ PIXEL_FORMAT_UNKNOWN = 0, /* - * ARGB_8888 format - * @since 18 - */ - PIXEL_FORMAT_ARGB_8888 = 1, - /* * RGB_565 format */ PIXEL_FORMAT_RGB_565 = 2, diff --git a/multimedia/media_foundation/native_avbuffer.h b/multimedia/media_foundation/native_avbuffer.h index 29ff41d31536af91b853ac9913aa96a421a5d150..49452cee96e0cc43d06a4031c3a0396bff2bcae6 100644 --- a/multimedia/media_foundation/native_avbuffer.h +++ b/multimedia/media_foundation/native_avbuffer.h @@ -133,7 +133,7 @@ OH_AVFormat *OH_AVBuffer_GetParameter(OH_AVBuffer *buffer); * @return Function result code. * {@link AV_ERR_OK} if the execution is successful. * {@link AV_ERR_INVALID_VAL} if input buffer is nullptr, buffer's magic error, - * input buffer's buffer is nulllptr, input format is nullptr, buffer's magic error, or input meta is nullptr. + * input buffer's buffer is nulllptr, input format is nullptr or input meta is nullptr. * @since 11 */ OH_AVErrCode OH_AVBuffer_SetParameter(OH_AVBuffer *buffer, const OH_AVFormat *format); diff --git a/multimedia/player_framework/avplayer.h b/multimedia/player_framework/avplayer.h index f87d5b2bcdf5fe9cef44aaacaed63e0b5f3711f3..474b2885a2090ebfefdad3643fc87826bcc8f4c6 100644 --- a/multimedia/player_framework/avplayer.h +++ b/multimedia/player_framework/avplayer.h @@ -592,20 +592,6 @@ OH_AVErrCode OH_AVPlayer_SetOnInfoCallback(OH_AVPlayer *player, OH_AVPlayerOnInf */ OH_AVErrCode OH_AVPlayer_SetOnErrorCallback(OH_AVPlayer *player, OH_AVPlayerOnErrorCallback callback, void *userData); -/** - * @brief Set volume mode of the player - * @param player Pointer to an OH_AVPlayer instance - * @param volumeMode The value {@link OH_AudioStream_VolumeMode} indicated volume mode of the player. - * @return Function result code. - * {@link AV_ERR_OK} if the execution is successful. - * {@link AV_ERR_INVALID_VAL} if input player is nullptr or volumeMode value is invalid. - * {@link AV_ERR_INVALID_STATE} function called in invalid state, should before prepare state. - * {@link AV_ERR_SERVICE_DIED} media service died, system error. - * @since 18 - * @version 1.0 - */ -OH_AVErrCode OH_AVPlayer_SetVolumeMode(OH_AVPlayer *player, OH_AudioStream_VolumeMode volumeMode); - #ifdef __cplusplus } #endif diff --git a/multimedia/player_framework/avplayer/libavplayer.ndk.json b/multimedia/player_framework/avplayer/libavplayer.ndk.json index 28f2b2b13e4a378b88a8c650c121d16e6f761ba0..d7151471ef8156446a5d99dfe765a02abccdaae0 100644 --- a/multimedia/player_framework/avplayer/libavplayer.ndk.json +++ b/multimedia/player_framework/avplayer/libavplayer.ndk.json @@ -134,9 +134,5 @@ { "first_introduced": "12", "name": "OH_AVPlayer_SetAudioEffectMode" - }, - { - "first_introduced": "18", - "name": "OH_AVPlayer_SetVolumeMode" } ] \ No newline at end of file diff --git a/multimedia/player_framework/avrecorder.h b/multimedia/player_framework/avrecorder.h index b94e92b97e0fa7ddef4d986de7a68a2605660124..b5fc9847df671ecb4b66cd2aab6cc1da7b5a74d3 100644 --- a/multimedia/player_framework/avrecorder.h +++ b/multimedia/player_framework/avrecorder.h @@ -78,6 +78,7 @@ OH_AVErrCode OH_AVRecorder_Prepare(OH_AVRecorder *recorder, OH_AVRecorder_Config * @return Function result code. * {@link AV_ERR_OK} if the execution is successful. * {@link AV_ERR_INVALID_VAL} if input recorder is nullptr or config is null. + * {@link AV_ERR_NO_MEMORY} failed to malloc memory. * @since 18 */ OH_AVErrCode OH_AVRecorder_GetAVRecorderConfig(OH_AVRecorder *recorder, OH_AVRecorder_Config **config); @@ -181,6 +182,7 @@ OH_AVErrCode OH_AVRecorder_Release(OH_AVRecorder *recorder); * @return Function result code. * {@link AV_ERR_OK} if the execution is successful. * {@link AV_ERR_INVALID_VAL} if input recorder is nullptr. + * {@link AV_ERR_NO_MEMORY} failed to malloc memory. * @since 18 */ OH_AVErrCode OH_AVRecorder_GetAvailableEncoder(OH_AVRecorder *recorder, OH_AVRecorder_EncoderInfo **info, diff --git a/multimedia/player_framework/avscreen_capture/libnative_avscreen_capture.ndk.json b/multimedia/player_framework/avscreen_capture/libnative_avscreen_capture.ndk.json index d175c78a730a8663fa828c1bc08125b1291ba346..b5238bb2876da686c1c0c94202a7184e44f345c4 100644 --- a/multimedia/player_framework/avscreen_capture/libnative_avscreen_capture.ndk.json +++ b/multimedia/player_framework/avscreen_capture/libnative_avscreen_capture.ndk.json @@ -108,7 +108,7 @@ "name": "OH_AVScreenCapture_ShowCursor" }, { - "first_introduced": "18", + "first_introduced": "15", "name": "OH_AVScreenCapture_SetDisplayCallback" } ] \ No newline at end of file diff --git a/resourceschedule/background_process_manager/background_process_manager.ndk.json b/resourceschedule/background_process_manager/background_process_manager.ndk.json index 022e9497562bd27122e3edbccbeea32394f87f61..db04aecf143c3582923491dfbe5a6468b58cf7c5 100644 --- a/resourceschedule/background_process_manager/background_process_manager.ndk.json +++ b/resourceschedule/background_process_manager/background_process_manager.ndk.json @@ -1,10 +1,10 @@ [ { - "first_introduced": "15", + "first_introduced": "17", "name": "OH_BackgroundProcessManager_SetProcessPriority" }, { - "first_introduced": "15", + "first_introduced": "17", "name": "OH_BackgroundProcessManager_ResetProcessPriority" } ] \ No newline at end of file diff --git a/resourceschedule/background_process_manager/include/background_process_manager.h b/resourceschedule/background_process_manager/include/background_process_manager.h index c9e3c085c02b91e650e312fc88b457118bcbf6e8..b2049aaadfe5d7b15eebffdaf9a8f7137a5819fc 100644 --- a/resourceschedule/background_process_manager/include/background_process_manager.h +++ b/resourceschedule/background_process_manager/include/background_process_manager.h @@ -19,7 +19,7 @@ * * @brief BackgroundProcessManager provides APIs. * - * @since 15 + * @since 17 */ /** @@ -32,7 +32,7 @@ * @library libbackground_process_manager.z.so * @kit BackgroundTasksKit * @syscap SystemCapability.Resourceschedule.BackgroundProcessManager - * @since 15 + * @since 17 */ #ifndef RESOURCESCHEDULE_BACKGROUND_PROCESS_MANAGER_H @@ -45,7 +45,7 @@ extern "C" { /** * @brief Describes the level of BackgroundProcessManager priority. * - * @since 15 + * @since 17 */ typedef enum BackgroundProcessManager_ProcessPriority { /** @@ -62,7 +62,7 @@ typedef enum BackgroundProcessManager_ProcessPriority { /** * @brief Enum for BackgroundProcessManager error code. * - * @since 15 + * @since 17 */ typedef enum BackgroundProcessManager_ErrorCode { /** @@ -91,8 +91,7 @@ typedef enum BackgroundProcessManager_ErrorCode { Specific priority can be referenced {@link BackgroundProcessManager_ProcessPriority}. * @return {@link ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS} 0 - Success. * {@link ERR_BACKGROUND_PROCESS_MANAGER_INVALID_PARAM} 401 - Parameter error. - * {@link ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR} 31800001 - Remote error. - * @since 15 + * @since 17 */ int OH_BackgroundProcessManager_SetProcessPriority(int pid, BackgroundProcessManager_ProcessPriority priority); @@ -101,8 +100,7 @@ int OH_BackgroundProcessManager_SetProcessPriority(int pid, BackgroundProcessMan * * @param pid Indicates the pid of the process to be reset. * @return {@link ERR_BACKGROUND_PROCESS_MANAGER_SUCCESS} 0 - Success. - * {@link ERR_BACKGROUND_PROCESS_MANAGER_REMOTE_ERROR} 31800001 - Remote error. - * @since 15 + * @since 17 */ int OH_BackgroundProcessManager_ResetProcessPriority(int pid); #ifdef __cplusplus diff --git a/resourceschedule/ffrt/BUILD.gn b/resourceschedule/ffrt/BUILD.gn index 8fb7e35b645fca609ace368aba41a469e2487ded..f9ad3084ea728edb153ca2498c4319845cf7fbfe 100644 --- a/resourceschedule/ffrt/BUILD.gn +++ b/resourceschedule/ffrt/BUILD.gn @@ -21,6 +21,7 @@ ohos_ndk_headers("ffrt_header") { "c/loop.h", "c/mutex.h", "c/queue.h", + "c/shared_mutex.h", "c/sleep.h", "c/task.h", "c/timer.h", @@ -37,6 +38,7 @@ ohos_ndk_library("libffrt_ndk") { "ffrt/loop.h", "ffrt/mutex.h", "ffrt/queue.h", + "ffrt/shared_mutex.h", "ffrt/sleep.h", "ffrt/task.h", "ffrt/timer.h", diff --git a/resourceschedule/ffrt/c/condition_variable.h b/resourceschedule/ffrt/c/condition_variable.h index d044dbcb6a1cb3b15afbb8114541801665ed00d5..21984d0e72568686dbd4ec598da5255ed7cb93b6 100644 --- a/resourceschedule/ffrt/c/condition_variable.h +++ b/resourceschedule/ffrt/c/condition_variable.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 10 - * @version 1.0 */ #ifndef FFRT_API_C_CONDITION_VARIABLE_H @@ -48,7 +47,6 @@ * @return Returns ffrt_success if the condition variable is initialized; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_cond_init(ffrt_cond_t* cond, const ffrt_condattr_t* attr); @@ -59,7 +57,6 @@ FFRT_C_API int ffrt_cond_init(ffrt_cond_t* cond, const ffrt_condattr_t* attr); * @return Returns ffrt_success if the thread is unblocked; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_cond_signal(ffrt_cond_t* cond); @@ -70,7 +67,6 @@ FFRT_C_API int ffrt_cond_signal(ffrt_cond_t* cond); * @return Returns ffrt_success if the threads are unblocked; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_cond_broadcast(ffrt_cond_t* cond); @@ -82,7 +78,6 @@ FFRT_C_API int ffrt_cond_broadcast(ffrt_cond_t* cond); * @return Returns ffrt_success if the thread is unblocked after being blocked; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_cond_wait(ffrt_cond_t* cond, ffrt_mutex_t* mutex); @@ -99,7 +94,6 @@ FFRT_C_API int ffrt_cond_wait(ffrt_cond_t* cond, ffrt_mutex_t* mutex); returns ffrt_error_timedout if the maximum duration reaches; returns ffrt_error_inval if the blocking fails. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_cond_timedwait(ffrt_cond_t* cond, ffrt_mutex_t* mutex, const struct timespec* time_point); @@ -110,7 +104,6 @@ FFRT_C_API int ffrt_cond_timedwait(ffrt_cond_t* cond, ffrt_mutex_t* mutex, const * @return Returns ffrt_success if the condition variable is destroyed; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_cond_destroy(ffrt_cond_t* cond); diff --git a/resourceschedule/ffrt/c/loop.h b/resourceschedule/ffrt/c/loop.h index 88dacad1eabf2a96393d4823f9920739d313da82..0c5ab2a2fb6329a6267b68a39ffcbda63d89edfd 100644 --- a/resourceschedule/ffrt/c/loop.h +++ b/resourceschedule/ffrt/c/loop.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 12 - * @version 1.0 */ #ifndef FFRT_API_C_LOOP_H @@ -54,7 +53,6 @@ typedef void* ffrt_loop_t; * @return Returns a non-null loop handle if the loop is created; returns a null pointer otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API ffrt_loop_t ffrt_loop_create(ffrt_queue_t queue); @@ -65,7 +63,6 @@ FFRT_C_API ffrt_loop_t ffrt_loop_create(ffrt_queue_t queue); * @return Returns 0 if the loop is destroyed; returns -1 otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_loop_destroy(ffrt_loop_t loop); @@ -76,7 +73,6 @@ FFRT_C_API int ffrt_loop_destroy(ffrt_loop_t loop); * @return Returns -1 if loop run fail; returns 0 otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_loop_run(ffrt_loop_t loop); @@ -85,7 +81,6 @@ FFRT_C_API int ffrt_loop_run(ffrt_loop_t loop); * * @param loop Indicates a loop handle. * @since 12 - * @version 1.0 */ FFRT_C_API void ffrt_loop_stop(ffrt_loop_t loop); @@ -101,7 +96,6 @@ FFRT_C_API void ffrt_loop_stop(ffrt_loop_t loop); * @return Returns 0 if success; returns -1 otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_loop_epoll_ctl(ffrt_loop_t loop, int op, int fd, uint32_t events, void *data, ffrt_poller_cb cb); @@ -115,7 +109,6 @@ FFRT_C_API int ffrt_loop_epoll_ctl(ffrt_loop_t loop, int op, int fd, uint32_t ev * @param repeat Indicates whether to repeat this timer. * @return Returns a timer handle. * @since 12 - * @version 1.0 */ FFRT_C_API ffrt_timer_t ffrt_loop_timer_start( ffrt_loop_t loop, uint64_t timeout, void* data, ffrt_timer_cb cb, bool repeat); @@ -128,7 +121,6 @@ FFRT_C_API ffrt_timer_t ffrt_loop_timer_start( * @return Returns 0 if success; returns -1 otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_loop_timer_stop(ffrt_loop_t loop, ffrt_timer_t handle); diff --git a/resourceschedule/ffrt/c/mutex.h b/resourceschedule/ffrt/c/mutex.h index 731af32139c460cc94271432f1192ff3485f22bf..f343f38d5b2e0de05e25d62ddfe088a03f387cd2 100644 --- a/resourceschedule/ffrt/c/mutex.h +++ b/resourceschedule/ffrt/c/mutex.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 10 - * @version 1.0 */ #ifndef FFRT_API_C_MUTEX_H @@ -46,7 +45,6 @@ * @return Returns ffrt_success if the mutex attribute is initialized; returns ffrt_error_inval otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_mutexattr_init(ffrt_mutexattr_t* attr); @@ -59,7 +57,6 @@ FFRT_C_API int ffrt_mutexattr_init(ffrt_mutexattr_t* attr); returns ffrt_error_inval if attr is a null pointer or the mutex attribute type is not ffrt_mutex_normal or ffrt_mutex_recursive. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_mutexattr_settype(ffrt_mutexattr_t* attr, int type); @@ -71,7 +68,6 @@ FFRT_C_API int ffrt_mutexattr_settype(ffrt_mutexattr_t* attr, int type); * @return Returns ffrt_success if the mutex attribute type is get successfully; returns ffrt_error_inval if attr or type is a null pointer. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_mutexattr_gettype(ffrt_mutexattr_t* attr, int* type); @@ -82,7 +78,6 @@ FFRT_C_API int ffrt_mutexattr_gettype(ffrt_mutexattr_t* attr, int* type); * @return Returns ffrt_success if the mutex attribute is destroyed; returns ffrt_error_inval otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_mutexattr_destroy(ffrt_mutexattr_t* attr); @@ -94,7 +89,6 @@ FFRT_C_API int ffrt_mutexattr_destroy(ffrt_mutexattr_t* attr); * @return Returns ffrt_success if the mutex is initialized; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_mutex_init(ffrt_mutex_t* mutex, const ffrt_mutexattr_t* attr); @@ -105,7 +99,6 @@ FFRT_C_API int ffrt_mutex_init(ffrt_mutex_t* mutex, const ffrt_mutexattr_t* attr * @return Returns ffrt_success if the mutex is locked; returns ffrt_error_inval or blocks the calling thread otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_mutex_lock(ffrt_mutex_t* mutex); @@ -116,7 +109,6 @@ FFRT_C_API int ffrt_mutex_lock(ffrt_mutex_t* mutex); * @return Returns ffrt_success if the mutex is unlocked; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_mutex_unlock(ffrt_mutex_t* mutex); @@ -127,7 +119,6 @@ FFRT_C_API int ffrt_mutex_unlock(ffrt_mutex_t* mutex); * @return Returns ffrt_success if the mutex is locked; returns ffrt_error_inval or ffrt_error_busy otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_mutex_trylock(ffrt_mutex_t* mutex); @@ -138,7 +129,6 @@ FFRT_C_API int ffrt_mutex_trylock(ffrt_mutex_t* mutex); * @return Returns ffrt_success if the mutex is destroyed; returns ffrt_error_inval otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_mutex_destroy(ffrt_mutex_t* mutex); diff --git a/resourceschedule/ffrt/c/queue.h b/resourceschedule/ffrt/c/queue.h index 9d202edfb5074fe9665e3cb6991477fdd6713efe..758b79b5adf0d4641c9ef11d4d941cb77c2ea045 100644 --- a/resourceschedule/ffrt/c/queue.h +++ b/resourceschedule/ffrt/c/queue.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 10 - * @version 1.0 */ #ifndef FFRT_API_C_QUEUE_H @@ -67,7 +66,6 @@ typedef void* ffrt_queue_t; * @return Returns 0 if the queue attribute is initialized; returns -1 otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_queue_attr_init(ffrt_queue_attr_t* attr); @@ -76,7 +74,6 @@ FFRT_C_API int ffrt_queue_attr_init(ffrt_queue_attr_t* attr); * * @param attr Indicates a pointer to the queue attribute. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_queue_attr_destroy(ffrt_queue_attr_t* attr); @@ -86,7 +83,6 @@ FFRT_C_API void ffrt_queue_attr_destroy(ffrt_queue_attr_t* attr); * @param attr Indicates a pointer to the queue attribute. * @param qos Indicates the QoS. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_queue_attr_set_qos(ffrt_queue_attr_t* attr, ffrt_qos_t qos); @@ -96,17 +92,17 @@ FFRT_C_API void ffrt_queue_attr_set_qos(ffrt_queue_attr_t* attr, ffrt_qos_t qos) * @param attr Indicates a pointer to the queue attribute. * @return Returns the QoS. * @since 10 - * @version 1.0 */ FFRT_C_API ffrt_qos_t ffrt_queue_attr_get_qos(const ffrt_queue_attr_t* attr); /** * @brief Sets the execution timeout of a serial queue attribute. * + * The lower limit of timeout value is 1 ms, if the value is less than 1 ms, it will be set to 1 ms. + * * @param attr Serial queue attribute pointer. * @param timeout_us Serial queue task execution timeout. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_queue_attr_set_timeout(ffrt_queue_attr_t* attr, uint64_t timeout_us); @@ -116,7 +112,6 @@ FFRT_C_API void ffrt_queue_attr_set_timeout(ffrt_queue_attr_t* attr, uint64_t ti * @param attr Serial queue attribute pointer. * @return Returns the serial queue task execution timeout. * @since 10 - * @version 1.0 */ FFRT_C_API uint64_t ffrt_queue_attr_get_timeout(const ffrt_queue_attr_t* attr); @@ -126,7 +121,6 @@ FFRT_C_API uint64_t ffrt_queue_attr_get_timeout(const ffrt_queue_attr_t* attr); * @param attr Serial queue attribute pointer. * @param f Serial queue timeout callback function. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_queue_attr_set_callback(ffrt_queue_attr_t* attr, ffrt_function_header_t* f); @@ -136,7 +130,6 @@ FFRT_C_API void ffrt_queue_attr_set_callback(ffrt_queue_attr_t* attr, ffrt_funct * @param attr Serial queue attribute pointer. * @return Returns the serial queue task timeout callback function. * @since 10 - * @version 1.0 */ FFRT_C_API ffrt_function_header_t* ffrt_queue_attr_get_callback(const ffrt_queue_attr_t* attr); @@ -146,7 +139,6 @@ FFRT_C_API ffrt_function_header_t* ffrt_queue_attr_get_callback(const ffrt_queue * @param attr Queue attribute pointer. * @param max_concurrency queue max_concurrency. * @since 12 - * @version 1.0 */ FFRT_C_API void ffrt_queue_attr_set_max_concurrency(ffrt_queue_attr_t* attr, const int max_concurrency); @@ -156,7 +148,6 @@ FFRT_C_API void ffrt_queue_attr_set_max_concurrency(ffrt_queue_attr_t* attr, con * @param attr Queue attribute pointer. * @return Returns the queue max concurrency. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_queue_attr_get_max_concurrency(const ffrt_queue_attr_t* attr); @@ -169,7 +160,6 @@ FFRT_C_API int ffrt_queue_attr_get_max_concurrency(const ffrt_queue_attr_t* attr * @return Returns a non-null queue handle if the queue is created; returns a null pointer otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API ffrt_queue_t ffrt_queue_create(ffrt_queue_type_t type, const char* name, const ffrt_queue_attr_t* attr); @@ -178,7 +168,6 @@ FFRT_C_API ffrt_queue_t ffrt_queue_create(ffrt_queue_type_t type, const char* na * * @param queue Indicates a queue handle. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_queue_destroy(ffrt_queue_t queue); @@ -189,7 +178,6 @@ FFRT_C_API void ffrt_queue_destroy(ffrt_queue_t queue); * @param f Indicates a pointer to the task executor. * @param attr Indicates a pointer to the task attribute. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_queue_submit(ffrt_queue_t queue, ffrt_function_header_t* f, const ffrt_task_attr_t* attr); @@ -202,7 +190,6 @@ FFRT_C_API void ffrt_queue_submit(ffrt_queue_t queue, ffrt_function_header_t* f, * @return Returns a non-null task handle if the task is submitted; returns a null pointer otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API ffrt_task_handle_t ffrt_queue_submit_h( ffrt_queue_t queue, ffrt_function_header_t* f, const ffrt_task_attr_t* attr); @@ -212,7 +199,6 @@ FFRT_C_API ffrt_task_handle_t ffrt_queue_submit_h( * * @param handle Indicates a task handle. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_queue_wait(ffrt_task_handle_t handle); @@ -223,7 +209,6 @@ FFRT_C_API void ffrt_queue_wait(ffrt_task_handle_t handle); * @return Returns 0 if the task is canceled; returns -1 otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_queue_cancel(ffrt_task_handle_t handle); @@ -232,7 +217,6 @@ FFRT_C_API int ffrt_queue_cancel(ffrt_task_handle_t handle); * * @return Returns application main thread queue. * @since 12 - * @version 1.0 */ FFRT_C_API ffrt_queue_t ffrt_get_main_queue(void); @@ -240,9 +224,8 @@ FFRT_C_API ffrt_queue_t ffrt_get_main_queue(void); * @brief Gets the application worker(ArkTs) thread queue. * * @return Returns application worker(ArkTs) thread queue. - * @deprecated since 15 + * @deprecated since 18 * @since 12 - * @version 1.0 */ FFRT_C_API ffrt_queue_t ffrt_get_current_queue(void); diff --git a/resourceschedule/ffrt/c/shared_mutex.h b/resourceschedule/ffrt/c/shared_mutex.h new file mode 100644 index 0000000000000000000000000000000000000000..a2a392427b9124eba293382336851cab45f96cd6 --- /dev/null +++ b/resourceschedule/ffrt/c/shared_mutex.h @@ -0,0 +1,113 @@ +/* + * Copyright (c) 2025 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/** + * @addtogroup FFRT + * @{ + * + * @brief Provides FFRT C APIs. + * + * @since 18 + */ + +/** + * @file shared_mutex.h + * + * @brief Declares the shared mutex interfaces in C. + * + * @library libffrt.z.so + * @kit FunctionFlowRuntimeKit + * @syscap SystemCapability.Resourceschedule.Ffrt.Core + * @since 18 + */ + +#ifndef FFRT_API_C_SHARED_MUTEX_H +#define FFRT_API_C_SHARED_MUTEX_H + +#include "type_def.h" + +/** + * @brief Initializes a rwlock. + * + * @param rwlock Indicates a pointer to the rwlock. + * @param attr Indicates a pointer to the rwlock attribute. + * @return Returns ffrt_success if the rwlock is initialized; + returns ffrt_error_inval otherwise. + * @since 18 + */ +FFRT_C_API int ffrt_rwlock_init(ffrt_rwlock_t* rwlock, const ffrt_rwlockattr_t* attr); + +/** + * @brief Locks a write lock. + * + * @param rwlock Indicates a pointer to the rwlock. + * @return Returns ffrt_success if the rwlock is locked; + returns ffrt_error_inval or blocks the calling thread otherwise. + * @since 18 + */ +FFRT_C_API int ffrt_rwlock_wrlock(ffrt_rwlock_t* rwlock); + +/** + * @brief Attempts to lock a write lock. + * + * @param rwlock Indicates a pointer to the rwlock. + * @return Returns ffrt_success if the rwlock is locked; + returns ffrt_error_inval or ffrt_error_busy otherwise. + * @since 18 + */ +FFRT_C_API int ffrt_rwlock_trywrlock(ffrt_rwlock_t* rwlock); + +/** + * @brief Locks a read lock. + * + * @param rwlock Indicates a pointer to the rwlock. + * @return Returns ffrt_success if the rwlock is locked; + returns ffrt_error_inval or blocks the calling thread otherwise. + * @since 18 + */ +FFRT_C_API int ffrt_rwlock_rdlock(ffrt_rwlock_t* rwlock); + +/** + * @brief Attempts to lock a read lock. + * + * @param rwlock Indicates a pointer to the rwlock. + * @return Returns ffrt_success if the rwlock is locked; + returns ffrt_error_inval or ffrt_error_busy otherwise. + * @since 18 + */ +FFRT_C_API int ffrt_rwlock_tryrdlock(ffrt_rwlock_t* rwlock); + +/** + * @brief Unlocks a rwlock. + * + * @param rwlock Indicates a pointer to the rwlock. + * @return Returns ffrt_success if the rwlock is unlocked; + returns ffrt_error_inval otherwise. + * @since 18 + */ +FFRT_C_API int ffrt_rwlock_unlock(ffrt_rwlock_t* rwlock); + +/** + * @brief Destroys a rwlock. + * + * @param rwlock Indicates a pointer to the rwlock. + * @return Returns ffrt_success if the rwlock is destroyed; + returns ffrt_error_inval otherwise. + * @since 18 + */ +FFRT_C_API int ffrt_rwlock_destroy(ffrt_rwlock_t* rwlock); + +#endif // FFRT_API_C_SHARED_MUTEX_H +/** @} */ \ No newline at end of file diff --git a/resourceschedule/ffrt/c/sleep.h b/resourceschedule/ffrt/c/sleep.h index 025e54f65f08aa4404220fd8e66e6c8cbc789ed0..fc6a9f25be7f787ce8b6daebfc5e71debf839d3f 100644 --- a/resourceschedule/ffrt/c/sleep.h +++ b/resourceschedule/ffrt/c/sleep.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 10 - * @version 1.0 */ #ifndef FFRT_API_C_SLEEP_H @@ -47,7 +46,6 @@ * @return Returns ffrt_success if the thread is suspended; returns ffrt_error otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_usleep(uint64_t usec); @@ -55,7 +53,6 @@ FFRT_C_API int ffrt_usleep(uint64_t usec); * @brief Passes control to other tasks so that they can be executed. * * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_yield(void); diff --git a/resourceschedule/ffrt/c/task.h b/resourceschedule/ffrt/c/task.h index b8b4fa65346e5fc88e85f9b049de799923338652..86df988f37a52d679251f02a8acfc5c5335f9e20 100644 --- a/resourceschedule/ffrt/c/task.h +++ b/resourceschedule/ffrt/c/task.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 10 - * @version 1.0 */ #ifndef FFRT_API_C_TASK_H @@ -47,7 +46,6 @@ * @return Returns 0 if the task attribute is initialized; returns -1 otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_task_attr_init(ffrt_task_attr_t* attr); @@ -57,7 +55,6 @@ FFRT_C_API int ffrt_task_attr_init(ffrt_task_attr_t* attr); * @param attr Indicates a pointer to the task attribute. * @param name Indicates a pointer to the task name. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_task_attr_set_name(ffrt_task_attr_t* attr, const char* name); @@ -68,7 +65,6 @@ FFRT_C_API void ffrt_task_attr_set_name(ffrt_task_attr_t* attr, const char* name * @return Returns a non-null pointer to the task name if the name is obtained; returns a null pointer otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API const char* ffrt_task_attr_get_name(const ffrt_task_attr_t* attr); @@ -77,7 +73,6 @@ FFRT_C_API const char* ffrt_task_attr_get_name(const ffrt_task_attr_t* attr); * * @param attr Indicates a pointer to the task attribute. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_task_attr_destroy(ffrt_task_attr_t* attr); @@ -87,7 +82,6 @@ FFRT_C_API void ffrt_task_attr_destroy(ffrt_task_attr_t* attr); * @param attr Indicates a pointer to the task attribute. * @param qos Indicates the QoS. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_task_attr_set_qos(ffrt_task_attr_t* attr, ffrt_qos_t qos); @@ -97,7 +91,6 @@ FFRT_C_API void ffrt_task_attr_set_qos(ffrt_task_attr_t* attr, ffrt_qos_t qos); * @param attr Indicates a pointer to the task attribute. * @return Returns the QoS, which is ffrt_qos_default by default. * @since 10 - * @version 1.0 */ FFRT_C_API ffrt_qos_t ffrt_task_attr_get_qos(const ffrt_task_attr_t* attr); @@ -107,7 +100,6 @@ FFRT_C_API ffrt_qos_t ffrt_task_attr_get_qos(const ffrt_task_attr_t* attr); * @param attr Indicates a pointer to the task attribute. * @param delay_us Indicates the delay time, in microseconds. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_task_attr_set_delay(ffrt_task_attr_t* attr, uint64_t delay_us); @@ -117,7 +109,6 @@ FFRT_C_API void ffrt_task_attr_set_delay(ffrt_task_attr_t* attr, uint64_t delay_ * @param attr Indicates a pointer to the task attribute. * @return Returns the delay time. * @since 10 - * @version 1.0 */ FFRT_C_API uint64_t ffrt_task_attr_get_delay(const ffrt_task_attr_t* attr); @@ -127,7 +118,6 @@ FFRT_C_API uint64_t ffrt_task_attr_get_delay(const ffrt_task_attr_t* attr); * @param attr Indicates a pointer to the task attribute. * @param priority Indicates the execute priority of concurrent queue task. * @since 12 - * @version 1.0 */ FFRT_C_API void ffrt_task_attr_set_queue_priority(ffrt_task_attr_t* attr, ffrt_queue_priority_t priority); @@ -137,7 +127,6 @@ FFRT_C_API void ffrt_task_attr_set_queue_priority(ffrt_task_attr_t* attr, ffrt_q * @param attr Indicates a pointer to the task attribute. * @return Returns the priority of concurrent queue task. * @since 12 - * @version 1.0 */ FFRT_C_API ffrt_queue_priority_t ffrt_task_attr_get_queue_priority(const ffrt_task_attr_t* attr); @@ -147,7 +136,6 @@ FFRT_C_API ffrt_queue_priority_t ffrt_task_attr_get_queue_priority(const ffrt_ta * @param attr Indicates a pointer to the task attribute. * @param size Indicates the task stack size, unit is byte. * @since 12 - * @version 1.0 */ FFRT_C_API void ffrt_task_attr_set_stack_size(ffrt_task_attr_t* attr, uint64_t size); @@ -157,7 +145,6 @@ FFRT_C_API void ffrt_task_attr_set_stack_size(ffrt_task_attr_t* attr, uint64_t s * @param attr Indicates a pointer to the task attribute. * @return Returns the task stack size, unit is byte. * @since 12 - * @version 1.0 */ FFRT_C_API uint64_t ffrt_task_attr_get_stack_size(const ffrt_task_attr_t* attr); @@ -168,7 +155,6 @@ FFRT_C_API uint64_t ffrt_task_attr_get_stack_size(const ffrt_task_attr_t* attr); * @return Returns 0 if the QoS is updated; returns -1 otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API int ffrt_this_task_update_qos(ffrt_qos_t qos); @@ -177,7 +163,6 @@ FFRT_C_API int ffrt_this_task_update_qos(ffrt_qos_t qos); * * @return Returns the task qos. * @since 12 - * @version 1.0 */ FFRT_C_API ffrt_qos_t ffrt_this_task_get_qos(void); @@ -186,7 +171,6 @@ FFRT_C_API ffrt_qos_t ffrt_this_task_get_qos(void); * * @return Returns the task ID. * @since 10 - * @version 1.0 */ FFRT_C_API uint64_t ffrt_this_task_get_id(void); @@ -197,7 +181,6 @@ FFRT_C_API uint64_t ffrt_this_task_get_id(void); * @return Returns a non-null pointer if the memory is allocated; returns a null pointer otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API void *ffrt_alloc_auto_managed_function_storage_base(ffrt_function_kind_t kind); @@ -209,7 +192,6 @@ FFRT_C_API void *ffrt_alloc_auto_managed_function_storage_base(ffrt_function_kin * @param out_deps Indicates a pointer to the output dependencies. * @param attr Indicates a pointer to the task attribute. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_submit_base(ffrt_function_header_t* f, const ffrt_deps_t* in_deps, const ffrt_deps_t* out_deps, const ffrt_task_attr_t* attr); @@ -224,7 +206,6 @@ FFRT_C_API void ffrt_submit_base(ffrt_function_header_t* f, const ffrt_deps_t* i * @return Returns a non-null task handle if the task is submitted; returns a null pointer otherwise. * @since 10 - * @version 1.0 */ FFRT_C_API ffrt_task_handle_t ffrt_submit_h_base(ffrt_function_header_t* f, const ffrt_deps_t* in_deps, const ffrt_deps_t* out_deps, const ffrt_task_attr_t* attr); @@ -235,7 +216,6 @@ FFRT_C_API ffrt_task_handle_t ffrt_submit_h_base(ffrt_function_header_t* f, cons * @param handle Indicates a task handle. * @return Returns the task handle original reference count. * @since 12 - * @version 1.0 */ FFRT_C_API uint32_t ffrt_task_handle_inc_ref(ffrt_task_handle_t handle); @@ -245,7 +225,6 @@ FFRT_C_API uint32_t ffrt_task_handle_inc_ref(ffrt_task_handle_t handle); * @param handle Indicates a task handle. * @return Returns the task handle original reference count. * @since 12 - * @version 1.0 */ FFRT_C_API uint32_t ffrt_task_handle_dec_ref(ffrt_task_handle_t handle); @@ -254,7 +233,6 @@ FFRT_C_API uint32_t ffrt_task_handle_dec_ref(ffrt_task_handle_t handle); * * @param handle Indicates a task handle. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_task_handle_destroy(ffrt_task_handle_t handle); @@ -263,7 +241,6 @@ FFRT_C_API void ffrt_task_handle_destroy(ffrt_task_handle_t handle); * * @param deps Indicates a pointer to the dependent tasks. * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_wait_deps(const ffrt_deps_t* deps); @@ -271,7 +248,6 @@ FFRT_C_API void ffrt_wait_deps(const ffrt_deps_t* deps); * @brief Waits until all submitted tasks are complete. * * @since 10 - * @version 1.0 */ FFRT_C_API void ffrt_wait(void); diff --git a/resourceschedule/ffrt/c/timer.h b/resourceschedule/ffrt/c/timer.h index 9cbc4267fb6e68b6797a52849fa7d65fdaccd8e7..1f13a4dffe037407146f584764fd982215607b36 100644 --- a/resourceschedule/ffrt/c/timer.h +++ b/resourceschedule/ffrt/c/timer.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 12 - * @version 1.0 */ #ifndef FFRT_API_C_TIMER_H @@ -50,7 +49,6 @@ * @param repeat Indicates whether to repeat this timer. * @return Returns a timer handle. * @since 12 - * @version 1.0 */ FFRT_C_API ffrt_timer_t ffrt_timer_start(ffrt_qos_t qos, uint64_t timeout, void* data, ffrt_timer_cb cb, bool repeat); @@ -62,7 +60,6 @@ FFRT_C_API ffrt_timer_t ffrt_timer_start(ffrt_qos_t qos, uint64_t timeout, void* * @return Returns 0 if success; returns -1 otherwise. * @since 12 - * @version 1.0 */ FFRT_C_API int ffrt_timer_stop(ffrt_qos_t qos, ffrt_timer_t handle); diff --git a/resourceschedule/ffrt/c/type_def.h b/resourceschedule/ffrt/c/type_def.h index 0d1dfb8d1173ad1932065ca6a7afa027acdb87f8..7fc8c6ed9ffbcd36287417236ddc23ba43a4cf84 100644 --- a/resourceschedule/ffrt/c/type_def.h +++ b/resourceschedule/ffrt/c/type_def.h @@ -31,7 +31,6 @@ * @kit FunctionFlowRuntimeKit * @syscap SystemCapability.Resourceschedule.Ffrt.Core * @since 10 - * @version 1.0 */ #ifndef FFRT_API_C_TYPE_DEF_H @@ -124,6 +123,11 @@ typedef enum { ffrt_cond_storage_size = 64, /** Queue storage size. */ ffrt_queue_attr_storage_size = 128, + /** Rwlock storage size. + * + * @since 18 + */ + ffrt_rwlock_storage_size = 64, } ffrt_storage_size_t; /** @@ -241,6 +245,16 @@ typedef struct { long storage; } ffrt_mutexattr_t; +/** + * @brief Defines the rwlock attribute structure. + * + * @since 18 + */ +typedef struct { + /** A long integer used to store the rwlock attribute. */ + long storage; +} ffrt_rwlockattr_t; + /** * @brief Enumerates the mutex types. * @@ -268,6 +282,16 @@ typedef struct { uint32_t storage[(ffrt_mutex_storage_size + sizeof(uint32_t) - 1) / sizeof(uint32_t)]; } ffrt_mutex_t; +/** + * @brief Defines the rwlock structure. + * + * @since 18 + */ +typedef struct { + /** An array of uint32_t used to store the rwlock. */ + uint32_t storage[(ffrt_rwlock_storage_size + sizeof(uint32_t) - 1) / sizeof(uint32_t)]; +} ffrt_rwlock_t; + /** * @brief Defines the condition variable structure. * diff --git a/resourceschedule/ffrt/ffrt.ndk.json b/resourceschedule/ffrt/ffrt.ndk.json index e0e760ce774511ebb8f48602912019c3672e5e9b..c7936fab20fe9713be78107b96b23022c0dca895 100644 --- a/resourceschedule/ffrt/ffrt.ndk.json +++ b/resourceschedule/ffrt/ffrt.ndk.json @@ -26,6 +26,34 @@ { "name": "ffrt_mutex_unlock" }, { "name": "ffrt_mutex_trylock" }, { "name": "ffrt_mutex_destroy" }, + { + "first_introduced": "18", + "name": "ffrt_rwlock_init" + }, + { + "first_introduced": "18", + "name": "ffrt_rwlock_wrlock" + }, + { + "first_introduced": "18", + "name": "ffrt_rwlock_trywrlock" + }, + { + "first_introduced": "18", + "name": "ffrt_rwlock_rdlock" + }, + { + "first_introduced": "18", + "name": "ffrt_rwlock_tryrdlock" + }, + { + "first_introduced": "18", + "name": "ffrt_rwlock_unlock" + }, + { + "first_introduced": "18", + "name": "ffrt_rwlock_destroy" + }, { "name": "ffrt_queue_attr_init" }, { "name": "ffrt_queue_attr_destroy" }, { "name": "ffrt_queue_attr_set_qos" }, diff --git a/third_party/musl/ndk_script/toolchain.sh b/third_party/musl/ndk_script/toolchain.sh index 1bdc1baffa44181f65361af650ec98a8c9414a57..7f90ff69dfbb4c8cb752eb19a562d905fa4dce31 100755 --- a/third_party/musl/ndk_script/toolchain.sh +++ b/third_party/musl/ndk_script/toolchain.sh @@ -49,14 +49,4 @@ function strip_dir() { fi done } -function remove_unnecessary_file { - file_list=("bin/llvm-ifs" "bin/llvm-ifs.exe" "lib/clang/current" "lib/arm-liteos-ohos" "lib/loongarch64-linux-ohos" "lib/mipsel-linux-ohos" "lib/riscv64-linux-ohos" "lib/clang/15.0.4/bin/loongarch64-linux-ohos" "lib/clang/15.0.4/lib/arm-liteos-ohos" "lib/clang/15.0.4/lib/i386-unknown-linux-gnu" "lib/clang/15.0.4/lib/loongarch64-linux-ohos" "lib/clang/15.0.4/lib/mipsel-linux-ohos" "lib/clang/15.0.4/lib/riscv64-linux-ohos" "lib/clang/15.0.4/lib/windows") - - for i in "${file_list[@]}"; do - if [ -e "${OUT_DIR}/${i}" ]; then - rm -rf "${OUT_DIR}/${i}" - fi - done -} -remove_unnecessary_file strip_dir ${OUT_DIR}/lib