IDE Window: Editor User Defined Words

From Lazarus wiki
Jump to navigationJump to search

Template:IDE Window: Editor Options User Defined Words
This is part of the online help for the IDE.
It describes the section: "Editor" / "User Defined Words". You can open the described dialog in your IDE via:

  • The menu: "Tools" => "Options" / Editor options ...
  • The source-editor pop-up menu: "Editor properties ...

Navigation

     

General

Allows to specify several lists of "terms" that will be highlighted in all editors. The list work highlighter independent. The terms apply to any text in any editor.

Terms can be added or removed from the lists using key-shortcuts from the editor. Those terms can either apply to all editors or just the current. A lists may be empty at start, and only be used with terms added via shortcut.

Predefined terms (specified in this option dialog) can be temporarily disabled using the same shortcuts.

Current Limitations
Terms added via shortcuts are currently not saved when the IDE is closed. They are also not cleared if the project is changed.

Terminology

Term
A word, part of a word, sentence (several words) or any sequence of chars. Must be a single line.
Bounds
The begin or end of a word. A bound can either be a space before/after the matched term, the begin or end of the line, or a "none word" char (e.g. punctuation, quotes or "=")

Note: The matching of bounds, currently does not care for spaces (or other none-word chars in the search term. " Abc." will require another none-word char on each end in order to match bounds.

Select, Add, Delete List

IDE Options User Defined 1.png

Create or remove lists. Select the list to modify.

Main Settings

IDE Options User Defined 2.png

Name

Set/Edit a name for the list. The name is used to show the list in the drop down on the toolbar.

Case sensitive / Word bound at start/end

These option can be set individual for each term in the list of pre-defined terms.


list of pre-defined terms

A list of pre-defined terms, that will be highlighted. This list is active, when the IDE is started. Terms in this list can be temporarily disabled using the key-shortcuts.

See "Handling of duplicates and matches with overlaps" for info on how duplicates are handled. Duplicates are allowed while a list is edited. They will be marked in red. Duplicates are removed, if you select another list, or close the option dialog.

Key Settings

IDE Options User Defined 3.png

Add/Remove/Toggle word or term

Case sensitive / Word bound at start/end

Ignore bounds for terms longer than

Smart match selection bounds

Add/Remove to all editors

Colors

Handling of duplicates and matches with overlaps

Within the same list

Across different lists