RichMemo/ru: what changed

Revision 3 to 4. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		![](/wiki-images/5/54/Richmemosample.png)
2	2
3	3		RichMemo - это пакет, который включает компонент для замены компонента Delphi TRichEdit. Он разработан кросс-платформенным способом, поэтому его реализация возможна для следующих платформ: Win32, MacOSX и Linux. Поскольку [[RichMemo/ru\|кроссплатформенность]] является основной целью, нативный API RichMemo может быть [[RichMemo/ru\|расширен]], чтобы сделать его совместимым с Delphi RichEdit.
4	4
5	5		Его основными характеристиками являются:
6	6
7	7		- Подсветка текста
8	8		- Системная поддержка редактирования Юникода
9	9
10	10		Планируется: (исправления приветствуются)
11	11
12	12		- Добавление изображений в текст
13	13		- Встраивание элементов управления LCL?
14	14
15	15		Загружаемый файл содержит компонент, установочный пакет и демонстрационное приложение, которое иллюстрирует возможности компонента, а также некоторые инструменты для оценки диаграммы в данной системе.
16	16
17	17		Пожалуйста, добавляйте ваши багрепорты/функции на [Github](https://github.com/skalogryz/richmemo/issues).
18	18
19	19		## Лицензия
20	20
21	21		Автор: Дмитрий 'скалогрыз' Бояринцев
22	22
23	23		[modified](http://svn.freepascal.org/svn/lazarus/trunk/COPYING.modifiedLGPL) [LGPL](http://svn.freepascal.org/svn/lazarus/trunk/COPYING.LGPL) (так же, как FPC RTL и Lazarus LCL). Вы можете связаться с автором, если измененный LGPL не работает с вашим проектом лицензирования.
24	24
25	25		## Загрузка
26	26
27	27		Последняя версия доступна здесь:
28	28
29		-	~~[`https://github.com/skalogryz/richmemo`](https://github.com/skalogryz/richmemo)~~
	29	+	```text
	30	+	https://github.com/skalogryz/richmemo
	31	+	```
30	32
31	33		Прим.перев.: Существует также [форк](https://github.com/mrandreastoth/richmemo) данного компонента на гитхабе от [Andreas Toth](https://github.com/mrandreastoth) aka mrandreastoth.
32	34
33	35		## Change Log
34	36
35	37		- Version 1.0.0 22th Jun 2009
36	38		- Version 0.8.0 Jun 2009
37	39
38	40		## Зависимости / Системные требования
39	41
40	42		- Lazarus 1.0.0
41	43
42	44		Статус: выпущен.
43	45
44	46		## Установка
45	47
46	48		- Скачайте исходники пакета
47	49		- Установите пакет в Lazarus и пересоберите его
48	50		- TRichMemo добавится в закладку 'Common Controls'.
49	51
50	52		![](/wiki-images/8/80/RichMemoPalette.PNG)
51	53
52	54		## TRichMemo
53	55
54	56		### Параметры шрифта
55	57
56	58		Параметры шрифта обычно представлены записью `TFontParams`. Тип используется для описания атрибутов шрифта rich. Некоторые атрибуты выходят за рамки класса `TFont`, поэтому необходим дополнительный тип. Однако большинство типов данных, связанных с `TFont`, используются повторно (т.е. `TFontStyles`).
57	59
58	60		- `Name` - название шрифта (семейство).
59	61		- `Size` - размер шрифта в пунктах (передача отрицательного значения может привести к неожиданным результатам).
60	62		- `Color` - цвет шрифта.
61	63		- `Style` - стили шрифта, включая полужирный, курсив, зачеркнутый, подчеркивание.
62	64		- `HasBkClr` - логический флаг, если текст для должен иметь цвет фона (если true, поле BkColor используется, в противном случае BkColor игнорируется). Прозрачность не поддерживается.
63	65		- `BkColor` - цвет фона (или подсветка) для текста.
64	66		- `VScriptPos` - вертикальная настройка текста ![](/wiki-images/c/c1/Richmemo_Subsuper.png).
65	67		- `vpNormal` - нет особой позиции.
66	68		- `vpSubscript` - текст - нижний индекс.
67	69		- `vpSuperscript` - текст - верхний индекс.
68	70
69	71
70	72		Фактическое вертикальное смещение индексов верх/низ зависит от реализации ОС и в настоящее время не может контролироваться.
71	73
72	74		Вы можете присвоить `FontParams` из структуры `TFont`. Для этого вам нужно использовать функцию `GetFontParams(afont: TFont)`. Обратите внимание, что для большинства элементов управления LCL для `TFont` установлены значения по умолчанию. Это не фактические значения, а скорее указание на то, что следует использовать шрифт по умолчанию для элемента управления (аналогично `crDefault` для `TColor`).
73	75
74	76		Функция `GetFontParams` разрешает имя шрифта по умолчанию и возвращает фактическое имя семейства шрифтов.
75	77
76	78		## Методы
77	79
78	80		### SetTextAttributes
79	81
80	82		``` pascal
81	83		procedure SetTextAttributes(TextStart, TextLen: Integer; AFont: TFont);
82	84		```
83	85
84	86		- `TextStart : Integer` - первый символ, который будет изменен
85	87		- `TextLen : Integer` - количество символов для изменения
86	88		- `AFont : TFont` - шрифт, который должен быть применен к части текста
87	89
88	90		``` pascal
89	91		procedure SetTextAttributes(TextStart, TextLen: Integer; const TextParams: TFontParams);
90	92		```
91	93
92	94		- `TextStart : Integer` - первый символ, который будет изменен
93	95		- `TextLen : Integer` - количество символов для изменения
94	96		- `TextParams : TFontParams` - параметры шрифта, которые будут установлены
95	97
96	98		Методы `SetTextureAttributes` изменяют указанный стиль текстового диапазона. Параметры шрифта передаются в обоих методах, параметром `AFont` (объект LCL `TFont`) или `TFontParams` (объявлено в RichMemo)
97	99
98	100		Установка атрибутов текста не меняет текущий выбор. Если необходимо изменить стиль выделенного в данный момент текста, вам следует выбрать `SelStart` и `SelLength` в качестве значений текстового диапазона:
99	101
100	102		``` pascal
101	103		RichMemo1.SetTextAttributes(RichMemo1.SelStart, RichMemo1.SelLength, FontDialog1.Font);
102	104		```
103	105
104	106		### GetTextAttributes
105	107
106	108		``` pascal
107	109		function GetTextAttributes(TextStart: Integer; var TextParams: TFontParams): Boolean; virtual;
108	110		```
109	111
110	112		- `TextStart : Integer` - позиция символа для запроса параметров шрифта
111	113		- `var TextParams : TFontParams` - выходное значение, заполненное атрибутами символа шрифта. Если метод завершается неудачно и возвращает `false`, значения поля записи будут неопределенными.
112	114
113	115		Заполняет параметры шрифта символа в позиции `TextStart`. Метод возвращает `True`, если `TextStart` является действительной позицией символа, и `False` в противном случае.
114	116
115	117		### GetStyleRange
116	118
117	119		``` pascal
118	120		function GetStyleRange(CharPos: Integer; var RangeStart, RangeLen: Integer): Boolean; virtual;
119	121		```
120	122
121	123		Возвращает диапазон символов с одинаковыми параметрами шрифта, т.е. все символы в диапазоне имеют одинаковые имя, размер, цвет и стили шрифта.
122	124
123	125		- `CharPos : Integer` - символ, который принадлежит диапазону стилей. Позиция не обязательно быть в начале диапазона стилей. Она может быть в середине конца диапазона стилей. Первая позиция символа возвращается параметром `RangeStart`.
124	126		- `var RangeStart : Integer` - первый символ в диапазоне
125	127		- `var RangeLen : Integer` - количество символов в диапазоне
126	128
127	129		Метод возвращает `true` в случае успеха. Метод возвращает `false`, если `CharPos` имеет неправильное значение - больше доступных символов или какая-либо другая ошибка.
128	130
129	131		### CharAtPos
130	132
131	133		``` pascal
132	134		function CharAtPos(x,y: Integer): Integer; virtual;
133	135		```
134	136
135	137		Возвращает смещение символа от нулевой позиции (не позиция UTF8). Возвращает -1 в случае неудачи.
136	138
137	139		- `x, y` - точка в клиентской области элемента управления RichMemo.
138	140
139	141		Метод знает о состоянии прокрутки элемента управления. Таким образом, два вызова `CharAtPos(0,0)` могут возвращать разные значения, если между вызовами изменяется позиция прокрутки. Смотрите "examples/hittest" для \[получения\] примера использования.
140	142
141	143		Если указанные `x,y` будут вне содержимого RichMemo, возвращаемое значение \[будет\] неопределенным. \[Поведение\] остается \[на усмотрение\] набора виджетов, который либо возвращает -1, либо закрывает доступный символ.
142	144
143	145		### SetRangeColor
144	146
145	147		``` pascal
146	148		procedure SetRangeColor(TextStart, TextLength: Integer; FontColor: TColor);
147	149		```
148	150
149	151		Метод устанавливает цвет символов в указанном диапазоне для FontColor. Другие параметры шрифта (имя, размер, стили) остаются без изменений.
150	152
151	153		- `TextStart: Integer` - первый символ в диапазоне
152	154		- `TextLength: Integer` - количество символов в диапазоне
153	155		- `FontColor: TColor` - цвет, который должен быть установлен
154	156
155	157		### SetRangeParams
156	158
157	159		``` pascal
158	160		procedure SetRangeParams(TextStart, TextLength: Integer; ModifyMask: TTextModifyMask;
159	161		const fnt: TFontParams; AddFontStyle, RemoveFontStyle: TFontStyles); overload;
160	162		```
161	163
162	164		Метод изменяет параметры шрифта в указанном диапазоне.
163	165
164	166		- `TextStart` - первый символ в диапазоне
165	167		- `TextLength` - количество символов в диапазоне
166	168		- `ModifyMask` - показывает, какие именно атрибуты шрифта должны быть обновлены. Маска принимает любую комбинацию из следующих значений:
167	169		- `tmm_Color` - Цвет шрифта будет изменен (поле `fnt.Color` должно быть заполнено)
168	170		- `tmm_Name` - имя шрифта будет изменено (поле `fnt.Name` должно быть заполнено)
169	171		- `tmm_Size` - размер шрифта будет изменен (поле `fnt.Size` должно быть заполнено)
170	172		- `tmm_Styles` - стили шрифта будут изменены в соответствии с параметрами `AddFontStyle, RemoveFontStyle`
171	173		- `tmm_BackColor` - Цвет подсветки текста (фона) будет изменен. (поля `fnt.HasBkClr` и `fnt.BkColor` должны быть заполнены)
172	174		- Отправка пустой маски приведет к возврату метода без внесения каких-либо изменений.
173	175		- `fnt` - Параметры шрифта, которые будут использоваться, в зависимости от значений `ModifyMask`.
174	176		- `AddFontStyle` - набор стилей, которые должны применяться к диапазону (используется только если `tmm_Style`s в `ModifyMask`, в противном случае игнорируется)
175	177		- `RemoveFontStyle` - набор стилей шрифта должен быть удален из диапазона (используется только если `tmm_Styles` в `ModifyMask`, в противном случае игнорируется)
176	178
177	179		``` pascal
178	180		procedure SetRangeParams(TextStart, TextLength: Integer;
179	181		ModifyMask: TTextModifyMask; const FontName: String;
180	182		FontSize: Integer; FontColor: TColor;
181	183		AddFontStyle, RemoveFontStyle: TFontStyles);
182	184		```
183	185
184	186		Перегруженная версия метода. Это просто оболочка вокруг параметра, использующая структуру `TFontParams`. Метод не поддерживает изменение цвета фона, вы должны использовать версию `TFontParams`
185	187
186	188		- `FontName` - имя шрифта, которое должно быть установлено (используется только если `tmm_Name` в `ModifyMask`, в противном случае игнорируется)
187	189		- `FontColor` - Цвет шрифта, который должен быть установлен (используется только если `tmm_Color` в `ModifyMask`, в противном случае игнорируется)
188	190
189	191		Например, если используется следующий код
190	192
191	193		```delphi
192	194		RichMemo1.SetRangeParams (
193	195		RichMemo1.SelStart, RichMemo1.SelLength,
194	196		[tmm_Styles, tmm_Color], // только изменение цвета и стиля
195	197		'', // имя шрифта - оно не используется, поэтому мы можем оставить его пустым
196	198		0, // размер шрифта - это размер шрифта, мы можем оставить его пустым
197	199		clGreen, // сделать весь текст в выбранной области зеленым цветом
198	200		[fsBold, fsItalic], // добавление жирного и курсивного стилей
199	201		[]
200	202		);
201	203		```
202	204
203	205		### GetParaAlignment
204	206
205	207		Получает выравнивание абзаца
206	208
207	209		``` pascal
208	210		function GetParaAlignment(TextStart: Integer; var AAlign: TParaAlignment): Boolean;
209	211		```
210	212
211	213		- `TextStart` - позиция символа, который принадлежит абзацу
212	214		- `AAlign` - получение выравнивания абзаца.
213	215
214	216		Примечание:
215	217
216	218		- Win32 - выравнивание по ширине не работает в Windows XP и более ранних версиях.
217	219		- OSX - из-за ограничений Carbon, это не работает в Carbon, но работает для виджетов Cocoa.
218	220
219	221		### SetParaAlignment
220	222
221	223		Устанавливает выравнивание абзаца
222	224
223	225		``` pascal
224	226		procedure SetParaAlignment(TextStart, TextLen: Integer; AAlign: TParaAlignment);
225	227		```
226	228
227	229		Примечание:
228	230
229	231		- Win32 - выравнивание по ширине не работает в Windows XP и более ранних версиях.
230	232		- OSX - из-за ограничений Carbon, это не работает в Carbon, но работает для виджетов Cocoa. Также необходимо, чтобы правильное выравнивание было загружено из файла RTF.
231	233
232	234		### GetParaMetric
233	235
234	236		Возвращает отступ метрики абзаца для данного абзаца ![](/wiki-images/b/be/Richmemo_parametric.PNG)
235	237
236	238		- `FirstLine` - смещение для первой строки (в пунктах) абзаца от начала элемента управления \[(т.н. "красная строка")\]
237	239		- `TailIndent` - смещение для каждой строки (в пунктах), за исключением первой строки, абзаца от конца элемента управления
238	240		- `HeadIndent` - смещение для каждой строки (в пунктах) абзаца от начала элемента управления
239	241		- `SpaceBefore` - дополнительное место перед абзацем (в пунктах)
240	242		- `SpaceAfter` - дополнительное место после абзаца (в пунктах)
241	243		- `LineSpacing` - коэффициент, используемый для расчета межстрочного интервала между строками в абзаце. Коэффициент применяется к размеру шрифта (самый высокий в строке), а не к высоте строки. Таким образом, это соответствует свойству CSS line-height. Обратите внимание, что нормальный межстрочный интервал равен 1,2. То есть шрифт размером 12 пт, фактический межстрочный интервал (равный 1,2) приведет к высоте строки 14 пт.
242	244		- не поддерживается в WinXP или более ранних версиях
243	245		- в большинстве систем не будет разрешено, если для межстрочного интервала установлено значение меньше 1,2. Значение будет проигнорировано, и оно по умолчанию будет равно 1,2
244	246
245	247		Примечание
246	248
247	249		- Параметры абзаца RichEdit указываются в пикселях, а не в точках, поэтому вам нужно либо преобразовать эти размеры самостоятельно, либо использовать метод RichMemoHelper.
248	250		- обозначение смещений «влево»/«вправо» исключено, чтобы избежать путаницы для RTL.
249	251
250	252		``` pascal
251	253		function GetParaMetric(TextStart: Integer; var AMetric: TParaMetric): Boolean;
252	254		```
253	255
254	256		### SetParaMetric
255	257
256	258		Устанавливает метрики абзаца
257	259
258	260		``` pascal
259	261		procedure SetParaMetric(TextStart, TextLen: Integer; const AMetric: TParaMetric);
260	262		```
261	263
262	264		Рекомендуется использовать функцию `InitParaMetric` для инициализации структуры `TParaMetric`. В противном случае обнуление структуры равно ее размеру (т.е. достаточно `FillChar(m, sizeof(TParaMetric), 0)`. Если значения `TParaMetric` получены из вызова `GetParaMetric`, то структура считается правильно инициализированной).
263	265
264	266		### GetParaRange
265	267
266	268		Возвращает диапазон символов для абзаца. Абзац идентифицируется символом.
267	269
268	270		``` pascal
269	271		function GetParaRange(CharOfs: Integer; var ParaRange: TParaRange): Boolean;
270	272		function GetParaRange(CharOfs: Integer; var TextStart, TextLength: Integer): Boolean;
271	273		```
272	274
273	275		`CharOfs` - символ, который принадлежит абзацу, диапазон которого возвращается. `TParaRange` - это структура, которая возвращает 3 поля
274	276
275	277		- `start` - первый символ в абзаце
276	278		- `lengthNoBr` - длина абзаца, за исключением символа разрыва строки
277	279		- `length` - длина абзаца, включая разрыв строки, если присутствующая последняя строка в элементе управления не содержит символа перевода строки, следовательно, `длина = lengthNoBr`.
278	280
279	281		### SetParaTabs
280	282
281	283		Устанавливает набор табуляций для абзацев указанной длины.
282	284
283	285		``` pascal
284	286		procedure SetParaTabs(TextStart, TextLen: Integer; const AStopList: TTabStopList);
285	287		```
286	288
287	289		- `TextStart`
288	290		- `TextLen`
289	291		- `AStopList` - структура, которая содержит массив табуляций.
290	292		- `Count` - указывает количество инициализированных элементов.
291	293		- `Tabs` - массив содержит описание каждой позиции табуляции, состоящее из `Offset` и `Alignment`.
292	294		- `Offset` - смещение точки табуляции в пунктах (с левой стороны элемента управления)
293	295		- `Align` - выравнивание позиции табуляции (`tabLeft` - по умолчанию, `tabCenter, tabRight, tabDecimal`).
294	296
295	297		Примечание
296	298
297	299		Renamefest
298	300		до r4140 перечисляемыми значениями `TTabAlignment` были `taLeft, taCenter, taRight, taDecimal`, но они вступали в противоречие с объявлениями `Classes.TAlignment`. Таким образом суффикс был изменен.
299	301
300	302		win32
301	303		позволяет не более 32 табуляций
302	304
303	305		gtk2
304	306		поддерживается только выравнивание `tabLeft`
305	307
306	308		carbon
307	309		не реализовано
308	310
309	311		### GetParaTabs
310	312
311	313		Получает массив табуляции. Если конкретные вкладки не указаны (по умолчанию виджет табуляции), счетчик AStopList будет установлен в 0.
312	314
313	315		``` pascal
314	316		function GetParaTabs(CharOfs: Integer; var AStopList: TTabStopList): Boolean;
315	317		```
316	318
317	319		### SetRangeParaParams
318	320
319	321		Выборочно устанавливает метрики абзаца
320	322
321	323		``` pascal
322	324		procedure SetRangeParaParams(TextStart, TextLength: Integer; ModifyMask: TParaModifyMask; const ParaMetric: TParaMetric);
323	325		```
324	326
325	327		- `TextStart` - символ первого абзаца, чтобы тоже применить стиль
326	328		- `TextLength` - количество символов, которые должны изменить свойства абзаца
327	329		- `ModifyMask` - Маска определяет, какой показатель должен быть установлен для каждого абзаца в блоке `TextStart..TextLength`.Другие символы останутся без изменений. Являются членами набора
328	330		- `pmm_FirstLine` - изменяет отступ первой строки. Поле `FirstLine` константы `ParaMetric` должно быть инициализировано
329	331		- `pmm_HeadIndent` - изменяет отступ абзаца с головы. Поле `HeadIndent` константы `ParaMetric` должно быть инициализировано
330	332		- `pmm_TailIndent` - изменяет отступ абзаца с хвоста. Поле `TailIndent` константы `ParaMetric` должно быть инициализировано
331	333		- `pmm_SpaceBefore` - меняет пробел до абзаца. Поле `SpaceBefore` константы `ParaMetric` должно быть инициализировано
332	334		- `pmm_SpaceAfter` - меняет пробел после (ниже) абзаца. Поле `SpaceAfter` константы `ParaMetric` должно быть инициализировано
333	335		- `pmm_LineSpacing` - межстрочный интервал внутри абзаца. Поле `LineSpace` константы `ParaMetric` должно быть инициализировано
334	336		- `ParaMetric` - структура, содержащая значения, которые будут установлены. Только поля, указанные \[структурой\] `ModifyMask` должны быть инициализированы
335	337
336	338		### LoadRichText
337	339
338	340		``` pascal
339	341		function LoadRichText(Source: TStream): Boolean; virtual;
340	342		```
341	343
342	344		- `Source: TStream` - поток для чтения данных из форматированного текста
343	345
344	346		Метод загружает данные в формате RTF из указанного потока. Возвращает true в случае успеха и false в противном случае. Если source равно nil, метод возвращает false.
345	347
346	348		Содержимое TRichMemo полностью заменяется содержимым в исходном потоке. Текущий выбор текста сбрасывается.
347	349
348	350		### SaveRichText
349	351
350	352		``` pascal
351	353		function SaveRichText(Dest: TStream): Boolean; virtual;
352	354		```
353	355
354	356		- `Source: TStream` - поток для записи данных форматированного текста
355	357
356	358		Метод сохраняет RTF-кодированные данные в указанном потоке. Возвращает true в случае успеха и false в противном случае. Если source равно nil, метод возвращает false.
357	359
358	360		Текущее состояние TRichMemo не меняется после возврата метода.
359	361
360	362		### Search
361	363
362	364		``` pascal
363	365		function Search(const ANiddle: string; Start, Len: Integer; const SearchOpt: TSearchOptions): Integer;
364	366		```
365	367
366	368		- `ANiddle: string` - текст для поиска.
367	369		- `Start: Integer` - позиция символа, с которой начинается поиск, если -1 или 0 - поиск сначала.
368	370		- `Len: Integer` - длина (в символах, а не в байтах) текста для поиска посередине.
369	371		- `SearchOpt: TSearchOptions`
370	372		- `soMatchCase` - поиск с учетом регистра.
371	373		- `soBackward` - поиск от конца документа до символа, обозначенного параметром "Start".
372	374		- `soWholeWord` - поиск всего слова.
373	375
374	376		Метод возвращает положение символа найденной подстроки. Позиция подходит для использования в свойстве `SelStart`. Тем не менее, может быть невозможно использовать для операции прямого копирования, если в коде присутствуют символы Unicode. Вместо этого следует использовать UTF8Copy.
375	377
376	378		Если `ANiddle` не был найден в тексте, возвращается -1
377	379
378	380		``` pascal
379	381		function Search(const ANiddle: string; Start, Len: Integer; const SearchOpt: TSearchOptions;
380	382		var TextStart, TextLength: Integer): Boolean;
381	383		```
382	384
383	385		(Метод введен с r5115)
384	386
385	387		- `ANiddle: string` - текст для поиска.
386	388		- `Start: Integer` - позиция символа, с которой начинается поиск, если -1 или 0 - поиск сначала.
387	389		- `Len: Integer` - длина (в символах, а не в байтах) текста для поиска посередине.
388	390		- `SearchOpt: TSearchOptions`
389	391		- `soMatchCase` - поиск с учетом регистра
390	392		- `soBackward` - поиск от конца документа до символа, обозначенного параметром "Start".
391	393		- `soWholeWord` - поиск всего слова.
392	394		- `(output) ATextStart` - позиция найденного текста (в символах)
393	395		- `(output) ATextLength` - длина найденного текста (в символах (позиции курсора!))
394	396
395	397		Метод возвращает значение true, если искомая подстрока найдена, в противном случае - значение false.
396	398
397	399		Возвращенные значения `ATextStart` и `ATextLength` подходят для использования в свойствах `SelStart` и `SelLength`.
398	400
399	401		> Note: для сложных сценариев найденный текст может совпадать с искомой подстрокой. Поведение поиска (в сложных сценариях) зависит от набора виджетов. Таким образом, поиск одной и той же строки в разных наборах виджетов (например, win32 или gtk2) может привести к разным результатам. Если вам нужны одинаковые результаты и вы их не получили, создайте отчет об ошибке.
400	402
401	403		Если вам нужно извлечь найденный текст, вы должны использовать метод `GetText()` (передавая значения `ATextStart` и `ATextLength`).
402	404
403	405		### GetText, GetUText
404	406
405	407		``` pascal
406	408		function GetText(TextStart, TextLength: Integer): String;
407	409		function GetUText(TextStart, TextLength: Integer): UnicodeString;
408	410		```
409	411
410	412		- `TextStart: Integer` -позиция символа для начала извлечения (0 - это первый символ в тексте).
411	413		- `TextLength: Integer` - длина (в символах, а не в байтах) текста для извлечения
412	414
413	415		`GetText()` возвращает подстроку UTF8
414	416
415	417		`GetUText()` возвращает подстроку UTF16
416	418
417	419		Текущее выделение не будет зависеть от операции. (Если вы видите, что выделение пострадало, пожалуйста, сообщите о проблеме).
418	420
419	421		Вы не должны учитывать \[абстрактную\] эффективность любого метода. Например, WinAPI внутренне работает с символами UTF16, поэтому `GetUText()` может быть более эффективным для него. В то время как Gtk2 работает с UTF8 и вызов `GetText()` может быть более эффективным для него. Вместо того, чтобы думать о базовой системе, вы должны учитывать потребности вашей задачи.
420	422
421	423		### Redo
422	424
423	425		``` pascal
424	426		procedure Redo;
425	427		```
426	428
427	429		Метод восстанавливает последнее предыдущее изменение [undone](http://lazarus-ccr.sourceforge.net/docs/lcl/stdctrls/tcustomedit.undo.html).
428	430
429	431		Вы всегда можете вызвать для проверки [[RichMemo/ru\|CanRedo]], если есть какие-либо действия\[, которые\] могут быть переделаны.
430	432
431	433		## Свойства
432	434
433	435		### ZoomFactor
434	436
435	437		``` pascal
436	438		property ZoomFactor: double
437	439		```
438	440
439	441		Read/Write свойство. Управляет масштабированием содержимого RichMemo. 1.0 - без увеличения. Менее \< 1,0 - уменьшить масштаб, более 1,0 - увеличить масштаб. Если установлено 0 - \[приводится к\] значению по умолчанию равным 1,0 коэффициенту масштабирования (без увеличения).
440	442
441	443		### HideSelection
442	444
443	445		``` pascal
444	446		property HideSelection: Boolean default false
445	447		```
446	448
447	449		Read/Write свойство. Если True, то выделение RichMemo скрыто, пока элемент управления не в фокусе. Если False, выделение отображается постоянно.
448	450
449	451		### CanRedo
450	452
451	453		``` pascal
452	454		property CanRedo: Boolean
453	455		```
454	456
455	457		Если \[возвращаемое значение\] True, в очереди отмены есть действия, которые можно повторить. Если \[возвращаемое\] значение False, в очереди отмены нет действий, которые можно повторить. Вызов Redo не будет иметь никакого эффекта.
456	458
457	459		### RTF
458	460
459	461		``` pascal
460	462		property Rtf: String
461	463		```
462	464
463	465		Read/Write свойство, которое позволяет читать или записывать текст в формате RTF для всего элемента управления. Назначение свойства - иметь возможность устанавливать Rich-Text во время разработки, однако свойство также будет работать во время выполнения.
464	466
465	467		![](/wiki-images/b/b8/RtfEditor.PNG)
466	468
467	469		Если значение свойства является пустой строкой, то свойство Lines используется как простой текст для инициализации значения элемента управления во время загрузки.
468	470
469	471		> Note: Свойство доступно только в классе TRichMemo, оно недоступно (или вообще не реализовано) в классе TCustomRichMemo. Рекомендуется использовать LoadRichText/SaveRichText для изменения содержимого страницы только потому, что они могут занимать меньше памяти, чем копирование всего расширенного текста в память.
470	472
471	473		> Note: для кроссплатформенной и прямой совместимости - в настоящее время свойство реализовано на основе набора виджетов, обеспечивающего чтение/запись в формате Rich-text. Весьма вероятно, что в ближайшем будущем оно будет изменено на использование кода чтения/записи RichMemo только RTF-stream. Проблема в том, что старые системы могут не поддерживать последнюю версию RTF.
472	474
473	475		Так что прямо сейчас вы можете столкнуться с проблемой, когда вы создадите проект в Gtk2 и сохраните richmemo время разработки, содержащее символы Unicode. Затем, если вы попытаетесь загрузить его на компьютер с XP и использовать собственный загрузчик widgetset, вы можете увидеть символы, отсутствующие или неправильно отображенные. Переход на использование \[механизмов\] RichMemo загрузки/сохранения RTF предотвратит эту проблему. В настоящее время вы также можете избежать этого, зарегистрировав загрузчики RichMemo (вызовите процедуры RegisterRTFLoader, RegisterRTFSaver при инициализации проекта перед загрузкой любого RichMemo)
474	476
475	477		## События
476	478
477	479		### OnSelectionChange
478	480
479	481		``` pascal
480	482		property OnSelectionChange: TNotifyEvent
481	483		TNotifyEvent = procedure (Sender: TObject) of object;
482	484		```
483	485
484	486		Событие запускается всякий раз, когда в RichMemo изменяется выделение: либо программно, либо из-за действий пользователя.
485	487
486	488		## TRichEditForMemo
487	489
488	490		Помощник класса, который реализует программный интерфейс RichEdit. Помощник объявлен в модуле RichEditHelpers, поэтому вы должны добавить его в раздел использования. Помощники доступны в FPC 2.6.0 или старше.
489	491
490	492		### Методы
491	493
492	494		#### FindText
493	495
494	496		Поиск заданного диапазона в тексте для целевой строки
495	497
496	498		### Свойства
497	499
498	500		#### SelAttributes
499	501
500	502		Читает/Изменяет атрибуты символа текущего выделения
501	503
502	504		### Paragraph
503	505
504	506		Читает/Изменяет атрибуты абзаца текущего выделения.
505	507
506	508		### RichMemoUtils
507	509
508	510		Представлен модуль, добавляющий некоторые полезные функции, специфичные для ОС, для работы с RichMemo.
509	511
510	512		#### InsertImageFromFile
511	513
512		-	~~`function InsertImageFromFile (const ARichMemo: TCustomRichMemo; APos: Integer;`\~~
513		-	~~` const FileNameUTF8: string;`\~~
514		-	~~` const AImgSize: TSize`\~~
515		-	~~`): Boolean = nil;`~~
	514	+	``` pascal
	515	+	function InsertImageFromFile (const ARichMemo: TCustomRichMemo; APos: Integer;
	516	+	const FileNameUTF8: string;
	517	+	const AImgSize: TSize
	518	+	): Boolean = nil;
	519	+	```
516	520
517	521		Отказ от ответственности: функция будет вставлять файл изображения в RichMemo (если он реализован набором виджетов), но очень неэффективным способом. Изображение будет прочитано снова, и память будет перераспределяться для изображения каждый раз. Поэтому, пожалуйста, не используйте его для смайликов в чате. Наилучшим \[выбором будет\] API (с кэшированием данных). (Вот почему этот метод не является частью класса TCustomRichMemo).
518	522
519	523		- `APos` - позиция в тексте
520	524		- `AImgSize` - размер, который нужно выставлять в ТОЧКАХ, а не в пикселях! Если и `cx`, и `cy` равны 0, размер изображения не будет изменен вообще. Если только один \[из размеров\] - `cx, cy` - равен нулю, результаты \[будут\] неопределенными.
521	525
522	526		Есть также служебная функция InsertImageFromFileNoResize, которая вызывает InsertImageFromFile, передавая размер как 0.
523	527
524	528		Пример использования
525	529
526	530		``` pascal
527	531		procedure TForm1.Button1Click(Sender: TObject);
528	532		begin
529	533		// вызов диалога для выбора картинки для вставки
530	534		if OpenDialog1.Execute then
531	535		// вставка картинки в текущую позицию курсора RichMemo
532	536		InsertImageFromFileNoResize(RichMemo1, RichMemo1.SelStart, OpenDialog1.FileName);
533	537		end;
534	538		```
535	539
536	540		### InsertStyledText, InsertColorStyledText, InsertFontText
537	541
538	542		Набор функций, которые упрощают добавление и замену стилизованного текста. Указанный стиль текста применяется к вставке. Общее правило для всех функций, если `InsPos` (позиция вставки) отрицательна - текст добавляется в конец. Для вставки текста в начало теста `InsPos` должна быть установлена в 0.
539	543
540	544		Вставленный текст не обязательно должен находиться на новой строке или добавлять новую строку. Возможно, вы захотите добавить символ `LineFeed` в параметр `TextUTF8`, чтобы вставленный текст был новой строкой.
541	545
542	546		``` pascal
543	547		procedure InsertStyledText(
544	548		const ARichMemo: TCustomRichMemo;
545	549		const TextUTF8: String;
546	550		AStyle: TFontStyles;
547	551		InsPos : Integer = -1 )
548	552		```
549	553
550	554		`InsertStyledText` вставляет стилизованный текст в указанную позицию.
551	555
552	556		``` pascal
553	557		procedure InsertColorStyledText(
554	558		const ARichMemo: TCustomRichMemo;
555	559		const TextUTF8: String;
556	560		AColor: TColor;
557	561		AStyle: TFontStyles;
558	562		InsPos : Integer = -1 )
559	563		```
560	564
561	565		`InsertColorStyledText` вставляет текст с указанным стилем и цветом в указанной позиции (по умолчанию в конец RichMemo).
562	566
563	567		``` pascal
564	568		procedure InsertFontText(
565	569		const ARichMemo: TCustomRichMemo;
566	570		const TextUTF8: String;
567	571		const prms: TFontParams;
568	572		InsPos : Integer = -1 )
569	573		```
570	574
571	575		`InsertFontText` вставляет текст и применяет к нему указанные FontParams.
572	576
573	577		Возможно, вы захотите создать помощник класса для реализации этих функций в качестве методов для RichMemo. Осторожно, если вы используете [[RichMemo/ru\|Delphi-совместимый помощник]] - вы можете \[попасть\] в конфликт.
574	578
575	579		## Установка
576	580
577	581		- Получить последнюю версию из SVN
578	582		- Откройте пакет и установите его, пересоберите IDE
579	583		- TRichMemo будет добавлен на вкладку 'Common Controls'
580	584
581	585		## Часто задаваемые вопросы
582	586
583	587		### Использование RichMemo в общих библиотеках
584	588
585	589		[Issue \#17412](http://bugs.freepascal.org/view.php?id=17412) Если вам нужно использовать компонент в разделяемой библиотеке, вам может понадобиться добавить ключ -fPIC к опции компилятора «пакета» и «проекта».
586	590
587	591		## (Delphi) RichEdit-подобный интерфейс
588	592
589	593		[Issue \#14632](http://bugs.freepascal.org/view.php?id=14632) Типичная проблема - портирование существующего кода, использующего RichEdit из Delphi. Интерфейс RichMemo не совпадает с RichEdit во многих отношениях. Но есть два способа справиться с этим:
590	594
591	595		- вы можете создать подкласс из TCustomRichMemo (или RichMemo) и реализовать методы Delphi RichEdit;
592	596		- вы можете использовать модуль RichMemoHelpers (требуется fpc 2.6.0 или более поздняя версия) и использовать методы, предоставляемые классом Helpers; в настоящее время реализованы свойства SelAttributes и Paragraph.
593	597
594	598		``` pascal
595	599		uses ... RichMemo, RichMemoHelpers;
596	600
597	601		TForm = class
598	602		RichMemo1 : TRichMemo;
599	603
600	604		// Свойство SelAttributes недоступно в базовом классе,
601	605		// но добавлено помощником, определенным в модуле RichMemoHelpers
602	606		RichMemo1.SelAttributes.Name := 'Courier New';
603	607		```
604	608
605	609		## Добавление смешанного цветного текста в конец RichMemo
606	610
607	611		Если вам просто нужна простая раскраска, то вот пример, который будет каждый раз добавлять новую строку со случайным цветом (протестировано в Windows):
608	612
609	613		``` pascal
610	614		procedure TForm1.Button1Click(Sender: TObject);
611	615		var
612	616		i, j: integer;
613	617		str: string;
614	618		begin
615	619		with Richmemo1 do
616	620		begin
617	621		str := 'Newline text';
618	622		i := Length(Lines.Text) - Lines.Count; // CR(перевод каретки) как #10#13 считается только один раз, так что вычтите его один раз
619	623		j := Length(str) + 1; // +1 сделать CR в том же формате
620	624		Lines.Add(str);
621	625		SetRangeColor(i, j, Round(random * $FFFFFF));
622	626		end;
623	627		end;
624	628		```
625	629
626		-	~~` ``Newline text`\~~
627		-	~~` ``NewLine text`\~~
628		-	~~` ``NewLine text`~~
	630	+	```text
	631	+	<span style="color:#0140FF">Newline text</span>
	632	+	<span style="color:#507FAF">NewLine text</span>
	633	+	<span style="color:#C04A90">NewLine text</span>
	634	+	```
629	635
630	636		Альтернативный пример простой раскраски (протестировано на Windows):
631	637
632	638		``` pascal
633	639		procedure TForm1.Button2Click(Sender: TObject);
634	640		begin
635	641		with RichMemo1 do
636	642		begin
637	643		Lines.Add('Line in red');
638	644		SetRangeColor(Length(Lines.Text) - Length(Lines[Lines.Count - 1]) - Lines.Count - 1, Length(Lines[Lines.Count - 1]), clRed);
639	645
640	646		Lines.Add('Line in blue');
641	647		SetRangeColor(Length(Lines.Text) - Length(Lines[Lines.Count - 1]) - Lines.Count - 1, Length(Lines[Lines.Count - 1]), clBlue);
642	648
643	649		Lines.Add('Normal line.');
644	650		Lines.Add('Normal line.');
645	651
646	652		Lines.Add('Line in green ');
647	653		SetRangeColor(Length(Lines.Text) - Length(Lines[Lines.Count - 1]) - Lines.Count - 1, Length(Lines[Lines.Count - 1]), clGreen);
648	654		end;
649	655		end;
650	656		```
651	657
652		-	~~` ``Line in red`\~~
653		-	~~` ``Line in blue`\~~
654		-	~~` ``Normal line.`\~~
655		-	~~` ``Normal line.`\~~
656		-	~~` ``Line in green`~~
	658	+	```text
	659	+	<span style="color:#FF0000">Line in red</span>
	660	+	<span style="color:#0000FF">Line in blue</span>
	661	+	<span style="color:#000000">Normal line.</span>
	662	+	<span style="color:#000000">Normal line.</span>
	663	+	<span style="color:#008000">Line in green</span>
	664	+	```
657	665
658	666		Если вам нужна смешанная раскраска, то это пример, который добавит новую строку с несколькими разноцветными словами (протестировано в Windows):
659	667
660	668		``` pascal
661	669		procedure TForm1.Button3Click(Sender: TObject);
662	670		procedure AddColorStr(s: string; const col: TColor = clBlack; const NewLine: boolean = true);
663	671		begin
664	672		with RichMemo1 do
665	673		begin
666	674		if NewLine then
667	675		begin
668	676		Lines.Add('');
669	677		Lines.Delete(Lines.Count - 1); // избегаем двойного межстрочного интервала
670	678		end;
671	679
672	680		SelStart := Length(Text);
673	681		SelText := s;
674	682		SelLength := Length(s);
675	683		SetRangeColor(SelStart, SelLength, col);
676	684
677	685		// отменяем выделение вставленной строки и помещаем курсор в конец текста
678	686		SelStart := Length(Text);
679	687		SelText := '';
680	688		end;
681	689		end;
682	690		begin
683	691		AddColorStr('Black, ');
684	692		AddColorStr('Green, ', clGReen, false);
685	693		AddColorStr('Blue, ', clBlue, false);
686	694		AddColorStr('Red', clRed, false);
687	695		end;
688	696		```
689	697
690		-	~~` ``Black, ``Green, ``Blue, ``Red`\~~
691		-	~~` ``Black, ``Green, ``Blue, ``Red`\~~
692		-	~~` ``Black, ``Green, ``Blue, ``Red`~~
	698	+	```text
	699	+	<span style="color:#000000">Black, </span><span style="color:#008000">Green, </span><span style="color:#0000FF">Blue, </span><span style="color:#FF0000">Red</span>
	700	+	<span style="color:#000000">Black, </span><span style="color:#008000">Green, </span><span style="color:#0000FF">Blue, </span><span style="color:#FF0000">Red</span>
	701	+	<span style="color:#000000">Black, </span><span style="color:#008000">Green, </span><span style="color:#0000FF">Blue, </span><span style="color:#FF0000">Red</span>
	702	+	```
693	703
694	704		## Разбор языка разметки
695	705
696	706		![mlparse example](/wiki-images/8/8c/Mlparse.png) Нативные элементы управления rich-edit не поддерживают синтаксический анализ языка разметки.
697	707
698	708		Вам нужно написать эту \[функциональность\] самостоятельно, как показано в примере с mlparse.
699	709
700	710		## Что внутри
701	711
702	712		### Матрица поддержки платформы
703	713
704	714		Ожидается, что значения в матрице не будут статическими (за исключением столбца "carbon"), каждая система должна поддерживать все функции, объявленные RichMemo.
705	715
706	716		Обратите внимание, что таблица содержит больше функций, чем опубликовано выше. Это означает, что API-интерфейсы уже доступны в RichMemo, но, поскольку они нестабильны (на некоторых платформах), они считаются «экспериментальными», а не обещанными.
707	717
708	718		\| Особенность \| Win32 \| Gtk2 \| Qt \| Cocoa \| Carbon \|
709	719		\|------------------------------------\|-------\|------\|-----\|-------\|--------\|
710	720		\| Выбор цвета и стиля шрифта \| \| \| \| \| \|
711	721		\| Цвет фона шрифта \| \| \| \| \| \|
712	722		\| Подстрочный, надстрочный \[текст\] \| \| \| \| \| \|
713	723		\| \[функция\] GetStyleRange \| \| \| \| \| \|
714	724		\| Выравнивание абзаца \| \| \| \| \| \|
715	725		\| Метрика абзаца \| \| \| \| \| \|
716	726		\| Отступы абзаца \| \| \| \| \| \|
717	727		\| Масштабирование \| \| \| \| \| \|
718	728		\| Печать \| \| \| \| \| \|
719	729		\| Загрузка/сохранение RTF \| \| \| \| \| \|
720	730		\| Возможность вставки \| \| \| \| \| \|
721	731
722	732		### Win32
723	733
724	734		![RichMemo without Theme patch](/wiki-images/e/e9/Rm_win32_notheme.PNG) ![RichMemo with Theme](/wiki-images/1/19/Rm_win32_theme.PNG)
725	735
726	736		- [RichEdit](https://msdn.microsoft.com/en-us/library/windows/desktop/bb787605%28v=vs.85%29.aspx) используется в качестве системного виджета. Последний известный .dll загружается и инициализируется при запуске. Обратите внимание, что RichEdit 1.0 не поддерживает большинство функций.
727	737		- Внутренняя оболочка RichEditManager предоставляется для совместимости с Win 9x. Однако это никогда не испытывалось и не проверялось. Также ожидается, что объект TOM может быть упакован как одна из реализаций RichEditManager. Однако имеющийся на месте «менеджер» может быть полностью удален.
728	738		- Согласно Интернету, элемент управления RichEdit не был обновлен Microsoft для поддержки рисования тем (начиная с XP и до Windows 8.1). Таким образом, RichEdit всегда может выглядеть как старый Win9x в 3D-элементе управления. На основе патча, предоставленного в [опубликованной проблеме](http://bugs.freepascal.org/view.php?id=25111) способ переопределить [WM_NCPAINT](https://msdn.microsoft.com/en-us/library/windows/desktop/dd145212%28v=vs.85%29.aspx) был представлен в r4153.
729	739
730	740		Win32RichMemo предоставляет глобальную переменную NCPaint. Это обработчик рисования не-клиентской области. По умолчанию он пытается нарисовать тематическую границу (см. Win32RichMemo.ThemedNCPaint для реализации). Он обеспечивает хорошие результаты по темам Windows XP, но в более поздних темах (где используются анимация) результаты не так хороши и должны быть обновлены.
731	741
732	742		Чтобы система могла выполнять только NCPaint (т.е. реализация LCL вызывает проблемы или новые окна обновляли RichEdit для правильного рисования границ), вы можете изменить значение NCPaint во время выполнения, сбросив его в nil:
733	743
734	744		``` pascal
735	745		uses
736	746		RichMemo, ..
737	747		{$ifdef WINDOWS}
738	748		Win32RichMemo
739	749		{$endif}
740	750
741	751		initialization
742	752		{$ifdef WINDOWS}
743	753		Win32RichMemo.NCPaint:=nil;
744	754		{$endif}
745	755		```
746	756
747	757		Вы также можете предоставить собственную реализацию NCPaint. Однако, если вы реализуете правильную анимацию рисунка темы, пожалуйста, предоставьте патч.
748	758
749	759		Поведение зависит от реализации Windows и не должно (и не будет) частью интерфейса RichMemo.
750	760
751	761		### Gtk2
752	762
753	763		- В качестве системного виджета используется [GtkTextView](https://developer.gnome.org/gtk2/stable/GtkTextView.html).
754	764		- Subscript и Superscript изначально не поддерживаются, в gtk2richmemo реализован дополнительный код для их реализации.
755	765		- Маркированные и нумерованные списки эмулируются.
756	766
757	767		### Gtk3
758	768
759	769		API между Gtk2 и [Gtk3](https://developer.gnome.org/gtk3/stable/GtkTextView.html) на самом деле не отличаются. Основное отличие в отрисовке. Для Gtk3 активно используется Cairo Canvas. Единственная область, на которую это влияет - "внутренности". Если кто-то хочет внести свой вклад в реализацию Gtk2 - пожалуйста, создайте отдельные модули gtk3richmemoXXX. Не нужно создавать {\$ ifdefs} в модулях gtk2.
760	770
761	771		### Cocoa
762	772
763	773		- Для Cocoa в качестве системного виджета используется [NSTextView](https://developer.apple.com/library/mac/documentation/Cocoa/Reference/ApplicationKit/Classes/NSTextView_Class/index.html).
764	774		- Не каждое семейство шрифтов предоставляет «курсивный» шрифт. Таким образом, даже если вы передадите fsItalic как часть Style для шрифта, он может быть проигнорирован.
765	775
766	776		### Qt
767	777
768	778		- Используется [QTextEdit](http://doc.qt.io/qt-4.8/qtextedit.html) виджет. В современных C-отображениях для Qt отсутствует множество API-интерфейсов RichText, поэтому полная реализация в настоящее время невозможна.
769	779		- Следующие классы должны быть сопоставлены с C-функциями:
770	780		- [QTextBlockFormatH](http://doc.qt.io/qt-4.8/qtextblockformat.html) необходим для выравнивания абзацев (например, отступы абзаца, межстрочный интервал и табуляции). QTextEdit предоставляет только выравнивание абзаца.
771	781		- [QTextCharFormatH](http://doc.qt.io/qt-4.8/qtextcharformat.html) необходим для дополнительного форматирования символов (то есть вертикальное выравнивание, поддержка ссылок). QTextEdit предоставляет только стили шрифтов.
772	782
773	783		## См. также
774	784
775	785		- [[RichMemo/Features]] - комментирует некоторые функции в процессе.
776	786		- [[RichMemo/WorkArounds]] - некоторые заметки о функциях еще не завершены.
777	787		- [[RichMemo/Defines]] - дополнительные переключатели пакетов, которые позволяют решить проблемы компиляции/времени выполнения
778	788		- [[RichMemo/Samples]] - еще примеры
779	789		- [MyNotex](https://sites.google.com/site/mynotex) приложение, которое использует модифицированный пакет Massimo Nardello RichMemo для Linux-Gtk2
780	790		- [[TMemo]]
781	791		- [[KControls\|KMemo control]]
782	792
783	793		---
784	794		From the Free Pascal wiki, page "RichMemo/ru", as it stood on 2022-02-28 after a change by Zoltanleo, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).

Back to history