// Fenrir console screen reader.
// Copyright (c) 2026 Storm Dragon
// SPDX-License-Identifier: GPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify it
// under the terms of the GNU General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option)
// any later version.
//
// This program is distributed in the hope that it will be useful, but WITHOUT
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
// more details.
//
// You should have received a copy of the GNU General Public License along with
// this program. If not, see <https://www.gnu.org/licenses/gpl-3.0.html>.

package interaction

type Kind int

const (
	CheckBox Kind = iota
	Number
	Entry
	List
	Button
	ComboBox
	Grid
)

type Control struct {
	ID, Label      string
	Group          string
	Hidden         bool // Retains draft values while excluded from navigation.
	Kind           Kind
	Checked        bool
	Number         float64
	Min, Max, Step float64
	UpDownStep     float64 // Zero uses the default step of 1 for Up and Down.
	Text           string
	Items          []string
	Selected       int
	Action         string
	Choices        []Choice
	Columns        int // Grid width; Text is its prefix filter.
	DeleteAction   string
}

type Choice struct {
	ID, Label, Unavailable string
	Literal                bool // User/dictionary data must not be translated.
}

type Tab struct {
	ID, Label string
	Controls  []Control
}

type FormType string

const TabForm FormType = "tab_form"

type Form struct {
	Type  FormType
	Title string
	Tabs  []Tab
}

type Key struct {
	Name                    string
	Text                    string
	Shift, Ctrl, Alt, AltGr bool
	Repeat                  bool
}

type Result struct {
	Speech    string
	Action    string
	Cancelled bool
}