docs: port to PyQt6

Author: bgermann

docs/src/gui/filter-programs.adoc

@@ -92,7 +92,7 @@ for i in range(0,100):
 ----
 
 Here is a similar program but it actually could filter.
-It puts up a PyQt5 dialog with a cancel button.
+It puts up a PyQt6 dialog with a cancel button.
 Then it reads the program line by line and passes it to standard output.
 As it goes along, it updates any process listening to standard error output.
 
@@ -104,9 +104,9 @@ import sys
 import os
 import time
 
-from PyQt5.QtWidgets import (QApplication, QDialog, QDialogButtonBox,
+from PyQt6.QtWidgets import (QApplication, QDialog, QDialogButtonBox,
                             QVBoxLayout,QDialogButtonBox)
-from PyQt5.QtCore import QTimer, Qt
+from PyQt6.QtCore import QTimer, Qt
 
 class CustomDialog(QDialog):
 

docs/src/gui/qtdragon.adoc

@@ -1522,9 +1522,9 @@ It will be referred to as `_xx` in this document, so `qtdragon_xx.ts` in this do
 
 The default locale for QtDragon is `_en` which means that any translation files created as `qtdragon_en.*` will not be used for translations.
 
-If any of the required utilities (pyuic5, pylupdate5, linguist) are not installed then the user will need to install the required development tools:
+If any of the required utilities (pyuic6, pylupdate6, linguist) are not installed then the user will need to install the required development tools:
 ----
-sudo apt install qttools5-dev-tools pyqt5-dev-tools
+sudo apt install qt6-tools-dev-tools pyqt6-dev-tools
 ----
 
 Change to the languages directory:
@@ -1534,7 +1534,7 @@ cd ~/linuxcnc-dev/share/qtvcp/screens/qtdragon/languages
 
 If any text changes have been made to the GUI then run the following to update the GUI Python file:
 ----
-pyuic5 ../qtdragon.ui > qtdragon.py
+pyuic6 ../qtdragon.ui > qtdragon.py
 ----
 
 The user can either create a new translation source file for a non-existing language translation
@@ -1547,7 +1547,7 @@ Create or edit a .ts file:
 ----
 
 [NOTE]
-this command is a script which runs the following: $ pylupdate5 *.py ../*.py ../../../../../lib/python/qtvcp/lib/qtdragon/*.py -ts qtdragon_xx.ts
+this command is a script which runs the following: $ pylupdate6 *.py ../*.py ../../../../../lib/python/qtvcp/lib/qtdragon/*.py -ts qtdragon_xx.ts
 
 The editing of the translation is done with the linguist application:
 ----

docs/src/gui/qtvcp-code-snippets.adoc

@@ -563,8 +563,8 @@ First we must import the libraries we need, if they're not already imported in t
 # **** IMPORT SECTION **** #
 ############################
 
-from PyQt5 import QtWidgets
-from PyQt5.QtGui import QColor
+from PyQt6 import QtWidgets
+from PyQt6.QtGui import QColor
 from qtvcp.widgets.state_led import StateLED as LED
 from qtvcp.core import Status, Info
 ----
@@ -675,7 +675,7 @@ def make_corner_widgets(self):
 *`self.PREFS_`*:: the _instance of an optional preference file_
 *`self.SETTINGS_`*:: the `Qsettings` _object_
 
-<5> Initializes a PyQt5 `QProgressBar`.
+<5> Initializes a PyQt6 `QProgressBar`.
 <6> Sets the max range of the progress bar to the max specified in the `INI`.
 <7> We create a QWidget +
     Since you can only add one widget to the tab corner and we want two there, we must add both into a *container*.

docs/src/gui/qtvcp-custom-widgets.adoc

@@ -101,7 +101,7 @@ This is where we import libraries that our widget class needs.
 ###############################
 # Imports
 ###############################
-from PyQt5 import QtWidgets                     # <1>
+from PyQt6 import QtWidgets                     # <1>
 from qtvcp.widgets.widget_baseclass \
     import _HalWidgetBase, _HalSensitiveBase    # <2>
 import hal                                      # <3>
@@ -171,7 +171,7 @@ This LED indicator widget will respond to selectable LinuxCNC controller states.
 ###############################
 # Imports
 ###############################
-from PyQt5.QtCore import pyqtProperty
+from PyQt6.QtCore import pyqtProperty
 from qtvcp.widgets.led_widget import LED
 from qtvcp.core import Status
 
@@ -252,7 +252,7 @@ This is where we import libraries that our widget class needs.
 ###############################
 # Imports
 ###############################
-from PyQt5.QtCore import pyqtProperty       # <1>
+from PyQt6.QtCore import pyqtProperty       # <1>
 from qtvcp.widgets.led_widget import LED    # <2>
 from qtvcp.core import Status               # <3>
 ----
@@ -457,9 +457,9 @@ It changes:
 import os
 import hal
 
-from PyQt5.QtWidgets import QWidget, QToolButton, QMenu, QAction
-from PyQt5.QtCore import Qt, QEvent, pyqtProperty, QBasicTimer, pyqtSignal
-from PyQt5.QtGui import QIcon
+from PyQt6.QtWidgets import QWidget, QToolButton, QMenu, QAction
+from PyQt6.QtCore import Qt, QEvent, pyqtProperty, QBasicTimer, pyqtSignal
+from PyQt6.QtGui import QIcon
 
 from qtvcp.widgets.widget_baseclass import _HalWidgetBase
 from qtvcp.widgets.dialog_widget import EntryDialog
@@ -659,8 +659,8 @@ Then `qtvcp/plugins/qtvcp_plugin.py` would need to be adjusted to _import_ them.
 ----
 #!/usr/bin/env python3
 
-from PyQt5 import QtCore, QtGui
-from PyQt5.QtDesigner import QPyDesignerCustomWidgetPlugin
+from PyQt6 import QtCore, QtGui
+from PyQt6.QtDesigner import QPyDesignerCustomWidgetPlugin
 from qtvcp.widgets.simple_widgets import Lcnc_GridLayout
 from qtvcp.widgets.qtvcp_icons import Icon
 ICON = Icon()
@@ -704,8 +704,8 @@ class LcncGridLayoutPlugin(QPyDesignerCustomWidgetPlugin):
 ----
 #!/usr/bin/env python3
 
-from PyQt5 import QtCore, QtGui
-from PyQt5.QtDesigner import QPyDesignerCustomWidgetPlugin
+from PyQt6 import QtCore, QtGui
+from PyQt6.QtDesigner import QPyDesignerCustomWidgetPlugin
 from qtvcp.widgets.system_tool_button import SystemToolButton
 from qtvcp.widgets.qtvcp_icons import Icon
 ICON = Icon()
@@ -756,8 +756,8 @@ This is the plugin used for _action buttons_.
 #!/usr/bin/env python3
 
 import sip
-from PyQt5 import QtCore, QtGui, QtWidgets
-from PyQt5.QtDesigner import QPyDesignerCustomWidgetPlugin, \
+from PyQt6 import QtCore, QtGui, QtWidgets
+from PyQt6.QtDesigner import QPyDesignerCustomWidgetPlugin, \
                 QPyDesignerTaskMenuExtension, QExtensionFactory, \
                 QDesignerFormWindowInterface, QPyDesignerMemberSheetExtension
 from qtvcp.widgets.action_button import ActionButton

docs/src/gui/qtvcp-vcp-panels.adoc

@@ -509,7 +509,7 @@ Here is a sample to change the circle color in cam_align: +
 import sys
 import os
 import importlib
-from PyQt5.QtCore import Qt
+from PyQt6.QtCore import Qt
 from qtvcp.core import Path
 
 PATH = Path()

docs/src/gui/qtvcp-vismach.adoc

@@ -585,7 +585,7 @@ part1 = Translate([dogs],-1,49,0)
 # create a top-level model
 model = Collection([base, saddle, head, carousel])
 
-# we want to either embed into qtvcp or display directly with PyQt5
+# we want to either embed into qtvcp or display directly with PyQt6
 # so build a window to display the model
 
 class Window(QWidget):
@@ -624,7 +624,7 @@ class Window(QWidget):
         mainLayout.addWidget(self.glWidget)
         self.setLayout(mainLayout)
 
-# if you call this file directly from python3, it will display a PyQt5 window
+# if you call this file directly from python3, it will display a PyQt6 window
 # good for confirming the parts of the assembly.
 
 if __name__ == '__main__':

docs/src/gui/qtvcp-widgets.adoc

@@ -2903,7 +2903,7 @@ def _releasedOutput(self, btncode):
     self['joy_{}_pressed'.format(btncode.lower())].emit(False)
 ----
 
-As coded these function _issue (emit) PyQt5 signals (joy_btn_pressed and joy_<letter>_pressed) for the any button pressed or released_.
+As coded these function _issue (emit) PyQt6 signals (joy_btn_pressed and joy_<letter>_pressed) for the any button pressed or released_.
 
 Signal 'joy_btn_pressed' outputs a string code for the button. +
 Signal 'joy_<letter>_pressed' outputs a bool value.

docs/src/gui/qtvcp.adoc

@@ -57,17 +57,17 @@ Normally QtVCP uses the stock UI and handler file, but you can specify QtVCP to
 A *'local' file* is one that is in the _configuration folder_ that defines the rest of the machine's requirements.
 
 One is not restricted to adding a custom panel on the right or a custom tab as QtVCP leverages _Qt Designer_ (the editor)
-and _PyQt5_ (the widget toolkit).
+and _PyQt6_ (the widget toolkit).
 
 QtVCP has some added *special LinuxCNC widgets and actions*. +
 There are special widgets to bridge third party widgets to HAL pins. +
 It's possible to create widget responses by connecting signals to Python code in the handler file.
 
 === QtVCP Widgets
 
-QtVCP uses the *PyQt5 toolkit's widgets* for LinuxCNC integration.
+QtVCP uses the *PyQt6 toolkit's widgets* for LinuxCNC integration.
 
-*Widget* is the _general name for user interface objects_ such as buttons and labels in PyQt5.
+*Widget* is the _general name for user interface objects_ such as buttons and labels in PyQt6.
 
 You are free to use any available *default widgets* in the Qt Designer editor.
 
@@ -145,7 +145,7 @@ If the update time is not set right the screen can become unresponsive or very j
 
 A Qt Designer file is a text file organized in the _XML_ standard that describes the *layout and widgets* of the screen.
 
-_PyQt5_ uses this file to build the display and react to those widgets.
+_PyQt6_ uses this file to build the display and react to those widgets.
 
 The Qt Designer editor makes it relatively easy to build and edit this file.
 
@@ -525,7 +525,7 @@ First you must have the *Qt Designer installed*. +
 The following commands should add it to your system, or use your package manager to do the same:
 
 ----
-sudo apt-get install qttools5-dev-tools qttools5-dev libpython3-dev
+sudo apt-get install pyqt6-dev-tools libpython3-dev
 ----
 
 ////
@@ -577,14 +577,14 @@ You may need to create the `plugins/python` folder.
 +
 ----
 . scripts/rip-environment   <1>
-designer -qt=5              <2>
+designer -qt=6              <2>
 ----
 
 * For a _package install_: +
   Open a terminal and type:
 +
 ----
-designer -qt=5
+designer -qt=6
 ----
 
 If all goes right, Qt Designer will launch and you will see the selectable LinuxCNC widgets on the left hand side.
@@ -734,7 +734,7 @@ import sys
 import os
 import linuxcnc
 
-from PyQt5 import QtCore, QtWidgets
+from PyQt6 import QtCore, QtWidgets
 
 from qtvcp.widgets.mdi_line import MDILine as MDI_WIDGET
 from qtvcp.widgets.gcode_editor import GcodeEditor as GCODE

docs/src/plasma/qtplasmac.adoc

@@ -4240,9 +4240,9 @@ It will be referred to as `_xx` in this document, so `qtplasmac_xx.ts` in this d
 
 The default locale for QtPlasmaC is `_en` which means that any translation files created as `qtplasmac_en.*` will not be used for translations.
 
-If any of the required utilities (pyuic5, pylupdate5, linguist) are not installed then the user will need to install the required development tools:
+If any of the required utilities (pyuic6, pylupdate6, linguist) are not installed then the user will need to install the required development tools:
 ----
-sudo apt install qttools5-dev-tools pyqt5-dev-tools
+sudo apt install qt6-tools-dev-tools pyqt6-dev-tools
 ----
 
 Change to the languages directory:
@@ -4252,7 +4252,7 @@ cd ~/linuxcnc-dev/share/qtvcp/screens/qtplasmac/languages
 
 If any text changes have been made to the GUI then run the following to update the GUI Python file:
 ----
-pyuic5 ../qtplasmac.ui > qtplasmac.py
+pyuic6 ../qtplasmac.ui > qtplasmac.py
 ----
 
 The user can either create a new translation source file for a non-existing language translation
@@ -4265,7 +4265,7 @@ Create or edit a .ts file:
 ----
 
 [NOTE]
-this command is a script which runs the following: $ pylupdate5 *.py ../*.py ../../../../../lib/python/qtvcp/lib/qtplasmac/*.py -ts qtplasmac_xx.ts
+this command is a script which runs the following: $ pylupdate6 *.py ../*.py ../../../../../lib/python/qtvcp/lib/qtplasmac/*.py -ts qtplasmac_xx.ts
 
 The editing of the translation is done with the linguist application:
 ----

docs/src/user/user-intro.adoc

@@ -139,15 +139,15 @@ TkLinuxCNC:: <<sec:tklinuxcnc-intro,TkLinuxCNC>>, another interface based on Tcl
 .TkLinuxCNC graphical interface
 image::images/tkemc.png["TkLinuxCNC graphical interface",align="center"]
 
-QtDragon:: <<cha:qtdragon-gui,QtDragon>>, a touch screen GUI based on QtVCP using the PyQt5 library.
+QtDragon:: <<cha:qtdragon-gui,QtDragon>>, a touch screen GUI based on QtVCP using the PyQt6 library.
 It comes in two versions 'QtDragon' and 'QtDragon_hd'.
 They are very similar in features but QtDragon_hd is made for larger monitors.
 
 [[fig:QtDragon-graphical-interface]]
 .QtDragon, a touch screen GUI based on QtVCP
 image::images/qtdragon.png["QtDragon, a touch screen GUI based on QtVCP",align="center"]
 
-QtPlasmaC:: <<cha:qtplasmac,QtPlasmaC>>, a touch screen plasma cutting GUI based on QtVCP using the PyQt5 library.
+QtPlasmaC:: <<cha:qtplasmac,QtPlasmaC>>, a touch screen plasma cutting GUI based on QtVCP using the PyQt6 library.
 It comes in three aspect ratios, 16:9, 4:3, and 9:16.
 
 [[fig:QtPlasmaC-graphical-interface]]
@@ -184,7 +184,7 @@ GladeVCP:: <<cha:glade-vcp,'GladeVCP'>>, a Glade-based virtual control panel tha
 .GladeVCP Example Embedded Into AXIS GUI
 image::../gui/images/axis-gladevcp.png["GladeVCP embedded into AXIS",align="center"]
 
-QtVCP:: <<cha:qtvcp,'QtVCP'>>, a PyQt5-based virtual control panel that can be added to most GUIs or run as a standalone panel.
+QtVCP:: <<cha:qtvcp,'QtVCP'>>, a PyQt6-based virtual control panel that can be added to most GUIs or run as a standalone panel.
   QtVCP has the advantage over PyVCP in that it is not limited to the display or control of HAL virtual signals,
   but can include other external interfaces outside LinuxCNC such as window or network events by extending with python code.
   QtVCP is also more flexible in how it may be configured to appear on the GUI with many special widgets: