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.actionbarmenu
18 
19 import android.view.Menu
20 import android.view.MenuItem
21 
22 /**
23  * Interface for handling a single menu item in action bar.
24  */
25 interface MenuItemController {
26     /**
27      * Returns the menu item resource id that the controller manages.
28      */
29     val id: Int
30 
31     /**
32      * Create the menu item.
33      */
onCreateOptionsItemnull34     fun onCreateOptionsItem(menu: Menu)
35 
36     /**
37      * Called immediately before the [MenuItem] is shown.
38      *
39      * @param item the [MenuItem] created by the controller
40      */
41     fun onPrepareOptionsItem(item: MenuItem)
42 
43     /**
44      * Attempts to handle the click action.
45      *
46      * @param item the [MenuItem] that was selected
47      * @return `true` if the action is handled by this controller
48      */
49     fun onOptionsItemSelected(item: MenuItem): Boolean
50 }