Формы и компоненты
Краткий обзор
- Разберитесь, как взаимосвязаны свойства, события и методы компонентов.
- Научитесь добавлять компоненты и настраивать обработчики событий с помощью панелей Tool Palette и Object Inspector.
- Изучите примеры отображения модальных форм, проверки ввода на пустое значение и управления поведением форм.
Обзор графических компонентов
Система скриптов работает с двумя типами компонентов: визуальными и невизуальными.
Визуальные компоненты используются для создания пользовательского интерфейса, а невизуальные — для выполнения различных задач. К последним относятся, например, компоненты Timer, OpenDialog и MainMenu.
-
Невизуальный компонент
Timerпозволяет выполнять определенный код через заданные интервалы времени и никогда не отображается пользователю. -
Компоненты
Button,EditиMemoявляются визуальными.
Оба типа компонентов отображаются при проектировании, но невизуальные компоненты не видны во время выполнения. Компоненты на панели Tool Palette являются объектно-ориентированными и имеют три следующих элемента:
- Свойства
- События
- Методы
Property — это характеристика объекта, которая влияет на его внешний вид, поведение или выполняемые им операции. Например, свойство Visible определяет, будет ли объект виден на форме скрипта.
Event — это действие или происшествие, обнаруживаемое скриптом. Программист пишет код для каждого обработчика событий в скрипте, предназначенного для обработки определенного события, например щелчка мышью.
Method — это процедура, которая всегда связана с объектом и определяет его поведение.
На каждой форме скрипта есть один или несколько компонентов. Компоненты обычно отображают информацию или позволяют пользователю выполнить действие. Например, Label используется для отображения статического текста, поле Edit позволяет пользователю вводить данные, а Button может использоваться для запуска действий.
На форме можно разместить любую комбинацию компонентов, и во время выполнения скрипта пользователь может взаимодействовать с любым из них. Задача программиста — определить, что произойдет, когда пользователь нажмет кнопку или изменит текст в поле Edit.
Система скриптов предоставляет ряд компонентов, с помощью которых можно создавать сложные пользовательские интерфейсы для скриптов. Чтобы разместить компонент на форме, найдите его значок на панели Tool Palette и дважды щелкните по нему. Компонент будет размещен на активной форме. Внешний вид большинства компонентов задается их свойствами. Изначально компонент размещается на форме в позиции по умолчанию, но при необходимости его можно переместить (перетащить) и изменить его размер (растянуть). Размер и положение также можно изменить позже с помощью панели Object Inspector.
При размещении компонента на форме система скриптов автоматически создает код, необходимый для его использования, и обновляет форму скрипта. Чтобы компонент на форме заработал, остается лишь задать свойства и написать код обработчиков событий, использующий нужные методы.
Проектирование форм скриптов
Форма скрипта предназначена для взаимодействия с пользователем в рабочей среде. Проектирование форм скриптов — основа визуальной разработки.
На практике все компоненты размещаются на форме скрипта, а каждое заданное свойство сохраняется в файле описания формы (файле *.DFM), связанном с кодом скрипта (файлом *.PAS). Для каждой формы скрипта существуют файл .PAS и соответствующий ему файл .DFM.
При работе с формой скрипта и ее компонентами свойства всех элементов можно просматривать и изменять на панели Object Inspector. Чтобы выбрать несколько компонентов, щелкайте по ним, удерживая клавишу Shift, или обведите нужные компоненты на форме рамкой выделения. У формы скрипта есть заголовок (свойство Caption на панели Object Inspector).
Создание новой формы скрипта
Открыв проект скрипта, щелкните правой кнопкой мыши по проекту на панели Projects, нажмите пункт Add New to Project в появившемся контекстном меню и выберите пункт Delphi Script Form. Откроется новая форма скрипта с именем по умолчанию EditScript1.pas.
Отображение формы скрипта
В скрипте должна быть процедура, которая отображает форму при запуске скрипта формы. В этой процедуре для формы можно вызвать метод ShowModal. Чтобы метод ShowModal формы скрипта работал корректно, свойство Visible формы должно иметь значение false.
ShowModal example:
Procedure RunDialog;
Begin
DialogForm.ShowModal;
End;
В примере ShowModal показан очень простой способ отображения формы скрипта при вызове процедуры RunDialog. Обратите внимание, что значения компонентам объекта DialogForm можно присвоить до вызова метода DialogForm.ShowModal.
Приведенный ниже пример использования свойства ModalResult немного сложнее. Следующие методы скрипта используются для кнопок на форме скрипта. Эти методы закрывают диалоговое окно, когда пользователь нажимает кнопку OK или Cancel; при этом метод ShowModal возвращает mrOk или mrCancel соответственно.
ModalResult Example:
Procedure TForm.OKButtonClick(Sender: TObject);
Begin
ModalResult := mrOK;
End;
Procedure TForm.CancelButtonClick(Sender: TObject);
Begin
ModalResult := mrCancel;
End;
Procedure RunShowModalExample;
Begin
// Form's Visible property must be false for ShowModal to work correctly.
If Form.ShowModal = mrOk Then ShowMessage('mrOk');
If Form.ShowModal = mrCancel Then ShowMessage('mrCancel');
End;
Когда пользователь нажимает любую из кнопок на этой форме скрипта, диалоговое окно закрывается. Вызывать метод Close не требуется, поскольку при задании ModalResult движок скриптов автоматически закрывает форму скрипта.
Обратите внимание: если вы хотите, чтобы при нажатии пользователем клавиши Esc параметр ModalResult формы получал значение Cancel, на панели Object Inspector задайте для свойства Cancel кнопки Cancel значение True или добавьте Sender.Cancel := True в обработчик события CancelButtonClick кнопки формы.
Получение данных от пользователя
Один из распространенных компонентов, позволяющих получать данные от пользователя, — TEdit. В этом компоненте есть поле, в котором пользователь может ввести строку символов. Обратите внимание, что существуют и другие компоненты Delphi, например TMaskEdit — компонент редактирования с маской ввода, хранящейся в строке. Эта маска управляет вводом или фильтрует его.
Приведенный ниже пример показывает, что происходит, когда пользователь нажимает кнопку после ввода текста в поле редактирования. Если пользователь ничего не ввел в компонент редактирования (поле пустое), обработчик события выводит предупреждение.
Procedure TScriptForm.ButtonClick(Sender : TObject);
Begin
If Edit1.Text = '' Then
Begin
ShowMessage('Warning - empty input!');
Exit;
End;
// do something else for the input
End;
Обратите внимание, что пользователь может переместить фокус ввода в диалоговом окне с помощью клавиши Tab или щелкнув по другому элементу управления на форме.
Реагирование на события
При щелчке по кнопке на форме или по компоненту система скриптов получает уведомление о событии от Altium Designer и вызывает соответствующий метод обработчика события.
See also
Проект HelloWorld из папки Scripts\DelphiScript Scripts\General\ в коллекции скриптов.
Пример скрипта ShowModal из папки Scripts\DelphiScript Scripts\General\ в коллекции скриптов.
Написание обработчиков событий
Каждый компонент в скрипте с формой имеет набор имен событий, которые используются обработчиками событий скрипта, определяющими его реакцию на действия пользователя в Altium Designer. Например, когда пользователь нажимает кнопку на форме, Altium Designer отправляет сообщение скрипту, и скрипт реагирует на это новое событие. Если для кнопки задан обработчик события OnClick, он выполняется.
Код для реакции на события обычно содержится в обработчиках событий DelphiScript, а у каждого компонента есть набор событий, на которые он может реагировать. Например, у всех компонентов, поддерживающих нажатие, есть событие OnClick, которое возникает, когда пользователь нажимает на компонент. У всех таких компонентов также есть события получения и потери фокуса. Однако если код для OnEnter и OnExit не задан (OnEnter — элемент управления получил фокус; OnExit — элемент управления потерял фокус), скрипт проигнорирует событие.
Итак, событие связывает действие в Altium Designer, например нажатие кнопки, с фрагментом кода, который на него реагирует. Этот код называется обработчиком события. Он изменяет значения свойств и вызывает методы.
Свойства компонента
Чтобы просмотреть список свойств компонента, выберите компонент и откройте вкладку Properties на панели Object Inspector.
События компонента
Чтобы просмотреть список событий, на которые может реагировать компонент, выберите компонент и откройте вкладку Events на панели Object Inspector. Чтобы создать процедуру обработки события, выберите событие, на которое должен реагировать компонент, и дважды щелкните его имя — система выполнения скриптов автоматически вставит код-заготовку обработчика события.
Например, выберите компонент TButton на панели Tool Palette и поместите его на форму скрипта, затем дважды щелкните рядом с именем события OnClick на панели Object Inspector. Система выполнения скриптов переключит фокус на редактор кода и создаст заготовку кода для события OnClick.
Например, если в обработчике события CloseClick кнопки вызывается метод Close, то при нажатии кнопки обработчик перехватит событие OnClick, что приведет к выполнению содержащегося в нем кода. В результате метод Close закроет форму скрипта.
Итак, выберите компонент кнопки на форме или с помощью панели Object Inspector, перейдите на вкладку Events и дважды щелкните поле справа от события OnClick — в скрипте появится новый обработчик события. Можно также дважды щелкнуть саму кнопку, и система выполнения скриптов добавит обработчик события OnClick. Обратите внимание, что для других типов компонентов действия по умолчанию будут отличаться.
Методы компонента
Список методов компонента приведен в документе Справочник компонентов.
Размещение компонентов на форме скрипта
Чтобы использовать в скрипте компоненты с панели Tool Palette, необходимо сначала создать форму скрипта, на которой будут размещаться компоненты. Как правило, при размещении компонентов на форме скрипта не требуется создавать или уничтожать эти объекты — форма скрипта делает это автоматически.
Система выполнения скриптов также автоматически генерирует код, необходимый для использования компонента, и обновляет форму скрипта. После этого для создания работающей формы скрипта достаточно настроить свойства, добавить код в обработчики событий и использовать необходимые методы.
Создание компонентов в скрипте
Компоненты можно создавать и уничтожать непосредственно в скрипте, передавая параметр Nil в Constructor компонента. Обычно передавать дескриптор формы не требуется, поскольку форма скрипта обрабатывает это автоматически. Например, можно создавать и уничтожать диалоговые окна Open и Save (классы TOpenDialog и TSaveDialog из Embarcadero Delphi RTL).
Настройка форм скриптов
Основные возможности настройки форм скриптов:
-
Чтобы форма оставалась поверх других открытых панелей, задайте для свойства
FormStyleзначениеfsStayOnTop. -
Чтобы определить поведение формы по умолчанию, задайте для
FormKindодно из следующих значений:fkNone,fkNormal,fkServerPanelилиfkModal. -
Если
fkModalзакрыта, форма будет модальной, то есть будет ожидать ввода пользователя, например закрытия формы, прежде чем продолжить выполнение. ЕслиfkServerPanel, форма будет отображаться как серверная панель. ЕслиfkNormal, форма будет работать как обычная немодальная форма. -
Чтобы убрать стандартные полосы прокрутки формы, измените значения свойств
HorzScrollBarиVertScrollBar. -
Чтобы сделать форму рамочным или дочерним окном MDI, используйте свойство
FormStyle. -
Чтобы изменить стиль границы формы, используйте свойства
BorderIconsиBorderStyle(результат виден во время выполнения). -
Чтобы изменить значок свернутой формы, используйте свойство
Icon. -
Чтобы задать начальное положение формы в окне приложения, используйте свойство
Position. -
Чтобы задать начальное состояние формы (например, свернутое, развернутое или обычное), используйте свойство
WindowState. -
Чтобы определить рабочую область формы во время выполнения, используйте свойства
ClientHeightиClientWidth(обратите внимание:ClientHeightиClientWidthзадают область внутри границ формы, аHeightиWidth— всю область формы). -
Чтобы указать, какой элемент управления первым получит фокус на форме во время выполнения, используйте свойство
ActiveControl. -
Чтобы передавать форме все события клавиатуры независимо от выбранного элемента управления, используйте свойство
KeyPreview. -
Чтобы указать конкретное меню, если форма содержит несколько меню, используйте свойство
Menu.
Обновление форм скриптов и компонентов
Если отображение формы скрипта перестает соответствовать ее текущему состоянию, например элементы управления не обновляются или не перерисовываются, они могут выглядеть зависшими или отображаться некорректно. Причиной может быть интенсивная фоновая обработка в этом скрипте.
Метод Update формы скрипта, а также многих компонентов скрипта с панели Tool Palette, позволяет обновить графическое содержимое формы или отдельных элементов управления. В приведенном ниже примере строки, содержащие метод Update, выделены серым цветом.
StatusBar component and its Update method Example:
Procedure TConverterForm.loadbuttonClick(Sender: TObject);
Begin
If OpenPictureDialog1.Execute then
Begin
XPProgressBar1.Position := 0;
XStatusBar1.SimpleText := ' Loading...';
XStatusBar1.Update;
// loading a monochrome bitmap only
Image1.Picture.LoadFromFile(OpenPictureDialog1.FileName);
// Check if image is monochrome, otherwise prompt a warning
If Image1.Picture.Bitmap.PixelFormat <> pf1bit Then
Begin
ShowWarning('The image is not a monochrome!');
Close;
End;
lImageSize.Caption := IntToStr(Image1.Picture.Width) + ' x ' +
IntToStr(Image1.Picture.Height) + ' mils';
convertbutton.Enabled := True;
LoadButton.Enabled := False;
XStatusBar1.SimpleText := ' Ready...';
XStatusBar1.Update;
End;
End;
Приведенный выше фрагмент кода взят из проекта скрипта PCB Logo Creator, который находится в папке Scripts\Delphiscript Scripts\Pcb\PCB Logo Creator доступной для скачивания коллекции скриптов.