summaryrefslogtreecommitdiffstats
path: root/doc/scripting-api
Commit message (Collapse)AuthorAgeFilesLines
* Fix readFile documentationKatja Marttila2017-12-041-1/+1
| | | | | | | | | readFile method returns string and not boolean. Fix it to documentation. Change-Id: I8454b423a01e93c747087de662e6795a72db26bd Reviewed-by: Karim Pinter <karim.pinter@qt.io> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Iikka Eklund <iikka.eklund@qt.io>
* Add clarifying documentation about QDesktopServices::openUrlAndy Shaw2017-11-131-0/+5
| | | | | | Change-Id: I2edca269b6f90511f4d41570a1ad08b7cc9d2f6a Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io> Reviewed-by: Niels Weber <niels.weber@qt.io>
* Merge remote-tracking branch 'origin/2.0'Katja Marttila2017-01-309-9/+9
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: Changelog dist/config/config.xml dist/packages/org.qtproject.ifw.binaries/meta/package.xml dist/packages/org.qtproject.ifw/meta/package.xml installerfw.pri src/libs/installer/lib7z_create.h src/libs/kdtools/kdgenericfactory.cpp src/libs/kdtools/kdgenericfactory.h src/libs/kdtools/kdupdaterapplication.cpp src/libs/kdtools/kdupdaterapplication.h src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp src/libs/kdtools/kdupdaterupdatesourcesinfo.h src/libs/kdtools/localpackagehub.cpp src/libs/kdtools/localpackagehub.h src/libs/kdtools/updatefinder.cpp src/libs/kdtools/updatefinder.h tools/binarycreator/resources/mkdmg.sh Change-Id: Iab2513f549832d2e750e77131c673457ab265af4
| * License header update to GPL-EXCEPTKatja Marttila2017-01-269-9/+9
| | | | | | | | | | Change-Id: I6426c4e8f932cf26c6c638dec18d0c12e22972d1 Reviewed-by: Janne Anttila <janne.anttila@theqtcompany.com>
* | Merge remote-tracking branch 'origin/2.0'Katja Marttila2016-06-211-0/+12
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: Changelog dist/config/config.xml dist/packages/org.qtproject.ifw.binaries/meta/package.xml dist/packages/org.qtproject.ifw/meta/package.xml installerfw.pri src/libs/7zip/7zip.pro src/libs/7zip/win/CPP/7zip/UI/Common/Update.cpp src/libs/installer/component.cpp src/libs/installer/lib7z_facade.cpp src/libs/installer/packagemanagercore.cpp src/libs/installer/proxycredentialsdialog.h src/sdk/translations/ja.ts tests/auto/installer/messageboxhandler/tst_messageboxhandler.cpp tests/auto/installer/scriptengine/tst_scriptengine.cpp tests/auto/installer/settings/tst_settings.cpp Change-Id: I3bb98b8490b3c3eb7f664c1abb7417155b5430b2
| * Revert "Use QQmlV4Function to correctly get empty parameters from script."Katja Marttila2016-02-171-0/+12
| | | | | | | | | | | | | | | | | | | | | | This reverts commit eb574d77b0ab9a92b61e7738d089cd4ea4304e51. The change will not work with Qt5.5 as it is causing constant crashes in Qt installers. Using this change will require a fix for Qt5. As we are about to make Qt installers based on 2.0 we need to revert this change for now. Change-Id: Ia7906d02db645f2407ab07d14f5a037224574b29 Reviewed-by: Andy Shaw <andy.shaw@theqtcompany.com>
* | Introduced gui.setTextItems() methodFrerich Raabe2016-06-151-0/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | This utility function can be used to populate a Qt control which is backed by some QAbstractItemModel with a list of strings. E.g. this can be used to populate a QComboBox or any QAbstractItemView with some items. This is very useful since in many cases, the methods for adding elements to such controls are neither slots, nor marked with Q_INVOKABLE and such unreachable from the script code. Change-Id: I2195f41e53765ef3a798477ed08d8f09ab5c4379 Reviewed-by: Katja Marttila <katja.marttila@qt.io>
* | Make communication via installer.execute() Unicode safeKarsten Heimrich2016-03-301-1/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | It was impossible to pass Unicode data safely to a process started via installer.execute(), or to read Unicode data printed by that process safely back in. The reason for this is that the code hardcoded the latin1 codec for converting between strings used in the script interpreter and bytes used by the QProcessWrapper API. Fix this by adding two new optional arguments to installer.execute() which can be used to define the codec to be used for writing to stdin resp. reading from stdout. This defaults to latin1 for backwards compatibility. Change-Id: I290d8d9617b286ef90b2f0a05c6e7a47f6df317f Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com> Reviewed-by: Frerich Raabe <raabe@froglogic.com>
* | Merge remote-tracking branch 'origin/2.0'Iikka Eklund2016-01-209-39/+27
|\| | | | | | | | | | | | | | | | | | | | | | | | | | | Conflicts: installerfw.pri src/libs/kdtools/kdgenericfactory.cpp src/libs/kdtools/kdgenericfactory.h src/libs/kdtools/kdupdaterapplication.cpp src/libs/kdtools/kdupdaterapplication.h src/libs/kdtools/kdupdaterupdatesourcesinfo.cpp src/libs/kdtools/kdupdaterupdatesourcesinfo.h sync.profile Change-Id: Ifdc8b065f89b7e241bd3788ed79768e21888161f
| * Update license headersIikka Eklund2015-12-299-27/+27
| | | | | | | | | | | | | | | | | | Update existing license headers. LGPL -> LGPLv21. Update copyright year as well. Change-Id: Ie1d71f8c68186b8f625f409ddf94691f178093c9 Reviewed-by: Katja Marttila <katja.marttila@theqtcompany.com> Reviewed-by: Jani Heikkinen <jani.heikkinen@theqtcompany.com>
| * Use QQmlV4Function to correctly get empty parameters from script.Karsten Heimrich2015-11-261-12/+0
| | | | | | | | | | | | | | | | | | By using QQmlV4Function to get the parameters, empty strings passed are correctly kept as empty and not null. Task-number: QTIFW-724 Change-Id: I592e2230e574ba82e765bd0079964db29452b2e9 Reviewed-by: Simon Hausmann <simon.hausmann@theqtcompany.com>
* | Implemented installer.readFile()Frerich Raabe2015-12-081-0/+11
| | | | | | | | | | | | | | | | | | | | | | For reading an external file using a specific encoding. This is convenient for having installers show the current configuration (e.g. effective license key) in case the configuration is stored in plain files as opposed to using e.g. the Windows registry. Change-Id: I87f8583b4cb192c4bd8b62a03f292a5cbefd52d8 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* | Document installer.components() restrictionsKai Koehne2015-08-201-2/+4
|/ | | | | | | | | | It's not obvious for the innocent user that components() are only available once the metadata has been fetched (i.e. not in a control script / component constructor). Change-Id: I033a78442d7e676a8aa662898a897af9e4d0ab65 Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* Doc: Clarify use of addOperationKai Koehne2015-05-291-9/+19
| | | | | | | | Make it explicit that addOperation , addElevatedOperation should be usually called from within createOperations(). Change-Id: Id14339b1259716825a9443cc563449025674976f Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Fix missing details output in example.Karsten Heimrich2015-05-271-1/+5
| | | | | | | | | | Commit 17e29fc8d3 introduced a behavior change, the installer.components is no longer a array property, it is now a function returning an array. Update docs. Change-Id: I4fcdee6cff4572012236e1ac0768013a1e5689ac Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Remove leftover. (signal and documentation)Karsten Heimrich2015-05-261-6/+0
| | | | | | | Change-Id: Ib735d8e7103ade0a9c31fa3d710542cafae3c8f2 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com> Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: add docs for PackageManagerCoreLeena Miettinen2015-05-261-0/+733
| | | | | | | | | | | Move the scripting API documentation to a separate qdoc file. Where possible (no QDoc errors are generated), only link from the C++ API documentation to the scripting API documentation. Change-Id: I969e9afc5cd45c495e6c517b825abb9a9aabdd82 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* Doc: link from C++ API ref to scripting API refLeena Miettinen2015-05-081-21/+30
| | | | | | | | Remove duplicated text where possible, and unify the text if it is needed in both files (by QDoc). Change-Id: If0c62a4a4abf6c1f61fd24f7947b9bc9bfb14f63 Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* Doc: add link to controller scripting topicLeena Miettinen2015-05-081-0/+2
| | | | | | Change-Id: I929ced36d59f52621785e44c7d93fd24f237d590 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* Doc: component.virtualStateChanged() signalLeena Miettinen2015-04-131-0/+6
| | | | | | | | Docs were missing from the scripting API docs. Change-Id: I941e387c4226fae2a4640605299d925b3101bf46 Task-number: QTIFW-655 Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* "Selected" property has gone.Jarek Kobus2015-04-101-6/+0
| | | | | | | Please see 5f6afc7d268dd16dd3f28d3579ae9517954a6553 Change-Id: I02a026c19d768b4d9c0c9f179d5738a121f46e99 Reviewed-by: Kai Koehne <kai.koehne@theqtcompany.com>
* Doc: move component scripting docs to a separate fileLeena Miettinen2015-03-091-0/+426
| | | | | | | | | Reformat the docs in the C++ file as C++ documentation. Fix language and style issues. Change-Id: Ifc2ac0a99700d8b2a2ca6835927cdfb0abd7ed2e Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Leena Miettinen <riitta-leena.miettinen@theqtcompany.com>
* Doc: add docs for print JavaScript objectLeena Miettinen2015-03-092-0/+5
| | | | | | Change-Id: I84d9987f3f6bfe6bf6788c89d4f5ab43c29655d5 Reviewed-by: Niels Weber <niels.weber@theqtcompany.com> Reviewed-by: Karsten Heimrich <karsten.heimrich@theqtcompany.com>
* Doc: add docs for the gui JavaScript objectLeena Miettinen2015-03-061-1/+36
| | | | | | | Text was copied from packagemanagergui.cpp. Change-Id: Idca8ce779bd5a3dbf5b3e7e4eca085c82973447e Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>
* Doc: move ScriptEngine scripting docs to separate filesLeena Miettinen2015-03-067-0/+535
Change-Id: Iac1c810cf52fb4a480ebde956d62830af97b6f8c Reviewed-by: Niels Weber <niels.weber@theqtcompany.com>