diff options
Diffstat (limited to 'spec/contextkit.html')
| -rw-r--r-- | spec/contextkit.html | 191 |
1 files changed, 191 insertions, 0 deletions
diff --git a/spec/contextkit.html b/spec/contextkit.html new file mode 100644 index 00000000..25e26972 --- /dev/null +++ b/spec/contextkit.html @@ -0,0 +1,191 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=ascii" /><title>ContextKit D-Bus interface specification version 0.0.1</title><style type="text/css"> + + body { + font-family: sans-serif; + margin: 2em; + height: 100%; + font-size: 1.2em; + } + h1 { + padding-top: 5px; + padding-bottom: 5px; + font-size: 1.6em; + background: #dadae2; + } + h2 { + font-size: 1.3em; + } + h3 { + font-size: 1.2em; + } + a:link, a:visited, a:link:hover, a:visited:hover { + font-weight: bold; + } + .topbox { + padding-top: 10px; + padding-left: 10px; + border-bottom: black solid 1px; + padding-bottom: 10px; + background: #dadae2; + font-size: 2em; + font-weight: bold; + color: #5c5c5c; + } + .topnavbox { + padding-left: 10px; + padding-top: 5px; + padding-bottom: 5px; + background: #abacba; + border-bottom: black solid 1px; + font-size: 1.2em; + } + .topnavbox a{ + color: black; + font-weight: normal; + } + .sidebar { + float: left; + /* width:9em; + border-right:#abacba solid 1px; + border-left: #abacba solid 1px; + height:100%; */ + border: #abacba solid 1px; + padding-left: 10px; + margin-left: 10px; + padding-right: 10px; + margin-right: 10px; + color: #5d5d5d; + background: #dadae2; + } + .sidebar a { + text-decoration: none; + border-bottom: #e29625 dotted 1px; + color: #e29625; + font-weight: normal; + } + .sidebar h1 { + font-size: 1.2em; + color: black; + } + .sidebar ul { + padding-left: 25px; + padding-bottom: 10px; + border-bottom: #abacba solid 1px; + } + .sidebar li { + padding-top: 2px; + padding-bottom: 2px; + } + .sidebar h2 { + font-style:italic; + font-size: 0.81em; + padding-left: 5px; + padding-right: 5px; + font-weight: normal; + } + .date { + font-size: 0.6em; + float: right; + font-style: italic; + } + .method, .signal, .property { + margin-left: 1em; + margin-right: 4em; + } + .rationale { + font-style: italic; + border-left: 0.25em solid #808080; + padding-left: 0.5em; + } + + .added { + color: #006600; + background: #ffffff; + } + .deprecated { + color: #ff0000; + background: #ffffff; + } + table, tr, td, th { + border: 1px solid #666; + } + + </style></head><body><h1 class="topbox">ContextKit D-Bus interface specification</h1><h2>Version 0.0.1</h2><div>Copyright (C) 2008 Nokia Corporation</div><div class="license"> +<p>This library 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 2.1 of the License, or (at your option) any later version.</p> + +<p>This library 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 +Lesser General Public License for more details.</p> + +<p>You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p> +</div><h2>Interfaces</h2><ul><li><code><a href="#org.freedesktop.ContextKit.Manager">org.freedesktop.ContextKit.Manager</a></code></li><li><code><a href="#org.freedesktop.ContextKit.Subscriber">org.freedesktop.ContextKit.Subscriber</a></code></li></ul><h1><a name="org.freedesktop.ContextKit.Manager" id="org.freedesktop.ContextKit.Manager"></a>org.freedesktop.ContextKit.Manager</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ContextKit.Manager.Get" id="org.freedesktop.ContextKit.Manager.Get">Get</a> ( + as: keys + ) → + a{sv}, as</h3><div class="docstring"> + Get the values of a set of context keys. + </div><div><h4>Parameters</h4><dl><dt><code>keys</code> − + <code>as</code></dt><dd> + An array of the keys to get. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>values</code> − + <code>a{sv}</code> (<a xmlns="" href="#type-Value_Set">Value_Set</a>)</dt><dd> + A Value_Set mapping the requested keys to their values. + </dd><dt><code>undeterminable_keys</code> − + <code>as</code></dt><dd> + An array of keys which we couldn't determine the values for. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ContextKit.Manager.GetSubscriber" id="org.freedesktop.ContextKit.Manager.GetSubscriber">GetSubscriber</a> ( + + ) → + o</h3><div class="docstring"> + Get the Subscriber object for making subscriptions. + </div><div><h4>Returns</h4><dl><dt><code>subscription_object</code> − + <code>o</code></dt><dd> + The object on which to subscribe, unsubscribe keys and listen to key value changes. + </dd></dl></div></div><p>Interface has no signals.</p><p>Interface has no Telepathy + properties.</p><p>Interface has no D-Bus core + properties.</p><h1><a name="org.freedesktop.ContextKit.Subscriber" id="org.freedesktop.ContextKit.Subscriber"></a>org.freedesktop.ContextKit.Subscriber</h1><h2>Methods:</h2><div class="method"><h3><a name="org.freedesktop.ContextKit.Subscriber.Subscribe" id="org.freedesktop.ContextKit.Subscriber.Subscribe">Subscribe</a> ( + as: keys + ) → + a{sv}, as</h3><div class="docstring"> + Subscribe to a one or more keys + </div><div><h4>Parameters</h4><dl><dt><code>keys</code> − + <code>as</code></dt><dd> + An array of the keys to subscribe to. + </dd></dl></div><div><h4>Returns</h4><dl><dt><code>values</code> − + <code>a{sv}</code> (<a xmlns="" href="#type-Value_Set">Value_Set</a>)</dt><dd> + A Value_Set mapping the requested keys to their current values. + </dd><dt><code>undeterminable_keys</code> − + <code>as</code></dt><dd> + An array of keys which we couldn't determine the values for. + </dd></dl></div></div><div class="method"><h3><a name="org.freedesktop.ContextKit.Subscriber.Unsubscribe" id="org.freedesktop.ContextKit.Subscriber.Unsubscribe">Unsubscribe</a> ( + as: keys + ) → + nothing</h3><div class="docstring"> + A Value_Set mapping the requested keys to their values. + </div><div><h4>Parameters</h4><dl><dt><code>keys</code> − + <code>as</code></dt><dd> + An array of the keys to unsubscribe from. + </dd></dl></div></div><h2>Signals:</h2><div class="signal"><h3><a name="org.freedesktop.ContextKit.Subscriber.Changed" id="org.freedesktop.ContextKit.Subscriber.Changed">Changed</a> ( + a{sv}: values, as: undeterminable_keys + )</h3><div class="docstring"></div><div><h4>Parameters</h4><dl><dt><code>values</code> − + <code>a{sv}</code> (<a xmlns="" href="#type-Value_Set">Value_Set</a>)</dt><dd> + A Value_Set mapping the changed keys to their values. + </dd><dt><code>undeterminable_keys</code> − + <code>as</code></dt><dd> + An array of keys which we can no longer determine the values for. + </dd></dl></div></div><p>Interface has no Telepathy + properties.</p><p>Interface has no D-Bus core + properties.</p><h1>Generic types</h1><h2>Mapping types</h2><div class="struct"><h3><a name="type-Value_Set" id="type-Value_Set">Value_Set</a> − a{ + s: Key → v: Value + } + </h3><div class="docstring">A mapping from key names to a variant</div><div><h4>Members</h4><dl><dt><code>Key</code> − + <code>s</code></dt><dd><em>(undocumented)</em></dd><dt><code>Value</code> − + <code>v</code></dt><dd><em>(undocumented)</em></dd></dl></div></div><h1>Index</h1><h2>Index of interfaces</h2><ul><li><code><a href="#org.freedesktop.ContextKit.Manager">org.freedesktop.ContextKit.Manager</a></code></li><li><code><a href="#org.freedesktop.ContextKit.Subscriber">org.freedesktop.ContextKit.Subscriber</a></code></li></ul><h2>Index of types</h2><ul><li><code><a href="#type-Value_Set">Value_Set</a></code> + − a{ s → v } + </li></ul></body></html> |