commit 2702242ae44e292fa653fff6dc317a80a1e6cf14 Author: Ad5001 Date: Sun Jul 11 18:56:36 2021 +0200 Initial commit diff --git a/Action.qml b/Action.qml new file mode 100644 index 0000000..c13fa23 --- /dev/null +++ b/Action.qml @@ -0,0 +1,73 @@ +/** + * MixedMenu - Simple library for QML allowing the mixed use of Native Menus and QtQuick ones. + * Copyright (C) 2021 Ad5001 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import QtQuick 2.12 +import QtQuick.Controls 2.12 as Controls +import Qt.labs.platform 1.1 as Native + +/*! + \qmltype Action + \inqmlmodule eu.ad5001.MixedMenu + \brief Platform specific Action. + + Either loading native menu or Qt's one. + +*/ +Item { + id: root + + signal triggered() + signal toggled() + + property bool useNative: Qt.platform.os == "osx" + property var trueItem: useNative ? nativeAction : controlsAction + + property alias checkable: controlsAction.checkable + property alias checked: controlsAction.checked + property alias enabled: controlsAction.enabled + property alias shortcut: controlsAction.shortcut + property alias text: controlsAction.text + property alias iconName: controlsAction.icon.name + property alias iconSource: controlsAction.icon.source + property alias iconColor: controlsAction.icon.color + + Native.MenuItem { + id: nativeAction + checkable: controlsAction.checkable + checked: controlsAction.checked + enabled: controlsAction.enabled + text: controlsAction.text + shortcut: controlsAction.shortcut + onTriggered: root.triggered() + } + + Controls.Action { + id: controlsAction + onTriggered: root.triggered() + onToggled: root.toggled() + } + + /*! + \qmlmethod void Action::toggle() + Toggles the \c checked state to its opposite state. + */ + function toggle(){ + root.trueItem.toggle() + } + +} diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Menu.qml b/Menu.qml new file mode 100644 index 0000000..eaedca9 --- /dev/null +++ b/Menu.qml @@ -0,0 +1,195 @@ +/** + * MixedMenu - Simple library for QML allowing the mixed use of Native Menus and QtQuick ones. + * Copyright (C) 2021 Ad5001 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import QtQuick 2.12 +import QtQuick.Controls 2.12 as Controls +import Qt.labs.platform 1.1 as Native + +/*! + \qmltype Menu + \inqmlmodule eu.ad5001.MixedMenu + \brief Platform specific Menu. + + Either loading native menu or Qt's one. + +*/ +Item { + id: root + + signal aboutToShow() + signal aboutToHide() + + property bool useNative: Qt.platform.os == "osx" + property var trueItem: useNative ? nativeMenu : controlsMenu + + property bool enabled: true + property string title: "" + property int count: 0 + property font font: root.trueItem.font + + Native.Menu { + id: nativeMenu + enabled: root.enabled + title: root.title + onAboutToShow: root.aboutToShow() + onAboutToHide: root.aboutToHide() + } + + Controls.Menu { + id: controlsMenu + enabled: root.enabled + title: root.title + onAboutToShow: root.aboutToShow() + onAboutToHide: root.aboutToHide() + } + + Component.onCompleted: { // Adding items to the menu + for(var i = 0; i < root.children.length; i++) { + var item = root.children[i] + if(item instanceof MenuSeparator || item instanceof MenuItem) { + addItem(item) + } else if(item instanceof Action) { + addAction(item) + } else if(item instanceof Menu) { + addMenu(item) + } + } + } + + /*! + \qmlmethod void Menu::addAction(Action action) + Adds an \a action to end of the menu. + */ + function addAction(action){ + if(root.useNative){ + nativeMenu.addItem(action.trueItem) // Is a MenuItem, Action being unavailable for Qt.labs + } else { + controlsMenu.addAction(action.trueItem) + } + root.count++ + } + + /*! + \qmlmethod void Menu::addItem(MenuItem item) + Adds an \a item to end of the menu. + */ + function addItem(item){ + root.trueItem.addItem(item.trueItem) + root.count++ + } + + /*! + \qmlmethod void Menu::addMenu(Menu submenu) + Adds a \a submenu to end of the menu. + */ + function addMenu(submenu){ + root.trueItem.addMenu(submenu.trueItem) + root.count++ + } + + /*! + \qmlmethod void Menu::insertAction(index, Action action) + Inserts an \a action at the specified \a index in the menu. + */ + function insertAction(index, action){ + if(root.useNative){ + nativeMenu.insertItem(index, action.trueItem) // Is a MenuItem, Action being unavailable for Qt.labs + } else { + controlsMenu.insertAction(index, action.trueItem) + } + root.count++ + } + + /*! + \qmlmethod void Menu::insertItem(index, MenuItem item) + Inserts an \a item at the specified \a index in the menu. + */ + function insertItem(index, item){ + root.trueItem.insertItem(index, item.trueItem) + root.count++ + } + + /*! + \qmlmethod void Menu::insertMenu(index, Menu submenu) + Inserts a \a submenu at the specified \a index in the menu. + */ + function insertMenu(index, submenu){ + root.trueItem.insertMenu(index, submenu.trueItem) + root.count++ + } + + /*! + \qmlmethod void Menu::removeAction(Action action) + Removes an \a action to from the menu. + */ + function removeAction(action){ + if(root.useNative){ + nativeMenu.removeItem(action.trueItem) // Is a MenuItem, Action being unavailable for Qt.labs + } else { + controlsMenu.removeAction(action.trueItem) + } + root.count-- + } + + /*! + \qmlmethod void Menu::removeMenu(MenuItem item) + Removes an \a item from the menu. + */ + function removeItem(item){ + root.trueItem.removeItem(submenu.item) + root.count-- + } + + /*! + \qmlmethod void Menu::removeMenu(Menu submenu) + Removes a \a submenu from the menu. + */ + function removeMenu(submenu){ + root.trueItem.removeMenu(submenu.trueItem) + root.count-- + } + + /*! + \qmlmethod void Menu::clear() + Removes all items from the menu. + */ + function clear(){ + root.trueItem.clear() + root.count = 0 + } + + /*! + \qmlmethod void Menu::close() + Closes the menu. + */ + function close(){ + root.trueItem.close() + } + + /*! + \qmlmethod void Menu::open() + Opens the menu at the mouse's position + */ + function open(){ + if(root.useNative){ + nativeMenu.open() + } else { + controlsMenu.popup() + } + } +} diff --git a/MenuBar.qml b/MenuBar.qml new file mode 100644 index 0000000..690326f --- /dev/null +++ b/MenuBar.qml @@ -0,0 +1,85 @@ +/** + * MixedMenu - Simple library for QML allowing the mixed use of Native Menus and QtQuick ones. + * Copyright (C) 2021 Ad5001 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import QtQuick 2.12 +import QtQuick.Controls 2.12 as Controls +import Qt.labs.platform 1.1 as Native + +/*! + \qmltype MenuBar + \inqmlmodule eu.ad5001.MixedMenu + \brief Platform specific MenuBar. + + Either loading native menu or Qt's one. + +*/ +Item { + id: root + + property bool useNative: Qt.platform.os == "osx" + property var trueItem: useNative ? nativeMenuBar : controlsMenuBar + + Native.MenuBar { + id: nativeMenuBar + } + + Controls.MenuBar { + id: controlsMenuBar + } + + Component.onCompleted: { // Adding items to the menu + for(var i = 0; i < root.children.length; i++) { + var item = root.children[i] + if(item instanceof Menu) { + addMenu(item) + } + } + } + + /*! + \qmlmethod void MenuBar::addMenu(Menu menu) + Adds a \a menu to end of the menubar. + */ + function addMenu(menu){ + root.trueItem.addMenu(menu.trueItem) + } + + /*! + \qmlmethod void MenuBar::insertMenu(index, Menu menu) + Inserts a \a menu at the specified \a index in the menubar. + */ + function insertMenu(index, menu){ + root.trueItem.insertMenu(index, menu.trueItem) + } + + /*! + \qmlmethod void MenuBar::removeMenu(Menu menu) + Removes a \a menu from the menubar. + */ + function removeMenu(menu){ + root.trueItem.removeMenu(menu.trueItem) + } + + /*! + \qmlmethod void MenuBar::clear() + Removes all menus from the menubar. + */ + function clear(){ + root.trueItem.clear() + } +} diff --git a/MenuItem.qml b/MenuItem.qml new file mode 100644 index 0000000..bd74dac --- /dev/null +++ b/MenuItem.qml @@ -0,0 +1,77 @@ +/** + * MixedMenu - Simple library for QML allowing the mixed use of Native Menus and QtQuick ones. + * Copyright (C) 2021 Ad5001 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import QtQuick 2.12 +import QtQml 2.12 +import QtQuick.Controls 2.12 as Controls +import Qt.labs.platform 1.1 as Native + +/*! + \qmltype MenuItem + \inqmlmodule eu.ad5001.MixedMenu + \brief Platform specific MenuItem. + + Either loading native menu or Qt's one. + +*/ +Item { + id: root + + signal triggered() + + property bool useNative: Qt.platform.os == "osx" + property var trueItem: useNative ? nativeMenuItem : controlsMenuItem + + property bool checkable: false + property bool checked: false + property bool enabled: true + property font font: trueItem.font + property string text: "" + property alias iconName: controlsMenuItem.icon.name + property alias iconSource: controlsMenuItem.icon.source + property alias iconColor: controlsMenuItem.icon.color + + Native.MenuItem { + id: nativeMenuItem + checkable: root.checkable + checked: root.checked + enabled: root.enabled + text: root.text + visible: root.visible && root.useNative + onTriggered: root.triggered() + } + + Controls.MenuItem { + id: controlsMenuItem + checkable: root.checkable + checked: root.checked + enabled: root.enabled + text: root.text + visible: root.visible && !root.useNative + height: visible ? implicitHeight : 0 + onTriggered: root.triggered() + } + + /*! + \qmlmethod void MenuItem::toggle() + Toggles the \c checked state to its opposite state. + */ + function toggle(){ + root.trueItem.toggle() + } +} diff --git a/MenuSeparator.qml b/MenuSeparator.qml new file mode 100644 index 0000000..6e928f0 --- /dev/null +++ b/MenuSeparator.qml @@ -0,0 +1,45 @@ +/** + * MixedMenu - Simple library for QML allowing the mixed use of Native Menus and QtQuick ones. + * Copyright (C) 2021 Ad5001 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +import QtQuick 2.12 +import QtQuick.Controls 2.12 as Controls +import Qt.labs.platform 1.1 as Native + +/*! + \qmltype MenuSeparator + \inqmlmodule eu.ad5001.MixedMenu + \brief Platform specific MenuBar. + + Either loads Qt's emulated one or the native one. +*/ +Item { + id: root + + property bool useNative: Qt.platform.os == "osx" + property var trueItem: useNative ? nativeSeparator : controlsSeparator + + Native.MenuSeparator { + id: nativeSeparator + visible: root.visible && root.useNative + } + + Controls.MenuSeparator { + id: controlsSeparator + visible: root.visible && !root.useNative + } +} diff --git a/README.md b/README.md new file mode 100644 index 0000000..ee3dc3f --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +# MixedMenu +Simple library for QML allowing the mixed use of Native Menus and QtQuick ones. + +It provides near drop-in replacements for QtQuick.Controls2 menus allowing to use the platform native ones on supported platforms like MacOSX. +Only required change: + +|QtQuick.Controls2/Qt.labs| > |eu.ad5001.MixedMenu| +|-------------------------|---|-------------------| +|`icon.name: ...` | > |`iconName: ...` | +|`icon.source: ...` | > |`iconSource: ...` | +|`icon.color: ...` | > |`iconColor: ...` | + + +Requires Qt version >5.12 diff --git a/eu.ad5001.mixedmenu.qdoc b/eu.ad5001.mixedmenu.qdoc new file mode 100644 index 0000000..81aaf90 --- /dev/null +++ b/eu.ad5001.mixedmenu.qdoc @@ -0,0 +1,27 @@ +/** + * MixedMenu - Simple library for QML allowing the mixed use of Native Menus and QtQuick ones. + * Copyright (C) 2021 Ad5001 + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ + +/*! + \qmlmodule eu.ad5001.MixedMenu 1.0 + \title MixedMenu QML Module + \brief Provides a near drop-in replacements for QtQuick.Controls menus allowing to use the platform native ones on supported platforms. + + It's recommended to use this module when making custom menus like context menus. +*/ + + diff --git a/qmldir b/qmldir new file mode 100644 index 0000000..b4c6254 --- /dev/null +++ b/qmldir @@ -0,0 +1,6 @@ +module eu.ad5001.MixedMenu +MenuBar 1.0 MenuBar.qml +MenuItem 1.0 MenuItem.qml +Action 1.0 Action.qml +Menu 1.0 Menu.qml +MenuSeparator 1.0 MenuSeparator.qml