Editing README
This commit is contained in:
parent
bcae0ab456
commit
092a101d2d
1 changed files with 28 additions and 9 deletions
27
README.md
27
README.md
|
@ -1,15 +1,34 @@
|
||||||
# MixedMenu
|
# MixedMenu
|
||||||
Simple library for QML allowing the mixed use of Native Menus and QtQuick ones.
|
Simple library for QML allowing the mixed use of Native Menus and QtQuick ones.
|
||||||
|
---
|
||||||
|
It provides near drop-in replacements for QtQuick.Controls 2 menus making use of the platform native ones on supported platforms like MacOSX.
|
||||||
|
It can be used for MenuBars, as well as context menus.
|
||||||
|
|
||||||
It provides near drop-in replacements for QtQuick.Controls2 menus allowing to use the platform native ones on supported platforms like MacOSX.
|
# Switching from QtQuick.Controls 2
|
||||||
Only required change:
|
|
||||||
|
## Add MixedMenu as QML module
|
||||||
|
The first thing you need to do is to add MixedMenu to your QML Import Path.
|
||||||
|
To do so, follow these steps:
|
||||||
|
1. Go into a QML Import path directory in your project (or Qt's main QML import path).
|
||||||
|
2. Create an "eu" directory, within an "ad5001" directory should be created.
|
||||||
|
3. Go into the "ad5001" folder
|
||||||
|
4. Install MixedMenu there.
|
||||||
|
- If you're using Git as version control, you can use `git submodule add https://git.ad5001.eu/Ad5001/MixedMenu`.
|
||||||
|
- Otherwise, simply clone the repository using `git clone https://git.ad5001.eu/Ad5001/MixedMenu`.
|
||||||
|
- Or download the archive from [here](https://git.ad5001.eu/Ad5001/MixedMenu/archive/main.zip).
|
||||||
|
|
||||||
|
|
||||||
|
## Code changes
|
||||||
|
When switching from QtQuick.Controls 2 to MixedMenu, the following changes need to be made to your Menu code:
|
||||||
|
|
||||||
|QtQuick.Controls2/Qt.labs | > |eu.ad5001.MixedMenu |
|
|QtQuick.Controls2/Qt.labs | > |eu.ad5001.MixedMenu |
|
||||||
|-------------------------|---|--------------------------------------------------------|
|
|-------------------------------------|---|--------------------------------------------------------|
|
||||||
|
|`import import QtQuick.Controls 2.12`| > |`import eu.ad5001.MixedMenu 1.0` |
|
||||||
|`icon.name: ...` | > |`iconName: ...` |
|
|`icon.name: ...` | > |`iconName: ...` |
|
||||||
|`icon.source: ...` | > |`iconSource: ...` |
|
|`icon.source: ...` | > |`iconSource: ...` |
|
||||||
|`icon.color: ...` | > |`iconColor: ...` |
|
|`icon.color: ...` | > |`iconColor: ...` |
|
||||||
|`menuBar: MenuBar {}` | > |`MenuBar { id: appMenu }`<br>`menuBar: appMenu.trueItem`|
|
|`menuBar: MenuBar {}` | > |`MenuBar { id: appMenu }`<br>`menuBar: appMenu.trueItem`|
|
||||||
|
|
||||||
|
|
||||||
Requires Qt version >5.12
|
## Requirements
|
||||||
|
MixedMenu requires Qt version >5.12 with QML support enabled.
|
||||||
|
|
Loading…
Reference in a new issue