Input Widgets

class qtpyvcp.widgets.input_widgets.jog_increment.JogIncrementWidget(parent=None, standalone=False)

class qtpyvcp.widgets.input_widgets.file_system.RemovableDeviceComboBox(parent=None)

ComboBox for choosing from a list of removable devices.

showEvent(self, e: QShowEvent)

class qtpyvcp.widgets.input_widgets.file_system.QtpyVCPQFileSystemModel

data(self, index: QModelIndex, role: int = Qt.ItemDataRole.DisplayRole) → Any

class qtpyvcp.widgets.input_widgets.file_system.FileSystemTable(parent=None)

showEvent(self, a0: QShowEvent)

openSelectedItem(index=None)

If ngc file, opens in LinuxCNC, if dir displays dir.

editSelectedFile()

Open the selected file in editor.

loadSelectedFile(index=None)

If ngc file, opens in LinuxCNC, if dir displays dir.

selectPrevious()

Select the previous item in the view.

selectNext()

Select the next item in the view.

rename()

renames the selected file or folder

newFile()

Create a new empty file

deleteItem()

Delete the selected item (either a file or folder).

setRootPath(root_path)

Sets the currently displayed path.

viewParentDirectory()

View the parent directory of the current view.

getSelection()

Returns list of selected indexes, or None.

class qtpyvcp.widgets.input_widgets.mdientry_widget.Validator

validate(self, a0: str, a1: int) → Tuple[QValidator.State, str, int]

class qtpyvcp.widgets.input_widgets.mdientry_widget.MDIEntry(parent=None)

MDI Entry

Input any valid g Code. Enter sends the g Code.

keyPressEvent(self, a0: QKeyEvent)

focusInEvent(self, a0: QFocusEvent)

initialize()

This method is called right before the main application starts.

terminate()

This method is called right before the main application ends.

class qtpyvcp.widgets.input_widgets.action_slider.ActionSlider(parent=None)

docstring for ActionSlider.

mouseDoubleClickEvent(self, a0: QMouseEvent)

mousePressEvent(self, ev: QMouseEvent)

mouseReleaseEvent(self, ev: QMouseEvent)

keyPressEvent(self, ev: QKeyEvent)

keyReleaseEvent(self, a0: QKeyEvent)

class qtpyvcp.widgets.input_widgets.offset_table.ItemDelegate(columns)

displayText(self, value: Any, locale: QLocale) → str

createEditor(self, parent: QWidget, option: QStyleOptionViewItem, index: QModelIndex) → QWidget

class qtpyvcp.widgets.input_widgets.offset_table.OffsetModel(parent=None)

headerData(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) → Any

columnCount(self, parent: QModelIndex = QModelIndex()) → int

rowCount(self, parent: QModelIndex = QModelIndex()) → int

flags(self, index: QModelIndex) → Qt.ItemFlags

data(self, index: QModelIndex, role: int = Qt.DisplayRole) → Any

setData(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) → bool

class qtpyvcp.widgets.input_widgets.offset_table.OffsetTable(parent=None)

deleteSelectedOffset()

Delete the currently selected item

clearOffsetTable(confirm=True)

Remove all items from the model

selectedRow()

Returns the row number of the currently selected row, or 0

DROLineEdit

class qtpyvcp.widgets.input_widgets.dro_line_edit.DROLineEdit(parent=None)

DRO that supports typing in desired position to set work coordinate offset.

updateValue(pos=None)

Update the displayed position.

keyPressEvent(self, a0: QKeyEvent)

class qtpyvcp.widgets.input_widgets.action_dial.ActionDial(parent=None)

docstring for ActionDial.

mousePressEvent(self, me: QMouseEvent)

mouseReleaseEvent(self, me: QMouseEvent)

keyPressEvent(self, ev: QKeyEvent)

keyReleaseEvent(self, a0: QKeyEvent)

class qtpyvcp.widgets.input_widgets.recent_file_combobox.RecentFileComboBox(parent=None)

class qtpyvcp.widgets.input_widgets.tool_table.ItemDelegate(columns)

displayText(self, value: Any, locale: QLocale) → str

createEditor(self, parent: QWidget, option: QStyleOptionViewItem, index: QModelIndex) → QWidget

class qtpyvcp.widgets.input_widgets.tool_table.ToolModel(parent=None)

headerData(self, section: int, orientation: Qt.Orientation, role: int = Qt.DisplayRole) → Any

columnCount(self, parent: QModelIndex = QModelIndex()) → int

rowCount(self, parent: QModelIndex = QModelIndex()) → int

flags(self, index: QModelIndex) → Qt.ItemFlags

data(self, index: QModelIndex, role: int = Qt.DisplayRole) → Any

setData(self, index: QModelIndex, value: Any, role: int = Qt.EditRole) → bool

toolDataFromRow(row)

Returns dictionary of tool data

class qtpyvcp.widgets.input_widgets.tool_table.ToolTable(parent=None)

deleteSelectedTool()

Delete the currently selected item

selectPrevious()

Select the previous item in the view.

selectNext()

Select the next item in the view.

clearToolTable(confirm=True)

Remove all items from the model

addTool()

Appends a new item to the model

loadSelectedTool()

Loads the currently selected tool

selectedRow()

Returns the row number of the currently selected row, or 0

GcodeTextEdit

QPlainTextEdit based G-code editor with syntax highlighting.

class qtpyvcp.widgets.input_widgets.gcode_text_edit.GcodeSyntaxHighlighter(document, font)

highlightBlock(text)

Apply syntax highlighting to the given block of text.

class qtpyvcp.widgets.input_widgets.gcode_text_edit.GcodeTextEdit(parent=None)

G-code Text Edit

QPlainTextEdit based G-code editor with syntax heightening.

keyPressEvent(self, e: QKeyEvent)

changeEvent(self, e: QEvent)

syntaxHighlightingOnOff(state)

Toggle syntax highlighting on/off

setPlainText(self, text: str)

EditorReadOnly(state)

Set to Read Only to disable editing

EditorReadWrite(state)

Set to Read Only to disable editing

contextMenuEvent(self, e: QContextMenuEvent)

resizeEvent(self, e: QResizeEvent)

class qtpyvcp.widgets.input_widgets.gcode_text_edit.NumberMargin(parent)

paintEvent(self, a0: QPaintEvent)

class qtpyvcp.widgets.input_widgets.gcode_editor.GcodeLexer(parent=None, standalone=False)

description(self, style: int) → str

defaultColor(self) → QColor

defaultColor(self, style: int) → QColor

styleText(self, start: int, end: int)

class qtpyvcp.widgets.input_widgets.gcode_editor.EditorBase(parent=None)

find_text_occurences(text)

Return byte positions of start and end of all ‘text’ occurences in the document

class qtpyvcp.widgets.input_widgets.gcode_editor.GcodeEditor(parent=None)

class qtpyvcp.widgets.input_widgets.gcode_editor.FindReplaceDialog(parent)

QtPyVCP MDI History Widget

This widget implements the following key elements: [1] A history display of MDI commands issued with the latest command at the top of the list and the oldest at the bottom of the list.

[2] A queue system of commands that have been entered but have not yet been executed. This allows the rapid entry of MDI commands to be executed without having to wait for any running commands to complete.

Todo

• add/test for styling based on the class queue codes

class qtpyvcp.widgets.input_widgets.mdihistory_widget.MDIHistory(parent=None)

MDI History and Queuing Widget.

This widget implements a visual view of the MDI command history. It also implements a command queuing startegy so that commands can be entered and queued up for execution. Visual style is used to identify items that have been completed, are running and are yet to run.

toggleQueue(toggle)

Toggle queue pause. Starting point is the queue is active.

clearQueue()

Clear queue items pending run state for items yet to be run.

removeSelectedItem()

Remove the selected lines

removeAll()

Remove all items from list and from history

runFromSelection()

Start running MDI from the selected row back to correct end.

runSelection()

Run the selected row only.

submit()

Put a new command on the queue for later execution.

rowClicked()

Item row clicked.

keyPressEvent(event)

Key movement processing. Arrow keys move the selected list item up/down Return key generates a submit situation by making the item as the next available command to processes.

setHistory(items_list)

Clear and reset the history in the list. item_list is a list of strings.

heartBeat()

Supports heart beat on the MDI History execution queue. Issue the next command from the queue. Double check machine is in ok state to accept next command. Issue the command and if success mark command as being active. Mark last command as done.

initialize()

Load up starting data and set signal connections.

terminate()

Teardown processing.

Line Edit

class qtpyvcp.widgets.input_widgets.line_edit.VCPLineEdit(parent=None)

VCP Entry Widget

initialize()

This method is called right before the main application starts.

terminate()

This method is called right before the main application ends.

class qtpyvcp.widgets.input_widgets.action_combobox.ActionComboBox(parent=None)

General purpose combobox for triggering QtPyVCP actions.

Parameters:

parent (QWidget) – The parent widget of the combobox, or None.

_action_name

The fully qualified name of the action the combobox triggers when the selection is changed.

Type:

str

mousePressEvent(self, e: QMouseEvent)

mouseReleaseEvent(self, e: QMouseEvent)

keyPressEvent(self, e: QKeyEvent)

keyReleaseEvent(self, e: QKeyEvent)

class qtpyvcp.widgets.input_widgets.setting_slider.VCPAbstractSettingsWidget

class qtpyvcp.widgets.input_widgets.setting_slider.VCPSettingsLineEdit(parent)

Settings LineEdit

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.input_widgets.setting_slider.VCPSettingsSlider(parent)

Settings Slider

Set action options like:

machine.jog.linear-speed

mouseDoubleClickEvent(self, a0: QMouseEvent)

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.input_widgets.setting_slider.VCPSettingsSpinBox(parent)

Settings SpinBox

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.input_widgets.setting_slider.VCPSettingsDoubleSpinBox(parent)

Settings DoubleSpinBox

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.input_widgets.setting_slider.VCPSettingsCheckBox(parent)

Settings CheckBox

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.input_widgets.setting_slider.VCPSettingsPushButton(parent)

Settings PushButton

initialize()

This method is called right before the main application starts.

class qtpyvcp.widgets.input_widgets.setting_slider.VCPSettingsComboBox(parent)

Settings ComboBox

initialize()

This method is called right before the main application starts.