bauiv1lib.settings.testing

  1# Released under the MIT License. See LICENSE for details.
  2#
  3"""Provides UI for test settings."""
  4
  5from __future__ import annotations
  6
  7import copy
  8from typing import TYPE_CHECKING
  9
 10import bauiv1 as bui
 11
 12if TYPE_CHECKING:
 13    from typing import Any, Callable
 14
 15
 16class TestingWindow(bui.Window):
 17    """Window for conveniently testing various settings."""
 18
 19    def __init__(
 20        self,
 21        title: bui.Lstr,
 22        entries: list[dict[str, Any]],
 23        transition: str = 'in_right',
 24        back_call: Callable[[], bui.Window] | None = None,
 25    ):
 26        assert bui.app.classic is not None
 27        uiscale = bui.app.ui_v1.uiscale
 28        self._width = 600
 29        self._height = 324 if uiscale is bui.UIScale.SMALL else 400
 30        self._entries = copy.deepcopy(entries)
 31        self._back_call = back_call
 32        super().__init__(
 33            root_widget=bui.containerwidget(
 34                size=(self._width, self._height),
 35                transition=transition,
 36                scale=(
 37                    2.5
 38                    if uiscale is bui.UIScale.SMALL
 39                    else 1.2
 40                    if uiscale is bui.UIScale.MEDIUM
 41                    else 1.0
 42                ),
 43                stack_offset=(0, -28)
 44                if uiscale is bui.UIScale.SMALL
 45                else (0, 0),
 46            )
 47        )
 48        self._back_button = btn = bui.buttonwidget(
 49            parent=self._root_widget,
 50            autoselect=True,
 51            position=(65, self._height - 59),
 52            size=(130, 60),
 53            scale=0.8,
 54            text_scale=1.2,
 55            label=bui.Lstr(resource='backText'),
 56            button_type='back',
 57            on_activate_call=self._do_back,
 58        )
 59        bui.textwidget(
 60            parent=self._root_widget,
 61            position=(self._width * 0.5, self._height - 35),
 62            size=(0, 0),
 63            color=bui.app.ui_v1.title_color,
 64            h_align='center',
 65            v_align='center',
 66            maxwidth=245,
 67            text=title,
 68        )
 69
 70        bui.buttonwidget(
 71            edit=self._back_button,
 72            button_type='backSmall',
 73            size=(60, 60),
 74            label=bui.charstr(bui.SpecialChar.BACK),
 75        )
 76
 77        bui.textwidget(
 78            parent=self._root_widget,
 79            position=(self._width * 0.5, self._height - 75),
 80            size=(0, 0),
 81            color=bui.app.ui_v1.infotextcolor,
 82            h_align='center',
 83            v_align='center',
 84            maxwidth=self._width * 0.75,
 85            text=bui.Lstr(resource='settingsWindowAdvanced.forTestingText'),
 86        )
 87        bui.containerwidget(edit=self._root_widget, cancel_button=btn)
 88        self._scroll_width = self._width - 130
 89        self._scroll_height = self._height - 140
 90        self._scrollwidget = bui.scrollwidget(
 91            parent=self._root_widget,
 92            size=(self._scroll_width, self._scroll_height),
 93            highlight=False,
 94            position=((self._width - self._scroll_width) * 0.5, 40),
 95        )
 96        bui.containerwidget(edit=self._scrollwidget, claims_left_right=True)
 97
 98        self._spacing = 50
 99
100        self._sub_width = self._scroll_width * 0.95
101        self._sub_height = 50 + len(self._entries) * self._spacing + 60
102        self._subcontainer = bui.containerwidget(
103            parent=self._scrollwidget,
104            size=(self._sub_width, self._sub_height),
105            background=False,
106        )
107
108        h = 230
109        v = self._sub_height - 48
110
111        for i, entry in enumerate(self._entries):
112            entry_name = entry['name']
113
114            # If we haven't yet, record the default value for this name so
115            # we can reset if we want..
116            if entry_name not in bui.app.classic.value_test_defaults:
117                bui.app.classic.value_test_defaults[
118                    entry_name
119                ] = bui.app.classic.value_test(entry_name)
120
121            bui.textwidget(
122                parent=self._subcontainer,
123                position=(h, v),
124                size=(0, 0),
125                h_align='right',
126                v_align='center',
127                maxwidth=200,
128                text=entry['label'],
129            )
130            btn = bui.buttonwidget(
131                parent=self._subcontainer,
132                position=(h + 20, v - 19),
133                size=(40, 40),
134                autoselect=True,
135                repeat=True,
136                left_widget=self._back_button,
137                button_type='square',
138                label='-',
139                on_activate_call=bui.Call(self._on_minus_press, entry['name']),
140            )
141            if i == 0:
142                bui.widget(edit=btn, up_widget=self._back_button)
143            # pylint: disable=consider-using-f-string
144            entry['widget'] = bui.textwidget(
145                parent=self._subcontainer,
146                position=(h + 100, v),
147                size=(0, 0),
148                h_align='center',
149                v_align='center',
150                maxwidth=60,
151                text='%.4g' % bui.app.classic.value_test(entry_name),
152            )
153            btn = bui.buttonwidget(
154                parent=self._subcontainer,
155                position=(h + 140, v - 19),
156                size=(40, 40),
157                autoselect=True,
158                repeat=True,
159                button_type='square',
160                label='+',
161                on_activate_call=bui.Call(self._on_plus_press, entry['name']),
162            )
163            if i == 0:
164                bui.widget(edit=btn, up_widget=self._back_button)
165            v -= self._spacing
166        v -= 35
167        bui.buttonwidget(
168            parent=self._subcontainer,
169            autoselect=True,
170            size=(200, 50),
171            position=(self._sub_width * 0.5 - 100, v),
172            label=bui.Lstr(resource='settingsWindowAdvanced.resetText'),
173            right_widget=btn,
174            on_activate_call=self._on_reset_press,
175        )
176
177    def _get_entry(self, name: str) -> dict[str, Any]:
178        for entry in self._entries:
179            if entry['name'] == name:
180                return entry
181        raise bui.NotFoundError(f'Entry not found: {name}')
182
183    def _on_reset_press(self) -> None:
184        assert bui.app.classic is not None
185        for entry in self._entries:
186            bui.app.classic.value_test(
187                entry['name'],
188                absolute=bui.app.classic.value_test_defaults[entry['name']],
189            )
190            # pylint: disable=consider-using-f-string
191            bui.textwidget(
192                edit=entry['widget'],
193                text='%.4g' % bui.app.classic.value_test(entry['name']),
194            )
195
196    def _on_minus_press(self, entry_name: str) -> None:
197        assert bui.app.classic is not None
198        entry = self._get_entry(entry_name)
199        bui.app.classic.value_test(entry['name'], change=-entry['increment'])
200        # pylint: disable=consider-using-f-string
201        bui.textwidget(
202            edit=entry['widget'],
203            text='%.4g' % bui.app.classic.value_test(entry['name']),
204        )
205
206    def _on_plus_press(self, entry_name: str) -> None:
207        assert bui.app.classic is not None
208        entry = self._get_entry(entry_name)
209        bui.app.classic.value_test(entry['name'], change=entry['increment'])
210        # pylint: disable=consider-using-f-string
211        bui.textwidget(
212            edit=entry['widget'],
213            text='%.4g' % bui.app.classic.value_test(entry['name']),
214        )
215
216    def _do_back(self) -> None:
217        # pylint: disable=cyclic-import
218        from bauiv1lib.settings.advanced import AdvancedSettingsWindow
219
220        bui.containerwidget(edit=self._root_widget, transition='out_right')
221        backwin = (
222            self._back_call()
223            if self._back_call is not None
224            else AdvancedSettingsWindow(transition='in_left')
225        )
226        assert bui.app.classic is not None
227        bui.app.ui_v1.set_main_menu_window(backwin.get_root_widget())