Difference between revisions of "Extending the IDE/ru"

From Lazarus wiki
Jump to navigationJump to search
m (Fixed syntax highlighting; deleted category included in page template)
 
(27 intermediate revisions by one other user not shown)
Line 37: Line 37:
 
Одиночный элемент меню, такой как [, например,] 'View Object Inspector', называется '''TIDEMenuCommand'''. Вы можете создать его с помощью '''RegisterIDEMenuCommand''', который имеет две формы с большим количеством параметров:
 
Одиночный элемент меню, такой как [, например,] 'View Object Inspector', называется '''TIDEMenuCommand'''. Вы можете создать его с помощью '''RegisterIDEMenuCommand''', который имеет две формы с большим количеством параметров:
  
<syntaxhighlight>function RegisterIDEMenuCommand(Parent: TIDEMenuSection;
+
<syntaxhighlight lang=pascal>function RegisterIDEMenuCommand(Parent: TIDEMenuSection;
 
                                 const Name, Caption: string;
 
                                 const Name, Caption: string;
 
                                 const OnClickMethod: TNotifyEvent = nil;
 
                                 const OnClickMethod: TNotifyEvent = nil;
Line 54: Line 54:
  
 
Следующий [код] регистрирует новую команду меню с именем 'MyTool', с заголовком 'Start my tool' и при нажатии выполняет процедуру ''StartMyTool'':
 
Следующий [код] регистрирует новую команду меню с именем 'MyTool', с заголовком 'Start my tool' и при нажатии выполняет процедуру ''StartMyTool'':
<syntaxhighlight>procedure StartMyTool;
+
<syntaxhighlight lang=pascal>procedure StartMyTool;
 
begin
 
begin
 
   ... выполняется при нажатии на пункт меню ...
 
   ... выполняется при нажатии на пункт меню ...
Line 68: Line 68:
 
Этот пункт меню не имеет сочетания клавиш. Если вы хотите [назначить ему] сочетание клавиш, вы должны создать '''TIDECommand''' и передать его в параметре '''Command'''. Например:
 
Этот пункт меню не имеет сочетания клавиш. Если вы хотите [назначить ему] сочетание клавиш, вы должны создать '''TIDECommand''' и передать его в параметре '''Command'''. Например:
  
<syntaxhighlight>uses ... IDECommands, MenuIntf;
+
<syntaxhighlight lang=pascal>uses ... IDECommands, MenuIntf;
 
...
 
...
 
var
 
var
Line 85: Line 85:
  
 
Все сочетания клавиш (ключи, которые вызывают какое-либо действие) зарегистрированы в IDECommandList. Вот пример того, как найти все команды, которые реагируют на клавиши {{keypress|Ctrl}}+{{keypress|D}} или две комбинации клавиш, начинающиеся с {{keypress|Ctrl}}+{{keypress|D}}:
 
Все сочетания клавиш (ключи, которые вызывают какое-либо действие) зарегистрированы в IDECommandList. Вот пример того, как найти все команды, которые реагируют на клавиши {{keypress|Ctrl}}+{{keypress|D}} или две комбинации клавиш, начинающиеся с {{keypress|Ctrl}}+{{keypress|D}}:
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses
 
uses
 
   Classes, SysUtils, LCLProc, IDECommands;
 
   Classes, SysUtils, LCLProc, IDECommands;
Line 119: Line 119:
 
Все конфигурационные файлы IDE хранятся в одном каталоге в виде XML-файлов. Пакеты также могут добавлять свои собственные файлы туда. Каталог [[pcp|primary config path]] можно прочитать с помощью:
 
Все конфигурационные файлы IDE хранятся в одном каталоге в виде XML-файлов. Пакеты также могут добавлять свои собственные файлы туда. Каталог [[pcp|primary config path]] можно прочитать с помощью:
  
<syntaxhighlight>uses LazIDEIntf;
+
<syntaxhighlight lang=pascal>uses LazIDEIntf;
 
...
 
...
 
   Directory := LazarusIDE.GetPrimaryConfigPath;</syntaxhighlight>
 
   Directory := LazarusIDE.GetPrimaryConfigPath;</syntaxhighlight>
Line 125: Line 125:
 
Пакеты могут создавать свои собственные файлы XML с помощью:
 
Пакеты могут создавать свои собственные файлы XML с помощью:
  
<syntaxhighlight>uses
+
<syntaxhighlight lang=pascal>uses
 
   ..., LCLProc, BaseIDEIntf, LazConfigStorage;
 
   ..., LCLProc, BaseIDEIntf, LazConfigStorage;
  
Line 205: Line 205:
  
 
Вот простой пример:
 
Вот простой пример:
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
unit Unit1;
 
unit Unit1;
  
Line 296: Line 296:
  
 
Это создаст include-файл паскаля, который используется в разделе initialization mybutton.pas:
 
Это создаст include-файл паскаля, который используется в разделе initialization mybutton.pas:
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
initialization
 
initialization
 
   {$I mybutton.lrs}
 
   {$I mybutton.lrs}
Line 323: Line 323:
  
 
Существует специальный редактор свойств для сокрытия [свойств]:
 
Существует специальный редактор свойств для сокрытия [свойств]:
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
   RegisterPropertyEditor(TypeInfo(TAnchorSide), TControl, 'AnchorSideLeft', THiddenPropertyEditor);
 
   RegisterPropertyEditor(TypeInfo(TAnchorSide), TControl, 'AnchorSideLeft', THiddenPropertyEditor);
 
</syntaxhighlight>
 
</syntaxhighlight>
Line 329: Line 329:
 
=== Поиск редактора свойств, используемого для свойства ===
 
=== Поиск редактора свойств, используемого для свойства ===
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses Classes, TypInfo;
 
uses Classes, TypInfo;
 
var
 
var
Line 348: Line 348:
 
*Создать пакет времени разработки (или расширить существующий)
 
*Создать пакет времени разработки (или расширить существующий)
 
*Ваша форма должна быть в модуле этого пакета
 
*Ваша форма должна быть в модуле этого пакета
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
...
 
...
 
interface
 
interface
Line 388: Line 388:
 
== Создание нового уникального имени компонента ==
 
== Создание нового уникального имени компонента ==
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses FormEditingIntf;
 
uses FormEditingIntf;
  
Line 404: Line 404:
 
== Выбор компонента в конструкторе/инспекторе объектов ==
 
== Выбор компонента в конструкторе/инспекторе объектов ==
  
<syntaxhighlight>uses propedits;
+
<syntaxhighlight lang=pascal>uses propedits;
 
..
 
..
 
GlobalDesignHook.SelectOnlyThis(AComponent);</syntaxhighlight>
 
GlobalDesignHook.SelectOnlyThis(AComponent);</syntaxhighlight>
Line 410: Line 410:
 
== Получение файла модуля, дизайнера формы ==
 
== Получение файла модуля, дизайнера формы ==
  
<syntaxhighlight>uses ProjectIntf, LazIDEIntf, ComponentEditors;
+
<syntaxhighlight lang=pascal>uses ProjectIntf, LazIDEIntf, ComponentEditors;
 
...
 
...
 
// открываем файл
 
// открываем файл
Line 426: Line 426:
 
== Сохранение модуля, дизайнера формы ==
 
== Сохранение модуля, дизайнера формы ==
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses LazIDEIntf;
 
uses LazIDEIntf;
 
...
 
...
Line 494: Line 494:
 
====Пример: когда [на родителя] помещается новый компонент, перемещать элемент управления в дочерний элемент====
 
====Пример: когда [на родителя] помещается новый компонент, перемещать элемент управления в дочерний элемент====
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
...
 
...
 
type
 
type
Line 543: Line 543:
 
Обычно дизайнер ловит все события мыши компонента. Если ваш пользовательский элемент управления должен обрабатывать дескриптор событий мыши, вы можете либо установить '''csDesignInteractive''' '''ControlStyle''', либо вы можете точно управлять им через сообщение ''CM_DESIGNHITTEST'' в вашем элементе управления:
 
Обычно дизайнер ловит все события мыши компонента. Если ваш пользовательский элемент управления должен обрабатывать дескриптор событий мыши, вы можете либо установить '''csDesignInteractive''' '''ControlStyle''', либо вы можете точно управлять им через сообщение ''CM_DESIGNHITTEST'' в вашем элементе управления:
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
type
 
type
 
   TYourControl = class(TCustomControl)
 
   TYourControl = class(TCustomControl)
Line 568: Line 568:
 
Например:
 
Например:
  
<syntaxhighlight>procedure TYourAddOn.OnDesignerModified(Sender: TObject);
+
<syntaxhighlight lang=pascal>procedure TYourAddOn.OnDesignerModified(Sender: TObject);
 
var
 
var
 
   IDEDesigner: TComponentEditorDesigner;
 
   IDEDesigner: TComponentEditorDesigner;
Line 637: Line 637:
 
Чтобы перебрать все паскалевские модули, перечисленные в инспекторе проектов, вы можете использовать, например:
 
Чтобы перебрать все паскалевские модули, перечисленные в инспекторе проектов, вы можете использовать, например:
  
<syntaxhighlight>uses  
+
<syntaxhighlight lang=pascal>uses  
 
   LCLProc, FileUtil, LazIDEIntf, ProjectIntf;
 
   LCLProc, FileUtil, LazIDEIntf, ProjectIntf;
  
Line 658: Line 658:
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
===All used units of project===
+
===Все используемые модули проекта===
  
To find all currently used units of a project/package you can use the following. Note that the IDE needs to parse all units, so it can take some time.
+
Чтобы найти все используемые в настоящее время модули проекта/пакета, вы можете использовать следующее. Обратите внимание, что в среде IDE необходимо проанализировать все модули, поэтому это может занять некоторое время.
  
<syntaxhighlight>uses  
+
<syntaxhighlight lang=pascal>uses  
 
   LazLoggerBase, LazIDEIntf, ProjectIntf;
 
   LazLoggerBase, LazIDEIntf, ProjectIntf;
  
Line 673: Line 673:
 
   if LazProject<>nil then  
 
   if LazProject<>nil then  
 
   begin
 
   begin
     Units:=LazarusIDE.FindUnitsOfOwner(LazProject,[fuooListed,fuooUsed]); // add fuooPackages to include units from packages
+
     Units:=LazarusIDE.FindUnitsOfOwner(LazProject,[fuooListed,fuooUsed]); // добавьте fuooPackages, чтобы включить модули из пакетов
 
     try
 
     try
 
       for i:=0 to Units.Count-1 do
 
       for i:=0 to Units.Count-1 do
Line 683: Line 683:
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
==The .lpr, .lpi and .lps file of a project==
+
==Файлы .lpr, .lpi и .lps проекта==
  
<syntaxhighlight>uses  
+
<syntaxhighlight lang=pascal>uses  
 
   LCLProc, FileUtil, ProjectIntf, LazIDEIntf;
 
   LCLProc, FileUtil, ProjectIntf, LazIDEIntf;
 
var
 
var
Line 691: Line 691:
 
begin
 
begin
 
   LazProject:=LazarusIDE.ActiveProject;
 
   LazProject:=LazarusIDE.ActiveProject;
   // every project has a .lpi file:
+
   // у каждого проекта есть файл .lpi:
   DebugLn(['Project'' lpi file: ',LazProject.ProjectInfoFile]);
+
   DebugLn(['Файл проекта lpi: ',LazProject.ProjectInfoFile]);
  
   // if the project session information is stored in a separate .lps file:
+
   // если информация о сеансе проекта хранится в отдельном файле .lps:
 
   if LazProject.SessionStorage<>pssNone then
 
   if LazProject.SessionStorage<>pssNone then
     DebugLn(['Project'' lps file: ',LazProject.ProjectSessionFile]);
+
     DebugLn(['Файл проекта lps: ',LazProject.ProjectSessionFile]);
  
   // If the project has a .lpr file it is the main source file:
+
   // Если у проекта есть файл .lpr, то он является основным исходным файлом:
 
   if (LazProject.MainFile<>nil)
 
   if (LazProject.MainFile<>nil)
 
   and (CompareFileExt(LazProject.MainFile.Filename,'lpr')=0) then
 
   and (CompareFileExt(LazProject.MainFile.Filename,'lpr')=0) then
     DebugLn(['Project has lpr file: ',LazProject.MainFile.Filename]);
+
     DebugLn(['Проект имеет файл lpr: ',LazProject.MainFile.Filename]);
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
==The executable / target file name of a project==
+
==Имя исполняемого / целевого файла проекта==
  
There is a macro $(TargetFile), which can be used in paths and external tools.
+
Существует макрос $(TargetFile), который можно использовать в путях и внешних инструментах.
You can query the macro in code:
+
Вы можете запросить макрос в коде:
  
<syntaxhighlight>uses MacroIntf;
+
<syntaxhighlight lang=pascal>uses MacroIntf;
  
 
function MyGetProjectTargetFile: string;
 
function MyGetProjectTargetFile: string;
Line 715: Line 715:
 
   Result:='$(TargetFile)';
 
   Result:='$(TargetFile)';
 
   if not IDEMacros.SubstituteMacros(Result) then
 
   if not IDEMacros.SubstituteMacros(Result) then
     raise Exception.Create('unable to retrieve target file of project');
+
     raise Exception.Create('невозможно получить целевой файл проекта');
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
See here for more macros: [[IDE Macros in paths and filenames]].
+
См. здесь для более полной информации по макросам: [[IDE_Macros_in_paths_and_filenames/ru|Макросы IDE в путях и именах файлов]].
  
==Add your own project type==
+
==Добавление своего собственного типа проекта==
  
You can add items to the 'New ...' dialog:
+
Вы можете добавлять [свои] пункты в диалоговое окно 'New ...':
  
*See the unit ProjectIntf of the package IDEIntf.
+
*Смотрите модуль ProjectIntf пакета IDEIntf.
*See the [[Project Templates]]
+
*См. [[Project_Templates/ru|Шаблоны проекта]]
  
 +
==Добавление своих собственных типов файлов==
  
==Add your own file type==
+
Вы можете добавлять [свои] пункты в диалоговое окно 'New ...':
  
You can add items to the 'New ...' dialog:
+
*Смотрите модуль ProjectIntf пакета IDEIntf.
 +
*Выбрав базовый класс TFileDescPascalUnit для обычных модулей или TFileDescPascalUnitWithResource для новой формы/модуля данных.  
  
*See the unit ProjectIntf of the package IDEIntf.
+
===Добавление нового типа файла===
*Choose a base class TFileDescPascalUnit for normal units or TFileDescPascalUnitWithResource for a new form/datamodule.
 
  
===Add a new file type===
+
<syntaxhighlight lang=pascal>uses ProjectIntf;
 
 
<syntaxhighlight>uses ProjectIntf;
 
 
...
 
...
 
   { TFileDescText }
 
   { TFileDescText }
Line 763: Line 762:
 
begin
 
begin
 
   inherited Create;
 
   inherited Create;
   Name:='MyText'; // do not translate this
+
   Name:='MyText'; // не переводите эту [строку]
 
   DefaultFilename:='text.txt';
 
   DefaultFilename:='text.txt';
 
   AddToProject:=false;
 
   AddToProject:=false;
Line 770: Line 769:
 
function TFileDescText.GetLocalizedName: string;
 
function TFileDescText.GetLocalizedName: string;
 
begin
 
begin
   Result:='My Text'; // replace this with a resourcestring
+
   Result:='My Text'; // замените это строкой из resourcestring
 
end;
 
end;
  
 
function TFileDescText.GetLocalizedDescription: string;
 
function TFileDescText.GetLocalizedDescription: string;
 
begin
 
begin
   Result:='An empty text file';
+
   Result:='Пустой текстовый файл';
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
===Add a new form type===
+
===Добавление нового типа формы===
  
<syntaxhighlight>uses ProjectIntf;
+
<syntaxhighlight lang=pascal>uses ProjectIntf;
  
 
...
 
...
Line 806: Line 805:
 
begin
 
begin
 
   inherited Create;
 
   inherited Create;
   Name:='MyForm'; // do not translate this
+
   Name:='MyForm'; // не переводите эту [строку]
 
   ResourceClass:=TMyForm;
 
   ResourceClass:=TMyForm;
 
   UseCreateFormStatements:=true;
 
   UseCreateFormStatements:=true;
Line 818: Line 817:
 
function TFileDescPascalUnitWithForm.GetLocalizedName: string;
 
function TFileDescPascalUnitWithForm.GetLocalizedName: string;
 
begin
 
begin
   Result:='MyForm'; // replace this with a resourcestring
+
   Result:='MyForm'; // замените это строкой из resourcestring
 
end;
 
end;
  
 
function TFileDescPascalUnitWithForm.GetLocalizedDescription: string;
 
function TFileDescPascalUnitWithForm.GetLocalizedDescription: string;
 
begin
 
begin
   Result:='Create a new MyForm from example package NotLCLDesigner';
+
   Result:='Создать новую MyForm из примера пакета NotLCLDesigner';
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
 +
== Сохранение пользовательских значений в [файлах] lpi/lps ==
  
== Store custom values in lpi/lps ==
+
Вы можете хранить свои собственные данные с помощью пар имя/значение в CustomData и CustomSessionData.
 
+
  LazarusIDE.ActiveProject.CustomData['Name']:=Value; // хранится в lpi - x-platform, общие данные
You can store your own data via name/value pairs in CustomData and CustomSessionData.
+
  LazarusIDE.ActiveProject.CustomSessionData['Name']:=Value; // хранится в lpi - x-platform, общие данные
  LazarusIDE.ActiveProject.CustomData['Name']:=Value; // stored in lpi - x-platform, shared data
 
  LazarusIDE.ActiveProject.CustomSessionData['Name']:=Value; // stored in lps - only this machine
 
  
=Packages=
+
=Пакеты=
You can perform various actions with [[Lazarus_Packages|Packages]]:
+
Вы можете выполнять различные действия с [[Lazarus_Packages/ru|пакетами]]:
  
==Search in all packages==
+
==Поиск во всех пакетах==
  
Iterate all packages loaded in the IDE (since 0.9.29).
+
Переберите все пакеты, загруженные в IDE (начиная с 0.9.29).
  
<syntaxhighlight>uses PackageIntf;
+
<syntaxhighlight lang=pascal>uses PackageIntf;
 
...
 
...
 
for i:=0 to PackageEditingInterface.GetPackageCount-1 do
 
for i:=0 to PackageEditingInterface.GetPackageCount-1 do
 
   writeln(PackageEditingInterface.GetPackages(i).Name);</syntaxhighlight>
 
   writeln(PackageEditingInterface.GetPackages(i).Name);</syntaxhighlight>
  
==Search a package with a name==
+
==Поиск в пакетах с [определенным] именем==
  
<syntaxhighlight>uses PackageIntf;
+
<syntaxhighlight lang=pascal>uses PackageIntf;
 
...
 
...
 
var
 
var
Line 857: Line 855:
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
Note: FindPackageWithName does not open the package editor. For that use DoOpenPackageWithName.
+
{{Note| FindPackageWithName не открывает редактор пакетов. Для этого используйте DoOpenPackageWithName.}}
  
==Get lpk filename of an installed package==
+
==Получение имени файла lpk установленного пакета==
  
<syntaxhighlight>uses PackageIntf;
+
<syntaxhighlight lang=pascal>uses PackageIntf;
 
...
 
...
 
var
 
var
Line 871: Line 869:
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
==Install packages==
+
==Установка пакетов==
  
'''Note''': Only install packages with IDE plugins. Installing other packages can make the IDE unstable.
+
{{Note| Устанавливайте только пакеты с плагинами IDE. Установка других пакетов может привести к нестабильной работе среды IDE.}}
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses PackageIntf, contnrs;
 
uses PackageIntf, contnrs;
 
...
 
...
Line 883: Line 881:
 
     Pkg.Name:='Cody';
 
     Pkg.Name:='Cody';
 
     PkgList.Add(Pkg);
 
     PkgList.Add(Pkg);
     // check if the IDE can find the cody.lpk and all dependencies
+
     // проверьте, может ли IDE найти cody.lpk и все зависимости
     // The IDE will prompt some warnings/confirmations if something looks strange.
+
     // Среда IDE покажет некоторые предупреждения/подтверждения, если что-то выглядит странно.
 
     if not PackageEditingInterface.CheckInstallPackageList(PkgList,[]) then
 
     if not PackageEditingInterface.CheckInstallPackageList(PkgList,[]) then
 
       exit;
 
       exit;
     // in this example we have checked already, so skip the warnings
+
     // в этом примере мы [это] уже проверили, поэтому пропустите предупреждения
     // and rebuild the IDE
+
     // и пересоберите IDE
 
     if PackageEditingInterface.InstallPackages(PkgList,[piiifSkipChecks,piiifRebuildIDE])<>mrOK then
 
     if PackageEditingInterface.InstallPackages(PkgList,[piiifSkipChecks,piiifRebuildIDE])<>mrOK then
 
       exit;
 
       exit;
Line 896: Line 894:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==Open a package file (lpk)==
+
==Открытие файла пакета (lpk)==
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses PackageIntf, FileUtil;
 
uses PackageIntf, FileUtil;
 
...
 
...
Line 911: Line 909:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
{{Warning| The IDE automatically closes unused packages on idle. Never keep a reference to an TIDEPackage.}}
+
{{Warning| Среда IDE автоматически закрывает неиспользуемые пакеты в режиме ожидания. Никогда не храните ссылку на TIDEPackage.}}
  
==Find the package(s) of a unit==
+
==Поиск пакета(-ов) модуля==
  
You have the file name of a unit, e.g. '/home/user/unit.pas', and you want to know to which package(s) and project(s) it belongs use this:
+
У вас есть имя файла модуля, например '/home/user/unit.pas', и [если] вы хотите знать, какому пакету(-ам) и проекту(-ам) он принадлежит, используйте это:
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses Classes, PackageIntf, ProjectIntf;
 
uses Classes, PackageIntf, ProjectIntf;
 
...
 
...
Line 927: Line 925:
 
   Owners:=PackageEditingInterface.GetPossibleOwnersOfUnit('/full/path/of/unit.pas',[]);
 
   Owners:=PackageEditingInterface.GetPossibleOwnersOfUnit('/full/path/of/unit.pas',[]);
 
   if Owners=nil then begin
 
   if Owners=nil then begin
     // unit is not directly associated with a project/package
+
     // модуль не связан напрямую с проектом/пакетом
     // maybe the unit was for some reason not added, but is reachable
+
     // возможно модуль был по какой-то причине не добавлен, но доступен
     // search in all unit paths of all projects/packages
+
     // поиск по всем путям модулей всех проектов/пакетов
     // Beware: This can lead to false hits
+
     // Осторожно: это может привести к ложным попаданиям
 
     Owners:=PackageEditingInterface.GetPossibleOwnersOfUnit('/full/path/of/unit.pas',
 
     Owners:=PackageEditingInterface.GetPossibleOwnersOfUnit('/full/path/of/unit.pas',
 
       [piosfExcludeOwned,piosfIncludeSourceDirectories]);
 
       [piosfExcludeOwned,piosfIncludeSourceDirectories]);
Line 949: Line 947:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
=Windows=
+
=Окна=
  
There are basically four types of IDE windows.  
+
Есть четыре основных типа окон IDE.  
  
*the main IDE bar is the Application.MainForm. It is always present.
+
*основная панель IDE - это Application.MainForm. Оно всегда присутствует.
*floating/dockable windows like the Source Editors, the Object Inspectors and Messages.
+
*плавающие / закрепляемые окна, такие как Редактор исходного кода, Инспекторы объектов и Сообщения.
*the modal forms, like the find dialog, options dialogs and questions.
+
*модальные формы, такие как диалог поиска, диалоги настроек и вопросы.
*hints and completion forms
+
*подсказки и заполнение форм
  
== Adding a new dockable IDE window ==
+
== Добавление нового закрепляемого окна IDE ==
  
What is a dockable IDE window:
+
Что такое закрепляемое окно IDE:
Windows like the Source Editor or the Object Inspector are floating windows, that can be docked if a docking package is installed, and its state, position and size is stored and restored on next IDE start. In order to restore a window the IDE needs a creator as defined in the unit '''IDEWindowIntf''' of the package IDEIntf. Each dockable window must have a unique name. Do not use generic names like 'FileBrowser' because this will easily clash with other packages. And don't use short names like 'XYZ', because the creator is responsible for all forms beginning with this name.
+
Окна, такие как Редактор исходного кода или Инспектор объектов, являются плавающими окнами, которые можно закрепить, если установлен пакет закрепления, а его состояние, положение и размер сохраняются и восстанавливаются при следующем запуске IDE. Для восстановления окна IDE нужен создатель, как определено в модуле '''IDEWindowIntf''' пакета IDEIntf. Каждое закрепляемое окно должно иметь уникальное имя. Не используйте общие имена, такие как 'FileBrowser', потому что это будет легко конфликтовать с другими пакетами. И не используйте короткие имена, такие как 'XYZ', потому что создатель отвечает за все формы, начинающиеся с этого имени.
  
===How to register a dockable IDE window===
+
===Как зарегистрировать закрепляемое окно IDE===
  
Remember to choose a long unique name that is a valid pascal identifier. Your window can have any caption you want.
+
Не забудьте выбрать длинное уникальное имя, которое является действительным идентификатором Паскаля. Ваше окно может иметь любой заголовок, который вы хотите.
  
<syntaxhighlight>uses SysUtils, IDEWindowIntf;
+
<syntaxhighlight lang=pascal>uses SysUtils, IDEWindowIntf;
 
...
 
...
 
var MyIDEWindow: TMyIDEWindow = nil;  
 
var MyIDEWindow: TMyIDEWindow = nil;  
Line 973: Line 971:
 
procedure CreateMyIDEWindow(Sender: TObject; aFormName: string; var AForm: TCustomForm; DoDisableAutoSizing: boolean);
 
procedure CreateMyIDEWindow(Sender: TObject; aFormName: string; var AForm: TCustomForm; DoDisableAutoSizing: boolean);
 
begin
 
begin
   // check the name
+
   // проверяем имя
 
   if CompareText(aFormName,MyIDEWindowName)<>0 then exit;
 
   if CompareText(aFormName,MyIDEWindowName)<>0 then exit;
   // create the form if not already done and disable autosizing
+
   // создаем форму, если это еще не сделано, и отключаем автомасштабирование
 
   IDEWindowCreators.CreateForm(MyIDEWindow,TMyIDEWindowm,DoDisableAutosizing,Application);
 
   IDEWindowCreators.CreateForm(MyIDEWindow,TMyIDEWindowm,DoDisableAutosizing,Application);
   ... init the window ...
+
   ... инициируем окно ...
 
   AForm:=MyIDEWindow;
 
   AForm:=MyIDEWindow;
 
end;
 
end;
Line 984: Line 982:
 
begin
 
begin
 
   IDEWindowCreators.Add('MyIDEWindow',@CreateMyIDEWindow,nil,'100','50%','+300','+20%');
 
   IDEWindowCreators.Add('MyIDEWindow',@CreateMyIDEWindow,nil,'100','50%','+300','+20%');
   // the default boundsrect of the form is:
+
   // стандартная граница формы - это:
   // Left=100, Top=50% of Screen.Height, Width=300, Height=20% of Screen.Height
+
   // Left=100, Top=50% от [величины] Screen.Height, Width=300, Height=20% от [величины] Screen.Height
   // when the IDE needs an instance of this window it calls the procedure CreateMyIDEWindow.
+
   // когда IDE требуется экземпляр этого окна, она вызывает процедуру CreateMyIDEWindow.
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
===Showing an IDE window===
+
===Отображение окна IDE===
  
'''Do not use Show'''. Use:
+
{{Warning| Не используйте [процедуру] Show.}} Используйте:
  
<syntaxhighlight>IDEWindowCreators.ShowForm(MyIDEWindow,false);</syntaxhighlight>
+
<syntaxhighlight lang=pascal>IDEWindowCreators.ShowForm(MyIDEWindow,false);</syntaxhighlight>
  
This will work with docking. The docking system might wrap the form into a docking site. The BringToFront parameter tells the docking system to make the form and all its parent sites visible and bring the top level site to the front.
+
Это будет работать с [механизмом] пристыковки. Система пристыковки может обернуть форму в стыковочный узел. Параметр BringToFront указывает системе закрепления сделать форму и все ее родительские сайты видимыми и вывести сайт верхнего уровня вперед.
  
===Notes about IDEWindowCreators and SimpleLayoutStorage===
+
===Заметки о IDEWindowCreators и SimpleLayoutStorage===
  
The IDEWindowCreators.SimpleLayoutStorage simply stores the BoundsRect and WindowState of all forms that were once opened. It is used as fallback if no dockmaster is installed. It stores the state even if a DockMaster is installed, so that when the dockmaster is uninstalled the forms bounds are restored.
+
IDEWindowCreators.SimpleLayoutStorage просто хранит BoundsRect и WindowState всех форм, которые когда-то были открыты. Он используется как запасной вариант, если не установлен док-мастер. Он сохраняет состояние, даже если установлен DockMaster, поэтому, когда dockmaster удален, границы форм восстанавливаются.
  
The IDEWindowCreators is used by all dockable forms to register themselves and to show forms. When showing a form the Creator checks if a IDEDockMaster is installed and will delegate the showing to it. If no IDEDockMaster is installed it simply shows the form. The IDEDockMaster can use the information in the IDEWindowCreators to create forms by names and get an idea where to place a form when showing it for the first time. For more details see the packages AnchorDockingDsgn and EasyDockMgDsgn.
+
IDEWindowCreators используется всеми присоединяемыми формами для регистрации и отображения форм. При показе формы Создатель проверяет, установлен ли IDEDockMaster, и передает ему отображение. Если IDEDockMaster не установлен, он просто показывает форму. IDEDockMaster может использовать информацию в IDEWindowCreators для создания форм по именам и получить представление о том, где разместить форму при ее первом отображении. Для более подробной информации смотрите пакеты AnchorDockingDsgn и EasyDockMgDsgn.
  
 
=CodeTools=
 
=CodeTools=
  
The CodeTools is a package providing a vast amount of functions to parse, search and change pascal sources and some basic functions for other languages as well. You can use them without the IDE too. It is recommended that you read first about the CodeTools in general before using them in the IDE: [[Codetools]].
+
CodeTools - это пакет, предоставляющий огромное количество функций для анализа, поиска и изменения исходных текстов, а также некоторые основные функции для других языков. Вы можете использовать их также и без IDE. Рекомендуется сначала прочитать о CodeTools в целом, прежде чем использовать их в IDE: [[Codetools]].
  
Before calling any of the CodeTools functions in the IDE you should commit the current changes of the source editor to the CodeTools buffers:
+
Перед вызовом любой из функций CodeTools в IDE вы должны зафиксировать текущие изменения редактора исходного кода в буферах CodeTools:
  
<syntaxhighlight>uses LazIDEIntf;
+
<syntaxhighlight lang=pascal>uses LazIDEIntf;
 
...
 
...
   // save changes in source editor to codetools
+
   // сохраняем изменения в редакторе исходного кода в codetools
   LazarusIDE.SaveSourceEditorChangesToCodeCache(-1); // -1: commit all source editors</syntaxhighlight>
+
   LazarusIDE.SaveSourceEditorChangesToCodeCache(-1); // -1: фиксируем все редакторы исходного кода</syntaxhighlight>
  
==Adding a resource directive to a file==
+
==Добавление директивы ресурса в файл==
  
This adds a {$R example.res} to a pascal unit:
+
Это добавляет {$R example.res} к модулю паскаля:
  
<syntaxhighlight>procedure AddResourceDirectiveToPascalSource(const Filename: string);
+
<syntaxhighlight lang=pascal>procedure AddResourceDirectiveToPascalSource(const Filename: string);
 
var
 
var
 
   ExpandedFilename: String;
 
   ExpandedFilename: String;
 
   CodeBuf: TCodeBuffer;
 
   CodeBuf: TCodeBuffer;
 
begin
 
begin
   // make sure the filename is trimmed and contains a full path
+
   // убеждаемся, что имя файла обрезано [от концевых пробелов] и содержит полный путь
 
   ExpandedFilename:=CleanAndExpandFilename(Filename);
 
   ExpandedFilename:=CleanAndExpandFilename(Filename);
 
    
 
    
   // save changes in source editor to codetools
+
   // сохраняем изменения в редакторе исходного кода в codetools
 
   LazarusIDE.SaveSourceEditorChangesToCodeCache(-1);
 
   LazarusIDE.SaveSourceEditorChangesToCodeCache(-1);
  
   // load the file
+
   // загружаем файл
 
   CodeBuf:=CodeToolBoss.LoadFile(ExpandedFilename,true,false);
 
   CodeBuf:=CodeToolBoss.LoadFile(ExpandedFilename,true,false);
  
   // add the resource directive
+
   // добавляем директиву ресурса
 
   if not CodeToolBoss.AddResourceDirective(CodeBuf,'example.res') then
 
   if not CodeToolBoss.AddResourceDirective(CodeBuf,'example.res') then
 
     LazarusIDE.DoJumpToCodeToolBossError;
 
     LazarusIDE.DoJumpToCodeToolBossError;
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
The codetools provides also functions like FindResourceDirective and RemoveDirective.
+
Codetools также предоставляет такие функции, как FindResourceDirective и RemoveDirective.
  
==Getting the search paths for units and include files==
+
==Получение путей поиска для модулей и включаемых файлов==
  
There are many different search paths in the IDE from projects, packages, the fpc and lazarus directory and there are many types of paths: before or after resolving macros, with or without inherited search paths, as relative or absolute paths. All files in a directory share the same set of search paths. You can get the search paths for each directory fully resolved by asking the codetools:
+
В среде IDE существует множество различных путей поиска из проектов, пакетов, каталога fpc и lazarus, и существует множество типов путей: до или после разрешения макросов, с унаследованными путями поиска или без них, как относительными или абсолютными путями. Все файлы в каталоге имеют одинаковый набор путей поиска. Вы можете получить пути поиска для каждого каталога, полностью решенного путем запроса codetools:
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses CodeToolManager;
 
uses CodeToolManager;
 
...
 
...
  
Dir:=''; // the empty directory is for new files and has the same settings as the project directory
+
Dir:=''; // пустой каталог для новых файлов и имеет те же настройки, что и каталог проекта
  
// Getting the search paths for include files:
+
// Получение путей поиска для включаемых файлов:
 
Path:=CodeToolBoss.GetIncludePathForDirectory(Dir);
 
Path:=CodeToolBoss.GetIncludePathForDirectory(Dir);
  
// Getting the search paths for units:
+
// Получение путей поиска для модулей:
// This search path is passed to the compiler.
+
// Этот путь поиска передается компилятору.
// It contains the package output directories, but not the package source directories.
+
// Он содержит выходные каталоги пакетов, но не каталоги с исходниками пакетов.
 
Path:=CodeToolBoss.GetUnitPathForDirectory(Dir);
 
Path:=CodeToolBoss.GetUnitPathForDirectory(Dir);
  
// There can be additional unit search paths for the IDE only (not passed to the compiler)
+
// Могут быть дополнительные пути поиска модулей только для IDE (не передаются компилятору)
 
Path:=CodeToolBoss.GetSrcPathForDirectory(Dir);
 
Path:=CodeToolBoss.GetSrcPathForDirectory(Dir);
  
// The complete search path contains also all package source paths for units:
+
// Полный путь поиска содержит также все исходные пути пакета для модулей:
 
Path:=CodeToolBoss.GetCompleteSrcPathForDirectory(Dir);
 
Path:=CodeToolBoss.GetCompleteSrcPathForDirectory(Dir);
 
</syntaxhighlight>
 
</syntaxhighlight>
  
=Source Editor=
+
=Редактор исходного кода=
  
==Active source editor==
+
==Активный редактор исходного кода==
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses SrcEditorIntf;
 
uses SrcEditorIntf;
 
...
 
...
Line 1,080: Line 1,078:
 
=SynEdit=
 
=SynEdit=
  
==Getting the settings for a TSynEdit==
+
==Получение настроек для TSynEdit==
  
When you have a dialog using a TSynEdit and you want to use the same font and settings like the source editor use:
+
Если у вас есть диалог с использованием TSynEdit, и вы хотите использовать тот же шрифт и настройки, которые использует редактор исходного кода:
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses SrcEditorIntf;
 
uses SrcEditorIntf;
 
...
 
...
Line 1,090: Line 1,088:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
==Getting the settings for a SynEdit highlighter==
+
==Получение настроек для подсветки SynEdit==
  
When you have a dialog using a TSynEdit with a highlighter and you want to use the same colors like the source editor highlighter for this language use:
+
Если у вас есть диалог, использующий TSynEdit с подсветкой, и вы хотите использовать те же цвета, что и для подсветки редактора исходного кода для этого языка, используйте:
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses SrcEditorIntf;
 
uses SrcEditorIntf;
 
...
 
...
Line 1,100: Line 1,098:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
See for an example: TSQLStringsPropertyEditorDlg.Create in the unit [http://svn.freepascal.org/svn/lazarus/trunk/components/sqldb/sqlstringspropertyeditordlg.pas SQLStringsPropertyEditorDlg].
+
См. пример: TSQLStringsPropertyEditorDlg.Create in the unit [http://svn.freepascal.org/svn/lazarus/trunk/components/sqldb/sqlstringspropertyeditordlg.pas SQLStringsPropertyEditorDlg].
  
=Help=
+
=Справка=
  
==Adding help for sources==
+
==Добавление справки для исходников==
  
First create a THelpDatabase:
+
Сначала создаем THelpDatabase:
<syntaxhighlight>HelpDB := TFPDocHTMLHelpDatabase(
+
<syntaxhighlight lang=pascal>HelpDB := TFPDocHTMLHelpDatabase(
 
   HelpDatabases.CreateHelpDatabase('ANameOfYourChoiceForTheDatabase',
 
   HelpDatabases.CreateHelpDatabase('ANameOfYourChoiceForTheDatabase',
 
   TFPDocHTMLHelpDatabase,true));
 
   TFPDocHTMLHelpDatabase,true));
Line 1,115: Line 1,113:
 
   'Package1 - A new package',
 
   'Package1 - A new package',
 
   'file://index.html');
 
   'file://index.html');
HelpDB.TOCNode := THelpNode.Create(HelpDB,FPDocNode);// once as TOC
+
HelpDB.TOCNode := THelpNode.Create(HelpDB,FPDocNode);// один раз как оглавление TOC
 
DirectoryItem := THelpDBISourceDirectory.Create(FPDocNode,'$(PkgDir)/lcl',
 
DirectoryItem := THelpDBISourceDirectory.Create(FPDocNode,'$(PkgDir)/lcl',
   '*.pp;*.pas',false);// and once as normal page
+
   '*.pp;*.pas',false);// и один раз как обычная страница
 
HelpDB.RegisterItem(DirectoryItem);</syntaxhighlight>
 
HelpDB.RegisterItem(DirectoryItem);</syntaxhighlight>
  
==Adding lines to the messages window==
+
==Добавление строк в окно сообщений==
  
<syntaxhighlight>unit IDEMsgIntf;
+
<syntaxhighlight lang=pascal>unit IDEMsgIntf;
 
...
 
...
 
var Dir: String;
 
var Dir: String;
Line 1,132: Line 1,130:
 
end;</syntaxhighlight>
 
end;</syntaxhighlight>
  
= IDE options frame =
+
= Окно настроек IDE =
  
== Open options in a specific frame ==
+
== Открытие параметров в определенном кадре ==
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses LazIDEIntf;
 
uses LazIDEIntf;
 
...
 
...
Line 1,142: Line 1,140:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
=Miscellaneous=
+
=Прочее=
  
==Adding a macro==
+
==Добавление макроса==
  
You can add your own IDE macros:
+
Вы можете добавить свои собственные макросы IDE:
  
<syntaxhighlight>
+
<syntaxhighlight lang=pascal>
 
uses MacroIntf, MacroDefIntf;
 
uses MacroIntf, MacroDefIntf;
  
 
procedure Register;
 
procedure Register;
 
begin
 
begin
   // registering a Macro with a fixed value:
+
   // регистрация макроса с фиксированным значением:
 
   IDEMacros.Add(TTransferMacro.Create('MyMacro1','Value','Description',nil,[]));
 
   IDEMacros.Add(TTransferMacro.Create('MyMacro1','Value','Description',nil,[]));
 
end;
 
end;
  
// registering a Macro with a dynamic value requires a method of an object
+
// регистрация макроса с динамическим значением требует метода объекта
 
procedure TForm1.Init;
 
procedure TForm1.Init;
 
begin
 
begin
Line 1,165: Line 1,163:
 
function TForm1.OnResolveMyMacro(const s: string; const Data: PtrInt;
 
function TForm1.OnResolveMyMacro(const s: string; const Data: PtrInt;
 
   var Abort: boolean): string;
 
   var Abort: boolean): string;
// s is the parameter. For example $MyMacro(parameter)
+
// s - это параметр. Например, $MyMacro(parameter)
// Data is the querying instance. Can be nil.
+
// Data - это экземпляр запроса. Может быть nil.
// If there is an error set Abort to true.
+
// Если есть ошибка, установите Abort в true.
// The result string can contain macros. For example Result:='$(FPCVer)/$(TargetOS)';
+
// Результирующая строка может содержать макросы. Например, Result:='$(FPCVer)/$(TargetOS)';
 
begin
 
begin
 
   Result:='MyValue';
 
   Result:='MyValue';
Line 1,174: Line 1,172:
 
</syntaxhighlight>
 
</syntaxhighlight>
  
== Debugging the IDE ==
+
== Отладка IDE ==
* Compile the IDE as usual e.g. via Tools/Build Lazarus. Make sure you set up debugging flags like -g or -gw2. Best is to use the profile "Debug IDE" which contains many flags useful for debugging.
+
* Скомпилируйте IDE как обычно, например, с помощью Tools/Build Lazarus. Убедитесь, что вы установили отладочные флаги, такие как -g или -gw2. Лучше всего использовать профиль "Debug IDE", который содержит много флагов, полезных для отладки.
* Open the ide\lazarus.lpi project. You cannot directly compile this project.
+
* Откройте проект ide\lazarus.lpi. Вы не можете напрямую скомпилировать этот проект.
* Set breakpoints as needed etc and run the project.
+
* Установите точки останова и пр. И запустите проект.
  
==See also==
+
==См. также==
  
{{AutoCategory}}
 
 
* [[Creating IDE Help]]
 
* [[Creating IDE Help]]
 
* [[Help protocol]]
 
* [[Help protocol]]
 
* [[How To Write Lazarus Component]]
 
* [[How To Write Lazarus Component]]

Latest revision as of 22:25, 14 February 2020

Deutsch (de) English (en) español (es) français (fr) 日本語 (ja) русский (ru) slovenčina (sk) 中文(中国大陆)‎ (zh_CN)


Расширение IDE

Обзор

Lazarus IDE поддерживает несколько типов плагинов:

Компоненты
это элементы, найденные в палитре компонентов. Например, TButton (находится на странице Standard) можно использовать для создания кнопок.
Редакторы компонентов
при двойном щелчке по компоненту в Дизайнере вызывается редактор компонентов. Редактор компонента также может добавить дополнительный элемент во всплывающее меню Дизайнера (доступ к нему осуществляется по щелчку правой кнопкой мыши на компоненте в конструкторе).
Редакторы свойств
Каждая строка в разделе сетки Инспектора объектов использует редактор свойств, чтобы разрешить установку или изменение значения этого свойства.
Эксперты
Эксперты охватывают все другие типы плагинов. Они могут регистрировать новые пункты меню, регистрировать ярлыки или расширять другие функции IDE.

Есть два возможных способа добавить свои собственные плагины в IDE Lazarus:

  1. Напишите пакет, установите его и зарегистрируйте ваши плагины в процедуре 'Register' модуля.
  2. Расширьте код Lazarus и отправьте свой svn diff в список рассылки Lazarus.

Пакеты и зависимости Makefile

Следующие шаги необходимы, если добавляются новые зависимости пакета.

  • Создание/Обновление Makefile для пакета через Package editor / More ... / Create Makefile.
  • Исправление всех зависимостей. См. tools/updatemakefiles.lpi

Пункты меню

Вы можете добавлять новые пункты меню, скрывать или перемещать существующие и добавлять подменю, разделы. Для ваших собственных форм вы можете зарегистрировать TMainMenu/TPopupMenu, чтобы другие пакеты могли расширять вашу форму дальше. Модуль MenuIntf пакета IDEIntf содержит всю регистрацию для меню и множество стандартных пунктов меню самой IDE.

Добавление пункта меню

Одиночный элемент меню, такой как [, например,] 'View Object Inspector', называется TIDEMenuCommand. Вы можете создать его с помощью RegisterIDEMenuCommand, который имеет две формы с большим количеством параметров:

function RegisterIDEMenuCommand(Parent: TIDEMenuSection;
                                const Name, Caption: string;
                                const OnClickMethod: TNotifyEvent = nil;
                                const OnClickProc: TNotifyProcedure = nil;
                                const Command: TIDECommand = nil;
                                const ResourceName: String = ''
                                ): TIDEMenuCommand; overload;
function RegisterIDEMenuCommand(const Path, Name, Caption: string;
                                const OnClickMethod: TNotifyEvent = nil;
                                const OnClickProc: TNotifyProcedure = nil;
                                const Command: TIDECommand = nil;
                                const ResourceName: String = ''
                                ): TIDEMenuCommand; overload;

Разница между этими двумя [функциями] только в том, как вы указываете родительский раздел меню. Вы можете указать раздел меню прямо или косвенно через путь. Многие стандартные разделы можно найти в модуле MenuIntf. Например, раздел mnuTools, который является [пунктом] меню Tools главной панели IDE. Он содержит раздел itmSecondaryTools, рекомендуемый для сторонних инструментов.

Следующий [код] регистрирует новую команду меню с именем 'MyTool', с заголовком 'Start my tool' и при нажатии выполняет процедуру StartMyTool:

procedure StartMyTool;
begin
  ... выполняется при нажатии на пункт меню ...
end;

procedure Register;
begin
  RegisterIDEMenuCommand(itmSecondaryTools, 'MyTool','Start my tool',nil,@StartMyTool);
end;

Если вы хотите вызвать метод вместо процедуры, используйте параметр OnClickMethod.

Этот пункт меню не имеет сочетания клавиш. Если вы хотите [назначить ему] сочетание клавиш, вы должны создать TIDECommand и передать его в параметре Command. Например:

uses ... IDECommands, MenuIntf;
...
var
  Key: TIDEShortCut;
  Cat: TIDECommandCategory;
  CmdMyTool: TIDECommand;
begin
  // регистрация сочетаний клавиш IDE и пункта меню
  Key := IDEShortCut(VK_UNKNOWN,[],VK_UNKNOWN,[]);
  Cat:=IDECommandList.FindCategoryByName(CommandCategoryToolMenuName);
  CmdMyTool := RegisterIDECommand(Cat,'Start my tool', 'Starts my tool to do some stuff', Key, nil, @StartMyTool);
  RegisterIDEMenuCommand(itmSecondaryTools, 'MyTool', 'Start my tool', nil, nil, CmdMyTool);
end;

Сочетания клавиш

Все сочетания клавиш (ключи, которые вызывают какое-либо действие) зарегистрированы в IDECommandList. Вот пример того, как найти все команды, которые реагируют на клавиши Ctrl+D или две комбинации клавиш, начинающиеся с Ctrl+D:

uses
  Classes, SysUtils, LCLProc, IDECommands;

procedure ListCtrlD;
// список всех команд IDE с комбинациями клавиш <Ctrl>+<D>
var
  i: integer;
  Cmd: TIDECommand;
  Commands: TFPList;
begin
  Commands:=IDECommandList.FindCommandsByShortCut(IDEShortCut(VK_D,[],VK_UNKNOWN,[]));
  try
    for i:=0 to Commands.Count-1 do begin
      Cmd:=TIDECommand(Commands[i]);
      writeln('Cmd: ',Cmd.Name,
        ' A=',dbgs(Cmd.ShortcutA.Shift1),'-',Cmd.ShortcutA.Key1,
        ',',dbgs(Cmd.ShortcutA.Shift2),'-',Cmd.ShortcutA.Key2,
        ' B=',dbgs(Cmd.ShortcutB.Shift1),'-',Cmd.ShortcutB.Key1,
        ',',dbgs(Cmd.ShortcutB.Shift2),'-',Cmd.ShortcutB.Key2
        );
    end;
  finally
    Commands.Free;
  end;
end;

Конфигурационные файлы

Загрузка/Сохранение настроек

Все конфигурационные файлы IDE хранятся в одном каталоге в виде XML-файлов. Пакеты также могут добавлять свои собственные файлы туда. Каталог primary config path можно прочитать с помощью:

uses LazIDEIntf;
...
  Directory := LazarusIDE.GetPrimaryConfigPath;

Пакеты могут создавать свои собственные файлы XML с помощью:

uses
  ..., LCLProc, BaseIDEIntf, LazConfigStorage;

const
  Version = 1;
var
  Config: TConfigStorage;
  SomeValue: String;
  SomeInteger: Integer;
  SomeBoolean: Boolean;
  FileVersion: LongInt;
begin
  SomeValue:='Default';
  SomeInteger:=3;
  SomeBoolean:=true;

  // сохранение настроек
  try
    Config:=GetIDEConfigStorage('mysettings.xml',false);
    try
      // сохраняем номер версии, чтобы будущие расширения могли обрабатывать старые файлы конфигурации
      Config.SetDeleteValue('Path/To/The/Version',Version,0);
      // сохраняем строковую переменную "SomeValue"
      // если SomeValue имеет значение по умолчанию, запись не сохраняется,
      // поэтому сохраняются только [значения,] отличающиеся от значения по умолчанию.
      // Таким образом, xml остается коротким, и значения по умолчанию могут измениться в будущем.
      Config.SetDeleteValue('Path/To/Some/Value',SomeValue,'Default');
      Config.SetDeleteValue('Path/To/Some/Integer',SomeInteger,3);
      Config.SetDeleteValue('Path/To/Some/Boolean',SomeBoolean,true);
      // далее [по коду] еще overloads-инструкции для SetDeleteValue, 
      // которые [всплывают в редакторе кода по нажатию] <Ctrl>+<Space> 
    finally
      Config.Free;
    end;

  except
    on E: Exception do begin
      DebugLn(['Saving mysettings.xml failed: ',E.Message]);
    end;
  end;

  // загрузка настроек
  try
    Config:=GetIDEConfigStorage('mysettings.xml',true);
    try
      // чтение версии конфигурации
      FileVersion:=Config.GetValue('Path/To/The/Version',0);
      // чтение строковой переменной "SomeValue". Если запись не существует, используется
      // значение по умолчанию
      SomeValue:=Config.GetValue('Path/To/Some/Value','Default');
      SomeInteger:=Config.GetValue('Path/To/Some/Integer',3);
      SomeBoolean:=Config.GetValue('Path/To/Some/Boolean',true);
    finally
      Config.Free;
    end;
  except
    on E: Exception do begin
      DebugLn(['Loading mysettings.xml failed: ',E.Message]);
    end;
  end;
end;

На заметку:

  • Каждый плагин IDE должен использовать свой собственный файл конфигурации. Особенно вы не должны использовать стандартные файлы опций IDE, такие как editoroptions.xml или environmentmentoptions.xml.
  • GetIDEConfigStorage при загрузке проверяет, существует ли файл и, если нет, копирует шаблон из вторичного каталога конфигурации.
  • Начиная с версии 0.9.31 вы можете использовать эту функцию для загрузки файла вне основного каталога конфигурации.

Компоненты

Расширение существующих компонентов

Источник: [1] Это обычная настройка существующих компонентов LCL, например, если вы хотите добавить свойства.

Добавьте необходимые свойства с соответствующими методами установки и получения и полями хранения.

Затем создайте их экземпляр «вручную», предоставив компонент-владелец (для последующей обработки), и установите [свойство] Parent и, возможно, [свойства] Top и Left и любые другие значения по умолчанию, необходимые для вашего компонента при инициализации.

Когда вы убедитесь, что ваш настроенный компонент отлажен, добавьте вызов RegisterComponent(), чтобы прикрепить его к палитре компонентов IDE и избавьте вас от необходимости выполнять код установки вручную (посмотрите на исходник любого компонента, чтобы узнать, как это сделать).

Вот простой пример:

unit Unit1;

{$mode objfpc}{$H+}

interface

uses
  Classes, SysUtils, Forms, StdCtrls;

type
  TEdX = class(TEdit)
  private
    FNewIntProp: integer;
    FNewStrProp: string;
    procedure SetNewIntProp(AValue: integer);
    procedure SetNewStrProp(AValue: string);
  public
    constructor Create(theComponent: TComponent); override;
    property NewIntProp: integer read FNewIntProp write SetNewIntProp;
    property NewStrProp: string read FNewStrProp write SetNewStrProp;
  end;

  TForm1 = class(TForm)
    procedure FormCreate(Sender: TObject);
  private
    edX: TEdX;
  public
  end;

var
  Form1: TForm1;

implementation

{ TForm1 }

procedure TForm1.FormCreate(Sender: TObject);
begin
  edX:= TEdX.Create(Self);
  edX.Parent:= Self;
  edX.Caption:= IntToStr(edX.NewIntProp);
  Caption:= edX.NewStrProp;
end;

{$R *.lfm}

{ TEdX }

procedure TEdX.SetNewIntProp(AValue: integer);
begin
  if FNewIntProp=AValue then Exit;
  FNewIntProp:=AValue;
  // добавьте свой код здесь
end;

procedure TEdX.SetNewStrProp(AValue: string);
begin
  if FNewStrProp=AValue then Exit;
  FNewStrProp:=AValue;
  // добавьте свой код здесь
end;

constructor TEdX.Create(theComponent: TComponent);
begin
  inherited Create(theComponent);
  FNewStrProp:= 'new string property value';
  FNewIntProp:= 99;
end;

end.

Написание компонент

Основная статья: How To Write Lazarus Component

Вы можете создавать новые компоненты через редактор пакетов.

Создайте или откройте пакет, нажмите add(добавить), нажмите New Component (Новый компонент), заполните пункты: Ancestor Type(Тип предка) = TButton, New class name (Имя нового класса) = TMyButton, palette page (страница палитры) = Misc, Unit file name (имя файла модуля) = mybutton.pas (этот файл будет создан), имя модуля MyButton, и нажмите кнопку ok.

Предоставление новому компоненту иконки для палитры компонентов

Создайте файл изображения в формате .bmp, .xpm или .png с тем же именем, что и класс компонента. Например, tmybutton.png и сохраните его в исходном каталоге пакета. Изображение может быть создано любой графической программой (например, GIMP [или IncScape]) и должно быть не больше 24x24 пикселей. Затем преобразуйте изображение в файл ресурсов с помощью инструмента lazres, который можно найти в каталоге lazarus/tools:

~/lazarus/tools/lazres mybutton.lrs tmybutton.png
Light bulb  Примечание: Лаззарус trunk/1.4+? использует файлы ресурсов .res взамен .lrs-файлов
~/lazarus/tools/lazres mybutton.res tmybutton.png

Это создаст include-файл паскаля, который используется в разделе initialization mybutton.pas:

initialization
  {$I mybutton.lrs}
  // или в более новой версии Lazarus - синтаксис docheck
  {$R mybutton.res}

Установите пакет.

Скрытие компонента в палитре компонентов

Пакет IDEIntf, модуль componentreg:

IDEComponentPalette.FindComponent('TButton').Visible:=false;

Написание редактора компонента

Редактор компонента обрабатывает такие вещи, как двойной щелчок по компоненту в конструкторе или добавление пунктов меню при щелчке правой кнопкой мыши по компоненту. Написать редактор компонентов легко. Посмотрите модуль componententeditors.pas пакета IDEIntf для [просмотра] кучи примеров. Например, чтобы показать редактор при двойном щелчке, см. TCheckListBoxComponentEditor.

Написание редакторов свойств

Каждый тип свойства (integer, string, TFont, ...) в Инспекторе объектов нуждается в редакторе свойств. Если у вашего компонента есть свойство Password типа string, вы можете определить редактор свойств для вашего конкретного класса компонента со именем свойства Password типа string. Модуль propedits.pp пакета IDEIntf содержит многие стандартные редакторы свойств, используемые самой IDE. Например, TStringPropertyEditor является редактором свойств по умолчанию для всех строк, в то время как TComponentNamePropertyEditor является более конкретным и обрабатывает только TComponent.Name. Смотрите [исходный код] модуля для [получения] множества примеров.

Сокрытие свойства в инспекторе объектов

Существует специальный редактор свойств для сокрытия [свойств]:

  RegisterPropertyEditor(TypeInfo(TAnchorSide), TControl, 'AnchorSideLeft', THiddenPropertyEditor);

Поиск редактора свойств, используемого для свойства

uses Classes, TypInfo;
var
  Instance: TPersistent; // ваш экземпляр
  PropInfo: PPropInfo;
  EdClass: TPropertyEditorClass;
begin
  PropInfo:=GetPropInfo(Instance.ClassType,'Name'); // замените Name именем свойства, которое вы ищете
  GetEditorClass(PropInfo, Instance);
end;

Формы

IDE позволяет легко создавать потомков форм и фреймов. Эти формы могут иметь новые published-компоненты и новые published-методы. Но, когда вы добавляете новые published-свойства, они не доступны через инспектор объектов. Они работают только во время выполнения [приложения]. Методы в IDE являются поддельными, они не могут быть выполнены. В среде IDE можно создавать компоненты, поскольку их классы зарегистрированы в палитре компонентов. Ваши новые свойства существуют только в вашем исходном коде. IDE пока не может их подделать. Вот почему вы должны зарегистрировать новый класс. Это означает [, что вы должны]:

  • Создать пакет времени разработки (или расширить существующий)
  • Ваша форма должна быть в модуле этого пакета
...
interface

uses FormEditingIntf, Forms;

type
  TYourForm = class(TForm)
  private
    FYourProperty: integer;
  published
    property YourProperty: integer read FYourProperty write FYourProperty;
  end;

procedure Register;

implementation

procedure Register;
begin
 FormEditingHook.RegisterDesignerBaseClass(TYourForm);
end;
...
  • Проверить [наличие процедуры] "Register" в редакторе пакетов для этого модуля.
  • Установить пакет в IDE

Дизайнер

Написание дизайнера-посредника

Стандартный конструктор позволяет визуально редактировать элементы управления LCL, тогда как все остальные отображаются в виде значков (например, TOpenDialog или TDataSource). Чтобы визуально редактировать элемент управления не [из библиотеки] LCL, вам нужно создать designer mediator (дизайнер-посредник). Он может быть использован для разработки веб-страниц, диаграмм UML или других наборов виджетов, таких как fpGUI. Полный пример приведен в examples/designnonlcl/.

  • Установите пакет с примерами examples/designnonlcl/notlcldesigner.lpk и перезапустите IDE. Это зарегистрирует дизайнер-посредник для компонентов TMyWidget и добавит новые компоненты TMyButton, TMyGroupBox в палитру компонентов.
  • Откройте проект с примерами examples/designnonlcl/project/NonLCL1.lpi.
  • Откройте unit1.pas и покажите дизайнер форм (F12). Вы должны увидеть компоненты в виде красных прямоугольников, которые можно выделять, перемещать и изменять их размер, как элементы управления LCL.

Создание нового уникального имени компонента

uses FormEditingIntf;

...

NewName:=FormEditingHook.CreateUniqueComponentName(AComponent);

// Или, если вам нужно создать имя перед созданием компонента:

NewName:=FormEditingHook.CreateUniqueComponentName(ComponentClassName,OwnerComponent);
// ComponentClassName будет использоваться в качестве префикса без начального T.
// OwnerComponent является новым владельцем нового компонента.

Выбор компонента в конструкторе/инспекторе объектов

uses propedits;
..
GlobalDesignHook.SelectOnlyThis(AComponent);

Получение файла модуля, дизайнера формы

uses ProjectIntf, LazIDEIntf, ComponentEditors;
...
// открываем файл
if LazarusIDE.DoOpenEditorFile(Filename,-1,-1,[ofAddToRecent])<>mrOk then exit;
// получаем интерфейс файла
aFile:=LazarusIDE.ActiveProject.FindFile(Filename,[]);
// получаем дизайнер
aDesigner:=TComponentEditorDesigner(LazarusIDE.GetDesignerWithProjectFile(AFile,true));
if aDesigner=nil then 
  exit; // этот модуль не имеет ресурса (форма, фрейм, модуль данных и т.д.)
// получаем форму
aForm:=aDesigner.Form;

Сохранение модуля, дизайнера формы

uses LazIDEIntf;
...
if LazarusIDE.DoSaveEditorFile(Filename,[])<>mrOk then exit;

Сохранение формы дизайнера как кода Паскаль

  • Используйте функцию FormEditingHook.SaveComponentAsPascal модуля FormEditingfIntf. См. examples/pascalstream/CopyAsPasPkg/copyaspasdemounit1.pas.

Обработчики событий

В IDE есть несколько событий, для которых плагины могут добавлять свои собственные обработчики.

События дизайнера

В propedits.pp есть объект "GlobalDesignHook", который поддерживает несколько событий для проектирования. Каждое событие вызывает список обработчиков. Обработчики по умолчанию добавляются в среду IDE. Вы можете добавить свои собственные обработчики с помощью методов AddHandlerXXX и RemoveHandlerXXX. Они будут вызваны перед обработчиками по умолчанию.

Примеры:

  • Добавление вашего обработчика (это обычно делается в конструкторе вашего объекта):
 GlobalDesignHook.AddHandlerPersistentAdded(@YourOnPersistentAdded);
  • Удаление вашего обработчика:
 GlobalDesignHook.RemoveHandlerPersistentAdded(@YourOnPersistentAdded);
  • Вы можете удалить все обработчики одновременно. Например, это хорошая идея - добавить эту строку в деструктор вашего объекта:
 GlobalDesignHook.RemoveAllHandlersForObject(Self);

Обработчики GlobalDesignHook:

  • Поиск корня
    • ChangeLookupRoot - Вызывается при изменении "LookupRoot". "LookupRoot" является объектом-владельцем выбранных компонентов. Обычно это TForm.
  • Методы
    • CreateMethod
    • GetMethodName
    • GetMethods
    • MethodExists
    • RenameMethod
    • ShowMethod
    • MethodFromAncestor
    • ChainCall
  • Компоненты
    • GetComponent
    • GetComponentName
    • GetComponentNames
    • GetRootClassName
    • AddClicked - Вызывается, когда пользователь выбирает класс компонента и щелкает дизайнер, чтобы добавить новый компонент. Вы можете изменить класс компонента и родительский элемент.
    • ComponentRenamed - Вызывается, когда компонент был переименован
  • Объекты TPersistent
    • PersistentAdded - Вызывается при добавлении нового TPersistent в LookupRoot
    • PersistentDeleting - Вызывается до освобождения TPersistent.
    • DeletePersistent - Вызывается IDE для удаления TPersistent.
    • GetSelectedPersistents - Вызывается при получении текущего выбора TPersistent.
    • SetSelectedPersistents - Вызывается при настройке текущего выбора TPersistent.
    • GetObject
    • GetObjectName
    • GetObjectNames
  • Изменение
    • Modified
    • Revert
    • RefreshPropertyValues
  • Выбор
    • SetSelection
    • GetSelection

Примеры для событий дизайнера

Пример: когда [на родителя] помещается новый компонент, перемещать элемент управления в дочерний элемент

...
type
  TYourDesignerExtension = class
  private
    function AddClicked(ADesigner: TIDesigner;
             MouseDownComponent: TComponent; Button: TMouseButton;
             Shift: TShiftState; X, Y: Integer;
             var AComponentClass: TComponentClass;
             var NewParent: TComponent): boolean of object;
  public
    constructor Create;
    destructor Destroy; override;
  end;

...
constructor TYourDesignerExtension.Create;
begin
  // регистрация вашего обработчика
  GlobalDesignHook.AddHandlerAddClicked(@AddClicked);
end;

destructor TYourDesignerExtension.Destroy;
begin
  // удаление вашего обработчика
  GlobalDesignHook.RemoveHandlerAddClicked(@AddClicked);
end;

function TYourDesignerExtension.AddClicked(ADesigner: TIDesigner;
             MouseDownComponent: TComponent; Button: TMouseButton;
             Shift: TShiftState; X, Y: Integer;
             var AComponentClass: TComponentClass;
             var NewParent: TComponent): boolean of object;
begin
  // в этом примере TYourControl - это пользовательский элемент управления с ChildControl.
  // Всякий раз, когда пользователь помещает элемент управления на TYourControl, вместо добавления
  // нового элемента управления на TYourControl, [этот] новый элемент управления добавляется как дочерний элемент
  // [имеющегося] ChildControl.
  // создание 
  if MouseDownComponent is TYourControl then
    NewParent:=TYourControl(MouseDownComponent).ChildControl;
  Result:=true;
end;

Отключение обработчика мыши в [режиме] дизайнера

Обычно дизайнер ловит все события мыши компонента. Если ваш пользовательский элемент управления должен обрабатывать дескриптор событий мыши, вы можете либо установить csDesignInteractive ControlStyle, либо вы можете точно управлять им через сообщение CM_DESIGNHITTEST в вашем элементе управления:

type
  TYourControl = class(TCustomControl)
  protected
    procedure CMDesignHitTest(var Message: TLMessage); message CM_DESIGNHITTEST;
  end;
...
procedure TYourControl.CMDesignHitTest(var Message: TLMessage);
var
  p: TSmallPoint;
  aShiftState: TShiftState;
begin
  aShiftState:=KeysToShiftState(PtrUInt(Message.WParam));
  p:=TSmallPoint(longint(Message.LParam));
  debugln(['TForm1.CMDesignHitTest ShiftState=',dbgs(aShiftState),' x=',p.x,' y=',p.y]);
  if SkipDesignerMouseHandler then
    Message.Result:=1; // теперь дизайнер вызывает обычные методы MouseUp, MouseMove и MouseDown.
end;

Получение уведомлений при изменении дизайнера форм

Каждая разработанная форма LCL имеет конструктор типа TIDesigner. В среде IDE создаются конструкторы типа TComponentEditorDesigner, определенные в компонентных компонентах модуля IDEIntf. Например:

procedure TYourAddOn.OnDesignerModified(Sender: TObject);
var
  IDEDesigner: TComponentEditorDesigner;
begin
  IDEDesigner:=TComponentEditorDesigner(Sender);
  ...
end;

procedure TYourAddOn.ConnectDesignerForm(Form1: TCustomForm);
var
  IDEDesigner: TComponentEditorDesigner;
begin
  IDEDesigner:=TComponentEditorDesigner(Form1.Designer);
  IDEDesigner.AddHandlerModified(@OnDesignerModified);
end;

События проекта

Эти события определены в модуле LazIDEIntf.

  • LazarusIDE.AddHandlerOnProjectClose: вызывается перед закрытием проекта
  • LazarusIDE.AddHandlerOnProjectOpened: вызывается после полного открытия проекта (например, все необходимые пакеты были загружены, модули были открыты в редакторе исходного кода)
  • LazarusIDE.AddHandlerOnSavingAll: вызывается перед тем, как IDE сохраняет все
  • LazarusIDE.AddHandlerOnSavedAll: вызывается после того, как IDE сохранил все
  • LazarusIDE.AddHandlerOnProjectBuilding: вызывается перед тем, как IDE создаст проект
  • LazarusIDE.AddHandlerOnProjectDependenciesCompiling: вызывается перед тем, как IDE компилирует пакетные зависимости проекта
  • LazarusIDE.AddHandlerOnProjectDependenciesCompiled: вызывается после компиляции зависимостей пакета IDE проекта
  • LazarusIDE.AddHandlerOnProjectBuildingFinished: вызывается после того, как IDE собрал проект (успешно или нет) (начиная с 1.5)

Другие события IDE

uses LazIDEIntf;

Вызовите их в процедуре регистрации вашего пакета:

  • LazarusIDE.AddHandlerOnIDERestoreWindows: вызывается, когда IDE восстанавливает свои окна (перед открытием первого проекта)
  • LazarusIDE.AddHandlerOnIDEClose: вызывается, когда IDE закрывается (после запроса закрытия, поэтому больше нет интерактивности)
  • LazarusIDE.AddHandlerOnQuickSyntaxCheck: вызывается при выполнении пункта меню или ярлыка для быстрой проверки синтаксиса
  • LazarusIDE.AddHandlerOnLazarusBuilding: вызывается перед тем, как IDE собирает Lazarus IDE (начиная с 1.5)
  • LazarusIDE.AddHandlerOnLazarusBuildingFinished: вызывается после того, как IDE собирает Lazarus IDE (начиная с 1.5)
  • LazarusIDE.AddHandlerGetFPCFrontEndParams: вызывается, когда IDE получает параметры клиентского инструмента интерфейса 'fpc' (начиная с 1.5)
  • LazarusIDE.AddHandlerGetFPCFrontEndPath: вызывается, когда IDE получает параметры клиентского инструмента интерфейса 'fpc' (начиная с 1.5)
  • LazarusIDE.AddHandlerOnUpdateIDEComponentPalette: ?
  • LazarusIDE.AddHandlerOnUpdateComponentPageControl: ?
  • LazarusIDE.AddHandlerOnShowDesignerFormOfSource: вызывается после показа конструктора формы для редактора кода (AEditor может быть nil!) (начиная с 1.5)
  • LazarusIDE.AddHandlerOnShowSourceOfActiveDesignerForm: вызывается после показа кода формы дизайнера (начиная с 1.5)
  • LazarusIDE.AddHandlerOnChangeToolStatus: вызывается, когда IDEToolStatus изменяется (например, itNone-> itBuilder и т. д.) (начиная с 1.5)

Вызовите их в разделе инициализации одного из модулей:

  • AddBootHandler
    • AddBootHandler(libhTransferMacrosCreated,@YourProc): вызывается после создания IDEMacros (начиная с версии 1.3)
    • AddBootHandler(libhEnvironmentOptionsLoaded,@YourProc): вызывается после загрузки параметров среды (начиная с версии 1.3)

Проект

Текущий проект

Текущий основной проект может быть получен [при помощи] LazarusIDE.ActiveProject. (модуль LazIDEIntf)

Все модули текущего проекта

Обратите внимание, что термин «юниты проекта» неоднозначен.

  • Инспектор проектов показывает список файлов .lpi. Проект может не использовать все эти модули на всех платформах, и, возможно, разработчик забыл добавить все используемые модули.
  • Модули из использованных пакетов не являются модулями проекта.

Все модули инспектора проекта

Чтобы перебрать все паскалевские модули, перечисленные в инспекторе проектов, вы можете использовать, например:

uses 
  LCLProc, FileUtil, LazIDEIntf, ProjectIntf;

procedure ListProjectUnits;
var
  LazProject: TLazProject;
  i: Integer;
  LazFile: TLazProjectFile;
begin
  LazProject:=LazarusIDE.ActiveProject;
  if LazProject<>nil then
    for i:=0 to LazProject.FileCount-1 do
    begin
      LazFile:=LazProject.Files[i];
      if LazFile.IsPartOfProject
      and FilenameIsPascalUnit(LazFile.Filename)
      then
        debugln(LazFile.Filename);
    end;
end;

Все используемые модули проекта

Чтобы найти все используемые в настоящее время модули проекта/пакета, вы можете использовать следующее. Обратите внимание, что в среде IDE необходимо проанализировать все модули, поэтому это может занять некоторое время.

uses 
  LazLoggerBase, LazIDEIntf, ProjectIntf;

procedure ListProjectUnits;
var
  LazProject: TLazProject;
  i: Integer;
begin
  LazProject:=LazarusIDE.ActiveProject;
  if LazProject<>nil then 
  begin
    Units:=LazarusIDE.FindUnitsOfOwner(LazProject,[fuooListed,fuooUsed]); // добавьте fuooPackages, чтобы включить модули из пакетов
    try
      for i:=0 to Units.Count-1 do
        debugln('Filename=',Units[i]);
    finally
      Units.Free;
    end;
  end;
end;

Файлы .lpr, .lpi и .lps проекта

uses 
  LCLProc, FileUtil, ProjectIntf, LazIDEIntf;
var
  LazProject: TLazProject;
begin
  LazProject:=LazarusIDE.ActiveProject;
  // у каждого проекта есть файл .lpi:
  DebugLn(['Файл проекта lpi: ',LazProject.ProjectInfoFile]);

  // если информация о сеансе проекта хранится в отдельном файле .lps:
  if LazProject.SessionStorage<>pssNone then
    DebugLn(['Файл проекта lps: ',LazProject.ProjectSessionFile]);

  // Если у проекта есть файл .lpr, то он является основным исходным файлом:
  if (LazProject.MainFile<>nil)
  and (CompareFileExt(LazProject.MainFile.Filename,'lpr')=0) then
    DebugLn(['Проект имеет файл lpr: ',LazProject.MainFile.Filename]);
end;

Имя исполняемого / целевого файла проекта

Существует макрос $(TargetFile), который можно использовать в путях и внешних инструментах. Вы можете запросить макрос в коде:

uses MacroIntf;

function MyGetProjectTargetFile: string;
begin
  Result:='$(TargetFile)';
  if not IDEMacros.SubstituteMacros(Result) then
    raise Exception.Create('невозможно получить целевой файл проекта');
end;

См. здесь для более полной информации по макросам: Макросы IDE в путях и именах файлов.

Добавление своего собственного типа проекта

Вы можете добавлять [свои] пункты в диалоговое окно 'New ...':

Добавление своих собственных типов файлов

Вы можете добавлять [свои] пункты в диалоговое окно 'New ...':

  • Смотрите модуль ProjectIntf пакета IDEIntf.
  • Выбрав базовый класс TFileDescPascalUnit для обычных модулей или TFileDescPascalUnitWithResource для новой формы/модуля данных.

Добавление нового типа файла

uses ProjectIntf;
...
  { TFileDescText }

  TFileDescMyText = class(TProjectFileDescriptor)
  public
    constructor Create; override;
    function GetLocalizedName: string; override;
    function GetLocalizedDescription: string; override;
  end;
...

procedure Register;

implementation

procedure Register;
begin
  RegisterProjectFileDescriptor(TFileDescMyText.Create,FileDescGroupName);
end;

{ TFileDescMyText }

constructor TFileDescMyText.Create;
begin
  inherited Create;
  Name:='MyText'; // не переводите эту [строку]
  DefaultFilename:='text.txt';
  AddToProject:=false;
end;

function TFileDescText.GetLocalizedName: string;
begin
  Result:='My Text'; // замените это строкой из resourcestring
end;

function TFileDescText.GetLocalizedDescription: string;
begin
  Result:='Пустой текстовый файл';
end;

Добавление нового типа формы

uses ProjectIntf;

...
  TFileDescPascalUnitWithMyForm = class(TFileDescPascalUnitWithResource)
  public
    constructor Create; override;
    function GetInterfaceUsesSection: string; override;
    function GetLocalizedName: string; override;
    function GetLocalizedDescription: string; override;
  end;
...

procedure Register;

implementation

procedure Register;
begin
  RegisterProjectFileDescriptor(TFileDescPascalUnitWithMyForm.Create,FileDescGroupName);
end;

{ TFileDescPascalUnitWithMyForm }

constructor TFileDescPascalUnitWithMyForm.Create;
begin
  inherited Create;
  Name:='MyForm'; // не переводите эту [строку]
  ResourceClass:=TMyForm;
  UseCreateFormStatements:=true;
end;

function TFileDescPascalUnitWithMyForm.GetInterfaceUsesSection: string;
begin
  Result:='Classes, SysUtils, MyWidgetSet';
end;

function TFileDescPascalUnitWithForm.GetLocalizedName: string;
begin
  Result:='MyForm'; // замените это строкой из resourcestring
end;

function TFileDescPascalUnitWithForm.GetLocalizedDescription: string;
begin
  Result:='Создать новую MyForm из примера пакета NotLCLDesigner';
end;

Сохранение пользовательских значений в [файлах] lpi/lps

Вы можете хранить свои собственные данные с помощью пар имя/значение в CustomData и CustomSessionData.

LazarusIDE.ActiveProject.CustomData['Name']:=Value; // хранится в lpi - x-platform, общие данные
LazarusIDE.ActiveProject.CustomSessionData['Name']:=Value; // хранится в lpi - x-platform, общие данные

Пакеты

Вы можете выполнять различные действия с пакетами:

Поиск во всех пакетах

Переберите все пакеты, загруженные в IDE (начиная с 0.9.29).

uses PackageIntf;
...
for i:=0 to PackageEditingInterface.GetPackageCount-1 do
  writeln(PackageEditingInterface.GetPackages(i).Name);

Поиск в пакетах с [определенным] именем

uses PackageIntf;
...
var
  Pkg: TIDEPackage;
begin
  Pkg:=PackageEditingInterface.FindPackageWithName('LCL');
  if Pkg<>nil then 
    ...
end;
Light bulb  Примечание: FindPackageWithName не открывает редактор пакетов. Для этого используйте DoOpenPackageWithName.

Получение имени файла lpk установленного пакета

uses PackageIntf;
...
var
  Pkg: TIDEPackage;
begin
  Pkg:=PackageEditingInterface.FindPackageWithName('LCL');
  if Pkg<>nil then 
    LPKFilename:=Pkg.Filename;
end;

Установка пакетов

Light bulb  Примечание: Устанавливайте только пакеты с плагинами IDE. Установка других пакетов может привести к нестабильной работе среды IDE.
uses PackageIntf, contnrs;
...
  PkgList:=TObjectList.create(true);
  try
    Pkg:=TLazPackageID.Create;
    Pkg.Name:='Cody';
    PkgList.Add(Pkg);
    // проверьте, может ли IDE найти cody.lpk и все зависимости
    // Среда IDE покажет некоторые предупреждения/подтверждения, если что-то выглядит странно.
    if not PackageEditingInterface.CheckInstallPackageList(PkgList,[]) then
      exit;
    // в этом примере мы [это] уже проверили, поэтому пропустите предупреждения
    // и пересоберите IDE
    if PackageEditingInterface.InstallPackages(PkgList,[piiifSkipChecks,piiifRebuildIDE])<>mrOK then
      exit;
  finally
    PkgList.Free;
  end;

Открытие файла пакета (lpk)

uses PackageIntf, FileUtil;
...
var
  pkg: TIDEPackage;
begin
  if PackageEditingInterface.DoOpenPackageFile(LPKFilename,[pofAddToRecent],false)<>mrOk then
    exit;
  Pkg:=PackageEditingInterface.FindPackageWithName(ExtractFilenameOnly(LPKFilename));
  ...
end;
Warning-icon.png

Предупреждение: Среда IDE автоматически закрывает неиспользуемые пакеты в режиме ожидания. Никогда не храните ссылку на TIDEPackage.

Поиск пакета(-ов) модуля

У вас есть имя файла модуля, например '/home/user/unit.pas', и [если] вы хотите знать, какому пакету(-ам) и проекту(-ам) он принадлежит, используйте это:

uses Classes, PackageIntf, ProjectIntf;
...
var
  Owners: TFPList;
  i: Integer;
  o: TObject;
begin
  Owners:=PackageEditingInterface.GetPossibleOwnersOfUnit('/full/path/of/unit.pas',[]);
  if Owners=nil then begin
    // модуль не связан напрямую с проектом/пакетом
    // возможно модуль был по какой-то причине не добавлен, но доступен
    // поиск по всем путям модулей всех проектов/пакетов
    // Осторожно: это может привести к ложным попаданиям
    Owners:=PackageEditingInterface.GetPossibleOwnersOfUnit('/full/path/of/unit.pas',
      [piosfExcludeOwned,piosfIncludeSourceDirectories]);
  end;
  if Owners=nil then exit;
  try
    for i:=0 to Owners.Count-1 do begin
      o:=TObject(Owners[i]);
      if o is TIDEPackage then begin
        writeln('Owner is package ',TIDEPackage(o).Name);
      end else if o is TLazProject then begin
        writeln('Owner is project ',TLazProject(o).ProjectInfoFile);
      end;
    end;
  finally
    Owners.Free;
  end;

Окна

Есть четыре основных типа окон IDE.

  • основная панель IDE - это Application.MainForm. Оно всегда присутствует.
  • плавающие / закрепляемые окна, такие как Редактор исходного кода, Инспекторы объектов и Сообщения.
  • модальные формы, такие как диалог поиска, диалоги настроек и вопросы.
  • подсказки и заполнение форм

Добавление нового закрепляемого окна IDE

Что такое закрепляемое окно IDE: Окна, такие как Редактор исходного кода или Инспектор объектов, являются плавающими окнами, которые можно закрепить, если установлен пакет закрепления, а его состояние, положение и размер сохраняются и восстанавливаются при следующем запуске IDE. Для восстановления окна IDE нужен создатель, как определено в модуле IDEWindowIntf пакета IDEIntf. Каждое закрепляемое окно должно иметь уникальное имя. Не используйте общие имена, такие как 'FileBrowser', потому что это будет легко конфликтовать с другими пакетами. И не используйте короткие имена, такие как 'XYZ', потому что создатель отвечает за все формы, начинающиеся с этого имени.

Как зарегистрировать закрепляемое окно IDE

Не забудьте выбрать длинное уникальное имя, которое является действительным идентификатором Паскаля. Ваше окно может иметь любой заголовок, который вы хотите.

uses SysUtils, IDEWindowIntf;
...
var MyIDEWindow: TMyIDEWindow = nil; 

procedure CreateMyIDEWindow(Sender: TObject; aFormName: string; var AForm: TCustomForm; DoDisableAutoSizing: boolean);
begin
  // проверяем имя
  if CompareText(aFormName,MyIDEWindowName)<>0 then exit;
  // создаем форму, если это еще не сделано, и отключаем автомасштабирование
  IDEWindowCreators.CreateForm(MyIDEWindow,TMyIDEWindowm,DoDisableAutosizing,Application);
  ... инициируем окно ...
  AForm:=MyIDEWindow;
end;

procedure Register;
begin
  IDEWindowCreators.Add('MyIDEWindow',@CreateMyIDEWindow,nil,'100','50%','+300','+20%');
  // стандартная граница формы - это:
  // Left=100, Top=50% от [величины] Screen.Height, Width=300, Height=20% от [величины] Screen.Height
  // когда IDE требуется экземпляр этого окна, она вызывает процедуру CreateMyIDEWindow.
end;

Отображение окна IDE

Warning-icon.png

Предупреждение: Не используйте [процедуру] Show.

Используйте:

IDEWindowCreators.ShowForm(MyIDEWindow,false);

Это будет работать с [механизмом] пристыковки. Система пристыковки может обернуть форму в стыковочный узел. Параметр BringToFront указывает системе закрепления сделать форму и все ее родительские сайты видимыми и вывести сайт верхнего уровня вперед.

Заметки о IDEWindowCreators и SimpleLayoutStorage

IDEWindowCreators.SimpleLayoutStorage просто хранит BoundsRect и WindowState всех форм, которые когда-то были открыты. Он используется как запасной вариант, если не установлен док-мастер. Он сохраняет состояние, даже если установлен DockMaster, поэтому, когда dockmaster удален, границы форм восстанавливаются.

IDEWindowCreators используется всеми присоединяемыми формами для регистрации и отображения форм. При показе формы Создатель проверяет, установлен ли IDEDockMaster, и передает ему отображение. Если IDEDockMaster не установлен, он просто показывает форму. IDEDockMaster может использовать информацию в IDEWindowCreators для создания форм по именам и получить представление о том, где разместить форму при ее первом отображении. Для более подробной информации смотрите пакеты AnchorDockingDsgn и EasyDockMgDsgn.

CodeTools

CodeTools - это пакет, предоставляющий огромное количество функций для анализа, поиска и изменения исходных текстов, а также некоторые основные функции для других языков. Вы можете использовать их также и без IDE. Рекомендуется сначала прочитать о CodeTools в целом, прежде чем использовать их в IDE: Codetools.

Перед вызовом любой из функций CodeTools в IDE вы должны зафиксировать текущие изменения редактора исходного кода в буферах CodeTools:

uses LazIDEIntf;
...
  // сохраняем изменения в редакторе исходного кода в codetools
  LazarusIDE.SaveSourceEditorChangesToCodeCache(-1); // -1: фиксируем все редакторы исходного кода

Добавление директивы ресурса в файл

Это добавляет {$R example.res} к модулю паскаля:

procedure AddResourceDirectiveToPascalSource(const Filename: string);
var
  ExpandedFilename: String;
  CodeBuf: TCodeBuffer;
begin
  // убеждаемся, что имя файла обрезано [от концевых пробелов] и содержит полный путь
  ExpandedFilename:=CleanAndExpandFilename(Filename);
  
  // сохраняем изменения в редакторе исходного кода в codetools
  LazarusIDE.SaveSourceEditorChangesToCodeCache(-1);

  // загружаем файл
  CodeBuf:=CodeToolBoss.LoadFile(ExpandedFilename,true,false);

  // добавляем директиву ресурса
  if not CodeToolBoss.AddResourceDirective(CodeBuf,'example.res') then
    LazarusIDE.DoJumpToCodeToolBossError;
end;

Codetools также предоставляет такие функции, как FindResourceDirective и RemoveDirective.

Получение путей поиска для модулей и включаемых файлов

В среде IDE существует множество различных путей поиска из проектов, пакетов, каталога fpc и lazarus, и существует множество типов путей: до или после разрешения макросов, с унаследованными путями поиска или без них, как относительными или абсолютными путями. Все файлы в каталоге имеют одинаковый набор путей поиска. Вы можете получить пути поиска для каждого каталога, полностью решенного путем запроса codetools:

uses CodeToolManager;
...

Dir:=''; // пустой каталог для новых файлов и имеет те же настройки, что и каталог проекта

// Получение путей поиска для включаемых файлов:
Path:=CodeToolBoss.GetIncludePathForDirectory(Dir);

// Получение путей поиска для модулей:
// Этот путь поиска передается компилятору.
// Он содержит выходные каталоги пакетов, но не каталоги с исходниками пакетов.
Path:=CodeToolBoss.GetUnitPathForDirectory(Dir);

// Могут быть дополнительные пути поиска модулей только для IDE (не передаются компилятору)
Path:=CodeToolBoss.GetSrcPathForDirectory(Dir);

// Полный путь поиска содержит также все исходные пути пакета для модулей:
Path:=CodeToolBoss.GetCompleteSrcPathForDirectory(Dir);

Редактор исходного кода

Активный редактор исходного кода

uses SrcEditorIntf;
...
Editor:=SourceEditorManagerIntf.ActiveEditor;
if Editor=nil then exit;
Filename:=Editor.FileName;
ScreenPos:=Editor.CursorScreenXY;
TextPos:=Editor.CursorTextXY;

SynEdit

Получение настроек для TSynEdit

Если у вас есть диалог с использованием TSynEdit, и вы хотите использовать тот же шрифт и настройки, которые использует редактор исходного кода:

uses SrcEditorIntf;
...
SourceEditorManagerIntf.GetEditorControlSettings(ASynEdit);

Получение настроек для подсветки SynEdit

Если у вас есть диалог, использующий TSynEdit с подсветкой, и вы хотите использовать те же цвета, что и для подсветки редактора исходного кода для этого языка, используйте:

uses SrcEditorIntf;
...
SourceEditorManagerIntf.GetHighlighterSettings(ASynHighlighter);

См. пример: TSQLStringsPropertyEditorDlg.Create in the unit SQLStringsPropertyEditorDlg.

Справка

Добавление справки для исходников

Сначала создаем THelpDatabase:

HelpDB := TFPDocHTMLHelpDatabase(
  HelpDatabases.CreateHelpDatabase('ANameOfYourChoiceForTheDatabase',
  TFPDocHTMLHelpDatabase,true));
HelpDB.DefaultBaseURL := 'http://your.help.org/';

FPDocNode := THelpNode.CreateURL(HelpDB,
  'Package1 - A new package',
  'file://index.html');
HelpDB.TOCNode := THelpNode.Create(HelpDB,FPDocNode);// один раз как оглавление TOC
DirectoryItem := THelpDBISourceDirectory.Create(FPDocNode,'$(PkgDir)/lcl',
  '*.pp;*.pas',false);// и один раз как обычная страница
HelpDB.RegisterItem(DirectoryItem);

Добавление строк в окно сообщений

unit IDEMsgIntf;
...
var Dir: String;
begin
  Dir:=GetCurrentDir;
  IDEMessagesWindow.BeginBlock;
  IDEMessagesWindow.AddMsg('unit1.pas(30,4) Error: Identifier not found "a"',Dir,0);
  IDEMessagesWindow.EndBlock;
end;

Окно настроек IDE

Открытие параметров в определенном кадре

uses LazIDEIntf;
...
LazarusIDE.DoOpenIDEOptions(TYourIDEOptionsFrame);

Прочее

Добавление макроса

Вы можете добавить свои собственные макросы IDE:

uses MacroIntf, MacroDefIntf;

procedure Register;
begin
  // регистрация макроса с фиксированным значением:
  IDEMacros.Add(TTransferMacro.Create('MyMacro1','Value','Description',nil,[]));
end;

// регистрация макроса с динамическим значением требует метода объекта
procedure TForm1.Init;
begin
  IDEMacros.Add(TTransferMacro.Create('MyMacro','Value','Description',@OnResolveMyMacro,[]));
end;

function TForm1.OnResolveMyMacro(const s: string; const Data: PtrInt;
  var Abort: boolean): string;
// s - это параметр. Например, $MyMacro(parameter)
// Data  - это экземпляр запроса. Может быть nil.
// Если есть ошибка, установите Abort в true.
// Результирующая строка может содержать макросы. Например, Result:='$(FPCVer)/$(TargetOS)';
begin
  Result:='MyValue';
end;

Отладка IDE

  • Скомпилируйте IDE как обычно, например, с помощью Tools/Build Lazarus. Убедитесь, что вы установили отладочные флаги, такие как -g или -gw2. Лучше всего использовать профиль "Debug IDE", который содержит много флагов, полезных для отладки.
  • Откройте проект ide\lazarus.lpi. Вы не можете напрямую скомпилировать этот проект.
  • Установите точки останова и пр. И запустите проект.

См. также