Jump to content

Qt for HarmonyOS/qtohosextras doc/ShareKit Namespace: Difference between revisions

From Qt Wiki
VisualWikitext
Created page with "<!-- Source: qtohosextras-sharekit.html --> <span id="sharekit-namespace"></span> = ShareKit Namespace = <span class="small-subtitle">(QtOhosExtras::ShareKit)<br /> </span> The ShareKit to expose Share Kit API. More... <div class="table"> {| class="wikitable alignedsummary" |- | class="memItemLeft rightAlign topAlign"| Header: | class="memIte..."
 
Update from qdoc output (QTFOROH-2307)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
<!-- Source: qtohosextras-sharekit.html -->
< [[Qt_for_HarmonyOS/qtohosextras_doc|Qt for HarmonyOS / qtohosextras doc]]
<span id="sharekit-namespace"></span>
 
= ShareKit Namespace =
= ShareKit Namespace =


<span class="small-subtitle">([[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace|QtOhosExtras::ShareKit]])<br />
QtOhosExtras::ShareKit
</span>


The [[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace|ShareKit]] to expose Share Kit API. [[#details|More...]]
The ShareKit to expose Share Kit API. [[#details|More...]]


<div class="table">
{| class="wikitable"
 
{| class="wikitable alignedsummary"
|-
|-
| class="memItemLeft rightAlign topAlign"| Header:
| Header:
| class="memItemRight bottomAlign"| <span class="preprocessor">#include </span>
| #include <ShareKit>
|-
|-
| class="memItemLeft rightAlign topAlign"| qmake:
| qmake:
| class="memItemRight bottomAlign"| QT += ohosextras
| QT += ohosextras
|-
|-
| class="memItemLeft rightAlign topAlign"| Since:
| Since:
| class="memItemRight bottomAlign"| Qt 5.12.12
| Qt 5.12.12
|}
|}


This namespace was introduced in Qt 5.12.12.


</div>
<span id="classes"></span>
<span id="classes"></span>
== Classes ==
== Classes ==


<div class="table">
{| class="wikitable"
 
|-
{| class="wikitable alignedsummary"
| class
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class|QOhosShareControllerOptions]]'''
|-
|-
| class="memItemLeft rightAlign topAlign"| class
| class
| class="memItemRight bottomAlign"| '''[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class|QOhosShareControllerOptions]]'''
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareOperationResult_Class|QOhosShareOperationResult]]'''
|-
|-
| class="memItemLeft rightAlign topAlign"| class
| class
| class="memItemRight bottomAlign"| '''[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]]'''
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]]'''
|}
|}


</div>
<span id="types"></span>
<span id="types"></span>
== Types ==
== Types ==


<div class="table">
{| class="wikitable"
 
{| class="wikitable alignedsummary"
|-
|-
| class="memItemLeft rightAlign topAlign"| enum
| enum class
| class="memItemRight bottomAlign"| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#ShareAbilityType-enum|ShareAbilityType]]''' { CopyToPasteboard, SaveToMediaAsset, SaveAsFile, Print, SaveToSuperHub }
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#ShareAbilityType-enum|ShareAbilityType]]''' { CopyToPasteboard, SaveToMediaAsset, SaveAsFile, Print, SaveToSuperHub }
|}
|}


</div>
<span id="functions"></span>
<span id="functions"></span>
== Functions ==
== Functions ==


<div class="table">
{| class="wikitable"
 
{| class="wikitable alignedsummary"
|-
|-
| class="memItemLeft rightAlign topAlign"| QSharedPointer
| QSharedPointer<QOhosSharedRecord>
| class="memItemRight bottomAlign"| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createContentRecord|createContentRecord]]'''(const QMimeType &amp;''mimeType'', const QString &amp;''content'')
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createContentRecord|createContentRecord]]'''(const QMimeType &''mimeType'', const QString &''content'')
|-
|-
| class="memItemLeft rightAlign topAlign"| QSharedPointer
| QSharedPointer<QOhosShareControllerOptions>
| class="memItemRight bottomAlign"| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createControllerOptions|createControllerOptions]]'''()
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createControllerOptions|createControllerOptions]]'''()
|-
|-
| class="memItemLeft rightAlign topAlign"| QSharedPointer
| QSharedPointer<QOhosSharedRecord>
| class="memItemRight bottomAlign"| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createFileRecord|createFileRecord]]'''(const QFileInfo &amp;''fileInfo'')
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createFileRecord|createFileRecord]]'''(const QFileInfo &''fileInfo'')
|-
|-
| class="memItemLeft rightAlign topAlign"| QSharedPointer
| QSharedPointer<QOhosSharedRecord>
| class="memItemRight bottomAlign"| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createUrlRecord|createUrlRecord]]'''(const QUrl &amp;''url'')
| '''[[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createUrlRecord|createUrlRecord]]'''(const QUrl &''url'')
|}
|}


</div>
<span id="details"></span>
<div class="descr">
<span id="details"></span>
== Detailed Description ==
== Detailed Description ==


The [[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace|ShareKit]] to expose Share Kit API.
</div>
<div class="classes">
<span id="classes-1"></span>
== Classes ==
== Classes ==


<span id="class-qohossharecontrolleroptions"></span>
=== class [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class|QOhosShareControllerOptions]] ===
=== class [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class|QOhosShareControllerOptions]] ===


The [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class|QOhosShareControllerOptions]] class is to configure items, such as the preview mode of the shared content, selection mode, and other information, and pop-up window anchor. It determines the display style of the sharing panel. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section107934816010 ShareControllerOptions]. [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class#details|More...]]
The QOhosShareControllerOptions class is to configure items, such as the preview mode of the shared content, selection mode, and other information, and pop-up window anchor. It determines the display style of the sharing panel. [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class#details|More...]]


<span id="class-qohossharedrecord"></span>
=== class [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareOperationResult_Class|QOhosShareOperationResult]] ===
=== class [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]] ===


The [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]] class represents a record to be shared with other application. A record can be created using. [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class#details|More...]]
ShareOperationResult wraps Ohos [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section17135118312 ShareOperationResult] interface. [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareOperationResult_Class#details|More...]]


===  class [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]] ===


</div>
The QOhosSharedRecord class represents a record to be shared with other application. [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class#details|More...]]
<div class="types">


<span id="type-documentation"></span>
== Type Documentation ==
== Type Documentation ==


<span id="ShareAbilityType-enum"></span>
=== <span id="ShareAbilityType-enum"></span>enum class ShareKit::ShareAbilityType ===
=== <span id="ShareAbilityType-enum"></span>enum ShareKit::<span class="name">ShareAbilityType</span> ===


Enumerates system sharing abilities shown on the sharing panel. Used with [[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class#setExcludedAbilities|QOhosShareControllerOptions::setExcludedAbilities]]() to hide selected abilities from the panel. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#shareabilitytype ShareAbilityType].
{| class="wikitable"
|-
! Constant
! Value
! Description
|-
| <code>QtOhosExtras::ShareKit::ShareAbilityType::CopyToPasteboard</code>
| <code>0</code>
| Copy the shared content to the pasteboard.
|-
| <code>QtOhosExtras::ShareKit::ShareAbilityType::SaveToMediaAsset</code>
| <code>1</code>
| Save the shared content to the Gallery.
|-
| <code>QtOhosExtras::ShareKit::ShareAbilityType::SaveAsFile</code>
| <code>2</code>
| Save the shared content as a file.
|-
| <code>QtOhosExtras::ShareKit::ShareAbilityType::Print</code>
| <code>3</code>
| Print the shared content.
|-
| <code>QtOhosExtras::ShareKit::ShareAbilityType::SaveToSuperHub</code>
| <code>4</code>
| Save the shared content to SuperHub.
|}


</div>
This enum was introduced or modified in Qt 5.12.12.
<div class="func">


<span id="function-documentation"></span>
== Function Documentation ==
== Function Documentation ==


<span id="createContentRecord"></span>
=== <span id="createContentRecord"></span>[https://doc.qt.io/qt-5/qsharedpointer.html QSharedPointer]<[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]]> ShareKit::createContentRecord(const [https://doc.qt.io/qt-5/qmimetype.html QMimeType] &''mimeType'', const [https://doc.qt.io/qt-5/qstring.html QString] &''content'') ===
=== createContentRecord ===
 
<syntaxhighlight lang="cpp">
QSharedPointer<QtOhosExtras::ShareKit::QOhosSharedRecord>
ShareKit::createContentRecord(const QMimeType &mimeType, const QString &content)
</syntaxhighlight>


Creates a shared &quot;content&quot; record with a given ''mimeType'' and ''content''. Shared record can be created with content (this function) or as a file shared record
Creates a shared "content" record with a given ''mimeType'' and ''content''. Shared record can be created with content (this function) or as a file shared record, see [[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createFileRecord|createFileRecord]](). See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.content]


See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.content]
=== <span id="createControllerOptions"></span>[https://doc.qt.io/qt-5/qsharedpointer.html QSharedPointer]<[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosShareControllerOptions_Class|QOhosShareControllerOptions]]> ShareKit::createControllerOptions() ===
 
'''See also''' QtOhosExtras::ShareKit::createFileRecord() and ..
 
<span id="createControllerOptions"></span>
=== createControllerOptions ===
 
<syntaxhighlight lang="cpp">
QSharedPointer<QtOhosExtras::ShareKit::QOhosShareControllerOptions>
ShareKit::createControllerOptions()
</syntaxhighlight>


Creates a controller options instnace. Controller options can be used to configure preview mode, selection mode and pop-up window anchor. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section107934816010 ShareControllerOptions]
Creates a controller options instnace. Controller options can be used to configure preview mode, selection mode and pop-up window anchor. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section107934816010 ShareControllerOptions]


<span id="createFileRecord"></span>
=== <span id="createFileRecord"></span>[https://doc.qt.io/qt-5/qsharedpointer.html QSharedPointer]<[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]]> ShareKit::createFileRecord(const [https://doc.qt.io/qt-5/qfileinfo.html QFileInfo] &''fileInfo'') ===
=== createFileRecord ===


<syntaxhighlight lang="cpp">
Creates a shared "file" record with a given ''fileInfo''. Shared record can be created with file (this function) or as a content record, see [[Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace#createContentRecord|createContentRecord]](). See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.uri]
QSharedPointer<QtOhosExtras::ShareKit::QOhosSharedRecord>
ShareKit::createFileRecord(const QFileInfo &fileInfo)
</syntaxhighlight>


Creates a shared &quot;file&quot; record with a given ''fileInfo''. Shared record can be created with file (this function) or as a content record
=== <span id="createUrlRecord"></span>[https://doc.qt.io/qt-5/qsharedpointer.html QSharedPointer]<[[Qt_for_HarmonyOS/qtohosextras_doc/QOhosSharedRecord_Class|QOhosSharedRecord]]> ShareKit::createUrlRecord(const [https://doc.qt.io/qt-5/qurl.html QUrl] &''url'') ===
 
See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.uri]
 
'''See also''' QtOhosExtras::ShareKit::createContentRecord() and ..
 
<span id="createUrlRecord"></span>
=== createUrlRecord ===
 
<syntaxhighlight lang="cpp">
QSharedPointer<QtOhosExtras::ShareKit::QOhosSharedRecord>
ShareKit::createUrlRecord(const QUrl &url)
</syntaxhighlight>


Creates a shared record with a given ''url''. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.content]
Creates a shared record with a given ''url''. See [https://developer.huawei.com/consumer/en/doc/harmonyos-references/share-system-share#section20696483813 SharedRecord.content]


 
[[Category:Qt for HarmonyOS]]
</div>

Latest revision as of 08:38, 16 September 2026

< Qt for HarmonyOS / qtohosextras doc

ShareKit Namespace

QtOhosExtras::ShareKit

The ShareKit to expose Share Kit API. More...

Header: #include <ShareKit>
qmake: QT += ohosextras
Since: Qt 5.12.12

This namespace was introduced in Qt 5.12.12.

Classes

class QOhosShareControllerOptions
class QOhosShareOperationResult
class QOhosSharedRecord

Types

enum class ShareAbilityType { CopyToPasteboard, SaveToMediaAsset, SaveAsFile, Print, SaveToSuperHub }

Functions

QSharedPointer<QOhosSharedRecord> createContentRecord(const QMimeType &mimeType, const QString &content)
QSharedPointer<QOhosShareControllerOptions> createControllerOptions()
QSharedPointer<QOhosSharedRecord> createFileRecord(const QFileInfo &fileInfo)
QSharedPointer<QOhosSharedRecord> createUrlRecord(const QUrl &url)

Detailed Description

Classes

class QOhosShareControllerOptions

The QOhosShareControllerOptions class is to configure items, such as the preview mode of the shared content, selection mode, and other information, and pop-up window anchor. It determines the display style of the sharing panel. More...

class QOhosShareOperationResult

ShareOperationResult wraps Ohos ShareOperationResult interface. More...

class QOhosSharedRecord

The QOhosSharedRecord class represents a record to be shared with other application. More...

Type Documentation

enum class ShareKit::ShareAbilityType

Enumerates system sharing abilities shown on the sharing panel. Used with QOhosShareControllerOptions::setExcludedAbilities() to hide selected abilities from the panel. See ShareAbilityType.

Constant Value Description
QtOhosExtras::ShareKit::ShareAbilityType::CopyToPasteboard 0 Copy the shared content to the pasteboard.
QtOhosExtras::ShareKit::ShareAbilityType::SaveToMediaAsset 1 Save the shared content to the Gallery.
QtOhosExtras::ShareKit::ShareAbilityType::SaveAsFile 2 Save the shared content as a file.
QtOhosExtras::ShareKit::ShareAbilityType::Print 3 Print the shared content.
QtOhosExtras::ShareKit::ShareAbilityType::SaveToSuperHub 4 Save the shared content to SuperHub.

This enum was introduced or modified in Qt 5.12.12.

Function Documentation

QSharedPointer<QOhosSharedRecord> ShareKit::createContentRecord(const QMimeType &mimeType, const QString &content)

Creates a shared "content" record with a given mimeType and content. Shared record can be created with content (this function) or as a file shared record, see createFileRecord(). See SharedRecord.content

QSharedPointer<QOhosShareControllerOptions> ShareKit::createControllerOptions()

Creates a controller options instnace. Controller options can be used to configure preview mode, selection mode and pop-up window anchor. See ShareControllerOptions

QSharedPointer<QOhosSharedRecord> ShareKit::createFileRecord(const QFileInfo &fileInfo)

Creates a shared "file" record with a given fileInfo. Shared record can be created with file (this function) or as a content record, see createContentRecord(). See SharedRecord.uri

QSharedPointer<QOhosSharedRecord> ShareKit::createUrlRecord(const QUrl &url)

Creates a shared record with a given url. See SharedRecord.content

Retrieved from "https://wiki.qt.io/index.php?title=Qt_for_HarmonyOS/qtohosextras_doc/ShareKit_Namespace&oldid=46384"