Std Edit: Difference between revisions

From FreeCAD Documentation
(Fixed GuiCommand.)
(Revised.)
Line 1: Line 1:
<languages/>
<languages/>

{{Page in progress}}

<translate>
<translate>


Line 15: Line 18:
{{GuiCommand
{{GuiCommand
|Name=Std Edit
|Name=Std Edit
|MenuLocation={{StdMenu|[[Std_Edit_Menu|Edit]]}} → Toggle Editmode
|MenuLocation=Edit → Toggle Edit mode
|Workbenches=All
|Workbenches=All
}}
}}


== Description == <!--T:2-->
==Description== <!--T:2-->


<!--T:3-->
<!--T:3-->
The '''Std Edit''' command activates or deactivates an object's edit mode.
The [[Image:Std_Edit.svg|24px]] [[Std_Edit|Edit]] command allows to enter or leave the edit mode of a selected object. An object must be either selected (then it enters edit mode) or in edit mode (then it leaves edit mode) for this command to work.


==Usage==
<!--T:4-->
The behaviour that occurs when entering edit mode depends on the object type. Some object types don't define any edit mode behaviour, in that case the standard behaviour (a transform widget) is used.


# If no object is in edit mode: select a single object.
<!--T:5-->
# Select the {{MenuCommand|Edit → [[Image:Std_Edit.svg|16px]] Toggle Edit mode}} option from the menu.
You can also perform the same action by double-clicking an object in the [[Tree view]].
# Either the edit mode of the selected object is activated or the existing edit mode deactivated.


==Notes==
== Scripting == <!--T:6-->

* Not all objects support edit mode.
* The functionality available in edit mode depends on the object type.
* Edit mode can also be activated by double clicking an object in the [[Tree_view|Tree view]].

==Scripting== <!--T:6-->

{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


<!--T:7-->
<!--T:7-->
This enters edit mode of a determined object:
To activate an object's edit mode use the {{incode|setEdit}} method of the document object.


</translate>
</translate>
{{Code|code=
{{Code|code=
import FreeCADGui

FreeCADGui.ActiveDocument.setEdit("myObjectName",0)
FreeCADGui.ActiveDocument.setEdit("myObjectName",0)
}}
}}
<translate>
<translate>

<!--T:11-->
<!--T:11-->
To deactivate an existing edit mode use the {{incode|resetEdit}} method of the document object.
This closes the edit mode:


</translate>
</translate>
{{Code|code=
{{Code|code=
FreeCADGui.ActiveDocument.resetEdit()
import FreeCADGui

FreeCADGui.ActiveDocument.resetEdit()
}}
}}
<translate>
<translate>
Line 60: Line 76:


</translate>
</translate>
{{clear}}

{{Std Base navi{{#translation:}}}}
{{Std Base navi{{#translation:}}}}

{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 15:38, 21 March 2020

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.


Std Edit

Menu location
Edit → Toggle Edit mode
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
None

Description

The Std Edit command activates or deactivates an object's edit mode.

Usage

  1. If no object is in edit mode: select a single object.
  2. Select the Edit → Toggle Edit mode option from the menu.
  3. Either the edit mode of the selected object is activated or the existing edit mode deactivated.

Notes

  • Not all objects support edit mode.
  • The functionality available in edit mode depends on the object type.
  • Edit mode can also be activated by double clicking an object in the Tree view.

Scripting

See also: FreeCAD Scripting Basics.

To activate an object's edit mode use the setEdit method of the document object.

import FreeCADGui

FreeCADGui.ActiveDocument.setEdit("myObjectName",0)

To deactivate an existing edit mode use the resetEdit method of the document object.

import FreeCADGui

FreeCADGui.ActiveDocument.resetEdit()