SimpleQmlNotify/README.md

116 lines
2.8 KiB
Markdown
Raw Normal View History

2019-11-19 13:28:02 +03:00
# SimpleQmlNotify
Simple Qml notification service for qml applications.
2019-11-19 15:20:38 +03:00
2020-03-30 15:56:56 +03:00
## Include
### For qmake projects
* cd yourRepo
* git submodule add https://github.com/QuasarApp/SimpleQmlNotify.git # add the repository of QSimpleQmlNotify into your repo like submodule
* git submodule update --init --recursive
* Include in your pro file the pri file of Qt-Secret library
2020-03-30 16:01:45 +03:00
``` qmake
include($$PWD/SimpleQmlNotify/QmlNotify.pri)
```
2020-03-30 15:56:56 +03:00
* Rebuild yuor project
### For cmake projects
#### The cmake build do not required Qt libraries.
* cd yourRepo
* git submodule add https://github.com/QuasarApp/SimpleQmlNotify.git # add the repository of QSimpleQmlNotify into your repo like submodule
* git submodule update --init --recursive
* Include in your CMakeLists.txt file the main CMakeLists.txt file of QSimpleQmlNotify library
2020-03-30 16:01:45 +03:00
``` cmake
include(QmlNotyfyService)
```
2020-03-30 15:56:56 +03:00
* Rebuild yuor project
2020-03-30 16:01:45 +03:00
2020-03-30 15:56:56 +03:00
### For other build system
* cd yourRepo
* git submodule add https://github.com/QuasarApp/SimpleQmlNotify.git # add the repository of QSimpleQmlNotify into your repo like submodule
* git submodule update --init --recursive
* Add the rule for build QmlNotyfyService
* Add INCLUDEPATH and LIBS for your build system
* Rebuild yuor project
## Using
### Notification
2019-11-19 15:20:38 +03:00
2021-04-16 10:05:32 +03:00
#### CPP
2019-11-19 15:20:38 +03:00
``` cpp
#include <qmlnotifyservice.h>
int main() {
QmlNotificationService::init();
auto service = QmlNotificationService::NotificationService::getService();
service->setNotify("title", "text", "UrlOfImage", NotificationData::Normal);
}
```
2021-04-16 10:05:32 +03:00
#### QML
2019-11-19 15:20:38 +03:00
``` qml
NotificationServiceView {
anchors.fill: parent;
}
```
### Questions
2021-04-16 10:05:32 +03:00
#### CPP
``` cpp
#include <qmlnotifyservice.h>
int main() {
QmlNotificationService::init();
auto service = QmlNotificationService::NotificationService::getService();
int questionCode = service->setQuestion("title", "some text");
QObject::connect(service, QmlNotificationService::NotificationService::questionCompleted,
[questionCode](bool accepted, int questionCode) {
if (accepted && code === questionCode) {
// your action here.
}
})
}
```
2021-04-16 10:05:32 +03:00
#### QML
``` qml
NotificationServiceView {
anchors.fill: parent;
}
readonly property int questionCode: 0;
questionCode = notificationService.setQuestion(qsTr("Remove %0 user").arg(userModel.userId),
qsTr("All saved data and records will be delete, Do you want continuee?"))
Connections {
target: notificationService
function onQuestionCompleted(accepted, code) {
if (accepted && code === privateRoot.questionCode) {
if (userModel)
backEnd.removeUser(userModel.userId)
}
}
}
```