ui/common/src/commonMain/kotlin/BrowserLauncher.kt
author Da Risk <da_risk@geekorum.com>
Tue, 06 May 2025 12:55:03 -0400
changeset 89 0cc872a9edbf
parent 80 2474591aa280
permissions -rw-r--r--
sample: make android sample edge to edge and target sdk 35
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     1
/*
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     2
 * AboutOss is an utility library to retrieve and display
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     3
 * opensource licenses in Android applications.
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     4
 *
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     5
 * Copyright (C) 2023-2025 by Frederic-Charles Barthelery.
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     6
 *
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     7
 * This file is part of AboutOss.
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     8
 *
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
     9
 * AboutOss is free software: you can redistribute it and/or modify
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    10
 * it under the terms of the GNU General Public License as published by
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    11
 * the Free Software Foundation, either version 3 of the License, or
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    12
 * (at your option) any later version.
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    13
 *
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    14
 * AboutOss is distributed in the hope that it will be useful,
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    15
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    16
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    17
 * GNU General Public License for more details.
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    18
 *
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    19
 * You should have received a copy of the GNU General Public License
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    20
 * along with AboutOss.  If not, see <http://www.gnu.org/licenses/>.
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    21
 */
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    22
package com.geekorum.aboutoss.ui.common
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    23
51
d69bdf1ad491 ui:common: separate BrowserLauncher functionality from ViewModel
Da Risk <da_risk@geekorum.com>
parents: 36
diff changeset
    24
import androidx.compose.runtime.Composable
d69bdf1ad491 ui:common: separate BrowserLauncher functionality from ViewModel
Da Risk <da_risk@geekorum.com>
parents: 36
diff changeset
    25
36
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    26
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    27
/**
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    28
 * Interface to be able to launch a browser to display a link
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    29
 */
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    30
interface BrowserLauncher {
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    31
80
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    32
    /**
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    33
     * Launch a browser to display [link]
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    34
     */
36
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    35
    fun launchUrl(link: String)
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    36
80
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    37
    /**
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    38
     * Signal that [uris] may be launched next
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    39
     *
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    40
     * A [BrowserLauncher] can preload these uris for faster display
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    41
     */
36
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    42
    fun mayLaunchUrl(vararg uris: String)
a8cfcfe9a6ed make :ui:common multiplatform
Da Risk <da_risk@geekorum.com>
parents:
diff changeset
    43
51
d69bdf1ad491 ui:common: separate BrowserLauncher functionality from ViewModel
Da Risk <da_risk@geekorum.com>
parents: 36
diff changeset
    44
}
d69bdf1ad491 ui:common: separate BrowserLauncher functionality from ViewModel
Da Risk <da_risk@geekorum.com>
parents: 36
diff changeset
    45
80
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    46
/**
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    47
 * Creates and [androidx.compose.runtime.remember] a [BrowserLauncher]
2474591aa280 ui:common: add more kdocs
Da Risk <da_risk@geekorum.com>
parents: 51
diff changeset
    48
 */
51
d69bdf1ad491 ui:common: separate BrowserLauncher functionality from ViewModel
Da Risk <da_risk@geekorum.com>
parents: 36
diff changeset
    49
@Composable
d69bdf1ad491 ui:common: separate BrowserLauncher functionality from ViewModel
Da Risk <da_risk@geekorum.com>
parents: 36
diff changeset
    50
expect fun rememberBrowserLauncher(): BrowserLauncher