From d35b27d44e72bd4d1f2e532085af52b8120e8138 Mon Sep 17 00:00:00 2001 From: Daniel Silverstone Date: Tue, 3 Jun 2014 15:40:28 +0100 Subject: Add iterator for search providers --- desktop/searchweb.h | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) (limited to 'desktop/searchweb.h') diff --git a/desktop/searchweb.h b/desktop/searchweb.h index 612e9bdd1..b3b3902cf 100644 --- a/desktop/searchweb.h +++ b/desktop/searchweb.h @@ -78,6 +78,30 @@ nserror search_web_omni(const char *term, enum search_web_omni_flags flags, stru */ nserror search_web_select_provider(int selection); + +/** + * Iterate the search providers, returning their names. + * + * \param from Index to start iteration from. Use 0 to begin iteration. + * Use the value returned from search_web_iterate_providers to + * continue an iteration. + * \param name Pointer to fill in with the search provider name requested. + * \return -1 if there are no more, otherwise the iterator for the next item. + * + * \verb + * ssize_t iter; + * const char *name; + * ... + * for (iter = search_web_iterate_providers(0, &name); + * iter != -1; + * iter = search_web_iterate_providers(iter, &name)) { + * do_something_with(name); + * } + * \endverb + */ +ssize_t search_web_iterate_providers(ssize_t from, const char **name); + + /** * Initialise the web search operations. * -- cgit v1.2.3