# MenuKt

Added in 1.1.0

*** ** * ** ***


```
public final class MenuKt
```

<br />

*** ** * ** ***

## Summary

| ### Public methods |
|---|---|
| `static final boolean` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).contains(android.view.MenuItem)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/MenuItem.html item)` Returns `true` if `https://developer.android.com/reference/androidx/core/view/package-summary#(android.view.Menu).contains(android.view.MenuItem)` is found in this menu. |
| `static final void` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).forEach(kotlin.Function1)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/MenuItem.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> action )` Performs the given action on each item in this menu. |
| `static final void` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).forEachIndexed(kotlin.Function2)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull Function2<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/Integer.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/MenuItem.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> action )` Performs the given action on each item in this menu, providing its sequential index. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/MenuItem.html` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).get(kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver, int index)` Returns the menu at `https://developer.android.com/reference/androidx/core/view/package-summary#(android.view.Menu).get(kotlin.Int)`. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/MenuItem.html>` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).getChildren()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver)` Returns a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html` over the items in this menu. |
| `static final int` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).getSize()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver)` Returns the number of items in this menu. |
| `static final boolean` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).isEmpty()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver)` Returns true if this menu contains no items. |
| `static final boolean` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).isNotEmpty()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver)` Returns true if this menu contains one or more items. |
| `static final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Iterator.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/MenuItem.html>` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).iterator()(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver)` Returns a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-iterator/index.html` over the items in this menu. |
| `static final void` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).minusAssign(android.view.MenuItem)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/MenuItem.html item)` Removes `https://developer.android.com/reference/androidx/core/view/package-summary#(android.view.Menu).minusAssign(android.view.MenuItem)` from this menu. |
| `static final void` | `https://developer.android.com/reference/androidx/core/view/MenuKt#(android.view.Menu).removeItemAt(kotlin.Int)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/android/view/Menu.html receiver, int index)` Removes the menu item at the specified index. |

## Public methods

### contains

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:contains) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final boolean contains(@NonNull Menu receiver, @NonNull MenuItem item)
```

Returns `true` if `https://developer.android.com/reference/androidx/core/view/package-summary#(android.view.Menu).contains(android.view.MenuItem)` is found in this menu.

### forEach

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:forEach) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final void forEach(
    @NonNull Menu receiver,
    @NonNull Function1<@NonNull MenuItem, Unit> action
)
```

Performs the given action on each item in this menu.

### forEachIndexed

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:forEachIndexed) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final void forEachIndexed(
    @NonNull Menu receiver,
    @NonNull Function2<@NonNull Integer, @NonNull MenuItem, Unit> action
)
```

Performs the given action on each item in this menu, providing its sequential index.

### get

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:get) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final @NonNull MenuItem get(@NonNull Menu receiver, int index)
```

Returns the menu at `https://developer.android.com/reference/androidx/core/view/package-summary#(android.view.Menu).get(kotlin.Int)`.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-index-out-of-bounds-exception/index.html` | if index is less than 0 or greater than or equal to the count. |

### getChildren

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+symbol:children) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final @NonNull Sequence<@NonNull MenuItem> getChildren(@NonNull Menu receiver)
```

Returns a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.sequences/-sequence/index.html` over the items in this menu.

### getSize

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+symbol:size) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final int getSize(@NonNull Menu receiver)
```

Returns the number of items in this menu.

### isEmpty

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:isEmpty) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final boolean isEmpty(@NonNull Menu receiver)
```

Returns true if this menu contains no items.

### isNotEmpty

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:isNotEmpty) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final boolean isNotEmpty(@NonNull Menu receiver)
```

Returns true if this menu contains one or more items.

### iterator

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:iterator) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final @NonNull Iterator<@NonNull MenuItem> iterator(@NonNull Menu receiver)
```

Returns a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-iterator/index.html` over the items in this menu.

### minusAssign

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:minusAssign) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
public static final void minusAssign(@NonNull Menu receiver, @NonNull MenuItem item)
```

Removes `https://developer.android.com/reference/androidx/core/view/package-summary#(android.view.Menu).minusAssign(android.view.MenuItem)` from this menu.

### removeItemAt

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/view/Menu.kt+function:removeItemAt) Added in [1.9.0](https://developer.android.com/jetpack/androidx/releases/core#1.9.0)

```
public static final void removeItemAt(@NonNull Menu receiver, int index)
```

Removes the menu item at the specified index.

| Throws |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-index-out-of-bounds-exception/index.html` | if index is less than 0 or greater than or equal to the count. |