[gnome-shell] ShellSearchProvider: Update documentation about 'name' and 'id'



commit af7a34521fea0f1c9eca83593ab84ada51fa9dc2
Author: Jasper St. Pierre <jstpierre mecheye net>
Date:   Fri Feb 8 16:30:45 2013 -0500

    ShellSearchProvider: Update documentation about 'name' and 'id'
    
    Document and enforce that a meta ID corresponds to the result ID
    that we've passed in. This does not break any existing search providers
    as far as I'm aware.
    
    https://bugzilla.gnome.org/show_bug.cgi?id=693836

 data/org.gnome.ShellSearchProvider.xml  |    2 +-
 data/org.gnome.ShellSearchProvider2.xml |    2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)
---
diff --git a/data/org.gnome.ShellSearchProvider.xml b/data/org.gnome.ShellSearchProvider.xml
index 48f6008..78ad305 100644
--- a/data/org.gnome.ShellSearchProvider.xml
+++ b/data/org.gnome.ShellSearchProvider.xml
@@ -46,7 +46,7 @@
     <!--
         GetResultMetas:
         @identifiers: An array of result identifiers as returned by GetInitialResultSet() or 
GetSubsearchResultSet()
-        @metas: A dictionary describing the given search result, containing 'id' and 'name' (both strings). 
Optionally, either 'gicon' (a serialized GIcon) or 'icon-data' (raw image data as (iiibiiay) - width, height, 
rowstride, has-alpha, bits per sample, channels, data) can be specified if the result can be better served 
with a thumbnail of the content (such as with images).
+        @metas: A dictionary describing the given search result, containing a human-readable 'name' 
(string), along with the result identifier this meta is for, 'id' (string). Optionally, either 'gicon' (a 
serialized GIcon) or 'icon-data' (raw image data as (iiibiiay) - width, height, rowstride, has-alpha, bits 
per sample, channels, data) can be specified if the result can be better served with a thumbnail of the 
content (such as with images). A 'description' field (string) may also be specified if more context would 
help the user find the desired result.
 
         Return an array of meta data used to display each given result
     -->
diff --git a/data/org.gnome.ShellSearchProvider2.xml b/data/org.gnome.ShellSearchProvider2.xml
index 26b213d..7947d03 100644
--- a/data/org.gnome.ShellSearchProvider2.xml
+++ b/data/org.gnome.ShellSearchProvider2.xml
@@ -46,7 +46,7 @@
     <!--
         GetResultMetas:
         @identifiers: An array of result identifiers as returned by GetInitialResultSet() or 
GetSubsearchResultSet()
-        @metas: A dictionary describing the given search result, containing 'id' and 'name' (both strings). 
Optionally, either 'gicon' (a serialized GIcon) or 'icon-data' (raw image data as (iiibiiay) - width, height, 
rowstride, has-alpha, bits per sample, channels, data) can be specified if the result can be better served 
with a thumbnail of the content (such as with images). A 'description' field (string) may also be specified 
if more context would help the user find the desired result.
+        @metas: A dictionary describing the given search result, containing a human-readable 'name' 
(string), along with the result identifier this meta is for, 'id' (string). Optionally, either 'gicon' (a 
serialized GIcon) or 'icon-data' (raw image data as (iiibiiay) - width, height, rowstride, has-alpha, bits 
per sample, channels, data) can be specified if the result can be better served with a thumbnail of the 
content (such as with images). A 'description' field (string) may also be specified if more context would 
help the user find the desired result.
 
         Return an array of meta data used to display each given result
     -->


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]