diff options
Diffstat (limited to 'desktop/searchweb.h')
-rw-r--r-- | desktop/searchweb.h | 29 |
1 files changed, 20 insertions, 9 deletions
diff --git a/desktop/searchweb.h b/desktop/searchweb.h index a96e7787b..d7e6a1c65 100644 --- a/desktop/searchweb.h +++ b/desktop/searchweb.h @@ -62,7 +62,7 @@ enum search_web_omni_flags { * term. The flags allow control over the operation. By default the * operations are: * - interpret the \a term as a url - * - if missing a scheme as a http: url + * - if missing a scheme as a https: url * - combined with the search providers url into a url for that provider. * * \param term The search term. @@ -72,37 +72,48 @@ enum search_web_omni_flags { */ nserror search_web_omni(const char *term, enum search_web_omni_flags flags, struct nsurl **url_out); + +/** + * obtain the current providers bitmap + * + * obtain the icon representing the current web search provider + * + * \param bitmap_out recives the resulting bitmap which may be NULL + * \return NSERROR_OK on success or NSERROR_INIT_FAILED if not initialised + */ +nserror search_web_get_provider_bitmap(struct bitmap **bitmap_out); + /** * Change the currently selected web search provider. * - * \param selection Index of the search provider to select or -1 to + * \param selection Name of the search provider to select or NULL to * reselect the current provider * \return NSERROR_OK on success or appropriate error code. */ -nserror search_web_select_provider(int selection); +nserror search_web_select_provider(const char *selection); /** * Iterate the search providers, returning their names. * - * \param from Index to start iteration from. Use 0 to begin iteration. + * \param from Index to start iteration from. Use -1 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. * * \verbatim - * ssize_t iter; + * ssize_t iter = -1; * const char *name; * ... - * for (iter = search_web_iterate_providers(0, &name); - * iter != -1; - * iter = search_web_iterate_providers(iter, &name)) { + * iter = search_web_iterate_providers(iter, &name); + * while(iter !=-1) { * do_something_with(name); + * iter = search_web_iterate_providers(iter, &name); * } * \endverbatim */ -ssize_t search_web_iterate_providers(ssize_t from, const char **name); +ssize_t search_web_iterate_providers(ssize_t iter, const char **name); /** |