Public Member Functions
def	accept (self)

def	createBaseLayout (self)

def	createFormEntry (self, name, label)

def	createLabel (self, value)

def	createLineEdit (self, name)

def	createMapConversionFormLayout (self)

def	prefillMapConversionForm (self)

Public Attributes
	baseLayout

	baseWidget

	form

	lineEditObjects

	object

Detailed Description

A default task panel for editing context objects.

Member Function Documentation

◆ accept()

def ArchIFCView.IfcContextUI.accept ( self )

This method runs as a callback when the user selects the ok button.

It writes the data entered into the forms to the object's IfcData
property.

References ArchIFCView.IfcContextUI.lineEditObjects, App::DocumentObjectWeakPtrT::Private.object, App::DocumentObjectT.object, App::FeaturePythonImp.object, App::PropertyPythonObject.object, Gui::ViewProviderWeakPtrT::Private.object, Gui::ViewProviderT.object, YYSTYPE.object, Gui::DocumentObjectItem.object(), Gui::ViewProviderPythonFeatureImp.object, ArchIFCView.IfcContextUI.object, importIFCHelper.ProjectImporter.object, PartGui::EdgeFaceSelection.object, PartGui::DlgFilletEdges::Private.object, PartGui::FaceSelection.object, PartGui::ThicknessWidget::Private::FaceSelection.object, nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::json_value.object, nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >.object(), ObjectObserver.object, SketcherGui::GenericConstraintSelection.object, SketcherGui::CarbonCopySelection.object, SketcherGui::ExtendSelection.object, SketcherGui::ExternalSelection.object, SketcherGui::FilletSelection.object, SketcherGui::SplittingSelection.object, SketcherGui::TrimmingSelection.object, and ArchIFC.IfcRoot.setObjIfcComplexAttributeValue().

Referenced by femexamples.examplesgui.FemExamples.clicked(), femexamples.examplesgui.FemExamples.double_clicked(), ArchComponent.ComponentTaskPanel.editObject(), and PathScripts.PathToolBitLibraryGui.ToolBitLibrary.toolEdit().

◆ createBaseLayout()

def ArchIFCView.IfcContextUI.createBaseLayout ( self )

Defines the basic layout of the task panel.

◆ createFormEntry()

def ArchIFCView.IfcContextUI.createFormEntry	(	self,
		name,
		label
	)

Creates a form entry.

The name corresponds to the data point being edited in the
RepresentationContexts complex attribute. The label is a human readable
version of the name.

Parameters
----------
name: str
    The name of the datapoint within the RepresentationContexts
    attribute being edited.
label: str
    A human readable version of the name.

Returns
-------
<PySide2.QtWidgets.QWidget>
    Widget containing the label and form.

References ArchIFCView.IfcContextUI.baseWidget, DraftGui.DraftToolBar.baseWidget, ArchIFCView.IfcContextUI.createLabel(), and ArchIFCView.IfcContextUI.createLineEdit().

Referenced by ArchIFCView.IfcContextUI.createMapConversionFormLayout().

◆ createLabel()

def ArchIFCView.IfcContextUI.createLabel	(	self,
		value
	)

Creates a translated label.

Parameters
----------
value: str
    The human readable label text.

Returns
-------
<PySide2.QtWidgets.QWidget>
    The label Qt widget.

References ArchIFCView.IfcContextUI.baseWidget, and DraftGui.DraftToolBar.baseWidget.

Referenced by ArchIFCView.IfcContextUI.createFormEntry(), and ArchIFCView.IfcContextUI.createMapConversionFormLayout().

◆ createLineEdit()

def ArchIFCView.IfcContextUI.createLineEdit	(	self,
		name
	)

Creates a form with the name specified.

Parameters
----------
name: str
    The name of the datapoint within the RepresentationContexts
    attribute being edited.

Returns
-------
<PySide2.QtWidgets.QWidget>
    The form Qt widget.

References ArchIFCView.IfcContextUI.baseWidget, DraftGui.DraftToolBar.baseWidget, and ArchIFCView.IfcContextUI.lineEditObjects.

Referenced by ArchIFCView.IfcContextUI.createFormEntry().

◆ createMapConversionFormLayout()

def ArchIFCView.IfcContextUI.createMapConversionFormLayout ( self )

Creates form entries for the data being edited.

Creates form entries for each of the data points being edited within
the IFC complex attribute, RepresentationContexts.

References ArchIFCView.IfcContextUI.baseLayout, ArchIFCView.IfcContextUI.createFormEntry(), and ArchIFCView.IfcContextUI.createLabel().

◆ prefillMapConversionForm()

def ArchIFCView.IfcContextUI.prefillMapConversionForm ( self )

Prefills each of the form entries with the existing value.

Gets the existing value from the object's IfcData, specifically the complex
attribute, RepresentationContexts.

References ArchIFC.IfcRoot.getObjIfcComplexAttribute(), ArchIFCView.IfcContextUI.lineEditObjects, App::DocumentObjectWeakPtrT::Private.object, App::DocumentObjectT.object, App::FeaturePythonImp.object, App::PropertyPythonObject.object, Gui::ViewProviderWeakPtrT::Private.object, Gui::ViewProviderT.object, YYSTYPE.object, Gui::DocumentObjectItem.object(), Gui::ViewProviderPythonFeatureImp.object, ArchIFCView.IfcContextUI.object, importIFCHelper.ProjectImporter.object, PartGui::EdgeFaceSelection.object, PartGui::DlgFilletEdges::Private.object, PartGui::FaceSelection.object, PartGui::ThicknessWidget::Private::FaceSelection.object, nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >::json_value.object, nlohmann::basic_json< ObjectType, ArrayType, StringType, BooleanType, NumberIntegerType, NumberUnsignedType, NumberFloatType, AllocatorType, JSONSerializer, BinaryType >.object(), ObjectObserver.object, SketcherGui::GenericConstraintSelection.object, SketcherGui::CarbonCopySelection.object, SketcherGui::ExtendSelection.object, SketcherGui::ExternalSelection.object, SketcherGui::FilletSelection.object, SketcherGui::SplittingSelection.object, and SketcherGui::TrimmingSelection.object.

Member Data Documentation

◆ baseLayout

ArchIFCView.IfcContextUI.baseLayout

Referenced by ArchIFCView.IfcContextUI.createMapConversionFormLayout().

◆ baseWidget

ArchIFCView.IfcContextUI.baseWidget

Referenced by DraftGui.DraftToolBar.checkSpecialChars(), ArchIFCView.IfcContextUI.createFormEntry(), ArchIFCView.IfcContextUI.createLabel(), ArchIFCView.IfcContextUI.createLineEdit(), DraftGui.DraftToolBar.offUi(), DraftGui.DraftToolBar.pickFile(), DraftGui.DraftToolBar.relocate(), DraftGui.DraftToolBar.setTitle(), DraftGui.DraftToolBar.setupStyle(), and DraftGui.DraftToolBar.taskUi().

◆ form

ArchIFCView.IfcContextUI.form

◆ lineEditObjects

ArchIFCView.IfcContextUI.lineEditObjects

Referenced by ArchIFCView.IfcContextUI.accept(), ArchIFCView.IfcContextUI.createLineEdit(), and ArchIFCView.IfcContextUI.prefillMapConversionForm().

◆ object

ArchIFCView.IfcContextUI.object

Referenced by ArchIFCView.IfcContextUI.accept(), ArchIFCView.IfcContextUI.prefillMapConversionForm(), importIFCHelper.ProjectImporter.setAttributes(), and importIFCHelper.ProjectImporter.setComplexAttributes().

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

FreeCAD/src/Mod/Arch/ArchIFCView.py

Public Member Functions

Public Attributes