Base UI Elements Usage Guide

Introduction

This document provides an overview of the base UI elements available in the Garnet framework and how to use them effectively in your views. These base classes provide customized widgets with added functionality for common UI elements. These classes are designed to be used as base classes for your custom UI elements, allowing you to easily add validation and styling consistant with the rest of the application.

Required Fields

The base UI elements provide a required parameter that can be set to True or False. When set to True, the field will be marked as required and will be styled differently. The required parameter is set to False by default. It is up to the developer to determine if a field is required or not. If a field is required it should also be validated before the form is submitted.

Invalid Fields

The base UI elements provide a set_invalid_style() method that can be used to mark the field as invalid. This method will change the style of the field to indicate that it is invalid. The reset_style() method can be used to reset the style to its default. If a field is invalid it should also be validated before the form is submitted. Invalid fields should also include a message to the user explaining why the field is invalid.

BaseLineEdit

The BaseLineEdit class provides a customized QLineEdit.

Usage:

Import the BaseLineEdit class:

from garnet.helpers.ui_elements.base_lineedit import BaseLineEdit

Create an instance of BaseLineEdit:

base_line_edit = BaseLineEdit(required=True)

Use the set_invalid_style() method to mark the field as invalid:
```
base_line_edit.set_invalid_style()
```
Use the reset_style() method to reset the style to its default:
```
base_line_edit.reset_style()
```

BaseListWidget

The BaseListWidget class provides a customized QListWidget.

Usage:

Import the BaseListWidget class:

from garnet.helpers.ui_elements.base_listwidget import BaseListWidget

Create an instance of BaseListWidget:

base_list_widget = BaseListWidget(required=True)

Use the set_invalid_style() method to mark the list widget as invalid:
```
base_list_widget.set_invalid_style()
```

Use the setSelectionMode() method to set the selection mode:

# Can be set by using the enum value or the integer value
base_list_widget.setSelectionMode(BaseListWidget.MultiSelection)
base_list_widget.setSelectionMode(0)

BaseTableWidget

The BaseTableWidget class provides a customized QTableWidget.

Usage:

Import the BaseTableWidget class:

from garnet.helpers.ui_elements.base_tablewidget import BaseTableWidget

Create an instance of BaseTableWidget:

base_table_widget = BaseTableWidget(required=True)

Use the set_invalid_style() method to mark the table widget as invalid:
```
base_table_widget.set_invalid_style()
```
Use the setColumnCount() and setRowCount() methods to define the table dimensions:
```
base_table_widget.setColumnCount(3)
base_table_widget.setRowCount(3)
```

BaseCheckBox

The BaseCheckBox class provides a customized QCheckBox. Usage:

Import the BaseCheckBox class:

from garnet.helpers.ui_elements.base_checkbox import BaseCheckBox

Create an instance of BaseCheckBox:

base_checkbox = BaseCheckBox(required=True)

Use the set_invalid_style() method to mark the checkbox as invalid:
```
base_checkbox.set_invalid_style()
```