### Example Usage of startActionMode

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/start-action-mode.html

Demonstrates how to start an action mode in ToolbarLayout with custom callbacks for menu inflation, action mode end, menu item selection, and select all functionality. It also shows how to provide a StateFlow for the 'All' selector state.

```kotlin
toolbarLayout.startActionMode(
    onInflateMenu = { menu, menuInflater ->
        // Inflate menu items here
        menuInflater.inflate(R.menu.action_menu, menu)
    },
    onEnd = {
        // Perform actions when action mode ends
    },
    onSelectMenuItem = { item ->
        // Handle action item click
        true // Return true to indicate the item click is handled
    },
    onSelectAll = { isChecked ->
        // Handle "All" selector click
    },
    allSelectorStateFlow = viewModel.allSelectorStateFlow
)
```

--------------------------------

### Setup Navigation with ToolbarLayout (DSL)

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/setup-navigation.html

Use this overload for programmatic navigation graph creation with ToolbarLayout using the NavGraphBuilder DSL. Specify the start destination and optionally a route.

```kotlin
toolbarLayout.setupNavigation(
    bottomTabLayout,
    navHostFragment,
    startDestination = "widgets_dest"
) {
    mainNavGraph()
}
```

--------------------------------

### Setup Navigation with DrawerLayout (DSL)

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/setup-navigation.html

Use this overload for programmatic navigation graph creation with DrawerLayout using the NavGraphBuilder DSL. Specify the start destination and optionally a route.

```kotlin
navDrawerLayout.setupNavigation(
    drawerNavigationView,
    navHostFragment,
    startDestination = "widgets_dest"
) {
    mainNavGraph()
}
```

--------------------------------

### Kotlin: Start Pop-Over Activity for Result

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/start-pop-over-activity-for-result.html

Demonstrates how to register an ActivityResultLauncher and then use it to start an activity in pop-over mode. This is useful for launching secondary activities that return a result to the calling activity.

```kotlin
val searchLauncher = registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result ->
    // Handle the result
}

startPopOverActivityForResult(
    intent = Intent(context, SearchActivity::class.java),
    popOverOptions = PopOverOptions.topRightAnchored(context),
    resultLauncher = searchLauncher
)
```

--------------------------------

### Basic SelectableLinearLayout Example

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-selectable-linear-layout/index.html

Demonstrates the basic usage of SelectableLinearLayout in an XML layout. This example sets the check mode to 'checkBox'.

```xml
<dev.oneuiproject.oneui.widget.SelectableLinearLayout
    android:layout_width="match_parent"
    android:layout_height="?android:listPreferredItemHeight"
    android:animateLayoutChanges="true"
    android:gravity="center_vertical"
    android:orientation="horizontal"
    android:paddingStart="?android:listPreferredItemPaddingStart"
    android:paddingEnd="?android:listPreferredItemPaddingEnd"
    app:checkMode="checkBox">

    <!-- Child views -->

</dev.oneuiproject.oneui.widget.SelectableLinearLayout>
```

--------------------------------

### startActionMode

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/start-action-mode.html

Starts the action mode for this ToolbarLayout. This method sets up the action mode with the specified callbacks and options.

```APIDOC
## startActionMode

### Description
Starts the action mode for this ToolbarLayout. This method sets up the action mode with the specified callbacks and options.

### Method Signature
inline fun <T : ToolbarLayout> T.startActionMode(
    crossinline onInflateMenu: (menu: Menu, menuInflater: MenuInflater) -> Unit,
    crossinline onEnd: () -> Unit,
    crossinline onSelectMenuItem: (item: MenuItem) -> Boolean,
    crossinline onSelectAll: (Boolean) -> Unit,
    searchOnActionMode: ToolbarLayout.SearchOnActionMode = Dismiss,
    allSelectorStateFlow: StateFlow<ToolbarLayout.AllSelectorState>? = null,
    showCancel: Boolean = false,
    maxActionItems: Int = 4
)

### Parameters
#### Lambda Parameters
- **onInflateMenu** - Lambda function called at the start of startActionMode. Inflate the menu items for this action mode session using this menu.
- **onEnd** - Lambda function to be invoked when action mode ends.
- **onSelectMenuItem** - Lambda function to be invoked when an action menu item is selected. Return true if the item click is handled, false otherwise.
- **onSelectAll** - Lambda function to be invoked when the `All` selector is clicked. This will not be triggered with ToolbarLayout.updateAllSelector.

#### Optional Parameters
- **searchOnActionMode** (ToolbarLayout.SearchOnActionMode) - The SearchOnActionMode option to set for this action mode. Defaults to SearchOnActionMode.Dismiss.
- **allSelectorStateFlow** (StateFlow<ToolbarLayout.AllSelectorState>?) - StateFlow of ToolbarLayout.AllSelectorState that updates the `All` selector state and count.
- **showCancel** (Boolean) - Show a Cancel button in the toolbar menu. Setting this to true disables adaptive action mode menu (i.e. menu will always be shown as a bottom action menu. This is false by default.
- **maxActionItems** (Int) - The maximum number of items to show as action items in the Toolbar. By default, it's 4.

### Example Usage
```kotlin
toolbarLayout.startActionMode(
    onInflateMenu = { menu, menuInflater ->
        // Inflate menu items here
        menuInflater.inflate(R.menu.action_menu, menu)
    },
    onEnd = {
        // Perform actions when action mode ends
    },
    onSelectMenuItem = { item ->
        // Handle action item click
        true // Return true to indicate the item click is handled
    },
    onSelectAll = { isChecked ->
        // Handle "All" selector click
    },
    allSelectorStateFlow = viewModel.allSelectorStateFlow
)
```

### See Also
- ToolbarLayout.endActionMode
```

--------------------------------

### Prebuilt PopOverOptions

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.popover/-pop-over-options/index.html

Provides static methods for common pop-over configurations, simplifying setup for typical use cases.

```APIDOC
## Prebuilt PopOverOptions

### Description
Static methods that return prebuilt PopOverOptions for common configurations.

### Available Options
- **centerAnchored**: Returns options for a centered pop-over.
- **topCenterAnchored**: Returns options for a top-centered pop-over.
- **bottomCenterAnchored**: Returns options for a bottom-centered pop-over.
- **topLeftAnchored**: Returns options for a top-left anchored pop-over.
- **centerLeftAnchored**: Returns options for a center-left anchored pop-over.
- **bottomLeftAnchored**: Returns options for a bottom-left anchored pop-over.
- **topRightAnchored**: Returns options for a top-right anchored pop-over.
- **centerRightAnchored**: Returns options for a center-right anchored pop-over.
- **bottomRightAnchored**: Returns options for a bottom-right anchored pop-over.
```

--------------------------------

### Execute Action on Animation Start

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/index.html

Adds an action to be executed when a ViewPropertyAnimator or a standard Animation has started.

```kotlin
inline fun ViewPropertyAnimator.doOnStart(crossinline action: (animation: Animator) -> Unit): Animator.AnimatorListener
```

```kotlin
inline fun Animation.doOnStart(crossinline action: (animation: Animation) -> Unit): Animation.AnimationListener
```

--------------------------------

### startQrRoiAnimation

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.qr.widget/-qr-code-scanner-view/start-qr-roi-animation.html

Starts the ROI scanning animation. Typically called after returning from static image mode or when resuming live scanning.

```APIDOC
## startQrRoiAnimation()

### Description
Starts the ROI scanning animation. This function is typically invoked after returning from static image mode or when resuming live scanning.

### Signature
`fun startQrRoiAnimation()`

### Parameters
This function does not take any parameters.

### Usage
```kotlin
qrCodeScannerView.startQrRoiAnimation()
```
```

--------------------------------

### Start Search Mode for ToolbarLayout

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/index.html

Activates the search mode for a ToolbarLayout, providing callbacks for query changes, start, and end events.

```kotlin
inline fun <T : ToolbarLayout> T.startSearchMode(onBackBehavior: ToolbarLayout.SearchModeOnBackBehavior, crossinline onQuery: (query: String, isSubmit: Boolean) -> Boolean, crossinline onStart: (searchView: SearchView) -> Unit = {}, crossinline onEnd: (searchView: SearchView) -> Unit = {})
```

--------------------------------

### animateViewOut Function

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-tip-popup/-tip-window/index.html

Starts the animation to dismiss the tip window.

```APIDOC
## animateViewOut Function

### Description
Initiates the animation for dismissing the tip window.

### Function Signature
`open fun animateViewOut()`
```

--------------------------------

### Setup Navigation with DrawerLayout

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/setup-navigation.html

Use this function to set up navigation for DrawerLayout with a DrawerNavigationView and NavHostFragment. It supports XML navigation graphs.

```kotlin
drawerLayout.setupNavigation(drawerNavigationView, navHostFragment)
```

--------------------------------

### Static SplashLayout Example

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/-splash-layout/index.html

Configure a static splash screen by setting `app:animated` to false and providing a single drawable reference for the image.

```XML
<dev.oneuiproject.oneui.layout.SplashLayout
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:animated="false"
    app:image="@drawable/your_drawable"/>
```

--------------------------------

### Setup Navigation with ToolbarLayout

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/setup-navigation.html

Use this function to set up navigation for ToolbarLayout with a BottomTabLayout and NavHostFragment. It supports XML navigation graphs.

```kotlin
toolbarLayout.setupNavigation(bottomTabLayout, navHostFragment)
```

--------------------------------

### setStartTimeTitle

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.dialog/-start-end-time-picker-dialog/set-start-time-title.html

Sets the title for the start time tab in the dialog.

```APIDOC
## setStartTimeTitle

### Description
Sets the title for the start time tab.

### Method
fun

### Parameters
#### Path Parameters
- **title** (String) - Required - The title to be set for the start time tab.
```

--------------------------------

### Start ActionMode for ToolbarLayout

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/index.html

Initiates the action mode for a ToolbarLayout, allowing for custom menu inflation, item selection, and end actions.

```kotlin
inline fun <T : ToolbarLayout> T.startActionMode(crossinline onInflateMenu: (menu: Menu, menuInflater: MenuInflater) -> Unit, crossinline onEnd: () -> Unit, crossinline onSelectMenuItem: (item: MenuItem) -> Boolean, crossinline onSelectAll: (Boolean) -> Unit, searchOnActionMode: ToolbarLayout.SearchOnActionMode = Dismiss, allSelectorStateFlow: StateFlow<ToolbarLayout.AllSelectorState>? = null, showCancel: Boolean = false, maxActionItems: Int = 4)
```

--------------------------------

### startSearchMode

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/start-search-mode.html

Starts the search mode for this ToolbarLayout. This method sets up the search mode with the specified behaviors and callbacks. It handles dismissing the soft keyboard when the query is submitted.

```APIDOC
## startSearchMode

### Description
Starts the search mode for this ToolbarLayout. This method sets up the search mode with the specified behaviors and callbacks. This handles dismissing the soft keyboard when the query is submitted.

### Signature
inline fun <T : ToolbarLayout> T.startSearchMode( onBackBehavior: ToolbarLayout.SearchModeOnBackBehavior, crossinline onQuery: (query: String, isSubmit: Boolean) -> Boolean, crossinline onStart: (searchView: SearchView) -> Unit = {}, crossinline onEnd: (searchView: SearchView) -> Unit = {})(source)

### Parameters
#### Path Parameters
- **onBackBehavior** (ToolbarLayout.SearchModeOnBackBehavior) - Required - Defines the behavior when the back button is pressed during search mode.
- **onQuery** ( (query: String, isSubmit: Boolean) -> Boolean ) - Required - Lambda function to be invoked when the query text changes or is submitted. Return true if the query has been handled, false otherwise.
- **onStart** ( (searchView: SearchView) -> Unit ) - Optional - Lambda function to be invoked when search mode starts.
- **onEnd** ( (searchView: SearchView) -> Unit ) - Optional - Lambda function to be invoked when search mode ends.

### Request Example
```kotlin
toolbarLayout.startSearchMode(
    ToolbarLayout.SearchModeOnBackBehavior.CLEAR_SEARCH,
    { query, isSubmit ->
        // Handle query change or submission
        true // Return true to indicate the query is handled
    },
    onStart = { searchView ->
        // Perform actions when search mode starts
    },
    onEnd = { searchView ->
        // Perform actions when search mode ends
    }
)
```

### See also
ToolbarLayout.endSearchMode
```

--------------------------------

### Animated SplashLayout Example

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/-splash-layout/index.html

Use this snippet to configure an animated splash screen. Ensure `app:animated` is set to true and provide drawable references for foreground and background images.

```XML
<dev.oneuiproject.oneui.layout.SplashLayout
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:animated="true"
    app:foreground_image="@drawable/your_foreground_drawable"
    app:background_image="@drawable/your_background_drawable"/>
```

--------------------------------

### startActionMode

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/-toolbar-layout/start-action-mode.html

Starts an Action Mode session. This shows the Toolbar's ActionMode with a toggleable 'All' Checkbox and a counter ('x selected') that temporarily replaces the Toolbar's title.

```APIDOC
## startActionMode

### Description
Starts an Action Mode session. This shows the Toolbar's ActionMode with a toggleable 'All' Checkbox and a counter ('x selected') that temporarily replaces the Toolbar's title.

### Method
open fun startActionMode

### Parameters
#### Path Parameters
* **listener** (ToolbarLayout.ActionModeListener) - Required - The ActionModeListener to be invoked for this action mode.
* **searchOnActionMode** (ToolbarLayout.SearchOnActionMode) - Optional - The SearchOnActionMode option to set for this action mode. It is set to Dismiss by default.
* **allSelectorStateFlow** (StateFlow<ToolbarLayout.AllSelectorState>?) - Optional - StateFlow of AllSelectorState that will be used to update "All" selector state and count. If not set, "All" selector state must be updated by calling updateAllSelector.
* **showCancel** (Boolean) - Optional - Show a Cancel button in the toolbar menu. Setting this to true disables adaptive action mode menu (i.e. menu will always be shown as a bottom action menu. This is false by default.
* **maxActionItems** (Int) - Optional - The maximum number of items to show as action items in the Toolbar. By default, it's 4.

### See also
ToolbarLayout.endActionMode
```

--------------------------------

### XML Layout for DescriptionPreference

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.preference/-description-preference/index.html

Example of how to declare and configure a DescriptionPreference in an XML layout file. It demonstrates setting the title, position mode, and rounded corners.

```xml
<DescriptionPreference
    app:title="This is a description"
    app:positionMode="firstItem"
    app:roundedCorners="all" />
```

--------------------------------

### Basic invokeOnBack Usage

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/invoke-on-back.html

Example of using invokeOnBack to handle a simple back press event. The 'onBackPressed' lambda is mandatory.

```kotlin
AppCompatActivity.invokeOnBack(onBackPressed = { /* Handle back press */ })

```

--------------------------------

### OnboardingTipsItemView Constructor

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-onboarding-tips-item-view/index.html

Initializes a new instance of the OnboardingTipsItemView class. This constructor is designed for use in Kotlin and supports default parameter values for attributes and styles.

```APIDOC
## OnboardingTipsItemView Constructor

### Description
Initializes a new instance of the OnboardingTipsItemView class. This constructor is designed for use in Kotlin and supports default parameter values for attributes and styles.

### Parameters
- **context** (Context) - The Context the view is running in, through which it can access the current theme, resources, etc.
- **attrs** (AttributeSet?) - Optional. The attributes of the XML tag that is inflating the view.
- **defStyleAttr** (Int) - Optional. An attribute in the current theme that contains a reference to a style resource that supplies default values for the view.
- **defStyleRes** (Int) - Optional. A resource identifier of a style resource that supplies default values for the view, used only if defStyleAttr is not provided or cannot be found in the theme.
```

--------------------------------

### OnboardingTipsItemView Constructor

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-onboarding-tips-item-view/index.html

Initializes a new instance of the OnboardingTipsItemView. Use this constructor when creating the view programmatically.

```kotlin
class OnboardingTipsItemView @JvmOverloads constructor( context: Context,  attrs: AttributeSet? = null,  defStyleAttr: Int = 0,  defStyleRes: Int = 0) : LinearLayout(context)
```

--------------------------------

### OnboardingTipsItemView Constructor (Overload)

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-onboarding-tips-item-view/index.html

The primary constructor for OnboardingTipsItemView, accepting context, attributes, default style attributes, and default style resources.

```kotlin
@JvmOverloads
constructor( context: Context,  attrs: AttributeSet? = null,  defStyleAttr: Int = 0,  defStyleRes: Int = 0)
```

--------------------------------

### Basic GridMenuDialog Usage

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.dialog/-grid-menu-dialog/index.html

Demonstrates how to create, inflate a menu, set a click listener, and show a GridMenuDialog. Return true from the listener to dismiss the dialog.

```kotlin
val dialog = GridMenuDialog(context)
dialog.inflateMenu(R.menu.my_menu)
dialog.setOnItemClickListener { item ->
    // Handle item click
    true // Return true to dismiss the dialog
}
dialog.show()
```

--------------------------------

### onTimeSet

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.dialog/-start-end-time-picker-dialog/-time-picker-change-listener/index.html

This function is called when the user has finished selecting a start and end time. It receives the selected start and end times as integers.

```APIDOC
## onTimeSet

### Description
Callback function invoked when the user completes the time selection process, providing the chosen start and end times.

### Signature
abstract fun onTimeSet(startTime: Int, endTime: Int)

### Parameters
#### Path Parameters
- **startTime** (Int) - Required - The selected start time.
- **endTime** (Int) - Required - The selected end time.
```

--------------------------------

### setupNavigation for DrawerLayout (DSL)

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/setup-navigation.html

Overload for programmatic navigation graph creation using NavGraphBuilder DSL for DrawerLayout.

```APIDOC
## setupNavigation for DrawerLayout (DSL)

### Description
Overload for programmatic navigation graph creation using NavGraphBuilder DSL for DrawerLayout.

### Method Signature
```kotlin
fun <T : DrawerLayout> T.setupNavigation(
    drawerNavigationView: DrawerNavigationView,
    navHostFragment: NavHostFragment,
    startDestination: KClass<*>, 
    route: KClass<*>? = null,
    configuration: AppBarConfiguration = AppBarConfiguration(drawerNavigationView.getDrawerMenu(), this),
    @FloatRange(from = 0.0, to = 1.0) toolbarBackThreshold: Float = 0.75f,
    lockWithDrawer: Boolean = true,
    builder: NavGraphBuilder.() -> Unit
)
```

### Parameters
* **drawerNavigationView** (DrawerNavigationView) - The DrawerNavigationView containing the navigation menu to be linked with navigation actions.
* **navHostFragment** (NavHostFragment) - The NavHostFragment that hosts the navigation graph and manages navigation transactions.
* **startDestination** (KClass<*>) - The starting destination class for the navigation graph.
* **route** (KClass<*>?, optional) - The route class for the navigation graph.
* **configuration** (AppBarConfiguration, optional) - Optional AppBarConfiguration to customize top-level destinations and drawer behavior. Defaults to using the menu from drawerNavigationView and this DrawerLayout as the drawer layout.
* **toolbarBackThreshold** (Float, optional) - The threshold (from 0.0 to 1.0) at which the DrawerLayout toolbar switches its title, subtitle and navigation icon to those of the back destination during predictive back animation progress. Defaults to 0.75f.
* **lockWithDrawer** (Boolean, optional) - Whether to update the lock state of the DrawerNavigationView when the drawer's lock state changes. Defaults to true.
* **builder** (NavGraphBuilder.() -> Unit) - A lambda function to build the navigation graph using NavGraphBuilder DSL.

### Usage Example
```kotlin
navDrawerLayout.setupNavigation(
    drawerNavigationView,
    navHostFragment,
    startDestination = "widgets_dest"
) {
    mainNavGraph()
}
```
```

--------------------------------

### TipWindow Constructor

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-tip-popup/-tip-window/index.html

Initializes a new instance of the TipWindow class with the specified content view, dimensions, and focusability.

```APIDOC
## TipWindow Constructor

### Description
Initializes a new instance of the TipWindow class.

### Parameters
* **contentView** (View) - The view to be displayed within the tip window.
* **width** (Int) - The width of the tip window.
* **height** (Int) - The height of the tip window.
* **focusable** (Boolean) - Indicates whether the tip window should be focusable.
```

--------------------------------

### Start ROI Scanning Animation

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.qr.widget/-qr-code-scanner-view/index.html

Starts the Region of Interest (ROI) scanning animation. This provides visual feedback to the user about the active scanning area.

```kotlin
fun startQrRoiAnimation()
```

--------------------------------

### startPopOverActivity

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/index.html

Starts an activity in PopOver mode. This mode is only available to large display Samsung devices with OneUI (API 28+). Otherwise, it behaves like a normal activity launch.

```APIDOC
## startPopOverActivity

### Description
Starts an activity in PopOver mode. This mode is only available to large display Samsung devices with OneUI (API 28+). Otherwise, it behaves like a normal activity launch.

### Method
`Activity.startPopOverActivity(intent: Intent, popOverOptions: PopOverOptions = PopOverOptions.topCenterAnchored(this))
@JvmOverloads
inline fun <T : Activity> Activity.startPopOverActivity(activityClass: Class<T>, popOverOptions: PopOverOptions = PopOverOptions.topCenterAnchored(this))`

### Parameters
- **intent** (Intent) - Required - The intent to start the activity.
- **popOverOptions** (PopOverOptions) - Optional - Options for the pop-over behavior. Defaults to `PopOverOptions.topCenterAnchored(this)`.
- **activityClass** (Class<T>) - Required - The class of the activity to start.
```

--------------------------------

### doOnBlockMultiSelection

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.recyclerview.ktx/do-on-block-multi-selection.html

Registers a multi-selection listener for block selection started by an S-Pen or mouse input. This function allows customization of selection start, completion, and item selectability.

```APIDOC
## doOnBlockMultiSelection

### Description
Registers a multi-selection listener for block selection started by an S-Pen or mouse input. This listener can be configured with callbacks for when selection starts, completes, and to determine if an item is selectable.

### Method
Extension Function

### Parameters
#### Lambda Parameters
- **onStarted** (()->Unit) - Required - Lambda to be invoked when block selection has started.
- **onCompleted** ((selectedItems: Set<AdapterItem>) -> Unit) - Required - Lambda to be invoked when block selection has completed. This includes the resulting `selectedItems` parameter - the set of items selected after filtering out those which are not allowed to be selected. The start and end positions are inclusive and can be the same or different (which one is larger depends on the direction of the selection).
- **isSelectable** ((RecyclerView, AdapterItem) -> Boolean) - Optional - Lambda to be invoked to check if an item is allowed to be selected. Default always returns `true`. During block selection, some items may be off-screen so their child view can be null. In such cases, AdapterItem.itemView is null and the computed id will be RecyclerView.NO_ID. If your isSelectable logic relies on a stable id or a non-null view, account for these cases accordingly.

### Important Notes
- During block selection, items may be off-screen, resulting in a null `AdapterItem.itemView` and `RecyclerView.NO_ID` for the computed ID. Ensure your `isSelectable` logic handles these cases if it depends on stable IDs or non-null views.
```

--------------------------------

### init

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/index.html

Initializes a DatePicker.

```APIDOC
## init

### Description
Initializes a DatePicker.

### Signature
```kotlin
@JvmName(name = "initDatePicker")
```
```

--------------------------------

### Example Usage of MultiSelectorDelegate

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.recyclerview.util/-multi-selector-delegate/index.html

Demonstrates how to integrate MultiSelectorDelegate into a custom RecyclerView adapter and fragment for multi-selection functionality. Ensure stable IDs are enabled and correctly implemented in getItemId and updateSelectableIds.

```kotlin
class IconsAdapter (
   onAllSelectorStateChanged: ((AllSelectorState) -> Unit),
   onBlockActionMode: (() -> Unit),
) : RecyclerView.Adapter<IconsAdapter.ViewHolder>(),
    MultiSelector<Long/*stable id*/> by MultiSelectorDelegate(
       onAllSelectorStateChanged = onAllSelectorStateChanged,
       onBlockActionMode = onBlockActionMode,
       isSelectable = { rv, pos ->
          (rv.adapter as MyAdapter).getItem(pos) is SelectableItem
       },
       // We're using stable Ids
       selectionId = null,
       selectionChangePayload = Payload.SELECTION_MODE
    ) {

   init {
       // We're using stable Ids
       setHasStableIds(true)
   }

   override fun getItemId(position: Int): Long {
       // Implement when using stable Ids
       return currentList[position].id.toLong()
   }

   fun submitList(list: List<Icon>) {
      asyncListDiffer.submitList(list)
      // submit selectable ids to the delegate everytime a
      // new list is submitted to the adapter.
      // Must be the same ids return in getItemId
      // when setHasStableIds is true
      updateSelectableIds( list.map {it.id.toLong()})
   }

   // rest of the adapter's implementations
 }

 class IconsFragment : Fragment(){

    private lateinit var iconsAdapter: IconsAdapter

    override fun onViewCreated(view: View, savedInstanceState: Bundle?) {

       iconsAdapter = IconsAdapter(
          onAllSelectorStateChanged = { toolbarLayout.updateAllSelector(it) },
          onBlockActionMode = { toolbarLayout.startActionMode(...))

       // configure the selection delegate with the recyclerview
       iconsAdapter.configureWith(binding.recyclerView)
    }

   // rest of the fragment's implementations
 }
```

--------------------------------

### getPositionForSection

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.recyclerview.util/-section-indexer-delegate/index.html

Retrieves the starting position of a given section.

```APIDOC
## getPositionForSection

### Description
Retrieves the starting position of a given section index within the list.

### Signature
open override fun getPositionForSection(sectionIndex: Int): Int
```

--------------------------------

### Start Search Mode with Callbacks

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/start-search-mode.html

Initiates search mode in ToolbarLayout. Handles back button behavior, query changes, and start/end callbacks for the search view. Use this to enable search functionality within your toolbar.

```kotlin
toolbarLayout.startSearchMode(
    ToolbarLayout.SearchModeOnBackBehavior.CLEAR_SEARCH,
    { query, isSubmit ->
        // Handle query change or submission
        true // Return true to indicate the query is handled
    },
    onStart = { searchView ->
        // Perform actions when search mode starts
    },
    onEnd = { searchView ->
        // Perform actions when search mode ends
    }
)
```

--------------------------------

### doOnStart

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/index.html

Adds a callback to be invoked when an animation starts.

```APIDOC
## doOnStart

### Description
Add an action which will be invoked when the animation is started.

### Signature
```kotlin
inline fun ViewPropertyAnimator.doOnStart(crossinline action: (animation: Animator) -> Unit): Animator.AnimatorListener
```

### Signature
```kotlin
inline fun Animation.doOnStart(crossinline action: (animation: Animation) -> Unit): Animation.AnimationListener
```
```

--------------------------------

### invokeOnBack with Optional Callbacks (API 34+)

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/invoke-on-back.html

Demonstrates using invokeOnBack with optional callbacks for back started, progressed, and cancelled states, available on API 34 and higher. The 'onBackPressed' lambda is mandatory.

```kotlin
AppCompatActivity.invokeOnBack(
    onBackPressed = { /* Handle back press */ },
    onBackStarted = { backEvent -> /* Handle back started */ },
    onBackProgressed = { backEvent -> /* Handle back progressed */ },
    onBackCancelled = { /* Handle back cancelled */ }
)

```

--------------------------------

### Get Window Width Excluding Insets

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/window-width-net-of-insets.html

Use this extension property with an Activity context to get the available horizontal space, excluding system UI elements. If used with a non-activity context, it returns the display width minus system decorations on API 29 and below.

```kotlin
val width = activityContext.windowWidthNetOfInsets
```

--------------------------------

### setupNavigation for DrawerLayout

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/index.html

Sets up navigation for DrawerLayout with a DrawerNavigationView and NavHostFragment. This function supports both XML and programmatically created navigation graphs.

```APIDOC
## setupNavigation for DrawerLayout

### Description
Sets up navigation for DrawerLayout with a DrawerNavigationView and NavHostFragment. Supports both XML and programmatically created navigation graphs (NavGraphBuilder DSL).

### Method
fun <T : DrawerLayout> T.setupNavigation(
    drawerNavigationView: DrawerNavigationView,
    navHostFragment: NavHostFragment,
    configuration: AppBarConfiguration = AppBarConfiguration(drawerNavigationView.getDrawerMenu(), this),
    @FloatRange(from = 0.0, to = 1.0) toolbarBackThreshold: Float = 0.75f,
    lockWithDrawer: Boolean = true
)

### Parameters
- **drawerNavigationView** (DrawerNavigationView) - The DrawerNavigationView to integrate with.
- **navHostFragment** (NavHostFragment) - The NavHostFragment to manage navigation.
- **configuration** (AppBarConfiguration) - Optional AppBarConfiguration for customizing the app bar.
- **toolbarBackThreshold** (Float) - Optional threshold for toolbar back behavior, defaults to 0.75f.
- **lockWithDrawer** (Boolean) - Optional flag to lock the drawer with the navigation, defaults to true.
```

--------------------------------

### setupNavigation for DrawerLayout with DSL

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/index.html

Overload for DrawerLayout that allows programmatic navigation graph creation using the NavGraphBuilder DSL.

```APIDOC
## setupNavigation for DrawerLayout with DSL

### Description
Overload for DrawerLayout that allows programmatic navigation graph creation using the NavGraphBuilder DSL.

### Method
fun <T : DrawerLayout> T.setupNavigation(
    drawerNavigationView: DrawerNavigationView,
    navHostFragment: NavHostFragment,
    startDestination: KClass<*>, 
    route: KClass<*>? = null,
    configuration: AppBarConfiguration = AppBarConfiguration(drawerNavigationView.getDrawerMenu(), this),
    @FloatRange(from = 0.0, to = 1.0) toolbarBackThreshold: Float = 0.75f,
    lockWithDrawer: Boolean = true,
    builder: NavGraphBuilder.() -> Unit
)

### Parameters
- **drawerNavigationView** (DrawerNavigationView) - The DrawerNavigationView to integrate with.
- **navHostFragment** (NavHostFragment) - The NavHostFragment to manage navigation.
- **startDestination** (KClass<*>) - The starting destination class for the navigation graph.
- **route** (KClass<*>?) - Optional route class for the navigation graph.
- **configuration** (AppBarConfiguration) - Optional AppBarConfiguration for customizing the app bar.
- **toolbarBackThreshold** (Float) - Optional threshold for toolbar back behavior, defaults to 0.75f.
- **lockWithDrawer** (Boolean) - Optional flag to lock the drawer with the navigation, defaults to true.
- **builder** (NavGraphBuilder.() -> Unit) - Lambda function to build the navigation graph using NavGraphBuilder DSL.
```

--------------------------------

### startPopOverActivityForResult

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/index.html

Starts an activity in PopOver mode for a result. This mode is only available to large display Samsung devices with OneUI (API 28+). Otherwise, it behaves like a normal activity launch.

```APIDOC
## startPopOverActivityForResult

### Description
Starts an activity in PopOver mode for a result. This mode is only available to large display Samsung devices with OneUI (API 28+). Otherwise, it behaves like a normal activity launch.

### Method
`@JvmOverloads
inline fun Activity.startPopOverActivityForResult(intent: Intent, popOverOptions: PopOverOptions = PopOverOptions.topCenterAnchored(this), resultLauncher: ActivityResultLauncher<Intent>)`

### Parameters
- **intent** (Intent) - Required - The intent to start the activity.
- **popOverOptions** (PopOverOptions) - Optional - Options for the pop-over behavior. Defaults to `PopOverOptions.topCenterAnchored(this)`.
- **resultLauncher** (ActivityResultLauncher<Intent>) - Required - The activity result launcher to handle the result.
```

--------------------------------

### Custom Constructor

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/-sesl-seek-bar-dual-colors/-custom/index.html

Initializes a new instance of the Custom class with specified background and foreground colors.

```APIDOC
## Custom Constructor

### Description
Initializes a new instance of the `Custom` class with specified background and foreground colors.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Constructor Signature
`Custom(bgColor: Int = "#f7c0bd".toColorInt(), fgColor: Int = "#f1462f".toColorInt())`

### Properties
- **bgColor** (`Int`): The overlap color for the background track. Defaults to a light red color.
- **fgColor** (`Int`): The overlap color for the activated track. Defaults to a darker red color.
```

--------------------------------

### DividerInsets Properties

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.utils/-divider-insets/index.html

Accesses the start and end insets of a DividerInsets object.

```APIDOC
## DividerInsets Properties

### Description
Provides access to the start and end insets defined for a divider.

### Properties
- **start** (Int) - The inset from the start edge of the RecyclerView item in pixels.
- **end** (Int) - The inset from the end edge of the RecyclerView item in pixels.
```

--------------------------------

### DividerInsets Constructor

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.utils/-divider-insets/index.html

Constructs a DividerInsets object with specified start and end insets.

```APIDOC
## DividerInsets Constructor

### Description
Initializes a new instance of the `DividerInsets` class with the specified start and end insets.

### Parameters
#### Path Parameters
- **start** (Int) - Required - The inset from the start edge of the RecyclerView item in pixels.
- **end** (Int) - Required - The inset from the end edge of the RecyclerView item in pixels.
```

--------------------------------

### setupNavigation for ToolbarLayout with DSL

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/index.html

Overload for ToolbarLayout that allows programmatic navigation graph creation using the NavGraphBuilder DSL.

```APIDOC
## setupNavigation for ToolbarLayout with DSL

### Description
Overload for ToolbarLayout that allows programmatic navigation graph creation using the NavGraphBuilder DSL.

### Method
fun <T : ToolbarLayout> T.setupNavigation(
    bottomTabLayout: BottomTabLayout,
    navHostFragment: NavHostFragment,
    startDestination: KClass<*>, 
    route: KClass<*>? = null,
    configuration: AppBarConfiguration = AppBarConfiguration(bottomTabLayout.bottomTabLayoutMenu, null),
    @FloatRange(from = 0.0, to = 1.0) toolbarBackThreshold: Float = 0.75f,
    builder: NavGraphBuilder.() -> Unit
)

### Parameters
- **bottomTabLayout** (BottomTabLayout) - The BottomTabLayout to integrate with.
- **navHostFragment** (NavHostFragment) - The NavHostFragment to manage navigation.
- **startDestination** (KClass<*>) - The starting destination class for the navigation graph.
- **route** (KClass<*>?) - Optional route class for the navigation graph.
- **configuration** (AppBarConfiguration) - Optional AppBarConfiguration for customizing the app bar.
- **toolbarBackThreshold** (Float) - Optional threshold for toolbar back behavior, defaults to 0.75f.
- **builder** (NavGraphBuilder.() -> Unit) - Lambda function to build the navigation graph using NavGraphBuilder DSL.
```

--------------------------------

### ViewPropertyAnimator.doOnStart

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/do-on-start.html

Adds a callback to be invoked when the animation has started. Returns the added AnimatorListener.

```APIDOC
## ViewPropertyAnimator.doOnStart

### Description
Adds an action which will be invoked when the animation has started.

### Method
inline fun

### Parameters
- **action** (Animator.() -> Unit) - The callback function to execute when the animation starts.

### Return
Animator.AnimatorListener - The AnimatorListener added to the Animator.

### See also
- Animator.start
```

--------------------------------

### Start Pop-Over Activity using Class

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/start-pop-over-activity.html

Launches an activity in pop-over mode using its class. This is suitable when you have the Activity class directly. Ensure the device supports OneUI pop-over mode; otherwise, it falls back to normal activity launch.

```kotlin
startPopOverActivity(
    activityClass = SearchActivity::class.java,
    popOverOptions = PopOverOptions.topRightAnchored(context)
  )
)
```

--------------------------------

### Animation.doOnStart

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/do-on-start.html

Adds a callback to be invoked when the animation starts. Returns the added AnimationListener.

```APIDOC
## Animation.doOnStart

### Description
Adds an action which will be invoked when the animation is started.

### Method
inline fun

### Parameters
- **action** (Animation.() -> Unit) - The callback function to execute when the animation starts.

### Return
Animation.AnimationListener - The AnimationListener added to the Animator.

### See also
- Animation.start
```

--------------------------------

### Set Summary Text Color

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-onboarding-tips-item-view/index.html

Sets the color for the summary text of the OnboardingTipsItemView.

```kotlin
fun setSummaryColor(@ColorInt color: Int)
```

--------------------------------

### setupNavigation for ToolbarLayout

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.navigation/index.html

Sets up navigation for ToolbarLayout with a BottomTabLayout and NavHostFragment. This function supports both XML and programmatically created navigation graphs.

```APIDOC
## setupNavigation for ToolbarLayout

### Description
Sets up navigation for ToolbarLayout with a BottomTabLayout and NavHostFragment. Supports both XML and programmatically created navigation graphs (NavGraphBuilder DSL).

### Method
fun <T : ToolbarLayout> T.setupNavigation(
    bottomTabLayout: BottomTabLayout,
    navHostFragment: NavHostFragment,
    configuration: AppBarConfiguration = AppBarConfiguration(bottomTabLayout.bottomTabLayoutMenu, null),
    @FloatRange(from = 0.0, to = 1.0) toolbarBackThreshold: Float = 0.75f
)

### Parameters
- **bottomTabLayout** (BottomTabLayout) - The BottomTabLayout to integrate with.
- **navHostFragment** (NavHostFragment) - The NavHostFragment to manage navigation.
- **configuration** (AppBarConfiguration) - Optional AppBarConfiguration for customizing the app bar.
- **toolbarBackThreshold** (Float) - Optional threshold for toolbar back behavior, defaults to 0.75f.
```

--------------------------------

### title Property

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-radio-item-view/index.html

Gets or sets the main title text displayed in the RadioItemView.

```APIDOC
## title Property

### Description
Represents the main title text displayed in the RadioItemView.

### Type
CharSequence?
```

--------------------------------

### summary Property

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-radio-item-view/index.html

Gets or sets the summary text displayed below the title in the RadioItemView.

```APIDOC
## summary Property

### Description
Represents the summary text associated with the RadioItemView, typically displayed below the main title.

### Type
CharSequence?
```

--------------------------------

### value Property

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.preference/-color-picker-preference/index.html

Gets or sets the integer value representing the selected color.

```APIDOC
## value Property

### Description
Gets or sets the integer value representing the selected color.

### Type
Int
```

--------------------------------

### Get Preference Methods

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.preference.app/-observable-preferences-data-store/index.html

Methods for retrieving preference values of different types.

```APIDOC
## Get Preference Methods

### Description
These methods allow you to retrieve preference values stored in the data store. If a preference does not exist, a default value is returned.

### Methods
- **getBoolean**(key: String, defValue: Boolean): Boolean
- **getFloat**(key: String, defValue: Float): Float
- **getInt**(key: String, defValue: Int): Int
- **getLong**(key: String, defValue: Long): Long
- **getString**(key: String, defValue: String?): String?
- **getStringSet**(key: String, defValues: MutableSet<String>?): Set<String>
```

--------------------------------

### setDividerInsets

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.utils/-sem-item-decoration/set-divider-insets.html

Sets custom divider insets for the start and end positions of list items.

```APIDOC
## setDividerInsets

### Description
Sets custom divider insets for the start and end positions of list items.

### Method
fun

### Parameters
#### Path Parameters
- **dividerInsets** (DividerInsets) - Required - Custom insets in pixels.
```

--------------------------------

### isDismissing Property

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-tip-popup/-tip-window/index.html

Gets a value indicating whether the tip window is currently being dismissed.

```APIDOC
## isDismissing Property

### Description
Indicates whether the tip window is currently in the process of being dismissed.

### Property Type
Boolean
```

--------------------------------

### FloatingActionBar Properties

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-floating-action-bar/index.html

Provides access to the properties of the FloatingActionBar, allowing you to get or set their values.

```APIDOC
## FloatingActionBar Properties

### selectedIndex

* **Type**: Int
* **Description**: Gets or sets the index of the currently selected button (0 or 1).
* **Example**: `floatingActionBar.selectedIndex = 1`
```

--------------------------------

### getCurrentMode()

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-seek-bar-plus/get-current-mode.html

Gets the current mode of the SeekBar. This function returns an integer representing the current mode.

```APIDOC
## getCurrentMode()

### Description
Gets the current mode of the SeekBar.

### Method
N/A (Function call)

### Parameters
None

### Return
- **Int** - The current mode of the SeekBar.

### See also
- SeekBarPlus.setMode
```

--------------------------------

### Initialize QrCodeScannerView

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.qr.widget/-qr-code-scanner-view/index.html

Initializes the scanner UI and enables QR scanning. Ensure to provide a title, flash availability, and a listener for callbacks.

```kotlin
fun initialize( title: CharSequence? = null,  isFlashAvailable: Boolean,  listener: QrCodeScannerView.Listener)
```

--------------------------------

### defaultSystemBarsDarkMode

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.utils/index.html

Provides a default lambda function to get the system bars dark mode settings.

```APIDOC
## fun Context.defaultSystemBarsDarkMode

### Description
Provides a default lambda function to get the system bars dark mode settings.

### Returns
() -> Pair<Boolean, Boolean> - A lambda function that returns the system bars dark mode settings.
```

--------------------------------

### show

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.dialog/-progress-dialog/-companion/index.html

Creates and shows a ProgressDialog. This is a factory method for easily displaying a progress dialog to the user.

```APIDOC
## show

### Description
Creates and shows a ProgressDialog. Allows customization of title, message, indeterminate state, cancelability, and a cancel listener.

### Method
`fun`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **context** (Context) - Required - The context to display the dialog in.
* **title** (CharSequence?) - Optional - The title of the dialog.
* **message** (CharSequence) - Required - The message to display in the dialog.
* **indeterminate** (Boolean) - Optional - Whether the progress is indeterminate (default: false).
* **cancelable** (Boolean) - Optional - Whether the dialog is cancelable by the user (default: false).
* **cancelListener** (DialogInterface.OnCancelListener?) - Optional - A listener to be invoked when the dialog is canceled.

### Response
#### Success Response
* **ProgressDialog** - The created and shown ProgressDialog instance.

### Response Example
```json
{
  "example": "ProgressDialog instance"
}
```
```

--------------------------------

### setDividerInsetStart

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.utils/-sem-item-decoration/set-divider-inset-start.html

Sets a custom start inset for the divider. This function takes an integer representing the inset in pixels.

```APIDOC
## setDividerInsetStart

### Description
Sets a custom start inset for the divider.

### Parameters
#### Path Parameters
* **dividerInsetStart** (Int) - Required - Custom start inset in pixels.
```

--------------------------------

### Set Title Text Color

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-onboarding-tips-item-view/index.html

Sets the color for the title text of the OnboardingTipsItemView.

```kotlin
fun setTitleColor(@ColorInt color: Int)
```

--------------------------------

### Get Relative Links Card from Preference Screen

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.ktx/index.html

Retrieves the RelativeLinksCard instance from a PreferenceFragmentCompat, if one exists.

```kotlin
fun PreferenceFragmentCompat.getRelativeLinksCard(): RelativeLinksCard?
```

--------------------------------

### QRCodeScannerView.initialize

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.qr.widget/-qr-code-scanner-view/initialize.html

Initializes the scanner UI and enables QR scanning. This must be called once after view inflation and before analysis begins.

```APIDOC
## initialize

### Description
Initializes the scanner UI and enables QR scanning. This must be called once after view inflation and before analysis begins.

### Method
fun

### Parameters
#### Path Parameters
- **title** (CharSequence?) - Optional - Guide text displayed above the scanning area.
- **isFlashAvailable** (Boolean) - Required - Whether the device camera supports flash.
- **listener** (QrCodeScannerView.Listener) - Required - Callback receiver for scan results and UI actions.
```

--------------------------------

### ProgressDialog.show()

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.dialog/-progress-dialog/-companion/show.html

Creates and shows a ProgressDialog with customizable options.

```APIDOC
## ProgressDialog.show()

### Description
Creates and shows a ProgressDialog. This method allows for customization of the dialog's title, message, indeterminate state, cancelability, and a cancel listener.

### Method
`fun show(context: Context, title: CharSequence?, message: CharSequence, indeterminate: Boolean = false, cancelable: Boolean = false, cancelListener: DialogInterface.OnCancelListener? = null): ProgressDialog`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* **context** (Context) - Required - The parent context.
* **title** (CharSequence?) - Optional - The title text for the dialog's window.
* **message** (CharSequence) - Required - The text to be displayed in the dialog.
* **indeterminate** (Boolean) - Optional - True if the dialog should be .setIndeterminate, false otherwise. Defaults to false.
* **cancelable** (Boolean) - Optional - True if the dialog is .setCancelable, false otherwise. Defaults to false.
* **cancelListener** (DialogInterface.OnCancelListener?) - Optional - The .setOnCancelListener to be invoked when the dialog is canceled.

### Request Example
```kotlin
// Example usage:
val dialog = ProgressDialog.show(
    context = myContext,
    title = "Loading",
    message = "Please wait...",
    indeterminate = true,
    cancelable = true,
    cancelListener = DialogInterface.OnCancelListener { dialog -> /* handle cancel */ }
)
```

### Response
#### Success Response
* **ProgressDialog** - The created and shown ProgressDialog instance.
```

--------------------------------

### NoUpdate Status Data Object

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/-app-info-layout/-status/index.html

Represents the state where no updates are available. Use when there are no new updates to install.

```kotlin
data object NoUpdate : AppInfoLayout.Status
```

--------------------------------

### setHintDescription

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.widget/-tip-popup/set-hint-description.html

Sets the hint description for the TipPopup.

```APIDOC
## setHintDescription

### Description
Set the hint description.

### Parameters
#### Path Parameters
- **hintDescription** (CharSequence?) - Required - The description to set.
```

--------------------------------

### startSplashAnimation

Source: https://tribalfs.github.io/oneui-design/oneui-design/dev.oneuiproject.oneui.layout/-splash-layout/start-splash-animation.html

Starts the splash animation. This function's effect is conditional and only applies when the `animated` attribute is set to `true`.

```APIDOC
## startSplashAnimation

### Description
Starts the splash animation. This Only applies when `R.attr.animated` is set to `true`.

### Signature
`fun startSplashAnimation()`
```