Debian Codegraph @

documentation/qml/pages/mainpage.qdoc

raw
1 /*!
2 \page index.html overview
3 \title Lomiri Action API
4
5 \contentspage {Lomiri Action API} {Contents}
6
7 \part Introduction
8
9 Lomiri Action API offers a way to easily integrate with the Lomiri components outside of the application such as the Launcher, HUD, AppMenu and MessagingMenu.
10
11 Applications have internally different types of actions with different life-cycles. Some actions are application wide that are relevant and
12 available throughout the whole life-cycle of the application. Other actions are context specific and only available when the application is in
13 certain visual state, such as in image editing mode. See \l {Action Contexts} for more details.
14
15 Application can define application wide actions dynamically during runtime and as offline (jumplist) actions that are available even if the
16 application is not running. Activating an offline action will launch the application when necessary.
17
18 Lomiri Action API can be used with three ways:
19 \list
20 \li - using the Qt C++ API (see the C++ documentation)
21 \li - Using this QML API directly
22 \li - Using the UI Toolkit
23 \endlist
24
25 UI Toolkit simplifies the ActionContext management and provides ActionManager as part of the MainView. See the UI Toolkit documentation for
26 more details.
27
28
29 \part General Topics
30 \list
31 \li \l {Action Contexts}
32 \li \l {Preview Actions}
33 \li \l {Platform Integration}
34 \li \l {Offline Actions}
35 \endlist
36
37 \part Reporting Bugs
38 If you find any problems with the or this documentation,
39 please file a bug in Lomiri Action API \l {https://bugs.launchpad.net/lomiri-action-api} {Launchpad page}
40
41 \part Components
42 Available through:
43 \code
44 import Lomiri.Action 1.0
45 \endcode
46
47 \part Base Items
48 \annotatedlist action-base
49
50 \part Paramaters
51 \annotatedlist action-parameters
52
53 \part Non-Instantiable
54 \annotatedlist action-non-instantiable
55
56 */