draftguitools.gui_base.GuiCommandSimplest Class Reference
Public Member Functions | |
| def | Activated (self) |
| def | IsActive (self) |
Public Attributes | |
| command_name | |
| doc | |
Detailed Description
Simplest base class for GuiCommands.
This class only sets up the command name and the document object
to use for the command.
When it is executed, it logs the command name to the log file,
and prints the command name to the console.
It implements the `IsActive` method, which must return `True`
when the command should be available.
It should return `True` when there is an active document,
otherwise the command (button or menu) should be disabled.
This class is meant to be inherited by other GuiCommand classes
to quickly log the command name, and set the correct document object.
Parameter
---------
name: str, optional
It defaults to `'None'`.
The name of the action that is being run,
for example, `'Heal'`, `'Flip dimensions'`,
`'Line'`, `'Circle'`, etc.
doc: App::Document, optional
It defaults to the value of `App.activeDocument()`.
The document object itself, which indicates where the actions
of the command will be executed.
Attributes
----------
command_name: str
This is the command name, which is assigned by `name`.
doc: App::Document
This is the document object itself, which is assigned by `doc`.
This attribute should be used by functions to make sure
that the operations are performed in the correct document
and not in other documents.
To set the active document we can use
>>> App.setActiveDocument(self.doc.Name)
Member Function Documentation
◆ Activated()
| def draftguitools.gui_base.GuiCommandSimplest.Activated | ( | self | ) |
Execute when the command is called. Log the command name to the log file and console. Also update the `doc` attribute.
Reimplemented in draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor, draftguitools.gui_arcs.Arc_3Points, draftguitools.gui_dimension_ops.FlipDimension, draftguitools.gui_grid.ToggleGrid, draftguitools.gui_groups.AddToGroup, draftguitools.gui_groups.SelectGroup, draftguitools.gui_groups.SetAutoGroup, draftguitools.gui_groups.AddToConstruction, draftguitools.gui_groups.AddNamedGroup, draftguitools.gui_hatch.Draft_Hatch, draftguitools.gui_heal.Heal, draftguitools.gui_layers.Layer, draftguitools.gui_lineslope.LineSlope, draftguitools.gui_togglemodes.ToggleConstructionMode, draftguitools.gui_togglemodes.ToggleContinueMode, draftguitools.gui_togglemodes.ToggleDisplayMode, and draftguitools.gui_togglemodes.BaseMode.
References draftguitools.gui_base.GuiCommandSimplest.command_name, draftguitools.gui_circulararray.CircularArray.command_name, draftguitools.gui_orthoarray.OrthoArray.command_name, draftguitools.gui_polararray.PolarArray.command_name, draftguitools.gui_snaps.Draft_Snap_Base.command_name, App::DynamicProperty::PropData.doc, App::RelabelDocumentExpressionVisitor.doc, App::LinkBaseExtension::PropInfo.doc, Py::PythonType.doc(), ExpressionCompleterModel::Info.doc, Gui::GraphvizView.doc, ItemInfo.doc, ItemInfo2.doc, importIFClegacy.IfcEntity.doc, draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.doc, draftguitools.gui_base.GuiCommandSimplest.doc, draftguitools.gui_base.GuiCommandBase.doc, draftguitools.gui_base_original.DraftTool.doc, drafttests.test_airfoildat.DraftAirfoilDAT.doc, drafttests.test_creation.DraftCreation.doc, drafttests.test_dwg.DraftDWG.doc, drafttests.test_dxf.DraftDXF.doc, drafttests.test_modification.DraftModification.doc, drafttests.test_oca.DraftOCA.doc, drafttests.test_pivy.DraftPivy.doc, drafttests.test_svg.DraftSVG.doc, WorkingPlane.Plane.doc, Import::ImportOCAF.doc, Import::ImportXCAF.doc, Import::ImportOCAFAssembly.doc, MeshPartGui::Mesh2ShapeGmsh::Private.doc, PartGui::SectionCut.doc, PartGui::FaceColors::Private.doc, PartDesignGui::ComboLinks.doc, Mod.PartDesign.WizardShaft.Shaft.Shaft.doc, Mod.PartDesign.WizardShaft.WizardShaft.TaskWizardShaft.doc, PathTests.TestCentroidPost.TestCentroidPost.doc, PathTests.TestGrblPost.TestGrblPost.doc, PathTests.TestLinuxCNCPost.TestLinuxCNCPost.doc, PathTests.TestMach3Mach4Post.TestMach3Mach4Post.doc, PathTests.TestPathAdaptive.TestPathAdaptive.doc, PathTests.TestPathDrillable.TestPathDrillable.doc, PathTests.TestPathHelix.TestPathHelix.doc, PathTests.TestPathHelpers.TestPathHelpers.doc, PathTests.TestPathPost.TestBuildPostList.doc, PathTests.TestPathPost.TestOutputNameSubstitution.doc, PathTests.TestPathPropertyBag.TestPathPropertyBag.doc, PathTests.TestPathSetupSheet.TestPathSetupSheet.doc, PathTests.TestPathStock.TestPathStock.doc, PathTests.TestPathToolController.TestPathToolController.doc, PathTests.TestPathUtil.TestPathUtil.doc, PathTests.TestRefactoredCentroidPost.TestRefactoredCentroidPost.doc, PathTests.TestRefactoredGrblPost.TestRefactoredGrblPost.doc, PathTests.TestRefactoredLinuxCNCPost.TestRefactoredLinuxCNCPost.doc, PathTests.TestRefactoredMach3Mach4Post.TestRefactoredMach3Mach4Post.doc, PathTests.TestRefactoredTestPost.TestRefactoredTestPost.doc, Sandbox::CustomAddObjectEvent.doc, Sandbox::CustomRemoveObjectEvent.doc, Sandbox::CustomRecomputeEvent.doc, Sandbox::DocumentSaverThread.doc, Mod.Show.SceneDetail.SceneDetail.doc, Mod.Show.SceneDetails.Camera.Camera.doc, Mod.Show.SceneDetails.ClipPlane.ClipPlane.doc, Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.doc, Mod.Show.SceneDetails.Pickability.Pickability.doc, Mod.Show.SceneDetails.VProperty.VProperty.doc, TestSpreadsheet.SpreadsheetCases.doc, TestSpreadsheetGui.SpreadsheetGuiCases.doc, and Commands.TemplatePyMod_Cmd2.doc.
Referenced by ArchStructure.CommandStructuralSystem.Activated(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), draftguitools.gui_ellipses.Ellipse.finish(), draftguitools.gui_lines.Line.finish(), draftguitools.gui_mirror.Mirror.finish(), draftguitools.gui_move.Move.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rectangles.Rectangle.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_splines.BSpline.finish(), draftguitools.gui_texts.Text.finish(), draftguitools.gui_points.Point.finish(), draftguitools.gui_shapestrings.ShapeString.finish(), draftguitools.gui_arcs.Arc_3Points.getPoint(), and ArchPanel.CommandPanel.getPoint().
◆ IsActive()
| def draftguitools.gui_base.GuiCommandSimplest.IsActive | ( | self | ) |
Return True when this command should be available. It is `True` when there is a document.
Reimplemented in draftguitools.gui_base.GuiCommandNeedsSelection.
Member Data Documentation
◆ command_name
| draftguitools.gui_base.GuiCommandSimplest.command_name |
◆ doc
| draftguitools.gui_base.GuiCommandSimplest.doc |
Referenced by draftguitools.gui_lineslope.LineSlope.accept(), draftguitools.gui_dimensions.Dimension.action(), draftguitools.gui_base.GuiCommandSimplest.Activated(), draftguitools.gui_beziers.BezCurve.Activated(), draftguitools.gui_beziers.CubicBezCurve.Activated(), draftguitools.gui_dimension_ops.FlipDimension.Activated(), draftguitools.gui_groups.AddToConstruction.Activated(), draftguitools.gui_heal.Heal.Activated(), draftguitools.gui_layers.Layer.Activated(), draftguitools.gui_splines.BSpline.Activated(), draftguitools.gui_wire2spline.WireToBSpline.Activated(), draftguitools.gui_lines.Line.Activated(), WorkingPlane.Plane.alignToPointAndAxis(), WorkingPlane.Plane.alignToPointAndAxis_SVG(), Mod.Show.SceneDetails.ClipPlane.ClipPlane.apply_data(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.apply_data(), Mod.Show.SceneDetails.Pickability.Pickability.apply_data(), Mod.Show.SceneDetails.VProperty.VProperty.apply_data(), importSVG.svgHandler.characters(), draftguitools.gui_drawing.Drawing.createDefaultPage(), draftguitools.gui_fillets.Fillet.draw_arc(), importSVG.svgHandler.endElement(), draftguitools.gui_arcs.Arc_3Points.finish(), draftguitools.gui_fillets.Fillet.finish(), draftguitools.gui_arcs.Arc.finish(), draftguitools.gui_beziers.BezCurve.finish(), draftguitools.gui_beziers.CubicBezCurve.finish(), draftguitools.gui_polygons.Polygon.finish(), draftguitools.gui_rotate.Rotate.finish(), draftguitools.gui_splines.BSpline.finish(), Mod.Show.SceneDetail.SceneDetail.full_key(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.get_annotations(), importIFClegacy.IfcEntity.getProperties(), importIFClegacy.IfcEntity.getProperty(), draftguitools.gui_groups.AddToGroup.proceed(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.read_meta(), draftguitools.gui_trimex.Trimex.redraw(), draftguitools.gui_lines.Line.removeTemporaryObject(), WorkingPlane.Plane.reset(), draftguitools.gui_annotationstyleeditor.AnnotationStyleEditor.save_meta(), Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.scene_value(), Mod.Show.SceneDetails.Pickability.Pickability.scene_value(), Mod.Show.SceneDetails.VProperty.VProperty.scene_value(), Mod.Show.SceneDetail.SceneDetail.set_doc(), drafttests.test_creation.DraftCreation.tearDown(), PathTests.TestPathDrillable.TestPathDrillable.tearDown(), PathTests.TestPathHelix.TestPathHelix.tearDown(), PathTests.TestPathPropertyBag.TestPathPropertyBag.tearDown(), PathTests.TestPathSetupSheet.TestPathSetupSheet.tearDown(), PathTests.TestPathToolController.TestPathToolController.tearDown(), TestSpreadsheet.SpreadsheetCases.tearDown(), PathTests.TestPathSetupSheet.TestPathSetupSheet.test00(), PathTests.TestPathUtil.TestPathUtil.test00(), PathTests.TestPathPost.TestOutputNameSubstitution.test000(), PathTests.TestPathSetupSheet.TestPathSetupSheet.test01(), PathTests.TestPathUtil.TestPathUtil.test01(), PathTests.TestPathAdaptive.TestPathAdaptive.test02(), PathTests.TestPathUtil.TestPathUtil.test02(), PathTests.TestPathAdaptive.TestPathAdaptive.test03(), PathTests.TestPathHelix.TestPathHelix.test03(), PathTests.TestPathUtil.TestPathUtil.test03(), PathTests.TestPathAdaptive.TestPathAdaptive.test04(), PathTests.TestPathHelix.TestPathHelix.test04(), PathTests.TestPathUtil.TestPathUtil.test04(), PathTests.TestPathAdaptive.TestPathAdaptive.test05(), PathTests.TestPathAdaptive.TestPathAdaptive.test06(), PathTests.TestPathAdaptive.TestPathAdaptive.test07(), PathTests.TestPathSetupSheet.TestPathSetupSheet.test13(), drafttests.test_creation.DraftCreation.test_dimension_linear_obj(), drafttests.test_creation.DraftCreation.test_dimension_radial_obj(), drafttests.test_creation.DraftCreation.test_facebinder(), drafttests.test_creation.DraftCreation.test_fillet(), drafttests.test_creation.DraftCreation.test_label(), TestSpreadsheet.SpreadsheetCases.testAggregates(), TestSpreadsheet.SpreadsheetCases.testAlias(), TestSpreadsheet.SpreadsheetCases.testAmbiguousAlias(), TestSpreadsheet.SpreadsheetCases.testBindAcrossSheets(), TestSpreadsheet.SpreadsheetCases.testBindHiddenRefAcrossSheets(), TestSpreadsheet.SpreadsheetCases.testClearAlias(), TestSpreadsheetGui.SpreadsheetGuiCases.testCopySingleCell(), TestSpreadsheet.SpreadsheetCases.testCrossDocumentLinks(), TestSpreadsheet.SpreadsheetCases.testExpressionWithAlias(), TestSpreadsheet.SpreadsheetCases.testFixPR6843(), TestSpreadsheet.SpreadsheetCases.testFunctions(), TestSpreadsheet.SpreadsheetCases.testInsertColumnsAlias(), TestSpreadsheet.SpreadsheetCases.testInsertRows(), TestSpreadsheet.SpreadsheetCases.testInsertRowsAlias(), TestSpreadsheet.SpreadsheetCases.testInvoluteGear(), TestSpreadsheet.SpreadsheetCases.testIssue3128(), TestSpreadsheet.SpreadsheetCases.testIssue3225(), TestSpreadsheet.SpreadsheetCases.testIssue3363(), TestSpreadsheet.SpreadsheetCases.testIssue3432(), TestSpreadsheet.SpreadsheetCases.testIssue4156(), TestSpreadsheet.SpreadsheetCases.testIssue6840(), TestSpreadsheet.SpreadsheetCases.testIssue6844(), TestSpreadsheet.SpreadsheetCases.testMatrix(), TestSpreadsheet.SpreadsheetCases.testMergeCells(), TestSpreadsheet.SpreadsheetCases.testMergeCellsAndBind(), TestSpreadsheet.SpreadsheetCases.testNumbers(), TestSpreadsheet.SpreadsheetCases.testPlacementName(), TestSpreadsheet.SpreadsheetCases.testPrecedence(), TestSpreadsheet.SpreadsheetCases.testQuantitiesAndFractionsAsNumbers(), TestSpreadsheet.SpreadsheetCases.testRelationalOperators(), TestSpreadsheet.SpreadsheetCases.testRemoveColumnsAlias(), TestSpreadsheet.SpreadsheetCases.testRemoveColumnsAliasReuseName(), TestSpreadsheet.SpreadsheetCases.testRemoveRows(), TestSpreadsheet.SpreadsheetCases.testRemoveRowsAlias(), TestSpreadsheet.SpreadsheetCases.testRemoveRowsAliasReuseName(), TestSpreadsheet.SpreadsheetCases.testRenameAlias(), TestSpreadsheet.SpreadsheetCases.testRenameAlias2(), TestSpreadsheet.SpreadsheetCases.testRenameAlias3(), TestSpreadsheet.SpreadsheetCases.testSetInvalidAlias(), TestSpreadsheet.SpreadsheetCases.testSetInvalidAlias2(), TestSpreadsheet.SpreadsheetCases.testSketcher(), TestSpreadsheet.SpreadsheetCases.testUndoAliasCreationReuseName(), TestSpreadsheet.SpreadsheetCases.testUnits(), draftguitools.gui_trimex.Trimex.trimObject(), draftguitools.gui_trimex.Trimex.trimObjects(), Mod.PartDesign.WizardShaft.Shaft.Shaft.updateConstraint(), Mod.PartDesign.WizardShaft.Shaft.Shaft.updateEdge(), and Mod.Show.SceneDetails.ObjectClipPlane.ObjectClipPlane.val().
The documentation for this class was generated from the following file:
- FreeCAD/src/Mod/Draft/draftguitools/gui_base.py
