Welcome to the Guitares documentation!

Guitares is a Python package for building configurable Graphical User Interfaces (GUIs) using PySide6. GUI layouts are defined in YAML configuration files rather than code, keeping application logic cleanly separated from the interface description.

A Guitares GUI consists of a main window (with optional drop-down menu) that contains one or more UI elements. The following elements are currently supported:

• Tab panels

• Frames (panels)

• Edit boxes

• Spin boxes

• Text labels

• Pop-up menus (dropdowns)

• List boxes

• Check boxes

• Radio button groups

• Sliders

• Push buttons

• Date/time edit boxes

• Table views

• File/directory chooser buttons

• Web views

• Map (MapLibre GL or Mapbox GL)

Check out the Getting started section for installation instructions and a quick-start guide.

Note

This project is under active development.

Contents

• Getting started
  • Prerequisites
  • Installation
  • Verifying the installation
  • Project structure
  • Map engine
• A Very Simple Example
  • The configuration file (hello.yml)
  • The app module (app.py)
  • The callback module (callbacks.py)
  • The run module (hello.py)
• Configuration
  • Window properties
  • Elements list
  • Menu
  • Splitting config across files
  • Common element keys
• Positioning elements
  • Coordinate system
  • Absolute vs. relative coordinates
  • Examples
  • High-DPI screens
• Elements
  • Edit box
  • Spin box
  • Text
  • Push button
  • Pop-up menu
  • List box
  • Check box
  • Radio button group
  • Slider
  • Date/time edit
  • Table view (read-only)
  • Table (editable)
  • File/directory chooser buttons
  • Web view
  • Frame (panel)
  • Tab panel
  • Map
• Variables
  • Variable groups
  • Setting variables
  • Getting variables
  • Variable types
  • Linking variables to elements
  • Dynamic labels and tooltips
• Callbacks
  • Defining callbacks
  • Callback signature
  • Reading and writing variables inside a callback
  • Callback modules
  • Dot-notation for class methods
  • Slider callbacks
• Element dependencies
  • Basic structure
  • Dependency keys
  • Check keys
  • Actions
  • checkfor logic
  • Examples
  • Multiple dependency rules
• Using tab panels
  • Basic structure
  • Tab keys
  • Loading elements from external files
  • Tab dependencies
  • Nested tab panels
• Menu
  • Basic structure
  • Menu keys
  • Nested sub-menus
  • Per-menu callback modules
  • Menu callbacks
  • Checkable menu items
• The Map Widget
  • Adding the map widget
  • Accessing the map object
  • Map navigation methods
  • Layer system
  • Map event callbacks
  • Using Mapbox
• Popup windows
  • Creating a popup config
  • Opening a popup from a callback
  • The popup callback module
  • Popup data flow
• Dialogs
  • Message dialogs
  • Timed dialogs
  • Progress dialogs
  • Input dialogs
  • File and directory dialogs
• Edit Mode
  • Activating edit mode
  • Keyboard shortcuts
  • Moving and resizing widgets
  • Editing widget properties
  • Adding new elements
  • Saving changes
  • Coordinate system
  • Limitations
• Using Style Sheets
  • Applying a stylesheet
  • Example stylesheet
  • Widget selectors
  • Using ID and class selectors
  • Further reading
• The GUI Object
  • Creating the GUI object
  • Building and running
  • Variable methods
  • Window methods
  • Popup windows
  • Map access
  • Resize factor
• More examples
  • Hello World
  • Simple Calculator
  • Checkbox
  • Listboxes
  • Pop-up menus
  • Radio buttons
  • Table view
  • Menu
  • Popup window
  • Frame collapse
  • News Website Comparison
  • MapLibre map
  • Visual Delta