From 1d03b09622f13b70d0201118a36bc4318c0e04f0 Mon Sep 17 00:00:00 2001 From: Andy Shaw Date: Wed, 29 Nov 2017 13:37:57 +0100 Subject: Add documentation for the setValidatorForCustomPage() function Change-Id: Id2c52f8a7fa2abbd1ac9de49d597269cb9bed220 Reviewed-by: Leena Miettinen Reviewed-by: Katja Marttila --- src/libs/installer/packagemanagercore.cpp | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/libs/installer/packagemanagercore.cpp b/src/libs/installer/packagemanagercore.cpp index 7b6842720..07afb4c7b 100644 --- a/src/libs/installer/packagemanagercore.cpp +++ b/src/libs/installer/packagemanagercore.cpp @@ -1324,6 +1324,12 @@ bool PackageManagerCore::setDefaultPageVisible(int page, bool visible) Sets a validator for the custom page specified by \a name and \a callbackName for the component \a component. + When using this, \a name has to match a dynamic page starting with \c Dynamic. For example, if the page + is called DynamicReadyToInstallWidget, then \a name should be set to \c ReadyToInstallWidget. The + \a callbackName should be set to a function that returns a boolean. When the \c Next button is pressed + on the custom page, then it will call the \a callbackName function. If this returns \c true, then it will + move to the next page. + \sa {installer::setValidatorForCustomPage}{installer.setValidatorForCustomPage} \sa setValidatorForCustomPageRequested() */ -- cgit v1.2.3