Better JavaDoc for Activity.onSearchRequested().

Fixes http://b/issue?id=1248721
This commit is contained in:
Bjorn Bringert
2009-09-25 14:25:41 +01:00
parent c7d1ee8b23
commit 6266e40a75

View File

@@ -2479,16 +2479,17 @@ public class Activity extends ContextThemeWrapper
/**
* This hook is called when the user signals the desire to start a search.
*
* <p>You can use this function as a simple way to launch the search UI, in response to a
* menu item, search button, or other widgets within your activity. Unless overidden,
* calling this function is the same as calling:
* <p>The default implementation simply calls
* {@link #startSearch startSearch(null, false, null, false)}, launching a local search.
* <p>You can use this function as a simple way to launch the search UI, in response to a
* menu item, search button, or other widgets within your activity. Unless overidden,
* calling this function is the same as calling
* {@link #startSearch startSearch(null, false, null, false)}, which launches
* search for the current activity as specified in its manifest, see {@link SearchManager}.
*
* <p>You can override this function to force global search, e.g. in response to a dedicated
* search key, or to block search entirely (by simply returning false).
*
* @return Returns true if search launched, false if activity blocks it
* @return Returns {@code true} if search launched, and {@code false} if activity blocks it.
* The default implementation always returns {@code true}.
*
* @see android.app.SearchManager
*/