ohos_pasteboard_sys/pasteboard/
pasteboard_ffi.rs

1// automatically generated by rust-bindgen 0.71.1
2
3#![allow(non_upper_case_globals)]
4#![allow(non_camel_case_types)]
5#![allow(non_snake_case)]
6use ohos_sys_opaque_types::OH_UdmfData;
7
8#[cfg(feature = "api-13")]
9#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
10impl Pasteboard_NotifyType {
11    /// Change of the Pasteboard data in the local device.
12    pub const LOCAL_DATA_CHANGE: Pasteboard_NotifyType = Pasteboard_NotifyType(1);
13    /// Change of the Pasteboard data in the remote devices.
14    pub const REMOTE_DATA_CHANGE: Pasteboard_NotifyType = Pasteboard_NotifyType(2);
15}
16#[repr(transparent)]
17/// Enumerates the types of data changes that can be observed.
18///
19///
20/// Available since API-level: 13
21#[cfg(feature = "api-13")]
22#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
23#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
24pub struct Pasteboard_NotifyType(pub ::core::ffi::c_uint);
25#[cfg(feature = "api-15")]
26#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
27impl Pasteboard_FileConflictOptions {
28    /// Overwrite when destUir has file with same name.
29    pub const PASTEBOARD_OVERWRITE: Pasteboard_FileConflictOptions =
30        Pasteboard_FileConflictOptions(0);
31    /// Skip when destUir has file with same name.
32    pub const PASTEBOARD_SKIP: Pasteboard_FileConflictOptions = Pasteboard_FileConflictOptions(1);
33}
34#[repr(transparent)]
35/// Enumerates the types of file confilct options when getting data from the Pastedboard.
36///
37///
38/// Available since API-level: 15
39#[cfg(feature = "api-15")]
40#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
41#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
42pub struct Pasteboard_FileConflictOptions(pub ::core::ffi::c_uint);
43#[cfg(feature = "api-15")]
44#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
45impl Pasteboard_ProgressIndicator {
46    /// Getting data without system default progress indicator.
47    pub const PASTEBOARD_NONE: Pasteboard_ProgressIndicator = Pasteboard_ProgressIndicator(0);
48    /// Getting data with system default progress indicator.
49    pub const PASTEBOARD_DEFAULT: Pasteboard_ProgressIndicator = Pasteboard_ProgressIndicator(1);
50}
51#[repr(transparent)]
52/// Enumerates the types of progress indicator when getting data from the Pastedboard.
53///
54///
55/// Available since API-level: 15
56#[cfg(feature = "api-15")]
57#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
58#[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
59pub struct Pasteboard_ProgressIndicator(pub ::core::ffi::c_uint);
60/// Represents the Pasteboard progress information.
61///
62///
63/// Available since API-level: 15
64#[cfg(feature = "api-15")]
65#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
66#[repr(C)]
67pub struct Pasteboard_ProgressInfo {
68    _unused: [u8; 0],
69}
70/// Defines the callback function used to return the progress information when getting PasteData.
71///
72/// # Arguments
73///
74/// * `progressInfo` - The progress information notified to Application.
75///
76/// Available since API-level: 15
77#[cfg(feature = "api-15")]
78#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
79pub type OH_Pasteboard_ProgressListener =
80    ::core::option::Option<unsafe extern "C" fn(progressInfo: *mut Pasteboard_ProgressInfo)>;
81/// Represents the pasteboard get data parameters when getting data from Pasteboard.
82///
83///
84/// Available since API-level: 15
85#[cfg(feature = "api-15")]
86#[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
87#[repr(C)]
88pub struct Pasteboard_GetDataParams {
89    _unused: [u8; 0],
90}
91/// Defines the callback function used to return the Pasteboard data changed.
92///
93/// # Arguments
94///
95/// * `context` - The context set by [`OH_PasteboardObserver_SetData`] function.
96///
97/// * `type` - The types of data changes. For details, see [`Pasteboard_NotifyType`].
98///
99/// Available since API-level: 13
100#[cfg(feature = "api-13")]
101#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
102pub type Pasteboard_Notify = ::core::option::Option<
103    unsafe extern "C" fn(context: *mut ::core::ffi::c_void, type_: Pasteboard_NotifyType),
104>;
105/// Defines the callback function used free the context.
106/// # Arguments
107///
108/// * `context` - Pointer to the context which is to be free.
109///
110/// Available since API-level: 13
111#[cfg(feature = "api-13")]
112#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
113pub type Pasteboard_Finalize =
114    ::core::option::Option<unsafe extern "C" fn(context: *mut ::core::ffi::c_void)>;
115/// Defines the Pasteboard subscriber information
116///
117///
118/// Available since API-level: 13
119#[cfg(feature = "api-13")]
120#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
121#[repr(C)]
122pub struct OH_PasteboardObserver {
123    _unused: [u8; 0],
124}
125/// Represents the Pasteboard information.
126///
127///
128/// Available since API-level: 13
129#[cfg(feature = "api-13")]
130#[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
131#[repr(C)]
132pub struct OH_Pasteboard {
133    _unused: [u8; 0],
134}
135extern "C" {
136    /// Creates a [`OH_PasteboardObserver`] instance.
137    ///
138    ///
139    /// # Returns
140    ///
141    /// * Returns the pointer to the [`OH_PasteboardObserver`] instance created if the operation is successful.
142    /// Returns nullptr if the operation is failed.
143    /// [`OH_PasteboardObserver.`]
144    /// Available since API-level: 13
145    #[cfg(feature = "api-13")]
146    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
147    pub fn OH_PasteboardObserver_Create() -> *mut OH_PasteboardObserver;
148    /// Destroy a [`OH_PasteboardObserver`] instance.
149    ///
150    /// # Arguments
151    ///
152    /// * `observer` - Pointer to the [`OH_PasteboardObserver`] instance to destroy.
153    ///
154    /// # Returns
155    ///
156    /// * Returns the status code of the execution. For details, see [`PASTEBOARD_ErrCode`].
157    /// Returns [`ERR_OK`] if the operation is successful.
158    /// Returns [`ERR_INVALID_PARAMETER`] if invalid args are detected.
159    /// [`OH_PasteboardObserver`] PASTEBOARD_ErrCode.
160    ///
161    /// Available since API-level: 13
162    #[cfg(feature = "api-13")]
163    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
164    pub fn OH_PasteboardObserver_Destroy(
165        observer: *mut OH_PasteboardObserver,
166    ) -> ::core::ffi::c_int;
167    /// Sets a callback function to return the Pasteboard data changed.
168    ///
169    /// # Arguments
170    ///
171    /// * `observer` - Pointer to the [`OH_PasteboardObserver`] instance.
172    ///
173    /// * `context` - Pointer to the context set, which is the first parameter in Pasteboard_Notify.
174    ///
175    /// * `callback` - Callback to set. For details, see [`Pasteboard_Notify`].
176    ///
177    /// * `finalize` - Optional callback that can free context when destroy observer.
178    /// For details, see [`Pasteboard_Finalize`].
179    ///
180    /// # Returns
181    ///
182    /// * Returns the status code of the execution. For details, see [`PASTEBOARD_ErrCode`].
183    /// Returns [`ERR_OK`] if the operation is successful.
184    /// Returns [`ERR_INVALID_PARAMETER`] if invalid args are detected.
185    /// [`OH_PasteboardObserver`] Pasteboard_Notify PASTEBOARD_ErrCode.
186    ///
187    /// Available since API-level: 13
188    #[cfg(feature = "api-13")]
189    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
190    pub fn OH_PasteboardObserver_SetData(
191        observer: *mut OH_PasteboardObserver,
192        context: *mut ::core::ffi::c_void,
193        callback: Pasteboard_Notify,
194        finalize: Pasteboard_Finalize,
195    ) -> ::core::ffi::c_int;
196    /// Creates a [`OH_Pasteboard`] instance.
197    ///
198    ///
199    /// # Returns
200    ///
201    /// * Returns the pointer to the [`OH_Pasteboard`] instance created if the operation is successful.
202    /// Returns nullptr if the memory is not enough.
203    /// [`OH_Pasteboard.`]
204    /// Available since API-level: 13
205    #[cfg(feature = "api-13")]
206    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
207    pub fn OH_Pasteboard_Create() -> *mut OH_Pasteboard;
208    /// Destroy a [`OH_Pasteboard`] instance.
209    ///
210    /// # Arguments
211    ///
212    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance to destroy.
213    /// [`OH_Pasteboard.`]
214    /// Available since API-level: 13
215    #[cfg(feature = "api-13")]
216    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
217    pub fn OH_Pasteboard_Destroy(pasteboard: *mut OH_Pasteboard);
218    /// Subscribes to the Pasteboard data change.
219    ///
220    /// # Arguments
221    ///
222    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
223    ///
224    /// * `type` - Event type to subscribe to report the pasteboard data change.
225    /// For details, see [`Pasteboard_NotifyType`].
226    ///
227    /// * `observer` - - Pointer to the observer information, which specifies the callback used to
228    /// reporting the pasteboard data change. For details, see [`OH_PasteboardObserver`].
229    ///
230    /// # Returns
231    ///
232    /// * Returns the status code of the execution. For details, [`PASTEBOARD_ErrCode`].
233    /// Returns [`ERR_OK`] if the operation is successful.
234    /// Returns [`ERR_INVALID_PARAMETER`] if invalid args are detected.
235    /// [`OH_Pasteboard`] OH_PasteboardObserver Pasteboard_NotifyType PASTEBOARD_ErrCode.
236    ///
237    /// Available since API-level: 13
238    #[cfg(feature = "api-13")]
239    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
240    pub fn OH_Pasteboard_Subscribe(
241        pasteboard: *mut OH_Pasteboard,
242        type_: ::core::ffi::c_int,
243        observer: *const OH_PasteboardObserver,
244    ) -> ::core::ffi::c_int;
245    /// Unsubscribes from the Pasteboard data change.
246    ///
247    /// # Arguments
248    ///
249    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
250    ///
251    /// * `type` - Event type to subscribe to report the pasteboard data change.
252    /// For details, see [`Pasteboard_NotifyType`].
253    ///
254    /// * `observer` - - Pointer to the observer information, which specifies the callback used to
255    /// reporting the pasteboard data change. For details, see [`OH_PasteboardObserver`].
256    ///
257    /// # Returns
258    ///
259    /// * Returns the status code of the execution. For details, [`PASTEBOARD_ErrCode`].
260    /// Returns [`ERR_OK`] if the operation is successful.
261    /// Returns [`ERR_INVALID_PARAMETER`] if invalid args are detected.
262    /// [`OH_Pasteboard`] OH_PasteboardObserver Pasteboard_NotifyType PASTEBOARD_ErrCode.
263    ///
264    /// Available since API-level: 13
265    #[cfg(feature = "api-13")]
266    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
267    pub fn OH_Pasteboard_Unsubscribe(
268        pasteboard: *mut OH_Pasteboard,
269        type_: ::core::ffi::c_int,
270        observer: *const OH_PasteboardObserver,
271    ) -> ::core::ffi::c_int;
272    /// Checks whether the Pasteboard data is from a remote device.
273    ///
274    /// # Arguments
275    ///
276    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
277    ///
278    /// # Returns
279    ///
280    /// * Returns a boolean value, which indicates whether the the data is from a remote device.
281    /// The value `false` means Pasteboard data is not from a remote device.
282    /// The value `true` means the opposite.
283    /// [`OH_Pasteboard.`]
284    /// Available since API-level: 13
285    #[cfg(feature = "api-13")]
286    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
287    pub fn OH_Pasteboard_IsRemoteData(pasteboard: *mut OH_Pasteboard) -> bool;
288    /// Obtains the source of Pasteboard data.
289    ///
290    /// # Arguments
291    ///
292    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
293    ///
294    /// * `source` - Pointer to the source data.
295    ///
296    /// * `len` - Length of the source data.
297    ///
298    /// # Returns
299    ///
300    /// * Returns the status code of the execution. For details, see [`PASTEBOARD_ErrCode`].
301    /// Returns [`ERR_OK`] if the operation is successful.
302    /// Returns [`ERR_INVALID_PARAMETER`] if invalid args are detected.
303    /// [`OH_Pasteboard`] PASTEBOARD_ErrCode.
304    ///
305    /// Available since API-level: 13
306    #[cfg(feature = "api-13")]
307    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
308    pub fn OH_Pasteboard_GetDataSource(
309        pasteboard: *mut OH_Pasteboard,
310        source: *mut ::core::ffi::c_char,
311        len: ::core::ffi::c_uint,
312    ) -> ::core::ffi::c_int;
313    /// Checks whether the Pasteboard has the specified type of data.
314    ///
315    /// # Arguments
316    ///
317    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
318    ///
319    /// * `type` - Poniter to the type of data to check.
320    ///
321    /// # Returns
322    ///
323    /// * Returns a boolean value, which indicates whether the Pasteboard has the specified type of data.
324    /// The value `true` means the Pasteboard has the specified type of data.
325    /// The value `false` means the opposite.
326    /// [`OH_Pasteboard.`]
327    /// Available since API-level: 13
328    #[cfg(feature = "api-13")]
329    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
330    pub fn OH_Pasteboard_HasType(
331        pasteboard: *mut OH_Pasteboard,
332        type_: *const ::core::ffi::c_char,
333    ) -> bool;
334    /// Checks whether there is data in the Pasteboard.
335    ///
336    /// # Arguments
337    ///
338    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
339    ///
340    /// # Returns
341    ///
342    /// * Returns a boolean value, which indicates whether there is data in the Pasteboard.
343    /// The value `true` means there is data in Pasteboard.
344    /// The value `false` means the opposite.
345    /// [`OH_Pasteboard.`]
346    /// Available since API-level: 13
347    #[cfg(feature = "api-13")]
348    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
349    pub fn OH_Pasteboard_HasData(pasteboard: *mut OH_Pasteboard) -> bool;
350    /// Obtains data from the Pasteboard.
351    ///
352    /// # Arguments
353    ///
354    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
355    ///
356    /// * `status` - The status code of the execution. For details, see [`PASTEBOARD_ErrCode`].
357    ///
358    /// # Returns
359    ///
360    /// * Returns the pointer to the [`OH_UdmfData`] instance.
361    /// [`OH_Pasteboard`] OH_UdmfData PASTEBOARD_ErrCode.
362    ///
363    /// Available since API-level: 13
364    #[cfg(feature = "api-13")]
365    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
366    pub fn OH_Pasteboard_GetData(
367        pasteboard: *mut OH_Pasteboard,
368        status: *mut ::core::ffi::c_int,
369    ) -> *mut OH_UdmfData;
370    /// Writes data to the Pasteboard.
371    ///
372    /// # Arguments
373    ///
374    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
375    ///
376    /// * `data` - Pointer to the [`OH_UdmfData`] instance.
377    ///
378    /// # Returns
379    ///
380    /// * Returns the status code of the execution. For details, see [`PASTEBOARD_ErrCode`].
381    /// Returns [`ERR_OK`] if the operation is successful.
382    /// Returns [`ERR_INVALID_PARAMETER`] if invalid args are detected.
383    /// [`OH_Pasteboard`] OH_UdmfData PASTEBOARD_ErrCode.
384    ///
385    /// Available since API-level: 13
386    #[cfg(feature = "api-13")]
387    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
388    pub fn OH_Pasteboard_SetData(
389        pasteboard: *mut OH_Pasteboard,
390        data: *mut OH_UdmfData,
391    ) -> ::core::ffi::c_int;
392    /// Clears the data in the Pastedboard.
393    ///
394    /// # Arguments
395    ///
396    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
397    ///
398    /// # Returns
399    ///
400    /// * Returns the status code of the execution. For details, see [`PASTEBOARD_ErrCode`].
401    /// Returns [`ERR_OK`] if the operation is successful.
402    /// Returns [`ERR_INVALID_PARAMETER`] if invalid args are detected.
403    /// [`OH_Pasteboard`] PASTEBOARD_ErrCode.
404    ///
405    /// Available since API-level: 13
406    #[cfg(feature = "api-13")]
407    #[cfg_attr(docsrs, doc(cfg(feature = "api-13")))]
408    pub fn OH_Pasteboard_ClearData(pasteboard: *mut OH_Pasteboard) -> ::core::ffi::c_int;
409    /// Obtains all MIME types of Pasteboard data.
410    ///
411    /// # Arguments
412    ///
413    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
414    ///
415    /// * `count` - Poniter to the count of MIME types.
416    ///
417    /// # Returns
418    ///
419    /// * Returns char array of MIME types in the Pasteboard.
420    /// Returns nullptr if the operation is failed.
421    /// [`OH_Pasteboard.`]
422    /// Available since API-level: 14
423    #[cfg(feature = "api-14")]
424    #[cfg_attr(docsrs, doc(cfg(feature = "api-14")))]
425    pub fn OH_Pasteboard_GetMimeTypes(
426        pasteboard: *mut OH_Pasteboard,
427        count: *mut ::core::ffi::c_uint,
428    ) -> *mut *mut ::core::ffi::c_char;
429    /// Gets the number of Pasteboard data changes.
430    ///
431    /// # Arguments
432    ///
433    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
434    ///
435    /// # Returns
436    ///
437    /// * the number of Pasteboard data changes.
438    /// Returns 0 means initial value or invalid value.In this case, no action is required.
439    ///
440    /// Available since API-level: 18
441    #[cfg(feature = "api-18")]
442    #[cfg_attr(docsrs, doc(cfg(feature = "api-18")))]
443    pub fn OH_Pasteboard_GetChangeCount(pasteboard: *mut OH_Pasteboard) -> u32;
444    /// Create a pointer to the instance of the [`Pasteboard_GetDataParams`].
445    ///
446    ///
447    /// # Returns
448    ///
449    /// * If the operation is successful, a pointer to the instance of the [`Pasteboard_GetDataParams`]
450    /// structure is returned. If the operation is failed, nullptr is returned.
451    /// [`Pasteboard_GetDataParams.`]
452    /// Available since API-level: 15
453    #[cfg(feature = "api-15")]
454    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
455    pub fn OH_Pasteboard_GetDataParams_Create() -> *mut Pasteboard_GetDataParams;
456    /// Destroy a pointer that points to an instance of [`Pasteboard_GetDataParams`].
457    ///
458    /// # Arguments
459    ///
460    /// * `params` - Represents a pointer to an instance of [`Pasteboard_GetDataParams`].
461    /// [`Pasteboard_GetDataParams.`]
462    /// Available since API-level: 15
463    #[cfg(feature = "api-15")]
464    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
465    pub fn OH_Pasteboard_GetDataParams_Destroy(params: *mut Pasteboard_GetDataParams);
466    /// Set the progress indicator to the [`Pasteboard_GetDataParams`].
467    ///
468    /// # Arguments
469    ///
470    /// * `params` - Represents a pointer to an instance of [`Pasteboard_GetDataParams`].
471    ///
472    /// * `progressIndicator` - Represents to the progress indicator.
473    /// [`Pasteboard_GetDataParams`] Pasteboard_ProgressIndicator.
474    ///
475    /// Available since API-level: 15
476    #[cfg(feature = "api-15")]
477    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
478    pub fn OH_Pasteboard_GetDataParams_SetProgressIndicator(
479        params: *mut Pasteboard_GetDataParams,
480        progressIndicator: Pasteboard_ProgressIndicator,
481    );
482    /// Set the destination uri to the [`Pasteboard_GetDataParams`].
483    ///
484    /// # Arguments
485    ///
486    /// * `params` - Represents a pointer to an instance of [`Pasteboard_GetDataParams`].
487    ///
488    /// * `destUri` - Pointer to a destination uri.
489    ///
490    /// * `destUriLen` - Indicates the length of destination uri.
491    /// [`Pasteboard_GetDataParams.`]
492    /// Available since API-level: 15
493    #[cfg(feature = "api-15")]
494    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
495    pub fn OH_Pasteboard_GetDataParams_SetDestUri(
496        params: *mut Pasteboard_GetDataParams,
497        destUri: *const ::core::ffi::c_char,
498        destUriLen: u32,
499    );
500    /// Set the file conflict options to the [`Pasteboard_GetDataParams`].
501    ///
502    /// # Arguments
503    ///
504    /// * `params` - Represents a pointer to an instance of [`Pasteboard_GetDataParams`].
505    ///
506    /// * `option` - Represents to the file conflict options.
507    /// [`Pasteboard_GetDataParams`] Pasteboard_FileConflictOptions.
508    ///
509    /// Available since API-level: 15
510    #[cfg(feature = "api-15")]
511    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
512    pub fn OH_Pasteboard_GetDataParams_SetFileConflictOptions(
513        params: *mut Pasteboard_GetDataParams,
514        option: Pasteboard_FileConflictOptions,
515    );
516    /// Set the progress indicator to the [`Pasteboard_GetDataParams`].
517    ///
518    /// # Arguments
519    ///
520    /// * `params` - Represents a pointer to an instance of [`Pasteboard_GetDataParams`].
521    ///
522    /// * `listener` - Represents to the data progress listener.
523    /// [`Pasteboard_GetDataParams`] OH_Pasteboard_ProgressListener.
524    ///
525    /// Available since API-level: 15
526    #[cfg(feature = "api-15")]
527    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
528    pub fn OH_Pasteboard_GetDataParams_SetProgressListener(
529        params: *mut Pasteboard_GetDataParams,
530        listener: OH_Pasteboard_ProgressListener,
531    );
532    /// Get the progress from the [`Pasteboard_ProgressInfo`].
533    ///
534    /// # Arguments
535    ///
536    /// * `progressInfo` - Represents a pointer to an instance of [`Pasteboard_ProgressInfo`].
537    ///
538    /// # Returns
539    ///
540    /// * Returns the progress.
541    /// [`Pasteboard_ProgressInfo.`]
542    /// Available since API-level: 15
543    #[cfg(feature = "api-15")]
544    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
545    pub fn OH_Pasteboard_ProgressInfo_GetProgress(
546        progressInfo: *mut Pasteboard_ProgressInfo,
547    ) -> ::core::ffi::c_int;
548    /// Defines the cancel function used to cancel the progress when getting PasteData.
549    ///
550    /// # Arguments
551    ///
552    /// * `params` - Pointer to indicates the [`Pasteboard_GetDataParams`].
553    /// [`Pasteboard_GetDataParams.`]
554    /// Available since API-level: 15
555    #[cfg(feature = "api-15")]
556    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
557    pub fn OH_Pasteboard_ProgressCancel(params: *mut Pasteboard_GetDataParams);
558    /// Obtains data from the Pasteboard with system progress indicator.
559    ///
560    /// ohos.permission.READ_PASTEBOARD
561    /// # Arguments
562    ///
563    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
564    ///
565    /// * `params` - Pointer to indicates the [`OH_Pasteboard_GetDataParams`].
566    ///
567    /// * `status` - The status code of the execution. For details, see [`PASTEBOARD_Errcode`].
568    ///
569    /// # Returns
570    ///
571    /// * Returns the pointer to the [`OH_PasteData`] instance.
572    /// [`OH_Pasteboard`] OH_PasteData PASTEBOARD_ErrCode.
573    ///
574    /// Available since API-level: 15
575    #[cfg(feature = "api-15")]
576    #[cfg_attr(docsrs, doc(cfg(feature = "api-15")))]
577    pub fn OH_Pasteboard_GetDataWithProgress(
578        pasteboard: *mut OH_Pasteboard,
579        params: *mut Pasteboard_GetDataParams,
580        status: *mut ::core::ffi::c_int,
581    ) -> *mut OH_UdmfData;
582    /// Notifies the system pasteboard to synchronize all time-lapse paste data from application.
583    ///
584    /// # Arguments
585    ///
586    /// * `pasteboard` - Pointer to the [`OH_Pasteboard`] instance.
587    ///
588    /// * `callback` - Indicates the pointer to the callback that is called after the synchronize is finished.
589    ///
590    /// Available since API-level: 21
591    #[cfg(feature = "api-21")]
592    #[cfg_attr(docsrs, doc(cfg(feature = "api-21")))]
593    pub fn OH_Pasteboard_SyncDelayedDataAsync(
594        pasteboard: *mut OH_Pasteboard,
595        callback: ::core::option::Option<unsafe extern "C" fn(errorCode: ::core::ffi::c_int)>,
596    );
597}
ohos_pasteboard_sys/pasteboard/pasteboard_ffi.rs

ohos_pasteboard_sys/pasteboard/
pasteboard_ffi.rs
