Difference between revisions of "Using the Icon Lists Pane"
(44 intermediate revisions by 4 users not shown) | |||
Line 2: | Line 2: | ||
− | |||
+ | [[File:Gen_Using_the_Icon_Lists_Pane_01.png|center]] | ||
− | + | ||
+ | ==Bookmarks== | ||
All currently active bookmarks will be listed under this tab. | All currently active bookmarks will be listed under this tab. | ||
+ | |||
+ | If you right-click on the greyed icon within the Icon list window then you will have the following options: | ||
''Show:'' Locate and highlight the relevant flowchart icon. | ''Show:'' Locate and highlight the relevant flowchart icon. | ||
''Remove:'' Removes one icon from the list. | ''Remove:'' Removes one icon from the list. | ||
− | '' | + | ''Enable:'' Enable the icon. |
+ | ''Disable:'' Disable the icon. | ||
+ | |||
'''Adding and removing bookmarks''' | '''Adding and removing bookmarks''' | ||
− | Bookmarks | + | Bookmarks can be added or rather toggled by right clicking an icon, it can be removed by simply toggling it again (Bookmarks > Toggle Bookmark). |
+ | |||
+ | A bookmarked icon can be removed from the list by right clicking or by pressing the arrow next to the icon name and clicking the 'Remove' option | ||
+ | |||
+ | To remove all bookmarks from the list and the flowcharts, right-click on the '''Bookmarks''' root at the top of the window and click 'Remove All' | ||
+ | '''Using bookmarks''' | ||
− | ''' | + | Bookmarks are mainly used for quicker navigation around the flowchart, you can jump to a bookmarked icon by clicking it in the Icon lists pane, this can also be done by right clicking it or clicking the arrow next to it and clicking 'Show'. |
+ | |||
+ | Bookmarked icons can also be found or navigated through directly using the flowchart, you can right click any icon on the flowchart and select 'Next Bookmark' or 'Previous Bookmark' (Bookmarks > Next/Previous Bookmark) | ||
+ | |||
+ | ==Breakpoints== | ||
All currently active breakpoints will be listed under this tab. | All currently active breakpoints will be listed under this tab. | ||
+ | |||
+ | If you right-click on the greyed icon within the Icon list window then you will have the following options: | ||
''Show:'' Locate and highlight the relevant flowchart icon. | ''Show:'' Locate and highlight the relevant flowchart icon. | ||
''Remove:'' Removes one icon from the list. | ''Remove:'' Removes one icon from the list. | ||
− | ''Remove all | + | ''Enable:'' Enable the icon. |
+ | ''Disable:'' Disable the icon. | ||
+ | |||
+ | To remove all breakpoints from the list and the flowcharts, right-click on the '''Breakpoints''' root at the top of the window and click 'Remove All' | ||
+ | |||
+ | '''Adding and removing breakpoints''' | ||
+ | |||
+ | Breakpoints can be toggled on or off by selecting the icon at which point you wish to break and selecting Toggle Breakpoint from the Edit menu. Alternatively you can toggle the breakpoint with the F9 function key. | ||
+ | |||
+ | An alternative method to clear all breakpoints is to select 'Clear All Breakpoints' from the Debug menu (Debug > Clear All Breakpoints). | ||
+ | |||
+ | |||
+ | '''Using breakpoints''' | ||
+ | |||
+ | When a flowchart is simulating it will stop at the first breakpoint that it reaches. Pressing Play again will resume program flow - to the next breakpoint if there are more than one. | ||
+ | |||
+ | |||
+ | When at a breakpoint the user can examine variable values, inputs and outputs etc. | ||
+ | |||
+ | Breakpoints are useful for stopping the program at the start of a problematic piece of code to allow the user to step through and debug the code. | ||
+ | |||
+ | |||
+ | If the ICD Mode is enabled in the Debug menu (Debug > ICD Mode) then enabling a breakpoint will cause the ICD hardware to stop the target on a particular flowchart icon. | ||
+ | |||
+ | |||
+ | ==Disabled== | ||
+ | Any icons that are disabled by the flowcharts will appear greyed out within the disabled window. | ||
+ | |||
+ | If you right-click on the greyed icon within the Icon list window then you will have the following options: | ||
+ | ''Show:'' Locate and highlight the relevant flowchart icon. | ||
+ | ''Enable:'' Enables the icon. | ||
+ | ''Delete:'' Deletes the icon from the flowchart. | ||
+ | ===Find results=== | ||
− | + | After using the [[Find and Replace|find and replace]] function this list will be populated with any results from the search query. | |
− | + | If you right-click on the greyed icon within the Icon list window then you will have the following options: | |
''Show:'' Locate and highlight the relevant flowchart icon. | ''Show:'' Locate and highlight the relevant flowchart icon. | ||
− | 'Bookmark:' Sets a bookmark on the highlighted | + | ''Set colour:'' Sets the colour of the icon associated with the find results |
− | 'Remove:' Removes one icon from the list. | + | ''Bookmark:'' Sets a bookmark on the highlighted error. |
− | ' | + | ''Remove:'' Removes one icon from the list. |
− | ' | + | ''Enable:'' Enables the icon. |
+ | ''Disable:'' Disables the icon. | ||
+ | |||
+ | To remove all found results, right-click on the ''Find Results''' root at the top of the window and click 'Remove All' | ||
+ | |||
+ | |||
+ | '''Finding results''' | ||
− | ''' | + | Icon search results appear in this window when using the 'Find All' function in the [[Find and Replace]] window. |
+ | |||
+ | The results highlight applicable icons which contain the specified content, icon types can be toggled to hide or show the specified type of icon(s) from the search results. | ||
+ | |||
+ | The results can be further filtered with options to search for specified content in areas such as macros, variables/expressions, descriptions/text as well as generated code. | ||
+ | |||
+ | Conditions can be applied to search for 'whole words' to find specific content, you can further specify and filter the results by searching for 'case sensitive' content, you can also search backwards from your location in the flowchart or rather to reverse the list order. | ||
+ | |||
+ | ==Error results== | ||
Flowcode will warn and point to any errors in the code during compilation or simulation, any detected errors will appear in the 'Error results' list. | Flowcode will warn and point to any errors in the code during compilation or simulation, any detected errors will appear in the 'Error results' list. | ||
+ | If you right-click on the greyed icon within the Icon list window then you will have the following options: | ||
''Show:'' Locate and highlight the relevant flowchart icon. | ''Show:'' Locate and highlight the relevant flowchart icon. | ||
+ | ''Set colour:'' Sets the colour of the icon associated with the error results | ||
''Bookmark:'' Sets a bookmark on the highlighted error. | ''Bookmark:'' Sets a bookmark on the highlighted error. | ||
''Remove:'' Removes one icon from the list. | ''Remove:'' Removes one icon from the list. | ||
− | '' | + | ''Enable:'' Enables the icon. |
− | + | ''Disable:'' Disables the icon. | |
+ | |||
+ | |||
+ | To clear the error list, . | ||
+ | |||
+ | '''Using error results''' | ||
+ | |||
+ | Flowcode lists errors in your flowchart in this list, you can locate and go to any icon with an error by clicking it in the list or right clicking it or clicking the arrow next to the icon name and selecting 'Show'. In the same context menu you can also bookmark the icon, remove, disable or enable the icon, you can also bookmark or remove all icons in the list. | ||
+ | |||
+ | |||
+ | |||
+ | ==TODO List== | ||
+ | |||
+ | TODO Lists are hand reminders that can be set within comment icons, the display name of components or command icons and within calculation icons. | ||
+ | |||
+ | [[File:Gen_Using_the_Icon_Lists_Pane_03.png]] | ||
+ | |||
+ | |||
+ | For the display name, either the original text can be removed or left intact, then a space, and then the word TODO in upper case followed by a colon then a space, and finally the message. | ||
+ | |||
+ | For example, within the display name of a component icon you could have '''TODO: Add more PrintString components''' or '''Component Macro TODO: Needs attention here''' | ||
+ | |||
+ | As soon as you delete the word TODO: it will be removed from the TODO window. | ||
+ | |||
+ | ==Video instructions== | ||
+ | |||
+ | See the [http://www.youtube.com/watch?v=0DJ_3HXKfJo&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ&index=32 Intro to the Icon Lists] video for an overview of the Icon Lists panel and a walk through of how to use it effectively. |
Latest revision as of 12:16, 29 November 2023
The icon lists pane can be accessed from the View > Icon lists option within the main Flowcode menu or will appear automatically when using the find and replace tool. The window has several tabs each containing a list of different icons, you can view the options associated with any icon by hovering over it and clicking on the dropdown arrow that appears. Removing icons from the bookmarks and breakpoints lists will remove the bookmark or breakpoint from that icon.
Contents
Bookmarks
All currently active bookmarks will be listed under this tab.
If you right-click on the greyed icon within the Icon list window then you will have the following options:
Show: Locate and highlight the relevant flowchart icon. Remove: Removes one icon from the list. Enable: Enable the icon. Disable: Disable the icon.
Adding and removing bookmarks
Bookmarks can be added or rather toggled by right clicking an icon, it can be removed by simply toggling it again (Bookmarks > Toggle Bookmark).
A bookmarked icon can be removed from the list by right clicking or by pressing the arrow next to the icon name and clicking the 'Remove' option
To remove all bookmarks from the list and the flowcharts, right-click on the Bookmarks root at the top of the window and click 'Remove All'
Using bookmarks
Bookmarks are mainly used for quicker navigation around the flowchart, you can jump to a bookmarked icon by clicking it in the Icon lists pane, this can also be done by right clicking it or clicking the arrow next to it and clicking 'Show'.
Bookmarked icons can also be found or navigated through directly using the flowchart, you can right click any icon on the flowchart and select 'Next Bookmark' or 'Previous Bookmark' (Bookmarks > Next/Previous Bookmark)
Breakpoints
All currently active breakpoints will be listed under this tab.
If you right-click on the greyed icon within the Icon list window then you will have the following options:
Show: Locate and highlight the relevant flowchart icon. Remove: Removes one icon from the list. Enable: Enable the icon. Disable: Disable the icon.
To remove all breakpoints from the list and the flowcharts, right-click on the Breakpoints root at the top of the window and click 'Remove All'
Adding and removing breakpoints
Breakpoints can be toggled on or off by selecting the icon at which point you wish to break and selecting Toggle Breakpoint from the Edit menu. Alternatively you can toggle the breakpoint with the F9 function key.
An alternative method to clear all breakpoints is to select 'Clear All Breakpoints' from the Debug menu (Debug > Clear All Breakpoints).
Using breakpoints
When a flowchart is simulating it will stop at the first breakpoint that it reaches. Pressing Play again will resume program flow - to the next breakpoint if there are more than one.
When at a breakpoint the user can examine variable values, inputs and outputs etc.
Breakpoints are useful for stopping the program at the start of a problematic piece of code to allow the user to step through and debug the code.
If the ICD Mode is enabled in the Debug menu (Debug > ICD Mode) then enabling a breakpoint will cause the ICD hardware to stop the target on a particular flowchart icon.
Disabled
Any icons that are disabled by the flowcharts will appear greyed out within the disabled window.
If you right-click on the greyed icon within the Icon list window then you will have the following options:
Show: Locate and highlight the relevant flowchart icon. Enable: Enables the icon. Delete: Deletes the icon from the flowchart.
Find results
After using the find and replace function this list will be populated with any results from the search query.
If you right-click on the greyed icon within the Icon list window then you will have the following options:
Show: Locate and highlight the relevant flowchart icon. Set colour: Sets the colour of the icon associated with the find results Bookmark: Sets a bookmark on the highlighted error. Remove: Removes one icon from the list. Enable: Enables the icon. Disable: Disables the icon.
To remove all found results, right-click on the Find Results' root at the top of the window and click 'Remove All'
Finding results
Icon search results appear in this window when using the 'Find All' function in the Find and Replace window.
The results highlight applicable icons which contain the specified content, icon types can be toggled to hide or show the specified type of icon(s) from the search results.
The results can be further filtered with options to search for specified content in areas such as macros, variables/expressions, descriptions/text as well as generated code.
Conditions can be applied to search for 'whole words' to find specific content, you can further specify and filter the results by searching for 'case sensitive' content, you can also search backwards from your location in the flowchart or rather to reverse the list order.
Error results
Flowcode will warn and point to any errors in the code during compilation or simulation, any detected errors will appear in the 'Error results' list.
If you right-click on the greyed icon within the Icon list window then you will have the following options:
Show: Locate and highlight the relevant flowchart icon. Set colour: Sets the colour of the icon associated with the error results Bookmark: Sets a bookmark on the highlighted error. Remove: Removes one icon from the list. Enable: Enables the icon. Disable: Disables the icon.
To clear the error list, .
Using error results
Flowcode lists errors in your flowchart in this list, you can locate and go to any icon with an error by clicking it in the list or right clicking it or clicking the arrow next to the icon name and selecting 'Show'. In the same context menu you can also bookmark the icon, remove, disable or enable the icon, you can also bookmark or remove all icons in the list.
TODO List
TODO Lists are hand reminders that can be set within comment icons, the display name of components or command icons and within calculation icons.
For the display name, either the original text can be removed or left intact, then a space, and then the word TODO in upper case followed by a colon then a space, and finally the message.
For example, within the display name of a component icon you could have TODO: Add more PrintString components or Component Macro TODO: Needs attention here
As soon as you delete the word TODO: it will be removed from the TODO window.
Video instructions
See the Intro to the Icon Lists video for an overview of the Icon Lists panel and a walk through of how to use it effectively.