# ThreePaneScaffoldHorizontalOrder

Artifact: [androidx.compose.material3.adaptive:adaptive-layout](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive) [View Source](https://cs.android.com/search?q=file:androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder.kt+class:androidx.compose.material3.adaptive.layout.ThreePaneScaffoldHorizontalOrder) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0) Common/All
- Cmn

  ```
  @ExperimentalMaterial3AdaptiveApi
  class ThreePaneScaffoldHorizontalOrder : PaneScaffoldHorizontalOrder<ThreePaneScaffoldRole>
  ```

*** ** * ** ***

Represents the horizontal order of panes in a `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/package-summary#ThreePaneScaffold(androidx.compose.ui.Modifier,androidx.compose.material3.adaptive.layout.PaneScaffoldDirective,androidx.compose.material3.adaptive.layout.ThreePaneScaffoldValue,androidx.compose.material3.adaptive.layout.ThreePaneScaffoldHorizontalOrder,kotlin.Function1,kotlin.Function1,androidx.compose.material3.adaptive.layout.PaneExpansionState,kotlin.Function2,kotlin.Function1)` from start to end. Currently this class only have two possible instances, i.e. `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ListDetailPaneScaffoldDefaults#PaneOrder()` and `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/SupportingPaneScaffoldDefaults#PaneOrder()`, which will be used internally by `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ListDetailPaneScaffold.composable#ListDetailPaneScaffold(androidx.compose.material3.adaptive.layout.PaneScaffoldDirective,androidx.compose.material3.adaptive.layout.ThreePaneScaffoldValue,kotlin.Function1,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Function2,androidx.compose.material3.adaptive.layout.PaneExpansionState)` and `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/SupportingPaneScaffold.composable#SupportingPaneScaffold(androidx.compose.material3.adaptive.layout.PaneScaffoldDirective,androidx.compose.material3.adaptive.layout.ThreePaneScaffoldValue,kotlin.Function1,kotlin.Function1,androidx.compose.ui.Modifier,kotlin.Function1,kotlin.Function2,androidx.compose.material3.adaptive.layout.PaneExpansionState)` respectively.

## Summary

| ### Public functions |
|---|---|---|
| `open operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#equals(kotlin.Any)(other: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#forEach(kotlin.Function1)(action: (https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldRole) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Performs the given `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldHorizontalOrder#forEach(kotlin.Function1)` for each pane in the order. | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#forEachIndexed(kotlin.Function2)(action: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldRole) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Performs the given `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldHorizontalOrder#forEachIndexed(kotlin.Function2)` for each pane in the order, with its index. | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#forEachIndexedReversed(kotlin.Function2)(action: (https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldRole) -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Performs the given `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldHorizontalOrder#forEachIndexedReversed(kotlin.Function2)` for each pane in the order, with its index, in reverse order. | Cmn |
| `operator https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldRole` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#get(kotlin.Int)(index: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#hashCode()()` | Cmn |
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#indexOf(androidx.compose.material3.adaptive.layout.ThreePaneScaffoldRole)(role: https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldRole)` Returns the index of the given role in the order. | Cmn |

| ### Public properties |
|---|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/ThreePaneScaffoldHorizontalOrder#size()` The number of panes in the order. | Cmn |

## Public functions

### equals

Cmn

```
open operator fun equals(other: Any?): Boolean
```

### forEach

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)

```
open fun forEach(action: (ThreePaneScaffoldRole) -> Unit): Unit
```

Performs the given `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldHorizontalOrder#forEach(kotlin.Function1)` for each pane in the order.

### forEachIndexed

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)

```
open fun forEachIndexed(action: (Int, ThreePaneScaffoldRole) -> Unit): Unit
```

Performs the given `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldHorizontalOrder#forEachIndexed(kotlin.Function2)` for each pane in the order, with its index.

### forEachIndexedReversed

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)

```
open fun forEachIndexedReversed(action: (Int, ThreePaneScaffoldRole) -> Unit): Unit
```

Performs the given `https://developer.android.com/reference/kotlin/androidx/compose/material3/adaptive/layout/PaneScaffoldHorizontalOrder#forEachIndexedReversed(kotlin.Function2)` for each pane in the order, with its index, in reverse order.

### get

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)

```
operator fun get(index: Int): ThreePaneScaffoldRole
```

### hashCode

Cmn

```
open fun hashCode(): Int
```

### indexOf

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)

```
open fun indexOf(role: ThreePaneScaffoldRole): Int
```

Returns the index of the given role in the order.

## Public properties

### size

Cmn Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/compose-material3-adaptive#1.1.0)

```
open val size: Int
```

The number of panes in the order.