Difference between revisions of "IDE Window: Editor Options Completion Hints"

From Free Pascal wiki
Jump to navigationJump to search
(→‎Navigation: Add main menu)
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{IDE Window: Editor Options Completion and Hints}}
+
<noinclude>{{IDE Window: Editor Options Completion Hints}}</noinclude>
  
<u><b>This is part of the online help for the IDE. </b></u><br/>
+
== Navigation ==
It describes the section: "Editor" / "Completion and Hints". You can open the described dialog in your IDE via:<br/>
 
*The menu: "Tools" => "Options" / Editor options ...
 
*The source-editor pop-up menu: "Editor properties ...
 
  
<font size="+1"><u><b>Navigation</b></u></font><br/>
+
* [[Main menu|Main Menu]] - Overview of all the main menu menu items for the IDE.
<table><tr><td>
+
 
*<font size="+1">[[IDE_Window:_Editor_Options|Editor Options]]</font> Overview of all Editor Options
+
* [[IDE Window: IDE Options Dialog|IDE Options]] - Overview of all the options for the IDE.
</td><td>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; </td><td>
+
 
*<font size="+1">[[IDE_Window:_Options|IDE Options]]</font> Overview of all options for the IDE</td>
+
* [[IDE Window: Editor Options|Editor Options]] - Overview of all the options for the IDE source code editor.
</tr></table>
+
 
 +
== Completion and Hints Dialog ==
 +
 
 +
You can open the '''Completion and Hints'''  dialog in your IDE via:
 +
 
 +
* The menu: '''Tools''' > '''Options''' > '''Editor - Completion and Hints'''
 +
 
 +
* From the source editor window pop-up (right-click) menu: '''Editor''' > '''Options''' > '''Editor - Completion and Hints'''
  
----
 
  
 
__TOC__
 
__TOC__
  
=Completion and Hints=
 
  
=== Auto remove empty methods ===
+
== Auto remove empty methods ==
 +
 
 +
Published methods without code are automatically removed on file save. For example, when you double click on a form the IDE creates the published method ''FormCreate''. When this is option is enabled and the method is still empty the IDE will remove it automatically when you save the form.
 +
 
 +
== Add close statement for Pascal blocks ==
 +
 
 +
Automatically add a close statement to complete a block of Pascal code. For example, when you type ''begin'' and press return the IDE will automatically add the ''end;''.
 +
 
 +
== Auto Display Function Prototypes ==
 +
 
 +
Show a hint with the parameters that the current procedure/function takes. This will activate, if you press {{keypress|(}} (left bracket) after the name of a function. It also activates, if you enter a {{keypress|,}} (comma) with the cursor inside the parentheses of a function call.
 +
 
 +
This can also be activated by pressing {{keypress|Shift|Ctrl|Space}}. Using the key combo works independently of the setting being enabled.
 +
 
 +
== Show Declaration Hints ==
 +
 
 +
When you hover the mouse over an identifier and wait a moment the IDE will show a hint. This provides details on where and how the identifier was declared/defined.
 +
 
 +
If the package ''TurboPowerIProDsgn'' is installed the mouse can move into the hint bubble and the location of the declaration acts as a link.
 +
 
 +
== Show Value Hints when debugging ==
 +
 
 +
When you hover the mouse over an identifier like for "Declaration Hints", but while debugging, then the IDE will evaluate the Identifier as a watch and display the current value.
 +
 
 +
=== Automatic typecasts for objects ===
 +
 
 +
If the identifier evaluated is an object (i.e. an instance of a class), then the IDE will typecast it to its actual class, showing more information.
  
Published methods without code are automatically removed on save. For example: When you double click on a form the IDE creates the published method FormCreate. When this is option is enabled and the method is still empty the IDE will remove it when you save the form.
+
That is by default "Sender: TObject" evaluates as TObject and only shows TObject fields. But with this option, it will determine the actual class (e.g. maybe a TButton) and show all the info for that class
  
=== Complete blocks ===
+
== Delay for completion box ==
  
Complete blocks. For example, when you type ''begin'' and press return the IDE will automatically add the ''end;''.
+
How long in seconds before the IDE opens the identifier completion dropdown.
This feature exists since 0.9.27.
 
  
=== Tooltip symbol Tools ===
+
The IDE only automatically opens the drop down if you. for example. type a {{keypress|.}} (full stop) after the name of a record or object.
  
When the mouse moves over an identifier in the source editor and waits a few seconds the IDE will present a hint with some informations.
+
== Delay for hints ==
  
 +
How long in seconds that you have to hover over an identifier before the IDE triggers  "Declaration Hints" or "Value Hints when debugging"
  
=== Tooltip expression evaluation ===
+
== Delay for long line hints in completion box ==
  
During debugging the tooltip hint will try to evaluate the expression at the cursor.
+
In the completion drop box some lines may not fully fit and be cut off. When you hover over such a line, or select it with {{keypress|up}} or {{keypress|down}}, then a hint will show the full line.
  
=== Delay ===
+
== Show long line hints ==
  
Set here the waiting period before the hint pops up.
+
How to position the "long line hints in completion box" hint.

Latest revision as of 12:29, 31 January 2021

English (en)

Navigation

  • Main Menu - Overview of all the main menu menu items for the IDE.
  • Editor Options - Overview of all the options for the IDE source code editor.

Completion and Hints Dialog

You can open the Completion and Hints dialog in your IDE via:

  • The menu: Tools > Options > Editor - Completion and Hints
  • From the source editor window pop-up (right-click) menu: Editor > Options > Editor - Completion and Hints



Auto remove empty methods

Published methods without code are automatically removed on file save. For example, when you double click on a form the IDE creates the published method FormCreate. When this is option is enabled and the method is still empty the IDE will remove it automatically when you save the form.

Add close statement for Pascal blocks

Automatically add a close statement to complete a block of Pascal code. For example, when you type begin and press return the IDE will automatically add the end;.

Auto Display Function Prototypes

Show a hint with the parameters that the current procedure/function takes. This will activate, if you press ( (left bracket) after the name of a function. It also activates, if you enter a , (comma) with the cursor inside the parentheses of a function call.

This can also be activated by pressing Shift+Ctrl+Space. Using the key combo works independently of the setting being enabled.

Show Declaration Hints

When you hover the mouse over an identifier and wait a moment the IDE will show a hint. This provides details on where and how the identifier was declared/defined.

If the package TurboPowerIProDsgn is installed the mouse can move into the hint bubble and the location of the declaration acts as a link.

Show Value Hints when debugging

When you hover the mouse over an identifier like for "Declaration Hints", but while debugging, then the IDE will evaluate the Identifier as a watch and display the current value.

Automatic typecasts for objects

If the identifier evaluated is an object (i.e. an instance of a class), then the IDE will typecast it to its actual class, showing more information.

That is by default "Sender: TObject" evaluates as TObject and only shows TObject fields. But with this option, it will determine the actual class (e.g. maybe a TButton) and show all the info for that class

Delay for completion box

How long in seconds before the IDE opens the identifier completion dropdown.

The IDE only automatically opens the drop down if you. for example. type a . (full stop) after the name of a record or object.

Delay for hints

How long in seconds that you have to hover over an identifier before the IDE triggers "Declaration Hints" or "Value Hints when debugging"

Delay for long line hints in completion box

In the completion drop box some lines may not fully fit and be cut off. When you hover over such a line, or select it with or , then a hint will show the full line.

Show long line hints

How to position the "long line hints in completion box" hint.