Public Member Functions
def	cleanupPage (self, obj)

def	createItemForBaseModel (self, base, sub, edges, extensions)

def	currentExtensions (self)

def	extensionsClear (self)

def	extensionsDisable (self)

def	extensionsEnable (self)

def	forAllItemsCall (self, cb)

def	getFields (self, obj)

def	getForm (self)

def	getSignalsForUpdate (self, obj)

def	initPage (self, obj)

def	registerSignalHandlers (self, obj)

def	restoreSelection (self, selection)

def	selectionChanged (self)

def	setExtensions (self, extensions)

def	setFields (self, obj)

def	showHideExtension (self)

def	toggleExtensionCorners (self)

def	updateData (self, obj, prop)

def	updateItemEnabled (self, item)

def	updateProxyExtensions (self, obj)

Public Member Functions inherited from PathScripts.PathOpGui.TaskPanelPage
def	getIcon (self, obj)

def	getTitle (self, obj)

def	modifyStandardButtons (self, buttonBox)

def	onDirtyChanged (self, callback)

def	pageCleanup (self)

def	pageGetFields (self)

def	pageRegisterSignalHandlers (self)

def	pageSetFields (self)

def	pageUpdateData (self, obj, prop)

def	resetToolController (self, job, tc)

def	selectInComboBox (self, name, combo)

def	setClean (self)

def	setDirty (self)

def	setIcon (self, icon)

def	setParent (self, parent)

def	setTitle (self, title)

def	setupCoolant (self, obj, combo)

def	setupToolController (self, obj, combo)

def	updateCoolant (self, obj, combo)

def	updatePanelVisibility (self, panelTitle, obj)

def	updateSelection (self, obj, sel)

def	updateToolController (self, obj, combo)

Public Attributes
	blockUpdateData

	defaultLength

	edgeList

	extensionEdges

	extensions

	model

	selectionModel

	switch

Public Attributes inherited from PathScripts.PathOpGui.TaskPanelPage
	features

	form

	icon

	isdirty

	job

	obj

	panelTitle

	parent

	signalDirtyChanged

	title

Static Public Attributes
	DataObject = QtCore.Qt.ItemDataRole.UserRole

int	DataSwitch = QtCore.Qt.ItemDataRole.UserRole + 2

dictionary	Direction

Member Function Documentation

◆ cleanupPage()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.cleanupPage	(	self,
		obj
	)

cleanupPage(obj) ... overwrite to perform any cleanup tasks before page is destroyed.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

Referenced by PathScripts.PathOpGui.TaskPanelPage.pageCleanup().

◆ createItemForBaseModel()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.createItemForBaseModel	(	self,
		base,
		sub,
		edges,
		extensions
	)

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions().

◆ currentExtensions()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.currentExtensions ( self )

References PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.forAllItemsCall().

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateProxyExtensions().

◆ extensionsClear()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensionsClear ( self )

References PathScripts.PathCircularHoleBaseGui.TaskPanelHoleGeometryPage.DataObject, PathScripts.PathJobDlg.JobCreate.DataObject, PathScripts.PathJobDlg.JobTemplateExport.DataObject, PathScripts.PathJobGui.TaskPanel.DataObject, PathScripts.PathOpGui.TaskPanelBaseGeometryPage.DataObject, PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.DataObject, PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.forAllItemsCall(), Gui::VectorListEditor.model, ArchMaterial._ArchMultiMaterialTaskPanel.model, PartGui::TaskCheckGeometryResults.model, PathScripts.PathJobDlg.JobCreate.model, PathScripts.PathOp.ObjectOp.model, PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.model, PathScripts.PathPropertyBagGui.TaskPanel.model, PathScripts.PathSetupSheetGui.OpTaskPanel.model, PathScripts.PathToolBitEdit.ToolBitEditor.model, SpreadsheetGui::SheetView.model, PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.selectionModel, Spreadsheet::Cell.setDirty(), Spreadsheet::PropertySheet.setDirty(), PathScripts.PathDressupLeadInOut.TaskPanel.setDirty(), PathScripts.PathDressupPathBoundaryGui.TaskPanel.setDirty(), and PathScripts.PathOpGui.TaskPanelPage.setDirty().

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers().

◆ extensionsDisable()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensionsDisable ( self )

References PathScripts.PathPocketShapeGui.TaskPanelExtensionPage._extensionsSetState().

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers().

◆ extensionsEnable()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensionsEnable ( self )

References PathScripts.PathPocketShapeGui.TaskPanelExtensionPage._extensionsSetState().

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers().

◆ forAllItemsCall()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.forAllItemsCall	(	self,
		cb
	)

References PathScripts.PathCircularHoleBaseGui.TaskPanelHoleGeometryPage.DataObject, PathScripts.PathJobDlg.JobCreate.DataObject, PathScripts.PathJobDlg.JobTemplateExport.DataObject, PathScripts.PathJobGui.TaskPanel.DataObject, PathScripts.PathOpGui.TaskPanelBaseGeometryPage.DataObject, PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.DataObject, Gui::VectorListEditor.model, ArchMaterial._ArchMultiMaterialTaskPanel.model, PartGui::TaskCheckGeometryResults.model, PathScripts.PathJobDlg.JobCreate.model, PathScripts.PathOp.ObjectOp.model, PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.model, PathScripts.PathPropertyBagGui.TaskPanel.model, PathScripts.PathSetupSheetGui.OpTaskPanel.model, PathScripts.PathToolBitEdit.ToolBitEditor.model, and SpreadsheetGui::SheetView.model.

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.currentExtensions(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensionsClear(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.restoreSelection(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.showHideExtension().

◆ getFields()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.getFields	(	self,
		obj
	)

getFields(obj) ... overwrite to transfer values from UI to obj's properties.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

◆ getForm()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.getForm ( self )

getForm() ... return UI form for this page.
Must be overwritten by subclasses.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

◆ getSignalsForUpdate()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.getSignalsForUpdate	(	self,
		obj
	)

getSignalsForUpdate(obj) ... return signals which, when triggered, cause the receiver to update the model.
See also registerSignalHandlers(obj)
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

Referenced by PathScripts.PathOpGui.TaskPanelPage.pageRegisterSignalHandlers().

◆ initPage()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.initPage	(	self,
		obj
	)

initPage(obj) ... overwrite to customize UI for specific model.
Note that this function is invoked after all page controllers have been created.
Should be overwritten by subclasses.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

References PathScripts.PathOpGui.TaskPanelPage.setTitle(), and DraftGui.DraftToolBar.setTitle().

◆ registerSignalHandlers()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers	(	self,
		obj
	)

registerSignalHandlers(obj) ... overwrite to register custom signal handlers.
In case an update of a model is not the desired operation of a signal invocation
(see getSignalsForUpdate(obj)) this function can be used to register signal handlers
manually.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

Referenced by PathScripts.PathOpGui.TaskPanelPage.pageRegisterSignalHandlers().

◆ restoreSelection()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.restoreSelection	(	self,
		selection
	)

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.selectionChanged(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions().

◆ selectionChanged()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.selectionChanged ( self )

References PathScripts.PathJobGui.TaskPanel.restoreSelection(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.restoreSelection().

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.toggleExtensionCorners().

◆ setExtensions()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions	(	self,
		extensions
	)

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setFields(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.toggleExtensionCorners(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateData().

◆ setFields()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setFields	(	self,
		obj
	)

setFields(obj) ... overwrite to transfer obj's property values to UI.
Can safely be overwritten by subclasses.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

◆ showHideExtension()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.showHideExtension ( self )

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers().

◆ toggleExtensionCorners()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.toggleExtensionCorners ( self )

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers().

◆ updateData()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateData	(	self,
		obj,
		prop
	)

updateData(obj, prop) ... overwrite if the receiver needs to react to property changes that might not have been caused by the receiver itself.
Sometimes a model will recalculate properties based on a change of another property. In order to keep the UI up to date with such changes this
function can be used.
Please note that the callback is synchronous with the property assignment operation. Also note that the notification is invoked regardless of the
actual value of the property assignment. In other words it also fires if a property gets assigned the same value it already has.
Taking above observations into account the implementation has to take care that it doesn't overwrite modified UI values by invoking setFields(obj).
This can happen if a subclass unconditionally transfers all values in getFields(obj) to the model and just calls setFields(obj) in this callback.
In such a scenario the first property assignment will cause all changes in the UI of the other fields to be overwritten by setFields(obj).
You have been warned.

Reimplemented from PathScripts.PathOpGui.TaskPanelPage.

References PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.blockUpdateData, PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions(), and PathScripts.PathPocketShape.ObjectPocket.setExtensions().

Referenced by PathScripts.PathJobDlg.JobCreate.exec_(), draftviewproviders.view_dimension.ViewProviderLinearDimension.onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension.onChanged(), draftviewproviders.view_wire.ViewProviderWire.onChanged(), PathScripts.PathOpGui.TaskPanelPage.pageUpdateData(), PathScripts.PathPropertyBagGui.TaskPanel.setupUi(), and PathScripts.PathSetupSheetGui.OpTaskPanel.setupUi().

◆ updateItemEnabled()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateItemEnabled	(	self,
		item
	)

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers().

◆ updateProxyExtensions()

def PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateProxyExtensions	(	self,
		obj
	)

References PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.currentExtensions(), Part::Geometry.extensions, and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensions.

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.getFields(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateItemEnabled().

Member Data Documentation

◆ blockUpdateData

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.blockUpdateData

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.getFields(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateData().

◆ DataObject

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.DataObject = QtCore.Qt.ItemDataRole.UserRole

static

◆ DataSwitch

int PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.DataSwitch = QtCore.Qt.ItemDataRole.UserRole + 2

static

◆ defaultLength

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.defaultLength

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.getFields(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setFields().

◆ Direction

dictionary PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.Direction

static

Initial value:

=  {
            PathPocketShape.Extension.DirectionNormal: translate('PathPocket', 'Normal'),
            PathPocketShape.Extension.DirectionX: translate('PathPocket', 'X'),
            PathPocketShape.Extension.DirectionY: translate('PathPocket', 'Y')
            }

◆ edgeList

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.edgeList

◆ extensionEdges

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensionEdges

◆ extensions

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensions

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setFields(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.updateProxyExtensions().

◆ model

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.model

Referenced by PathScripts.PathSetupSheetGui.OpTaskPanel.accept(), PathScripts.PathPocket.ObjectPocket.areaOpShapes(), PathScripts.PathVcarve.ObjectVcarve.buildPathMedial(), PathScripts.PathJobDlg.JobCreate.exec_(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensionsClear(), PathScripts.PathCircularHoleBase.ObjectOp.findAllHoles(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.forAllItemsCall(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.getFields(), PathScripts.PathJobDlg.JobCreate.item1ValueChanged(), PathScripts.PathEngrave.ObjectEngrave.opExecute(), PathScripts.PathVcarve.ObjectVcarve.opExecute(), PathScripts.PathDeburr.ObjectDeburr.opRejectAddBase(), PathScripts.PathPropertyBagGui.TaskPanel.propertyAdd(), PathScripts.PathPropertyBagGui.TaskPanel.propertyModifyIndex(), PathScripts.PathPropertyBagGui.TaskPanel.propertyRemove(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.registerSignalHandlers(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.restoreSelection(), PathScripts.PathOp.ObjectOp.setDefaultValues(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions(), ArchMaterial.MultiMaterialDelegate.setModelData(), PathScripts.PathJobDlg.JobCreate.setupModel(), PathScripts.PathPropertyBagGui.TaskPanel.setupUi(), PathScripts.PathSetupSheetGui.OpTaskPanel.setupUi(), PathScripts.PathJobDlg.JobCreate.updateData(), and PathScripts.PathSetupSheetGui.OpTaskPanel.updateData().

◆ selectionModel

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.selectionModel

Referenced by PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.extensionsClear(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.restoreSelection(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions(), and PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.showHideExtension().

◆ switch

PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.switch

Referenced by PathScripts.PathDressupTagGui.PathDressupTagViewProvider.attach(), PathScripts.PathJobGui.ViewProvider.attach(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.cleanupPage(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.createItemForBaseModel(), draftguitools.gui_trackers.Tracker.finalize(), draftguitools.gui_trackers.Tracker.lowerTracker(), draftguitools.gui_trackers.Tracker.off(), draftguitools.gui_trackers.Tracker.on(), ArchPanel.ViewProviderPanelCut.onChanged(), ArchPanel.ViewProviderPanelSheet.onChanged(), draftguitools.gui_trackers.Tracker.raiseTracker(), PathScripts.PathPocketShapeGui.TaskPanelExtensionPage.setExtensions(), PathScripts.PathJobGui.ViewProvider.showOriginAxis(), PathScripts.PathDressupTagGui.PathDressupTagViewProvider.turnMarkerDisplayOn(), and PathScripts.PathDressupTagGui.PathDressupTagViewProvider.updatePositions().

The documentation for this class was generated from the following file:

Sources/FreeCAD/src/Mod/Path/PathScripts/PathPocketShapeGui.py

Public Member Functions

Public Attributes

Static Public Attributes

Member Function Documentation

◆ cleanupPage()

◆ createItemForBaseModel()

◆ currentExtensions()

◆ extensionsClear()

◆ extensionsDisable()

◆ extensionsEnable()

◆ forAllItemsCall()

◆ getFields()

◆ getForm()

◆ getSignalsForUpdate()

◆ initPage()

◆ registerSignalHandlers()

◆ restoreSelection()

◆ selectionChanged()

◆ setExtensions()

◆ setFields()

◆ showHideExtension()

◆ toggleExtensionCorners()

◆ updateData()

◆ updateItemEnabled()

◆ updateProxyExtensions()

Member Data Documentation

◆ blockUpdateData

◆ DataObject

◆ DataSwitch

◆ defaultLength

◆ Direction

◆ edgeList

◆ extensionEdges

◆ extensions

◆ model

◆ selectionModel

◆ switch