diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/config/ifw.qdocconf | 3 | ||||
| -rw-r--r-- | doc/installerfw.qdoc | 36 | ||||
| -rw-r--r-- | doc/operations.qdoc | 4 | ||||
| -rw-r--r-- | doc/scripting-api/gui.qdoc | 7 | ||||
| -rw-r--r-- | doc/scripting-api/packagemanagercore.qdoc | 26 | ||||
| -rw-r--r-- | doc/scripting.qdoc | 68 |
6 files changed, 132 insertions, 12 deletions
diff --git a/doc/config/ifw.qdocconf b/doc/config/ifw.qdocconf index 3d9b1d7d4..870245eb2 100644 --- a/doc/config/ifw.qdocconf +++ b/doc/config/ifw.qdocconf @@ -8,8 +8,7 @@ project = "Qt Installer Framework" description = "Qt Installer Framework Manual" url = http://qt-project.org/doc/qtinstallerframework/ -sourcedirs += includes -sourcedirs += ../../src/libs/installer ../../src/libs/kdtools +sourcedirs += ../../src/libs/installer ../../src/libs/kdtools ../includes headerdirs += ../../src/libs/installer ../../src/libs/kdtools imagedirs = $SRCDIR/images $SRCDIR/templates/images diff --git a/doc/installerfw.qdoc b/doc/installerfw.qdoc index 43ef0afe4..7a667f912 100644 --- a/doc/installerfw.qdoc +++ b/doc/installerfw.qdoc @@ -217,13 +217,18 @@ \li WizardStyle \li Set the wizard style to be used ("Modern", "Mac", "Aero" or "Classic"). \row + \li StyleSheet + \li Set the stylesheet file. + \row \li WizardDefaultWidth \li Sets the default width of the wizard in pixels. Setting a banner image will - override this. + override this. You can add the \c em or \c ex suffix to the specified value to + use the \e em or \e ex unit, as in a CSS file. \row \li WizardDefaultHeight \li Sets the default height of the wizard in pixels. Setting a watermark image will - override this. + override this. You can add the \c em or \c ex suffix to the specified value to + use the \e em or \e ex unit, as in a CSS file. \row \li TitleColor \li Set the color of the titles and subtitles (takes an HTML color code, @@ -277,6 +282,10 @@ \li Set to \c true if the installation path can contain non-ASCII characters. \row + \li DisableAuthorizationFallback + \li Set to \c true if the installation should not ask users to run the authorization + fallback in case of authorization errors. Instead abort the installation immediately. + \row \li RepositorySettingsPageVisible \li Set to \c false to hide the repository settings page inside the settings dialog. \row @@ -307,6 +316,11 @@ \li Set to \c true if you want to create a local repository inside the installation directory. This option has no effect on online installers. The repository will be automatically added to the list of default repositories. + \row + \li InstallActionColumnVisible + \li Set to \c true if you want to add an extra column into component tree showing install actions. + This extra column indicates whether a component is going to be installed or uninstalled, + or just stay installed or uninstalled. \endtable @@ -543,11 +557,12 @@ \row \li DisplayName \li Human-readable name of the component. Required. + Specify translations for the name of the component as values of additional + DisplayName tags, with the xml:lang attribute set to the correct locale. \row \li Description \li Human-readable description of the component. Required. - Specify translations for the description as values of additional - Description tags, with the xml:lang attribute set to the correct locale. + Translations may be specified similarly to DisplayName tag. If a localization that matches the locale is not found and an untranslated version exists, that one will be used. Otherwise no Description will be shown for that locale. @@ -603,6 +618,8 @@ \li List of license agreements to be accepted by the installing user. To add several licenses, add several \c <License> child elements that each specify the license \c name and \c file. + ASCII and UTF8 file formats are supported for license files. + If there are translations listed for this component, the installer will also look for translated licenses. These need to have the same name as the original license file but with an added @@ -667,6 +684,12 @@ \li RequiresAdminRights \li Set to \c true if the package needs to be installed with elevated permissions. Optional. + \row + \li Checkable + \li Set to \c false if you want to hide the checkbox for an item. This is useful + when only a few subcomponents should be selected instead of all. Optional. + \note The content from the data directory is not installed if \c Checkable + is \c false unless \c ForcedInstallation is set to \c true. \endtable \section2 Component Dependencies @@ -830,6 +853,11 @@ \row \li -v or --verbose \li Display debug output. + + \row + \li -s or --sign identity + \li Only available on OS X. Allows specifying a code signing identity to be + used for signing the generated app bundle. \endtable These parameters are followed by the name of the target binary and a list diff --git a/doc/operations.qdoc b/doc/operations.qdoc index 99330698a..9e3ad7ee9 100644 --- a/doc/operations.qdoc +++ b/doc/operations.qdoc @@ -122,7 +122,9 @@ \li Creates a shortcut from the file specified by \c filename to \c linkname. On Windows, this creates a .lnk file which can have - \c arguments. On Unix, this creates a symbolic link. + \c arguments. Furthermore, on Windows, \c filename can be + an HTTP or FTP URL in which case a URL shortcut is created. + On Unix, this creates a symbolic link. \row \li CreateDesktopEntry \li "CreateDesktopEntry" \c {filename "key=value[ key2=value2[ key3=value3]]]"} diff --git a/doc/scripting-api/gui.qdoc b/doc/scripting-api/gui.qdoc index 5883fb50c..4a669a769 100644 --- a/doc/scripting-api/gui.qdoc +++ b/doc/scripting-api/gui.qdoc @@ -168,3 +168,10 @@ /*! \qmlmethod void gui::setModified(boolean value) */ + +/*! + \qmlmethod void gui::setTextItems(object control, string[] items) + + Updates the model of \a control (which must be a QComboBox or QAbstractItemView) + such that it contains the given \a items. +*/ diff --git a/doc/scripting-api/packagemanagercore.qdoc b/doc/scripting-api/packagemanagercore.qdoc index 53e1fbf9c..66441fce5 100644 --- a/doc/scripting-api/packagemanagercore.qdoc +++ b/doc/scripting-api/packagemanagercore.qdoc @@ -35,9 +35,11 @@ /*! \qmlmethod array installer::components() - Returns an array of all available components. + Returns an array of all components currently available. + If the repository metadata have not been fetched yet, + the array will be empty. - \sa component + \sa component, installer::finishAllComponentsReset(), installer::finishUpdaterComponentsReset() */ /*! @@ -332,6 +334,17 @@ */ /*! + \qmlmethod boolean installer::readFile(string filePath, string codecName) + + Returns the contents of the file \a filePath using the encoding specified + by \a codecName. The file is read in the text mode, that is, end-of-line + terminators are translated to the local encoding. + + \note If the file does not exist or an error occurs while reading the file, an + empty string is returned. +*/ + +/*! \qmlmethod boolean installer::fileExists(string filePath) Returns \c true if the \a filePath exists; otherwise returns \c false. @@ -492,13 +505,20 @@ /*! \qmlmethod array installer::execute(string program, stringlist arguments = undefined, - string stdin = "") + string stdin = "", string stdinCodec = "latin1", + string stdoutCodec = "latin1") Starts the program \a program with the arguments \a arguments in a new process and waits for it to finish. \a stdin is sent as standard input to the application. + \a stdInCodec is the name of the codec to use for converting the input string + into bytes to write to the standard input of the application. + + \a stdOutCodec is the name of the codec to use for converting data written by the + application to standard output into a string. + Returns an empty array if the program could not be executed, otherwise the output of command as the first item, and the return code as the second. diff --git a/doc/scripting.qdoc b/doc/scripting.qdoc index 69c9ec5a2..a6cb2526a 100644 --- a/doc/scripting.qdoc +++ b/doc/scripting.qdoc @@ -138,7 +138,7 @@ methods that you must implement: \code - #include <KDUpdater/UpdateOperation> + #include <UpdateOperation> class CustomOperation : public KDUpdater::UpdateOperation { @@ -205,7 +205,7 @@ Finally, you need to register your custom operation class, as follows: \code - #include <KDupdater/UpdateOperationFactory> + #include <UpdateOperationFactory> KDUpdater::UpdateOperationFactory::instance().registerUpdateOperation< CustomOperation >( "CustomOperation" ); \endcode @@ -266,6 +266,27 @@ For example, \c {C:\Program Files} on Windows, \c {/opt} on Linux and \c {/Applications} on OS X. + + See also the table that lists examples of \l {Applications-directory-on-Windows} + {applications directories on Windows}. + \row + \li ApplicationsDirX86 + \li Applications Directory for 32 bit programs. This is useful on Windows, + on other platforms it is the same as \c ApplicationsDir. + + For example, \c {C:\Program Files (x86)} on Windows. + + See also the table that lists examples of \l {Applications-directory-on-Windows} + {applications directories on Windows}. + \row + \li ApplicationsDirX64 + \li Applications Directory for 64 bit programs. This is useful on Windows, + on other platforms it is the same as \c ApplicationsDir. + + For example, \c {C:\Program Files} on Windows. + + See also the table that lists examples of \l {Applications-directory-on-Windows} + {applications directories on Windows}. \row \li InstallerDirPath \li The directory that contains the installer application executable. @@ -297,4 +318,47 @@ component.addOperation("CreateShortcut", "@TargetDir@/MyApp.exe", "@StartMenuDir@/MyApp.lnk"); } \endcode + + + \target Applications-directory-on-Windows + For example, applications directory on Windows: + \table + \header + \li OS (Windows) + \li Qt Installer Framework + \li Variable + \li Example Path + \row + \li {1, 3} 32bit + \li {1, 3} 32bit + \li ApplicationsDir + \li \c {C:\Program Files} + \row + \li ApplicationsDirX86 + \li \c {C:\Program Files} + \row + \li ApplicationsDirX64 + \li \c {C:\Program Files} + \row + \li {1, 6} 64bit + \li {1, 3} 32bit + \li ApplicationsDir + \li \c {C:\Program Files (x86)} + \row + \li ApplicationsDirX86 + \li \c {C:\Program Files (x86)} + \row + \li ApplicationsDirX64 + \li \c {C:\Program Files} + \row + \li {1, 3} 64bit + \li ApplicationsDir + \li \c {C:\Program Files} + \row + \li ApplicationsDirX86 + \li \c {C:\Program Files (x86)} + \row + \li ApplicationsDirX64 + \li \c {C:\Program Files} + \endtable */ |