Warning, /frameworks/krunner/src/data/org.kde.krunner1.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
0002 <!--
0003 SPDX-License-Identifier: LGPL-2.0-or-later
0004 SPDX-FileCopyrightText: 2017, 2018 David Edmundson <davidedmundson@kde.org>
0005 SPDX-FileCopyrightText: 2020 Kai Uwe Broulik <kde@broulik.de>
0006 SPDX-FileCopyrightText: 2020-2021 Alexander Lohnau <alexander.lohnau@gmx.de>
0007 -->
0008
0009 <node>
0010 <interface name="org.kde.krunner1">
0011 <!--
0012 This method gets called when a match session is over.
0013 It can be used to clear data which should not be kept in memory after a match session.
0014 -->
0015 <method name="Teardown"/>
0016
0017 <!--
0018 This method can be used to set runner config at runtime. In case the service wildcard is used
0019 the config is only for one service requested.
0020 It gets only called when the X-Plasma-Api value is set to DBus2
0021
0022 Possible values for the response map are:
0023 MatchRegex (String)
0024 MinLetterCount (int)
0025 TriggerWords (StringList)
0026 Actions (RemoteActions), see X-Plasma-Request-Actions-Once property docs
0027
0028 See API documentation of the AbstractRunner class for details about these values.
0029 -->
0030 <method name="Config">
0031 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
0032 <arg name="config" type="a{sv}" direction="out">
0033 </arg>
0034 </method>
0035
0036 <!--
0037 Returns a list of actions supported by this runner.
0038 For example, a song match returned by a music player runner can be queued, added to the playlist, or played.
0039 This should be constant
0040 Structure is:
0041 - ID
0042 - Text
0043 - IconName
0044 -->
0045 <method name="Actions">
0046 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="KRunner::Actions" />
0047 <arg name="matches" type="a(sss)" direction="out">
0048 </arg>
0049 </method>
0050
0051 <!--
0052 Execute an action
0053 -->
0054 <method name="Run">
0055 <!--
0056 The Unique ID from Match.
0057 -->
0058 <arg name="matchId" type="s" direction="in"/>
0059 <!--
0060 The action ID to run. For the default action this will be empty.
0061 -->
0062 <arg name="actionId" type="s" direction="in"/>
0063 </method>
0064 <!--
0065 Fetch matching results for a given query.
0066
0067 Note: Multiple Match calls may be made with new queries before a call has returned
0068 has returned.
0069 -->
0070 <method name="Match">
0071 <arg name="query" type="s" direction="in"/>
0072 <!--
0073 Return a list of items that match the
0074 Structure is:
0075 - Id
0076 - Text
0077 - IconName
0078 - Type (see KRunner::QueryMatch::Type)
0079 - Relevance
0080 - Properties (VariantMap)
0081 - urls (StringList)
0082 - category
0083 - subtext
0084 - actions (StringList of RemoteAction's IDs). In case you don't want to display any actions set this to an empty list.
0085 Otherwise all the actions will be shown for compatibility with the previous versions of the D-Bus API.
0086 When the actions only need to be fetched once you can set the X-Plasma-Request-Actions-Once property of
0087 the service file to true.
0088 - icon-data (iiibiiay). Custom icon pixmap. Icon name should be preferred, if available.
0089 Format is the same as org.freedesktop.Notifications icon-data, in order: width, height, row stride,
0090 has alpha, bits per sample, number of channels, pixmap data.
0091 - multiline (boolean). If the text should be displayed as styled multiline text.
0092 -->
0093 <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="RemoteMatches"/>
0094 <arg name="matches" type="a(sssida{sv})" direction="out"/>
0095 </method>
0096 </interface>
0097 </node>