Std DlgMacroExecute: Difference between revisions

From FreeCAD Documentation
No edit summary
(Docnav)
(14 intermediate revisions by the same user not shown)
Line 4: Line 4:
<!--T:7-->
<!--T:7-->
{{Docnav
{{Docnav
|[[Std_DlgMacroRecord|DlgMacroRecord]]
|[[Std_MacroStopRecord|MacroStopRecord]]
|[[Std_DlgMacroExecuteDirect|DlgMacroExecuteDirect]]
|[[Std_DlgMacroExecuteDirect|DlgMacroExecuteDirect]]
|[[Std_Macro_Menu|Std Macro Menu]]
|[[Std_Macro_Menu|Std Macro Menu]]
|IconL=Std_MacroStopRecord.svg
|IconL=Std_DlgMacroRecord.svg
|IconR=Std_DlgMacroExecuteDirect.svg
|IconR=Std_DlgMacroExecuteDirect.svg
|IconC=Freecad.svg
|IconC=Freecad.svg
Line 41: Line 41:
==Options== <!--T:9-->
==Options== <!--T:9-->


===Find file===
===Find file / Find in files=== <!--T:40-->


<!--T:41-->
: {{Version|0.22}}
: {{Version|0.22}}


<!--T:42-->
: This line edit widget is used to filter by filename those macros that appear in the macros file list. You may use regular expressions or simply enter text. Only those filenames that match the entered text will appear in the macro file list. All matches are case-insensitive. Note: both filters are applied sequentially, so only those files that match both the '''Find file''' text and the '''Find in files''' text will appear in the macro files list.
: These two input boxes can be used to filter macros from the file list on the '''User macros''' tab or the '''System macros''' tab. You may use regular expressions or simply enter text. All matches are case-insensitive.


<!--T:43-->
===Find in files===
: '''Find file''' filters the list by filename. Only filenames that match the entered text will appear in the list. '''Find in files''' filters the list by file content. Only files whose text content matches the entered text will appear in the list.


<!--T:44-->
: {{Version|0.22}}
: Remove all text from a filter's input box to disable it. If both input boxes contain text, both filters are applied. Filtering may result in an empty list.

: This line edit widget is used to filter by file content those macros that appear in the macros file list. The text entered into this widget can be a regular expression or simple text. Only those files that have text content that matches the contents of this widget will appear in the macro files list. Note: both filters are applied sequentially, so only those files that match both the '''Find file''' text and the '''Find in files''' text will appear in the macro files list.


===User macros=== <!--T:10-->
===User macros=== <!--T:10-->

<!--T:45-->
: The '''User macros''' tab lists the macros available in the '''User macros location'''.


<!--T:11-->
<!--T:11-->
# Click a macro in the list to select it.
# The '''User macros''' tab lists the macros available in the '''User macros location'''.
# Click a macro to select it.
# The name of the selected macro will appear in the '''Macro name''' box.
# The name of the selected macro will appear in the '''Macro name''' box.


===System macros=== <!--T:12-->
===System macros=== <!--T:12-->


<!--T:13-->
<!--T:46-->
: The '''System macros''' tab is not used much at this time. To make use of this tab you must put some macros in a folder named "Macro" and it should a sibling folder of the bin folder where FreeCAD is installed. To find this folder enter
: To make use of the '''System macros''' tab you must create a folder named {{FileName|Macro}} as a sibling folder of the {{FileName|bin}} folder where FreeCAD is installed and put some macros there.


<!--T:47-->
: To find the {{FileName|bin}} folder enter this in the [[Python_console|Python console]]:

</translate>
: {{Code|code=
: {{Code|code=
App.getHomePath()}}
App.getHomePath()
}}
<translate>


<!--T:48-->
: in the python console, open it, and create a Macro folder there. These will appear in the System tab. These are just normal macros that work like any others.
# Click a macro in the list to select it.
# The name of the selected macro will appear in the '''Macro name''' box.


===User macros location=== <!--T:14-->
===User macros location=== <!--T:14-->
Line 155: Line 167:
<!--T:38-->
<!--T:38-->
{{Docnav
{{Docnav
|[[Std_DlgMacroRecord|DlgMacroRecord]]
|[[Std_MacroStopRecord|MacroStopRecord]]
|[[Std_DlgMacroExecuteDirect|DlgMacroExecuteDirect]]
|[[Std_DlgMacroExecuteDirect|DlgMacroExecuteDirect]]
|[[Std_Macro_Menu|Std Macro Menu]]
|[[Std_Macro_Menu|Std Macro Menu]]
|IconL=Std_MacroStopRecord.svg
|IconL=Std_DlgMacroRecord.svg
|IconR=Std_DlgMacroExecuteDirect.svg
|IconR=Std_DlgMacroExecuteDirect.svg
|IconC=Freecad.svg
|IconC=Freecad.svg

Revision as of 08:02, 10 October 2023

Std DlgMacroExecute

Menu location
Macro → Macros...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Std DlgMacroExecuteDirect

Description

The Std DlgMacroExecute command opens the Execute macro dialog box. From this dialog box macros can be executed, edited and managed.

The Execute macro dialog box

Usage

  1. There are several ways to invoke the command:
  2. The Execute macro dialog box opens. See Options.

Options

Find file / Find in files

introduced in version 0.22
These two input boxes can be used to filter macros from the file list on the User macros tab or the System macros tab. You may use regular expressions or simply enter text. All matches are case-insensitive.
Find file filters the list by filename. Only filenames that match the entered text will appear in the list. Find in files filters the list by file content. Only files whose text content matches the entered text will appear in the list.
Remove all text from a filter's input box to disable it. If both input boxes contain text, both filters are applied. Filtering may result in an empty list.

User macros

The User macros tab lists the macros available in the User macros location.
  1. Click a macro in the list to select it.
  2. The name of the selected macro will appear in the Macro name box.

System macros

To make use of the System macros tab you must create a folder named Macro as a sibling folder of the bin folder where FreeCAD is installed and put some macros there.
To find the bin folder enter this in the Python console:
App.getHomePath()
  1. Click a macro in the list to select it.
  2. The name of the selected macro will appear in the Macro name box.

User macros location

  1. Press the ... button to change the user macros location.
  2. Browse to a different folder and select it.

Execute

  1. To execute a macro do one of the following:
    • Select the macro in the list and press the Execute button.
    • Double-click the macro in the list.
  2. The dialog box closes.
  3. The macro is executed.

Close

  1. Press Esc or the Close button to close the dialog box.

Create

  1. Press the Create button to create a new macro file.
  2. Enter a name in the dialog box that pops up. You do not have to include the .FCMacro extension.
  3. Press Enter or the OK button.
  4. Both dialog boxes close.
  5. The new file is opened in the Macro editor.

Delete

  1. Select the macro you want to delete in the list.
  2. Press the Delete button.
  3. Press the Yes button in the confirmation dialog box that pops up.

Edit

  1. Select the macro you want to edit in the list.
  2. Press the Edit button.
  3. The dialog box closes.
  4. The selected file is opened in the Macro editor.

Rename

  1. Select the macro you want to rename in the list.
  2. Press the Rename button.
  3. Enter a new name in the dialog box that pops up. You do not have to include the .FCMacro extension.
  4. Press Enter or the OK button.

Duplicate

  1. Select the macro you want to duplicate in the list.
  2. Press the Duplicate button.
  3. Enter a new name in the dialog box that pops up. You do not have to include the .FCMacro extension.
  4. Press Enter or the OK button.

Toolbar

  1. Select the macro you want to add to a custom toolbar in the list.
  2. Press the Toolbar button.
  3. Two 'walkthrough' dialogs will guide you through the required steps. See Interface Customization for more information.

Download

  1. Press the Download button to start the Addon manager.

Notes

  • To learn more about macros see the Macros page.

Preferences

  • The user macros location can also be changed in the preferences: Edit → Preferences... → Python → Macro → Macro path. See Preferences Editor.