summaryrefslogtreecommitdiff
path: root/src/com/android/quicksearchbox/ui/SuggestionsListView.kt
blob: 75a0d7738ece975ab36e5bbb43ea6bd0c08fb38d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
 * Copyright (C) 2022 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.android.quicksearchbox.ui

import android.view.View
import android.widget.AbsListView

/**
 * Interface for suggestions list UI views.
 */
interface SuggestionsListView<A> {
    /**
     * See [View.setOnKeyListener].
     */
    fun setOnKeyListener(l: View.OnKeyListener?)

    /**
     * See [AbsListView.setOnScrollListener].
     */
    fun setOnScrollListener(l: AbsListView.OnScrollListener?)

    /**
     * See [View.setOnFocusChangeListener].
     */
    fun setOnFocusChangeListener(l: View.OnFocusChangeListener?)

    /**
     * See [View.setVisibility].
     */
    fun setVisibility(visibility: Int)

    /**
     * Sets the adapter for the list. See [AbsListView.setAdapter]
     */
    fun setSuggestionsAdapter(adapter: SuggestionsAdapter<A?>?)

    /**
     * Gets the adapter for the list.
     */
    fun getSuggestionsAdapter(): SuggestionsAdapter<A?>?

    /**
     * Gets the ID of the currently selected item.
     */
    fun  getSelectedItemId(): Long
}