1 /*
2  * Copyright (C) 2020 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 
17 package com.android.deskclock.uidata
18 
19 /**
20  * The interface through which interested parties are notified of changes to the vertical scroll
21  * position of the selected tab. Callbacks to listener occur when any of these events occur:
22  *
23  * <ul>
24  *   <li>the vertical scroll position of the selected tab is now scrolled to the top
25  *   <li>the vertical scroll position of the selected tab is no longer scrolled to the top
26  *   <li>the selected tab changed and the new tab scroll state does not match the prior tab
27  * </ul>
28  */
29 interface TabScrollListener {
30     /**
31      * @param selectedTab an enumerated value indicating the current selected tab
32      * @param scrolledToTop indicates whether the current selected tab is scrolled to its top
33      */
selectedTabScrollToTopChangednull34     fun selectedTabScrollToTopChanged(selectedTab: UiDataModel.Tab, scrolledToTop: Boolean)
35 }