am 81d84c0c: am 6266e40a: Better JavaDoc for Activity.onSearchRequested().

Merge commit '81d84c0cb244290a58bf8e78a3d638750cf7dd3f' into eclair-plus-aosp

* commit '81d84c0cb244290a58bf8e78a3d638750cf7dd3f':
  Better JavaDoc for Activity.onSearchRequested().
This commit is contained in:
Bjorn Bringert
2009-09-25 06:51:01 -07:00
committed by Android Git Automerger

View File

@@ -2555,15 +2555,16 @@ public class Activity extends ContextThemeWrapper
* This hook is called when the user signals the desire to start a search. * 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 * <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, * menu item, search button, or other widgets within your activity. Unless overidden,
* calling this function is the same as calling: * calling this function is the same as calling
* <p>The default implementation simply calls * {@link #startSearch startSearch(null, false, null, false)}, which launches
* {@link #startSearch startSearch(null, false, null, false)}, launching a local search. * 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 * <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). * 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 * @see android.app.SearchManager
*/ */