SuggestionClickListener.java revision 7a0c3a7c6fdabce949b59e0a2c6ec1d44a140c24 
1/*
2 * Copyright (C) 2009 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package com.android.quicksearchbox.ui;
18
19/**
20 * Listener interface for clicks on suggestions.
21 */
22public interface SuggestionClickListener {
23
24    /**
25     * Called when a suggestion is clicked.
26     *
27     * @param adapter Adapter that contains the clicked suggestion.
28     * @param suggestionId The ID of the suggestion clicked. If the suggestion list is flat, this
29     *      will be the position within the list.
30     */
31    void onSuggestionClicked(SuggestionsAdapter<?> adapter, long suggestionId);
32
33    /**
34     * Called when a quick contact badge in a suggestion is clicked.
35     *
36     * @param adapter Adapter that contains the clicked suggestion.
37     * @param suggestionId The ID of the suggestion clicked. If the suggestion list is flat, this
38     *      will be the position within the list.
39     */
40    void onSuggestionQuickContactClicked(SuggestionsAdapter<?> adapter, long suggestionId);
41
42    /**
43     * Called when the user requests to remove a suggestion from the search history.
44     *
45     * @param adapter Adapter that contains the clicked suggestion.
46     * @param suggestionId The ID of the suggestion clicked. If the suggestion list is flat, this
47     *      will be the position within the list.
48     */
49    void onSuggestionRemoveFromHistoryClicked(SuggestionsAdapter<?> adapter, long suggestionId);
50
51    /**
52     * Called when the "query refine" button of a suggestion is clicked.
53     *
54     * @param adapter Adapter that contains the clicked suggestion.
55     * @param suggestionId The ID of the suggestion clicked. If the suggestion list is flat, this
56     *      will be the position within the list.
57     */
58    void onSuggestionQueryRefineClicked(SuggestionsAdapter<?> adapter, long suggestionId);
59}
60