am dbc7e27e: docs: document the \'showSearchIconAsBadge" flag and "icon" attribute as deprecated. bug 2105329

Merge commit 'dbc7e27ef10349f11ac940d59ff4f812319fce51' into eclair

* commit 'dbc7e27ef10349f11ac940d59ff4f812319fce51':
  docs: document the 'showSearchIconAsBadge" flag and
This commit is contained in:
Scott Main
2009-11-13 10:45:32 -08:00
committed by Android Git Automerger
2 changed files with 17 additions and 25 deletions

View File

@@ -769,17 +769,15 @@ import java.util.List;
* </tr> * </tr>
* *
* <tr><th>android:icon</th> * <tr><th>android:icon</th>
* <td>If provided, this icon will be shown in place of the label above the search box. * <td><strong>This is deprecated.</strong><br/>The default
* This is a reference to a drawable (icon) resource. Note that the application icon * application icon is now always used, so this attribute is
* is also used as an icon to the left of the search box and you cannot modify this * obsolete.</td>
* behavior, so including the icon attribute is unecessary and this may be
* deprecated in the future.</td>
* <td align="center">No</td> * <td align="center">No</td>
* </tr> * </tr>
* *
* <tr><th>android:hint</th> * <tr><th>android:hint</th>
* <td>This is the text to display in the search text field when no user text has been * <td>This is the text to display in the search text field when no text
* entered.</td> * has been entered by the user.</td>
* <td align="center">No</td> * <td align="center">No</td>
* </tr> * </tr>
* *
@@ -790,17 +788,14 @@ import java.util.List;
* <tbody> * <tbody>
* <tr><th>showSearchLabelAsBadge</th> * <tr><th>showSearchLabelAsBadge</th>
* <td>If set, this flag enables the display of the search target (label) * <td>If set, this flag enables the display of the search target (label)
* above the search box. If this flag and showSearchIconAsBadge * above the search box. As an alternative, you may
* (see below) are both not set, no badge will be shown.</td> * want to instead use "hint" text in the search box.
* See the "android:hint" attribute above.</td>
* </tr> * </tr>
* <tr><th>showSearchIconAsBadge</th> * <tr><th>showSearchIconAsBadge</th>
* <td>If set, this flag enables the display of the search target (icon) * <td><strong>This is deprecated.</strong><br/>The default
* above the search box. If this flag and showSearchLabelAsBadge * application icon is now always used, so this
* (see above) are both not set, no badge will be shown. If both flags * option is obsolete.</td>
* are set, showSearchIconAsBadge has precedence and the icon will be
* shown. Because the application icon is now used to the left of the
* search box by default, using this search mode is no longer necessary
* and may be deprecated in the future.</td>
* </tr> * </tr>
* <tr><th>queryRewriteFromData</th> * <tr><th>queryRewriteFromData</th>
* <td>If set, this flag causes the suggestion column SUGGEST_COLUMN_INTENT_DATA * <td>If set, this flag causes the suggestion column SUGGEST_COLUMN_INTENT_DATA

View File

@@ -2892,12 +2892,9 @@
For a more in-depth discussion of search configuration, please refer to For a more in-depth discussion of search configuration, please refer to
{@link android.app.SearchManager}. --> {@link android.app.SearchManager}. -->
<declare-styleable name="Searchable"> <declare-styleable name="Searchable">
<!-- If provided, this icon will be shown in place of the label above the search box. <!--<strong>This is deprecated.</strong><br/>The default
This is a reference to a drawable (icon) resource. Note that the application icon application icon is now always used, so this attribute is
is also used as an icon to the left of the search box and you cannot modify this obsolete.-->
behavior, so including the icon attribute is unecessary and this may be
deprecated in the future.
<i>Optional attribute.</i> -->
<attr name="icon" /> <attr name="icon" />
<!-- This is the user-displayed name of the searchable activity. <i>Required <!-- This is the user-displayed name of the searchable activity. <i>Required
attribute.</i> --> attribute.</i> -->
@@ -2920,9 +2917,9 @@
<!-- If set, this flag enables the display of the search target (label) within the <!-- If set, this flag enables the display of the search target (label) within the
search bar. If neither bad mode is selected, no badge will be shown. --> search bar. If neither bad mode is selected, no badge will be shown. -->
<flag name="showSearchLabelAsBadge" value="0x04" /> <flag name="showSearchLabelAsBadge" value="0x04" />
<!-- If set, this flag enables the display of the search target (icon) within the <!--<strong>This is deprecated.</strong><br/>The default
search bar. (Note, overrides showSearchLabel) If neither bad mode is selected, application icon is now always used, so this option is
no badge will be shown.--> obsolete.-->
<flag name="showSearchIconAsBadge" value="0x08" /> <flag name="showSearchIconAsBadge" value="0x08" />
<!-- If set, this flag causes the suggestion column SUGGEST_COLUMN_INTENT_DATA to <!-- If set, this flag causes the suggestion column SUGGEST_COLUMN_INTENT_DATA to
be considered as the text for suggestion query rewriting. This should only be considered as the text for suggestion query rewriting. This should only