FreeCAD macro adds additional functionality to FreeCAD's built-in python editor. It is not a replacement for the editor, but rather a supplemental toolkit for the editor. It gives you functions like find and replace, diffing, snapshots, templates, bookmarks, and convenient links to help and documentation.
Install via the Addon manager in the macros section. The macro will create a new file called Editor_Assistant_Templates.txt in the same folder. This file holds the templates. It will need to be removed manually when you uninstall the macro.
Download the toolbar icon: 
Link
By default the macro opens in a 3rd tab in the combo view. You will have Model, Task, and Editor assistant tabs. If you prefer having a floating dockable, hold Alt key down while executing the macro.
The title bar will show the current version: "Editor Assistant v1.09", for example. The dialog works with the concept of a current editor, which will be one of the text documents currently open. These can be python scripts or "Text document" objects. Basically, any view in the MDI area that has a QPlainTextEdit as a child shows up in the macro's editor list at the top of the dialog. The editor list will need to be refreshed from time to time when you open/close a document, using the "Refresh" button. Ensure you are viewing the current editor by selecting it in the editor list at the top of the macro.
The widgets in the dialog are presented in a series of horizontal lines (using QHBoxLayouts). Here I will discuss briefly each line and the widgets contained on each. These lines can be individually enabled/disabled in settings menu -> layout.
The Top Line has the Main menu button and the Toast button. This is the only line that cannot be disabled.
This button is at the top left of the dialog and has the main editor assistant icon. Click the button to bring up the main menu, which contains the Close option to exit the macro. (But it's not really necessary to close the macro, just switch to one of the other tabs.) The main menu will be discussed in more detail below.
At the top of the dialog, above the Editor List there is a button reserved for "toast" messages. These are transient messages that disappear automatically after a few seconds. They can be error messages or just information. The button serves as the label for the messages. Click the button to see a log of previous messages in the Report view. The color of the message indicates the type of message. Types are: message: black, information: blue, error: red, warning: yellow. For some types the background color of the toast button is temporarily changed to provide better contrast.
This is the QListWidget at the top of the dialog. It will list the names of the documents currently registered with the dialog. Select an item in the list to make make that item the current editor. This also sets the focus on that editor. All the actions in the dialog will work on that current editor even if you select a different editor in FreeCAD's MDI widget. It is recommended to select the editor here so the dialog is in sync with the correct editor. From time to time the list might need to be synchronized with the open editors when a file has been opened/closed/created. Press Refresh to do this.
This button is labeled "Refresh". Click it if you have opened a new document or closed a document, so the Editor List can be updated. Updates also happen when other functions are used and when documents are opened, but not when closed.
This button is next to the refresh button and has a down arrow icon. Click this button to bring up a menu of Goto options. This is a very powerful and useful feature that can save you a lot of time. The Goto menu is also incorporated into the main menu as a Goto submenu. The Goto menu will be discussed in more detail below. It provides quick access to find results, bookmarks, line number presets, and more.
This is a QLineEdit that can hold either a single number (the line number you wish to go to) or a (comma separated) list of numbers that will appear in a selection menu when press return/enter while the widget has keyboard focus. The goto line option(s) appear as menu items in the Goto menu.
Important: Both undo and redo will replace all the text in the current editor with what it was when the undo/redo was stored in memory. This overwrite any changes you made by, for example, typing directly into the editor. As an example, suppose you rename some variable using replace all, from "myvar" to "myvariable". This is staged in the undo queue as "Undo replace myvar". Then you type in code for a new function definition. After typing that in you decide you want to undo renaming myvar to myvarible because it's too much typing, so you click Undo rename myvar. Guess what just happened to the new function definition? It's a gone pecan (but is staged in Redo). The editor has its own Undo/Redo system that does not always coincide with the macro's Undo/Redo queue. Use the macro's Undo to undo things done in the macro, such as replacing text or something done in the To console: line edit.
Click to undo an operation. Undo only works on things done in the dialog. There is a maximum number of events that can be undone. Currently, this is 100, but is subject to change. This is set in the source code as UNDO_QUEUE_MAX_SIZE = 100, at the top of the source file. You can change this default in user parameters. Tools menu -> edit parameters -> Plugings -> Editor assistant -> UndoQueueMaxSize. This is to prevent potential out of memory errors. The queue is based on the current editor. As you switch editors (via the editor list) the Undo button label will change, and will sometimes become disabled if there are no undo events in the queue for that editor.
Clicking this button purges the undo/redo queues. This cannot be undone.
When an operation is undone, the undone is popped and sent to the redo queue.
This button clears both the Find edit and the Replace edit fields.
This is a QLineEdit into which you may enter text to search for in the current editor. As characters are typed you will see a new toast showing how many times the entered text can be found in the current editor. If you are in "find" highlight mode you will also see matching text being highlighted in the current editor, if it is visible. (The Match case checkbox and the Whole words checkbox both figure into this.) You may press Enter/Return in this box to instigate a search or use one of the Find buttons, Find next for Find previous. For both the Find and Replace line edit widgets there is a context menu option to paste the currently selected text from the current editor into them. This can also be done by double clicking the line edit. For example, select some text in the current editor, and then double click the Find edit to put that text into it, replacing any existing text.
The text in the Find edit can also be used to fill in replacement text when using templates, discussed in more detail below.
Click this button to find the next instance of the text in the Find edit. If a match is found the text will be selected in the current editor and the cursor will move to that line. If it is not found, then nothing happens. Ctrl+Click to search from the beginning of the document. Alt+Click to find from selection. This uses the text currently selected in the current editor as if it were in the Find edit widget.
Like Find next except it searches backward. Ctrl+Click to begin the search from the end of the document. Alt+Click to find from selection. This uses the text currently selected in the current editor as if it were in the Find edit widget.
Note: the find from selection option for both Find previous and Find next does not limit the search to the selection, it searches the entire document for the selection.
This button replaces the text in the Find edit with that in the Replace edit and vice versa. You might find this convenient when you have done a search and replace and want to reverse that operation.
This is a QLineEdit containing replacement text (replacing the text in the Find Edit) when the Replace or Replace All buttons are used. The text in the Replace edit can also be used as replacement text when using templates, discussed in more detail below.
Replace the currently selected text in the current editor with the text in the Replace Edit, and then toggle the Find next button. Note: there need not be a previous find success. Whatever is currently selected gets replaced. You can use Undo to undo this operation.
Replace all occurrences of the text in the Find edit with the text in the Replace edit in the entire document. Or Ctrl+Click to only replace the occurrences in the currently selected text. If Replace edit is empty, then the occurrences are simply deleted. This respects both the Match case checkbox state and the match whole words check state. This can be undone using the Undo button.
Moves the selected text in the current editor to the left by 4 spaces if there are 4 spaces in front of every selected line. If not every selected line has 4 leading spaces the operation will not be done for any of the lines.
Moves the selected text in the current editor to the right by 4 spaces. If the Memo combo box contains any text, then that text is used rather than 4 spaces. The Indent icon changes to reflect this different behavior. This can be useful where you wish to comment out a block of text with a comment, such as #original. It can also be used if you prefer a different indentation than 4 spaces, for example if you want 2 spaces only.
If this contains text the behavior of the Indent button changes. This text is used instead of 4 spaces. See Indent button above for more details.
This is a QCheckBox. If checked searches are case-sensitive. Replace and Replace all both respect this checkbox state.
This is a QCheckBox. If checked, then searches are for the entire word. For example, "en" will not find "end" as a match if Whole words is checked.
This is a QCheckBox. If checked, then when there is a search that finds no result the cursor is set back to the top of the document. Or if it is a backwards search then the cursor goes back to the end of the document.
Takes a snapshot of the current editor, including it's full text and position of cursor if there is text selected. Snapshots can be very useful as temporary, in-memory backups of the file currently open. They can be used to restore the content back to the previous state, including the cursor position. They can be used to create diffs to show the changes that have been made since the snapshot was taken. (When a file is first opened an automatic snapshot is taken.) There is a special menu devoted to snapshots and diffs, the Snaps menu, discussed in more detail below.
Snapshots can be taken, popped, restored, discarded, saved, loaded, edited, and diffed. Popping a snapshot means to restore it to the current editor and then discard it. Restoring is like popping except for 2 differences: the snapshot is not discarded, and snapshots may be restored in any order (not only the most recent). Discarding is like popping except without restoring. You may save the snapshot as a file with the .py or .FCMacro extension, or any other extension you prefer. You can also save all the snapshots into a single file, stored in JSON format. Snapshots may be loaded from the JSON file. Editing a snapshot involves editing the "reason", which is a very brief description of the snapshot. Diffing creates an html file showing the differences between the 2 compared things, typically the current editor with one of its snapshots. Diffs can also be made between the current editor an another open file or between the current editor and some clipboard text.
Discards most recent snapshot (without restoring it). Use pop to restore and discard or use restore from the menu if you don't want to discard.
This opens the Snaps menu, discussed in more detail below.
This pops the latest snapshot in the queue, restoring it to the current document (overwriting its contents) and then discarding the snapshot.
This line edit can be very useful for directly controlling the current QPlainTextEdit widget, referenced as variable "editor" from this widget. For example, enter editor.selectAll() to select all the text in the current document. Refer to Qt documentation for functions available to QPlainTextEdit widgets.
Another variable available is "dlg", which refers to the Editor assistant dialog itself. This is mainly something I wanted as a debugging aid while writing this macro, but can have its uses.
Enter search("search string") to search FreeCAD source code on github in a new browser tab.
Enter qSearch("search string") to search qt for python documentation in a new browser tab.
Enter help("search string") for help on python. For example, help("numpy") will bring up help documentation in a new text document on that package. Another example, help("Part.makeShell") for help on the Part.makeShell() function.
Enter menu(Part.Circle) (Notice no quotation marks.) to get an interactive menu related to all things Part.Circle. Enter menu(Sketcher.Sketch) for an interactive menu on Sketcher.Sketch.
Use "\n" for multiple line commands.
Once a command has been entered you can then access "editor" and "dlg" via the python console.
Randomly, different default texts will appear in the To console: edit each time you run the macro to help demonstrate more of its capabilities.
There are 3 menus: the main menu, the goto menu, and the snaps menu. The goto and snaps menus are also accessible from the main menu.
The main menu is accessed by clicking the Main menu button at the top left of the dialog.
Here you can change some settings. Currently, only layout is available, but more settings will likely be coming to this menu in the future. Within layout you can individually enable/disable various lines of widgets. This is so you can make the dialog smaller if you need to and if you don't need access to those widgets you are hiding. There are also 3 presets to choose from: show all, show only defaults, show minimal. Clicking any of the 3 presets changes the individual line settings.
Discussed in detail in its own section below.
Discussed in detail in its own section below.
Templates are a way to insert text into the current document without needing to do so much typing. They are also convenient because there is less need to refer to documentation for exact syntax, arguments available, etc. In its simplest form a template merely inserts some text into the current cursor position. A more advanced usage is to have replaceable text that is dynamically replaced during the insertion. The cursor position can also be manipulated automatically by the template mechanism.
Templates are a dictionary of dictionaries. The entire template set is a dictionary with the template names serving as keys. The value for each top level key is a dictionary. A template item is a dictionary whose key is seen in the template editor in the list widget.
This template item dictionary must have at least one key named "output". The rest are all optional. The value of this "output" key is the text to be inserted or one of these recognized tokens:
"output" keywords: "input" -- output text is typed into a multiline QInputDialog during template execution "input1" -- same as input, but a single line edit dialog is used "selection" -- output text is the text that is currently selected in the current editor "clipboard" -- output text comes from the clipboard Any other value is the output text.
An optional key is "goto", which contains the line to go to before inserting the text. The value can be a line number, such as "42". It can also be "home" (move to beginning of document), "end" (move to end of document), or "input" (get the line from the user during template execution). If there is no "goto" key, or if its value is "current" or "", then the text is inserted at the current cursor position. Use "relative:NNN" for relative line changes.
"goto" values: "home" -- go to start of document "end" -- go to end of document "42" -- go to line 42 (or whatever) "input" -- get the line number in a popup QInputDialog during template execution "current" or "" -- use current cursor position "relative:3" -- go 3 lines down from current cursor position "relative:-7" -- go 7 lines up from current cursor position
We have only "output" and "goto" as recognized tokens for key names that have special meanings. All other keys are treated as the text to be replaced in the "output" value. For example, if the key is "label", then the string label is replaced with the value of this key during template execution. You can see this at work with the default "button" template item. The 2 keys "label" and "name" are replaced in the "output" value.
Replacement key values: "input" -- get input from user during template execution in a multiline text input dialog "input1" -- same as input, but use a single line input dialog "clipboard" -- use the text in the clipboard to replace this key in the "output" value text "find" -- use the text from the Find edit "replace" -- use the text from the Replace edit "selection" -- use the text selected in the current editor Any other value is used directly as the replacement text Examples: "label": "myLabel" (replaces all instances of "label" in the output text with "myLabel") "name": "input" (replaces all instances of "name" with what the user enters into a multi line input dialog during template execution) "QPushButton": "QAbstractButton" (replaces all instances of "QPushButton" in the output text with "QAbstractButton" during template execution) "message": "clipboard" (replaces all instances of "message" in the output text with the text from the clipboard)
Template items are converted many times between string and dictionary using json.dumps() and json.loads(). These functions require very specific syntax. You must use double quotes, for example, and a colon after the key name, commas to separate, etc. The templates are stored in a file called "Editor_Assistant_Templates.txt" and may be edited with any text editor if you prefer that method over using the Template editor dialog. This file is created and placed into the Macro folder, as a sibling to the macro. Its name is based on the macro name, so if you rename the macro it also uses a different name for its templates file. This can be a way to maintain separate template files, if preferred. The file is created and managed automatically, but it must be manually deleted if you decide to uninstall the macro.
This brings up a QInputDialog.getItem() dialog from which you can select the desired template to execute.
This does the same thing as Insert from dialog except you are presented with the templates directly as menu / submenu items, the goal being to make it a bit more streamlined. Once the template is selected the procedure is the same for both here and using Insert from dialog. Just use the one you prefer.
This brings up the Template editor dialog. In that dialog you can create new templates, delete templates, edit their content, execute them, test them, execute to clipboard, and get some additional help text.
Filtering allows you to view only those templates that contain the given filter text. So, for example, if you only want to see the templates for a certain project you could include the project name in the templates' names for that project, and then apply the filter to see only those templates. Or you might have some specifically for QInputDialogs.
This creates a new template that is a copy of the currently selected template, to be used as a starting point. There is no limit to how many templates you may have, except for the amount of memory / storage / processing power, of course.
This deletes the currently selected template. If you delete the last template, a new default is created. This is so there is always at least one template. Deleting cannot be undone. (But if you press the cancel button your templates file has not yet been changed at this point. It only changes on clicking Apply or Ok.)
This allows to rename a template. You cannot have 2 templates with the same name since they are stored as python dictionaries.
This is the list of templates at the top of the dialog. Select the template to work on and its text appears in the edit widget. Changing templates causes the previous template's changes to be updated in editor memory, but not the templates file. That file only gets updated when pressing Ok or Apply. Press Cancel to close the dialog without changing the templates file (as long as you didn't already use Apply).
This widget is where you type in the template item definition. Because it is a QPlainTextEdit the macro might from time to time mis-identify it as an open editor. In such cases you will see FreeCAD 0.20 as the editor title. You can ignore this for the time being, although some functions might work on it, such as find/replace, this is all quite by accident and not all dialog functions are guaranteed to work properly.
Use this button to test a template to see the output that it will produce when executed. You will see the output presented in a QMessageBox.
Use this to execute the selected template just as if it were applied from the Templates menu using Insert. Use this if you have made a temporary change to the template item definition, but don't want to save it to the templates file. Use execute, then Cancel when done.
This works like the Test button except the output gets copied to the system clipboard. You can then paste it into your document.
Brings up a small information dialog showing some basic information about using templates.
These work as you would expect in standard dialogs. Ok will apply the changes you have made to the templates file and close the dialog. Apply does the same as Ok, but without closing the dialog. Cancel closes the dialog without applying any changes (but doesn't undo any previously applied changes).
The Help menu provides dynamic menus for help on various topics inside the Reference submenu. There you have quick access to the various FreeCAD modules, such as Part, Draft, etc., to FreeCAD/App and FreeCADGui/Gui modules. You have also have access to the various Qt/PySide modules. When you click on the topic of interest the results of an interactive help() inquiry are placed into a new editor window. This is a very powerful reference tool. Experiment with it to get a better feel for how it works.
In addition to the reference submenu you can also search FreeCAD source code and Qt for python online documentation.
Note: the menu creation can also be done via the To console: line edit. Type in menu("Part.Circle") to see an example. Similarly, search("search string") searches FreeCAD source on github and qSearch("search string") searches Qt for Python documentation.
Highlighting is changing the background color of some text in the current editor. This is done for text that matches what is currently selected in the editor or what is in the Find edit. The highlight command can be invoked from the Main menu or from the Find edit context menu. Note: the text highlighting is automatically undone when the selection changes. Text currently selected does not appear to get the highlighting, but it is highlighted, it's just the selection highlighting supercedes the highlighting done here.
Highlighting does not change the text. You can see this by doing taking a snapshot before highlighting, and then doing a diff to see there are no changes. Previously, highlighting was added to undo, but that was when a different method of highlighting involving adding html was used. Since that is no longer the case and since adding highlighting to the undo queue tends to replace more important undo items, it has been removed from undo.
There are 2 highlighting modes: "find" and "selection". By default, the macro opens in "find" highlight mode. If you select some text in the current editor, then invoke highlight from selection from the main menu, this puts you into "selection" mode. When in "find" mode, every time you make a change to the text in the Find edit the highlighting gets updated. When in "selection" mode this does not happen, not even when the selection changes. (You can double click the Find edit to conveniently put the selected text into it.)
When changing the state of the Match case and Match whole words checkboxes, the highlighting gets updated automatically for both "find" and "selection" modes.
This uses the text currently selected in the current editor as the search text for the highlight process. This can be useful where you have some text in the Find edit that you don't want to change, but you want to highlight occurrences of some text in the current editor. It is recommended to use the Find edit where possible because then when you update the text in the Find edit the highlight changes automatically. This doesn't happen when changing the selected text while in "selection" highlight mode.
This uses the text in the Find edit as the search text for the highlight process.
Opens a custom file open dialog with the file selected if there is a current item in the editor list. You can then drag/drop this file to the forum to attach to your post.
Closes the dialog and exits the macro. If for some reason due to a bug you cannot get the Main menu to function you can also close the macro from the To console: edit or from the python console with dlg.close().
The goto menu is where you can go to various places in the open document. It can be a real time-saver for larger documents.
Here you will find dynamic menus created for each line (if any) listed in the Goto line numbers edit. If only one line is entered, then you get the one line as a menu option. If multiple lines are entered (comma-separated) you get a menu for each line number. (Pressing enter in the Goto line numbers edit also brings up this dynamic menu generation.)
This is a way to quickly jump to a particular function definition or class definition in your file. It is sorted by class name, then function name, so all the functions in a class are grouped together. This is a huge time-saver. Get familiar with it. Note: this is done with very simple methodology. It does not always work perfectly.
A bookmark can be created for each line of interest. Creation is done by adding a comment to the line in the form of ##: comment, 2 pound symbols (#) and a colon (:) followed by a label/comment, which can be anything. Without a comment/label the bookmark will be ignored. The default "##:" bookmark marker can be changed in user parameters: Tools menu -> edit parameters -> plugins -> editor assitant -> "BookmarkMarker". The bookmark marker should, of course, begin with a # or else the python interpreter will most likely flag it as a syntax error.
If the Find edit contains text that can be found in the document, then for each line the text is found on there is a dynamic menu item. There will be a few characters before and after the Find text added for context.
Just like Find results except it uses the text currently selected in the current document as the find text instead of taking it from the Find edit. Just select some text in the document, then click this menu to find all its locations and jump to them.
Go to the top / bottom of the current document.
Snapshots provide a sort of simplified version control system. When you take a snapshot of a file you get not only the full current text, but also the cursor position, including any selected text, if any. When the snapshot is restored, then also the cursor position is restored along with the text. Snapshots can also be diffed against the current editor. (Note: diffs are only for viewing, not intended to use as patches.)
Take a snapshot of the current editor. The snapshot is stored in memory only, not to persistent storage.
Restore the last snap taken of the current editor. (There might be some more recently taken of other editors, but this only accesses those taken of the current editor/document.) Options here are to restore to the current editor (overwriting any existing contents), to the clipboard, or to a new Text document object.
This restores to the current editor any of the snapshots in memory regardless of which editor was current when the snapshot was taken. It also allows access to snapshots other than the most recently taken one.
You can save the the most recent snapshot taken of the current document as a single file with .py, .FCMacro, or any other extension you wish to use. Or you can also save all the snapshots into a text file in JSON format. Snapshots are stored in memory, not to persistent storage. This Save option provides a way for this, so the snapshots can be used over multiple sessions.
Load the previously saved JSON format file of snapshots.
Discarding a snapshot is to destroy it without restoring. This differs from popping in that the snapshot is restored before discarding.
Diff a snapshot against the current editor. An auto snapshot is taken automatically when a file is first opened. If you make changes to the file, you can use the Diff feature to inspect your changes. It looks very much like the output you see with git diff. I find this quite convenient when putting together the Changelogs for my various projects. The diff may by saved to html and opened in a browser. The Diff Saver class has a few options, including context and column widths, that are not transferred to the saved html file.
In addition to diffing against snapshots of the current editor, you can also diff against text held in the clipboard and against other open editors.
A "reason" is a short documentation for a snapshot. By editing the reason you are editing this documentation.
- accept mario52 PR, work on backup file and dialog
- accept PR from mario52
- set fixed width for some elements to prevent them getting too wide at times
- change backup file name formatting
- tabify with the Model view if the combo view isn't found (combo view is gone now in 0.22)
- PR from mario52
- add icons to menus
- save and execute macro button
- backup management
- highlight active tab
- PR from mario52
- update some icons
- use open file dialog instead of save file dialog when opening json files
- remove line setting parameter outside Plugins/Editor_Assistant
- bump version information to 1.90b
- bug fix -- add another missing import
- support dir() in To console: QLineEdit
- bug fix -- add missing import
- PR from mario52
- add icons for template editor
- remember last folder when opening/saving
- add Drag to forum to main menu
- keep same selection after replacing text in selection using replace all
- accept mario52 PR to add custom indent text
- eliminate some xpm string warnings
- put on wiki for addon manager install
- workaround some qt modules not available for import on all systems
- rearrange icons, so clear and reverse are in front of find and replace, to better indicate their purposes
- down arrow moves from find edit to replace edit, up arrow from replace to find
- randomly add different suggested text to To console: edit each time the macro is executed
- ensure popSnapBtn exists before trying to enable/disable after call to refresh()
- mario52 PR -- add reverse and clear buttons for find/replace edits.
- add stretch between go to end button and the bookmark buttons, to keep them all together
- do not add highlighting to the undo/redo queue, not needed with new highlight method and obfuscates more important stuff that could be undone
- fix bug in replace all where the final character of the document was getting deleted
- make unindent and indent icon arrows red
- add wiki search function
- speed up loading by not importing some things until needed when creating help -> reference menus for FreeCAD packages.
- fix bug in highlighting where keys like "+" were being interpreted as re special characters
- bookmark icons
- add bookmark features
- add bookmark buttons to goto line
- make goto line shown by default
- add filter to template editor
- add to settings menu: Show all, Show defaults, Show minimal
- add UndoQueueMaxSize to parameters, default = 100
- add BookmarkMarker to parameters, default = "##:"
- add MaxIconizedButtonWidth to parameters, default: 32 px
- add EditorListMinimumHeight to parameters, default: 32 px
- add new combo boxes to settings -> layout menu, make hidden by default to keep dialog small
- accept mario52 PR, put new combo boxes that remember recent Find and Replace texts
- Check if QtNetwork is available, if not disable in help -> reference -> qt -> menu
- bug fix: 'selection' mode was switching to 'find' mode without user invoking highlight by find
- performance fix: return from highlight() if txt to be highlighted is empty string
- make lastHighlightMode = "find" by default so user gets highlighting when first entering anything into find edit
- Support Match whole words with highlighting and replace all (already worked with replace next)
- Redo highlighting when find edit text changes
- Redo highlighting when match case or whole words checkbox state changes
- Make highlight function respect state of match case checkbox
- remove view modes since those can be found in FreeCAD Windows menu.
- add support for 'relative:' token for 'goto' keys in templates
- change highlighting from html to QtGui.QTextEdit.ExtraSelection class
- remove unHighlight since no longer needed (text automatically unhighlights with a new selection)
- disable highlighting where text contains <, nbsp;, or font///style.
- highlighting
- use submenus for class/def lines, find results, and find from selection results in goto menu
- Diff saver use table column headers instead of QLabels
- "output" key in template item can have token values: "input", "input1", "clipboard", "selection"
- other keys can have token values: "input", "input1", "selection", "clipboard", "find" ,"replace"
- bug fix with snap diff menu generation
- do not convert \n to chr(10) when executing templates
- 'input' now uses multi line text input dialog
- 'input1' new token uses single line text input
- build dynamic menus for template insertion
- check if macro already running and exit if so rather than have multiple instances
- minor changes to template editor
-
- button duplicates current template
- create new default template if last one is deleted
Template editor dialog improvements
- on deleting select the next item
- on renaming, offer current name as default
- on renaming, select same item
- on new item, don't allow empty name
- move apply button to standard dialog button box
- change label of execute to clipboard so all buttons line up vertically
- make template editor dialog non-modal
- Ctrl+Replace all button = replace only in selection (not in whole document)
- Home/End buttons, default = not shown, enable in main menu -> settings -> layout -> GotoLine
- Add Home/End menu items to Goto menu
- allow "\n" to be used in input dialogs when using templates
- add "current" as optional value for "goto"
- update help documentation in template editor
- add "goto" key token to templates
- instead of saving templates in user parameters, create a new file called: "Editor_Assistant_Templates.txt" in same folder as macro
- add execute to clipboard button in template editor
- add execute button in editor
- preformat help text
- preformat test text
- add apply button in editor
- add template function
- Add .FCMacro, .py, .txt to snapshot save as file type
- add qSearch() to search qt for python online documentation
- add search() to help menu: 3 ways to search 1) from find edit text, 2) from selected text, 3) ask for text in a new dialog
- add search() function to To console: line edit (opens new browser tab to github repo search results page)
- add menu() alias for dlg.makeReferenceMenu() in To console:
- better support module names as strings in help() and menu()
- allow for multiple line statements in To console line edit
- allow for help("help string") in To console line edit
- add help menu
- bugfix --error when creating new empty document
- put line numbers first for find results in goto menu
- put some context characters ahead of find results in goto menu
- remove a debug message
- Automatically take a snapshot of each file when it is first opened.
- add goto menu to main menu
- add snaps menu to main menu
- internally rename snaps menu from context menu to normal menu since it's no longer a context menu
- disconnect mdi area subWindowActivated signal on closing
- move diffs to mdi area for a more seamless integration
- add low priority toast option -- such toasts do not overwrite existing toasts
- add view mode to main menu
supported modes: tabbed, tiled, cascade
- refresh editor list when a new text file is opened
- fix typo in window title
- change default from floating dockable widget to embedded as a 3rd tab in combo view.
- fix bug where warning toasts were shown as normal messages
- add Close to main menu
- add main menu button
- add settings -> layout menu to enable/disable individual lines of widgets
- optimize diff performance
- show log of all toasts when clicking toast button instead of just the last toast
- add restore last snap to restore any menu
- allow to diff current editor to any other open editor
- allow to diff current editor against clipboard text
- extend showDiff() to be able to make diffs of arbitrary text strings
- add labels to diff screen
- add find selection results to goto menu
- trim some labels -- rely on icon and tooltips
- after To console command check if text changed for creating undo
- on To console command open python console if not already open, set keyboard focus to it
- add dlg variable to To console command
- add Loop checkbox
- Ctrl+Find to search from beginning
- Ctrl+Find previous to search from end
- Alt+Find / Find previous to search using selected text
- fix failure to set current editor (causes some blinking)
- add restore any functionality
- rename some buttons so pop, restore, discard always mean the same things
- add reason editor
- check for tabs and warn if any are found
- remove some tabs from Gimp-generated XPM icon string
- improve diff viewer
- make diffs into html and show in a web browser view
- improve tooltips for snaps menu button and goto menu button
- allow to pop individual snaps out of order
- add load/save to/from JSON files (all snaps for all editors)
- add snap diff functionality (diff text goes to new Text document object)
- improve cursor centering
- check macro hasn't been closed before attempting to clear toast
- warn that find results do not respect whole words checkbox
- make Find results menu respect Match case checkbox
- add find results to goto menu
- add bookmark functionality
- put submenus in goto menu for line numbers, class/defs, and bookmarks
- rearrange some icons
- add goto menu
- allow for multiple line numbers (comma separated list) in goto line edit
- change from task panel to dockable widget (Hold Alt key while executing macro for old behavior.)
- rework some icons
- add error checking for when there are no open editors
- add snapshot feature
- add text cursor positioning to snapshots and undo/redo
- new icons for indent and unindent
- double click Find/Replace edits to replace existing content with selected text in current editor
- add redo button
- add undo queue clear button
- rearrange widgets, putting goto on same line as refresh button
- add placeholder text to goto line edit
- Use a button for toast messages instead of a label. That way it can be clicked and the last toast reshown.
- Use message types instead of colors direction. message types: warning, error, message, information
- Set background color for some message types to get a nice contrast.
- Set a maximum length for undo queue and pop the oldest when the max is reached. This is to prevent out of memory issues potentially.
- UNDO_QUEUE_MAX_SIZE = 100 (subject to change)
- avoid infinite loop if replace all is clicked without anything in the Find edit
- implement Undo button
- handle backslashed characters in Find edit, such as \t, \n
- fix type in Replace all handler.
- Disable Replace all if Whole words is checked.
- Make Replace all respect Match case checkbox (but still not Whole words)
- add icons to the dialog
- new icon
- remove icon, to be replaced
- embed xpm icon