mirror of
https://gitlab.com/freepascal.org/lazarus/lazarus.git
synced 2025-04-30 23:23:39 +02:00
81 lines
4.2 KiB
XML
81 lines
4.2 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<fpdoc-descriptions>
|
|
<package name="SynEdit">
|
|
<descr>
|
|
<p>Related Topics:</p>
|
|
<p>
|
|
<link id="SynEditTextBase.TextBuffer and Views">TextBuffer and Views (Virtual Text Representation)</link>
|
|
</p>
|
|
</descr>
|
|
<module name="SynEdit">
|
|
<element name="TCustomSynEdit.BeginUpdate">
|
|
<short>Disables updates of internal data strucures, in order to speed up contineous updates. Also disables painting</short>
|
|
<descr>BeginUpdate disables the updating of many internal values and structures.
|
|
|
|
If an application want's to apply several changes at once to SynEdit, it should call BeginUpdate. This will speed up the process, as SynEdit only needs to calculate those values once, when all vhanges are applied.
|
|
|
|
The application must make sure to call EndUpdate once for each time it called BeginUpdate.
|
|
|
|
While in a BeginUpdate/EndUpdate block SynEdit will not repaint. Any paint request received, will be delayed untill the Endupdate is executed.
|
|
|
|
SynEdit will trigger OnChangeUpdating, if the update state changes. This is for the most outer calls to Begin/EndUpdate, but not for nested calls.
|
|
|
|
Some items not updated wile in a Begin/EndUpdate block:
|
|
* Highlight info
|
|
* Fold info
|
|
* CaretPos (will be updated on EndUpdate, to the last caret pos that was requested)
|
|
* Trailing spaces (if trimming is enabled)
|
|
* delay of certain events, like OnStatusChange
|
|
|
|
This means for example, that setting the caret pos temporarily to a position outside the visible area, will not force an update of the topline, while in update state.
|
|
|
|
It also allows one to insert code like the begin and end of a multiline comment "(*" / "*)" as 2 separate changes, without folded code below the new comment being affected (even the code would temporarily become a comment, and not have any keywords (begin/end) on which to fold)
|
|
|
|
</descr>
|
|
</element>
|
|
<element name="TCustomSynEdit.EndUpdate">
|
|
<short>Enable updates internal data strucures, and applies all changes since BeginUpdate</short>
|
|
</element>
|
|
<element name="TCustomSynEdit.MouseOptions">
|
|
<short>Controls the behaviour of the mouse (mouse-clicks)</short>
|
|
<seealso>
|
|
<link id="#SynEdit.SynEdit.TSynEdit.Options">Options</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomSynEdit.Options">
|
|
<short>General options to change the SynEdits behaviour</short>
|
|
<descr>
|
|
<p>
|
|
<u>About old/deprecated values for controlling the mouse:</u>
|
|
</p>
|
|
<p>They have been moved to <link id="#SynEdit.SynEdit.TSynEdit.MouseOptions">MouseOptions</link>
|
|
</p>
|
|
<p>If a new value is set to Options, then MouseOptions are updated only if any of them changed compared to their previous value in this property (Options), otherwise their value in MouseOptions is kept.
|
|
</p>
|
|
<p>If MouseOptions is assigned a new value, it will forward clearing any flag that it receives, but not forward setting any flags.
|
|
</p>
|
|
<p>This means:
|
|
<ul>
|
|
<li>As long as you only use Options both properties are kept in sync.</li>
|
|
<li>If you use MouseOptions instead, then you should leave the old flags in this property cleared. Which will allow you to set/change all other flags in this property, without interfering with MouseOptions.</li>
|
|
</ul>
|
|
</p>
|
|
</descr>
|
|
<seealso>
|
|
<link id="#SynEdit.SynEdit.TSynEdit.Options2">Options2</link>
|
|
<link id="#SynEdit.SynEdit.TSynEdit.MouseOptions">MouseOptions</link>
|
|
</seealso>
|
|
</element>
|
|
<element name="TCustomSynEdit.Options2">
|
|
<seealso>
|
|
<link id="#SynEdit.SynEdit.TSynEdit.Options">Options</link>
|
|
</seealso>
|
|
<short>More general options to change the SynEdits behaviour</short>
|
|
</element>
|
|
<element name="TCustomSynEdit.RowColumnToPixels"><short>Converts row, column to pixel on client area</short><descr>The pixel is the leftmost, upmost pixel of the character rectangular area.
|
|
For example row, colum 1,1 translates to 0,0 on client area if there is no gutter, no borderwidth, no scrolling etc.</descr>
|
|
</element>
|
|
</module>
|
|
</package>
|
|
</fpdoc-descriptions>
|