StreamController/GtkHelper/GtkHelper.py at main · SithTech/StreamController · GitHub

History

499 lines (391 loc) · 16.9 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

"""

Author: Core447

Year: 2023

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

any later version.

This programm comes with ABSOLUTELY NO WARRANTY!

You should have received a copy of the GNU General Public License

along with this program. If not, see <https://www.gnu.org/licenses/>.

"""

from typing_extensions import deprecated

# Import gtk modules

import gi

from src.backend.DeckManagement.HelperMethods import open_web

gi.require_version("Gtk", "4.0")

gi.require_version("Adw", "1")

from gi.repository import Gtk, Adw, Gdk, GLib

# Import Python modules

from loguru import logger as log

import webbrowser as web

# Import globals

import globals as gl

# Helper Functions

def get_focused_widgets(start: Gtk.Widget) -> list[Gtk.Widget]:

widgets = []

while True:

child = start.get_focus_child()

if child is None:

return widgets

widgets.append(child)

start = child

def get_deepest_focused_widget(start: Gtk.Widget) -> Gtk.Widget:

return get_focused_widgets(start)[-1]

def get_deepest_focused_widget_with_attr(start: Gtk.Widget, attr:str) -> Gtk.Widget:

for widget in reversed(get_focused_widgets(start)):

if hasattr(widget, attr):

return widget

def better_disconnect(widget: Gtk.Widget, handler: callable):

try:

widget.disconnect_by_func(handler)

except Exception:

pass

def better_unparent(widget: Gtk.Widget):

if widget.get_parent() is not None:

widget.unparent()

# Helper Classes

class BetterExpander(Adw.ExpanderRow):

def __init__(self, *args, **kwargs):

super().__init__(*args, **kwargs)

def set_sort_func(self, *args, **kwargs):

revealer_list_box = self.get_list_box()

revealer_list_box.set_sort_func(*args, **kwargs)

def set_filter_func(self, *args, **kwargs):

revealer_list_box = self.get_list_box()

revealer_list_box.set_filter_func(*args, **kwargs)

def invalidate_filter(self):

list_box = self.get_list_box()

list_box.invalidate_filter()

def invalidate_sort(self):

list_box = self.get_list_box()

list_box.invalidate_sort()

def get_rows(self):

revealer_list_box = self.get_list_box()

if revealer_list_box is None:

return

rows = []

child = revealer_list_box.get_first_child()

while child is not None:

rows.append(child)

child = child.get_next_sibling()

return rows

def get_list_box(self) -> Gtk.ListBox:

expander_box = self.get_first_child()

if expander_box is None:

return

expander_list_box = expander_box.get_first_child()

if expander_list_box is None:

return

revealer = expander_list_box.get_next_sibling()

revealer_list_box = revealer.get_first_child()

return revealer_list_box

def clear(self):

rows = self.get_rows()

list_box = self.get_list_box()

list_box.remove_all()

for row in rows:

row = None

del row

del rows

def reorder_child_after(self, child, after):

childs = self.get_rows()

after_index = childs.index(after)

if after_index is None:

log.warning("After child could not be found. Please add it first")

return

# Remove child from list

childs.remove(child)

# Add child in new position

childs.insert(after_index, child)

# Remove all childs

self.clear()

# Add all childs in new order

for child in childs:

self.add_row(child)

def remove_child(self, child:Gtk.Widget) -> None:

self.get_list_box().remove(child)

def get_index_of_child(self, child):

for i, action in enumerate(self.actions):

if action == child:

return i

raise ValueError("Child not found")

def get_arrow_image(self) -> Gtk.Image:

box: Gtk.Box = self.get_child()

list_box: Gtk.ListBox = box.get_first_child()

adw_action_row: Adw.ActionRow = list_box.get_first_child()

box: Gtk.Box = adw_action_row.get_child()

box: Gtk.Box = box.get_last_child()

image: Gtk.Image = box.get_last_child()

return image

class BetterPreferencesGroup(Adw.PreferencesGroup):

def __init__(self, *args, **kwargs):

super().__init__(*args, **kwargs)

def clear(self):

list_box = self.get_list_box()

list_box.remove_all()

def set_sort_func(self, *args, **kwargs):

list_box = self.get_list_box()

list_box.set_sort_func(*args, **kwargs)

def set_filter_func(self, *args, **kwargs):

list_box = self.get_list_box()

list_box.set_filter_func(*args, **kwargs)

def invalidate_filter(self):

list_box = self.get_list_box()

list_box.invalidate_filter()

def invalidate_sort(self):

list_box = self.get_list_box()

list_box.invalidate_sort()

def get_rows(self):

list_box = self.get_list_box()

if list_box is None:

return

rows = []

child = list_box.get_first_child()

while child is not None:

rows.append(child)

child = child.get_next_sibling()

return rows

def get_list_box(self):

first_box = self.get_first_child()

second_box = first_box.get_first_child()

third_box = second_box.get_next_sibling()

list_box = third_box.get_first_child()

return list_box

class AttributeRow(Adw.PreferencesRow):

def __init__(self, title:str, attr:str, *args, **kwargs):

super().__init__(*args, **kwargs)

self.title = title

self.attr_str = attr

self.build()

def build(self):

self.main_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, hexpand=True,

margin_top=15, margin_bottom=15)

self.set_child(self.main_box)

self.title_label = Gtk.Label(label=self.title, xalign=0, hexpand=True, margin_start=15)

self.main_box.append(self.title_label)

self.attribute_label = Gtk.Label(label=self.attr_str, halign=0, margin_end=15)

self.main_box.append(self.attribute_label)

def set_title(self, title:str):

self.title_label.set_label(title)

def set_url(self, attr:str):

if attr is None:

attr = "N/A"

self.attribute_label.set_label(attr)

class EntryDialog(Gtk.ApplicationWindow):

def __init__(self, parent_window, dialog_title:str, entry_heading:str = "Name:", default_text:str = None, confirm_label:str = "OK", forbid_answers:list[str] = [],

empty_warning:str = "The name cannot be empty", cancel_label:str = "Cancel", already_exists_warning:str = "This name already exists",

placeholder:str = None):

self.default_text = default_text

self.confirm_label = confirm_label

self.entry_heading = entry_heading

self.forbid_answers = forbid_answers

self.empty_warning = empty_warning

self.cancel_label = cancel_label

self.placeholder_text = placeholder

self.already_exists_warning = already_exists_warning

super().__init__(transient_for=parent_window, modal=True, default_height=150, default_width=350, title = dialog_title)

self.callback_func = None

self.build()

def build(self):

# Create title bar

self.title_bar = Gtk.HeaderBar(show_title_buttons=False, css_classes=["flat"])

# Cancel button

self.cancel_button = Gtk.Button(label=self.cancel_label)

self.cancel_button.connect('clicked', self.on_cancel)

# Confirm button

self.confirm_button = Gtk.Button(label=self.confirm_label, css_classes=['confirm-button'], sensitive=False)

self.confirm_button.connect('clicked', self.on_confirm)

# Main box

self.main_box = Gtk.Box(orientation=Gtk.Orientation.VERTICAL, hexpand=True, vexpand=True, margin_start=20, margin_end=20, margin_top=20, margin_bottom=20)

# Label

self.label = Gtk.Label(label=self.entry_heading)

# Input box

self.input_box = Gtk.Entry(hexpand=True, margin_top=10, text=self.default_text, placeholder_text=self.placeholder_text)

self.input_box.connect('changed', self.on_name_change)

# Warning label

self.warning_label = Gtk.Label(label=self.empty_warning, css_classes=['warning-label'], margin_top=10)

# Add objects

self.set_titlebar(self.title_bar)

self.title_bar.pack_start(self.cancel_button)

self.title_bar.pack_end(self.confirm_button)

self.set_child(self.main_box)

self.main_box.append(self.label)

self.main_box.append(self.input_box)

self.main_box.append(self.warning_label)

# Set status

self.on_name_change(self.input_box)

# Trigger on_confirm on return press

self.input_box.connect("activate", self.on_confirm)

def on_cancel(self, button):

self.destroy()

def on_name_change(self, entry):

if entry.get_text() == '':

self.set_dialog_status(0)

elif entry.get_text() not in self.forbid_answers:

self.set_dialog_status(2)

else:

self.set_dialog_status(1)

def set_dialog_status(self, status):

"""

Sets the status of the dialog

Args:

status (int): The status of the dialog: 0: no name; 1:already in use; 2:ok

"""

if status == 0:

# Label

if self.main_box.get_last_child() is not self.warning_label:

self.main_box.append(self.warning_label)

self.warning_label.set_text(self.empty_warning)

# Button

self.confirm_button.set_sensitive(False)

self.confirm_button.set_css_classes(['confirm-button'])

if status == 1:

# Label

if self.main_box.get_last_child() is not self.warning_label:

self.main_box.append(self.warning_label)

self.warning_label.set_text(self.already_exists_warning)

# Button

self.confirm_button.set_sensitive(False)

self.confirm_button.set_css_classes(['confirm-button-error'])

if status == 2:

# Label

if self.main_box.get_last_child() is self.warning_label:

self.main_box.remove(self.warning_label)

# Button

self.confirm_button.set_sensitive(True)

self.confirm_button.set_css_classes(['confirm-button'])

def show(self, callback_func):

self.callback_func = callback_func

self.present()

def on_confirm(self, button):

self.callback_func(self.input_box.get_text())

self.destroy()

class ErrorPage(Gtk.Box):

def __init__(self, reload_func: callable = None,

error_text:str = "Error",

reload_args = []):

super().__init__(orientation=Gtk.Orientation.VERTICAL,

halign=Gtk.Align.CENTER,

valign=Gtk.Align.CENTER)

self.reload_func = reload_func

self.error_text = error_text

self.reload_args = reload_args

self.build()

def build(self):

self.error_label = Gtk.Label(label=self.error_text)

self.append(self.error_label)

self.retry_button = Gtk.Button(label="Retry")

self.retry_button.connect("clicked", self.on_retry_button_click)

if callable(self.reload_func):

self.append(self.retry_button)

def on_retry_button_click(self, button):

self.reload_func(*self.reload_args)

def set_error_text(self, error_text):

self.error_label.set_text(error_text)

def set_reload_func(self, reload_func):

if callable(self.reload_func):

if callable(reload_func):

self.reload_func = reload_func

else:

self.remove(self.retry_button)

else:

self.append(self.retry_button)

self.reload_func = reload_func

def set_reload_args(self, reload_args):

self.reload_args = reload_args

class OriginalURL(Adw.ActionRow):

def __init__(self):

super().__init__(title="Original URL:", subtitle="N/A")

self.set_activatable(False)

self.suffix_box = Gtk.Box(valign=Gtk.Align.CENTER)

self.add_suffix(self.suffix_box)

self.open_button = Gtk.Button(icon_name="web-browser-symbolic")

self.open_button.connect("clicked", self.on_open_clicked)

self.suffix_box.append(self.open_button)

def set_url(self, url:str):

if url is None:

self.set_subtitle("N/A")

self.open_button.set_sensitive(False)

return

self.set_subtitle(url)

self.open_button.set_sensitive(True)

def on_open_clicked(self, button:Gtk.Button):

if self.get_subtitle() in [None, "N/A", ""]:

return

open_web(self.get_subtitle())

class EntryRowWithoutTitle(Adw.EntryRow):

def __init__(self, *args, **kwargs):

super().__init__(*args, **kwargs)

# Make title invisible

child:Gtk.Box = self.get_child() # Box

prefix_box:Gtk.Box = child.get_first_child()

gizmo = prefix_box.get_next_sibling()

empty_title = gizmo.get_first_child()

title = empty_title.get_next_sibling()

empty_title.set_visible(False)

title.set_visible(False)

class BackButton(Gtk.Button):

def __init__(self, *args, **kwargs):

super().__init__(*args, **kwargs)

self.box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL, spacing=6)

self.set_child(self.box)

self.box.append(Gtk.Image(icon_name="go-previous-symbolic"))

self.box.append(Gtk.Label(label=gl.lm.get("go-back")))

class RevertButton(Gtk.Button):

def __init__(self, **kwargs):

super().__init__(icon_name="edit-undo-symbolic", **kwargs)

self.set_tooltip_text("Revert to action defaults")

class LoadingScreen(Gtk.Box):

def __init__(self):

super().__init__(orientation=Gtk.Orientation.VERTICAL, hexpand=True, vexpand=True,

valign=Gtk.Align.CENTER, halign=Gtk.Align.CENTER)

self.spinner = Gtk.Spinner(spinning=False)

self.append(self.spinner)

self.loading_label = Gtk.Label(label="Loading")

self.append(self.loading_label)

self.progress_bar = Gtk.ProgressBar(margin_top=20, show_text=True, text="", visible=False)

self.append(self.progress_bar)

def set_spinning(self, loading: bool):

if loading:

GLib.idle_add(self.spinner.start)

else:

GLib.idle_add(self.spinner.stop)

@deprecated("This has been deprecated in favor of GtkHelper.ComboRow.ComboRow.")

class ComboRow(Adw.PreferencesRow):

def __init__(self, title, model: Gtk.ListStore, **kwargs):

super().__init__(title=title, **kwargs)

self.model = model

self.main_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL,

margin_start=10, margin_end=10,

margin_top=10, margin_bottom=10)

self.set_child(self.main_box)

self.label = Gtk.Label(label=title, hexpand=True, xalign=0)

self.main_box.append(self.label)

self.combo_box = Gtk.ComboBox.new_with_model(self.model)

self.main_box.append(self.combo_box)

@deprecated("This has been deprecated in favor of GtkHelper.ScaleRow.ScaleRow.")

class ScaleRow(Adw.PreferencesRow):

def __init__(self, title, value: float, min: float, max: float, step: float, text_right: str = "", text_left: str = "", **kwargs):

super().__init__(title=title, **kwargs)

self.main_box = Gtk.Box(orientation=Gtk.Orientation.HORIZONTAL,

margin_start=10, margin_end=10,

margin_top=10, margin_bottom=10)

self.set_child(self.main_box)

self.label = Gtk.Label(label=title, hexpand=True, xalign=0)

self.main_box.append(self.label)

self.adjustment = Gtk.Adjustment.new(value, min, max, step, 1, 0)

self.scale = Gtk.Scale(orientation=Gtk.Orientation.HORIZONTAL, adjustment=self.adjustment)

self.scale.set_size_request(200, -1) # Adjust width as needed

self.scale.set_tooltip_text(str(value))

def correct_step_amount(adjustment):

value = adjustment.get_value()

step = adjustment.get_step_increment()

rounded_value = round(value / step) * step

adjustment.set_value(rounded_value)

self.adjustment.connect("value-changed", correct_step_amount)

self.label_right = Gtk.Label(label=text_right, hexpand=False, xalign=0)

self.label_left = Gtk.Label(label=text_left, hexpand=False, xalign=0)

self.main_box.append(self.label_left)

self.main_box.append(self.scale)

self.main_box.append(self.label_right)

StreamController/GtkHelper/GtkHelper.py at main · SithTech/StreamController · GitHub

Expand file tree

Breadcrumbs

GtkHelper.py

Latest commit

History

Breadcrumbs

GtkHelper.py

File metadata and controls