Qt for HarmonyOS/qtohosextras doc/QOhosStartOptions Class
< Qt for HarmonyOS / qtohosextras doc
QOhosStartOptions Class
The QOhosStartOptions class is to provide new options for new started ability or process. More...
| Header: | #include <QOhosStartOptions> |
|---|---|
| qmake: | QT += ohosextras |
| Since: | Qt 5.12.12 |
Public Types
| class | QOhosWindowCreateParams |
| enum | ProcessMode { NEW_PROCESS_ATTACH_TO_PARENT, NEW_PROCESS_ATTACH_TO_STATUS_BAR_ITEM } |
| enum | StartupVisibility { STARTUP_HIDE, STARTUP_SHOW } |
| enum | SupportWindowMode { FULL_SCREEN, SPLIT, FLOATING } |
| enum | WindowMode { WINDOW_MODE_SPLIT_PRIMARY, WINDOW_MODE_SPLIT_SECONDARY, WINDOW_MODE_FULLSCREEN } |
Public Functions
| virtual | ~QOhosStartOptions() |
| virtual void | setDisplayId(int displayId) = 0 |
| virtual void | setHideStartWindow(bool hideStartWindow) = 0 |
| virtual void | setMaxWindowHeight(int maxWindowHeight) = 0 |
| virtual void | setMaxWindowWidth(int maxWindowWidth) = 0 |
| virtual void | setMinWindowHeight(int minWindowHeight) = 0 |
| virtual void | setMinWindowWidth(int minWindowWidth) = 0 |
| virtual void | setProcessMode(QtOhosExtras::QOhosStartOptions::ProcessMode processMode) = 0 |
| virtual void | setStartWindowBackgroundColor(const QColor &startWindowBackgroundColor) = 0 |
| virtual void | setStartWindowIcon(const QImage &startWindowIcon) = 0 |
| virtual void | setStartupVisibility(QtOhosExtras::QOhosStartOptions::StartupVisibility startupVisiblity) = 0 |
| virtual void | setSupportWindowModes(const QList<QtOhosExtras::QOhosStartOptions::SupportWindowMode> &supportWindowModes) = 0 |
| virtual void | setWindowCreateParams(const QtOhosExtras::QOhosStartOptions::QOhosWindowCreateParams &windowCreateParams) = 0 |
| virtual void | setWindowFocused(bool windowFocused) = 0 |
| virtual void | setWindowHeight(int windowHeight) = 0 |
| virtual void | setWindowLeft(int windowLeft) = 0 |
| virtual void | setWindowMode(QtOhosExtras::QOhosStartOptions::WindowMode windowMode) = 0 |
| virtual void | setWindowTop(int windowTop) = 0 |
| virtual void | setWindowWidth(int windowWidth) = 0 |
| virtual void | setWithAnimation(bool withAnimation) = 0 |
Static Public Members
| const QMetaObject | staticMetaObject |
Protected Functions
| QOhosStartOptions() |
Detailed Description
The QOhosStartOptions class is to provide new options for new started ability or process.
See also createStartOptions(), startAbility(), and startAppProcess().
Member Type Documentation
enum QOhosStartOptions::ProcessMode
Enumerates the process modes. See Process Mode.
| Constant | Value | Description |
|---|---|---|
| QtOhosExtras::QOhosStartOptions::NEW_PROCESS_ATTACH_TO_PARENT | 0 | A new process is created, the ability is started on the process, and the process exits along with the parent process. |
| QtOhosExtras::QOhosStartOptions::NEW_PROCESS_ATTACH_TO_STATUS_BAR_ITEM | 1 | A new process is created, the ability is started on the process, and the process is bound to the status bar icon. |
enum QOhosStartOptions::StartupVisibility
Enumerates the visibility statuses of an ability after it is started.
| Constant | Value | Description |
|---|---|---|
| QtOhosExtras::QOhosStartOptions::STARTUP_HIDE | 0 | The target ability is hidden after it is started in the new process. |
| QtOhosExtras::QOhosStartOptions::STARTUP_SHOW | 1 | The target ability is displayed normally after it is started in the new process. |
enum QOhosStartOptions::SupportWindowMode
Enumerates the supported window modes when the ability is started.
| Constant | Value | Description |
|---|---|---|
| QtOhosExtras::QOhosStartOptions::FULL_SCREEN | 0 | Indicates support for full screen mode. |
| QtOhosExtras::QOhosStartOptions::SPLIT | 1 | Indicates support for split mode. |
| QtOhosExtras::QOhosStartOptions::FLOATING | 2 | Indicates support for floating mode. |
enum QOhosStartOptions::WindowMode
Enumerates the window mode when the ability is started.
| Constant | Value | Description |
|---|---|---|
| QtOhosExtras::QOhosStartOptions::WINDOW_MODE_SPLIT_PRIMARY | 0 | Primary screen in split-screen mode. |
| QtOhosExtras::QOhosStartOptions::WINDOW_MODE_SPLIT_SECONDARY | 1 | Secondary screen in split-screen mode. |
| QtOhosExtras::QOhosStartOptions::WINDOW_MODE_FULLSCREEN | 2 | Full screen mode. |
Member Function Documentation
[protected] QOhosStartOptions::QOhosStartOptions()
Default constructs an instance of QOhosStartOptions.
[virtual] QOhosStartOptions::~QOhosStartOptions()
Destroys the instance of QOhosStartOptions.
[pure virtual] void QOhosStartOptions::setDisplayId(int displayId)
Sets displayId. The default value is 0, indicating the current display.
[pure virtual] void QOhosStartOptions::setHideStartWindow(bool hideStartWindow)
Controls whether to hide the start window when launching the current application's UIAbility.
[pure virtual] void QOhosStartOptions::setMaxWindowHeight(int maxWindowHeight)
Sets maxWindowHeight as the maximum height, in px.
[pure virtual] void QOhosStartOptions::setProcessMode(QtOhosExtras::QOhosStartOptions::ProcessMode processMode)
Sets processMode.
[pure virtual] void QOhosStartOptions::setWindowMode(QtOhosExtras::QOhosStartOptions::WindowMode windowMode)
Sets windowMode when the ability is started.