commonMain.in.procyk.compose.qrcode.options.dsl.QrOptionsBuilderScope.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of qr-code-desktop Show documentation

Helper functions and extensions when working with compose-multiplatform projects

There is a newer version: 1.6.1.0

/**
 * Based on QRose by Alexander Zhirkevich from [Github](https://github.com/alexzhirkevich/qrose)
 *
 * MIT License
 *
 * Copyright (c) 2023 Alexander Zhirkevich
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
package `in`.procyk.compose.qrcode.options.dsl

import `in`.procyk.compose.qrcode.options.DelicateQRCodeApi
import `in`.procyk.compose.qrcode.options.QrErrorCorrectionLevel
import `in`.procyk.compose.qrcode.options.QrErrorCorrectionLevel.Auto

sealed interface QrOptionsBuilderScope  {

    /**
     * Level of error correction.
     * [Auto] by default
     * */
    var errorCorrectionLevel: QrErrorCorrectionLevel

    /**
     * Enable 4th qr code eye. False by default
     * */
    @DelicateQRCodeApi
    var fourEyed : Boolean

    /**
     * Shapes of the QR code pattern and its parts.
     * */
    fun shapes(centralSymmetry : Boolean = true, block: QrShapesBuilderScope.() -> Unit)

    /**
     * Colors of QR code parts.
     * */
    fun colors(block: QrColorsBuilderScope.() -> Unit)

    /**
     * Middle image.
     * */
    fun logo(block: QrLogoBuilderScope.() -> Unit)
}