А Вы ещё не используете базовую форму и базовую фрейму в своих Delphi-проектах?

В этой заметке я хочу рассказать о базовой форме и базовой фрейме. Что это такое, и зачем это нужно. Под словом “базовая” я подразумеваю, что любая форма/фрейма в проекте является наследником TMyBaseForm/TMyBaseFrame, а не стандартных TForm/TFrame. Т.е. слово “базовая” никакого отношения к базам данных не имеет; в своих проектах, при создании новых форм и фрейм, я всегда наследуюсь от базовых.

Немного лирики

Представьте себе типичный Delphi-проект для работы с базой данных. Наиболее распространённым и привычным является такой интерфейс: таблица БД (набор из нескольких записей) отображается в гриде, данные редактируются в отдельной (модальной) форме. Возьмём, к примеру, справочник контрагентов. Делаем: а) форму со строкой поиска и гридом, для отображения контрагентов; б) форму для редактирования карточки контрагента. По двойному клику на строке в гриде открывается карточка контрагента на редактирование в модальном режиме.

В моей практике подобный тип интерфейса наиболее распространённый:  грид предоставляет интерфейс для отображения списка записей таблицы, модальная форма используется для редактирования конкретной записи. Есть и другие варианты, но для сегодняшнего вопроса это не принципиально.

Итак, допустим мы сделали пару форм для контрагентов. Потом ещё пару форм для работы со справочником поставщиков. Потом ещё пару форм. А потом ещё. А потом мы вдруг обнаруживаем проблему-неприятность: если пользователь свернёт модальную форму, то модальная форма свернётся не в панель задач, а в нижнюю часть рабочего стола, причём родительская форма останется на экране и одновременно не доступной для пользователя. Чтобы такую “красоту” избежать, можно скрыть/сделать неактивной кнопку сворачивания в модальной форме. Но это тоже не красиво – пользователь не сможет свернуть приложение. Поэтому я предпочитаю в модальной форме обрабатывать сообщение WM_SYSCOMMAND: SC_MINIMIZE как-то так:

procedure TForm1.WMSysCommand(var Msg: TMessage);
begin
  if (Msg.WParam = SC_MINIMIZE) and (fsModal in FormState)
    then Application.Minimize
    else inherited;
end;

Это наиболее ожидаемое поведение приложения для пользователя: если форма открыта в модальном режиме, то при её сворачивании происходит сворачивание всего приложения. Отлично, проблему решили для карточки контрагента, теперь копируем код в карточку поставщика, потом ещё, и ещё…

Или вот ещё одно привычное для пользователя поведение GUI: если форма не главная (окно настроек, модальная карточка контрагента, плавающее окно и т.п.), то при нажатии на клавишу Escape пользователь ожидает закрытия (скрытия) окна. Как правильно закрывать форму по Escape я писал ранее, а именно: обработка сообщения CM_DIALOGKEY. Ну т.е. и эту проблему мы решили для карточки контрагента, затем для карточки поставщика (copy/paste рулит), затем ещё, и ещё…

Надеюсь Вы поняли, к чему я клоню. Чем больше форм, тем больше копирований приходится делать, устраняя какую-то мелочь. Опять же, дублирование кода, тоже плохо.

В общем, устраняя в очередной раз проблему невольно задумываешься: а как бы сделать так, чтобы не дублировать код? В принципе, в некоторых случаях можно написать общую ловушку (хук) на cообщения и анализировать ActiveForm. Но хук – это, во-первых, не красиво, а во-вторых – не всё можно сделать “снаружи” формы без ухищрений. Например, тоже полезная вещь: автоматическое уничтожение формы при её закрытии. Имея базовую форму, можно в ней объявить свойство FreeOnClose.

Базовая форма

Итак, нам нужна базовая форма. Базовая форма – это класс наследник от TForm, в котором мы реализуем “рюшечки”, “хотелки” и “необходимки”, которых нету в TForm, но которые являются общими для всех форм нашего приложения. А вот все формы в приложении уже наследуются от базовой.

К слову сказать, сегодня я обнаружил поведение, свойственное всем приложениям Delphi при включённой теме Aero в Windows (обычно я её отключаю, поэтому и не замечал ранее): если закрыть окно (с последующим уничтожением), то иконка в строке заголовка окна успеет сменится на дефолтовую. Это заметно как раз в тот момент, когда окно начинает уменьшаться и плавно исчезает с экрана. Естественно, это элементарно фиксится в базовой форме. И именно мысль “как здорово иметь базовую форму” побудила меня написать заметку, которую я уже давно планировал написать…

Базовая форма создаётся элементарно – отдельный модуль, в котором размещается наш класс (назовём его пока TMyBaseFrame = class(TForm)), и реализуется вся логика. Сложнее сделать так, чтобы эта форма попала в меню IDE Delphi –> File \ New. Это нужно, чтобы формы для своих приложений создавать в пару кликов, и чтобы IDE могла отобразить дополнительные published-свойства базовой формы. Для это придётся написать визард.

Я не стал изобретать велосипед, а просто сделал по образу и подобию того, как это сделано в устаревшей (уже, но всё ещё актуальной для Delphi 7), и бесплатной библиотеке TntComponents.

А далее, на основе базовой формы можно сделать ещё несколько базовых форм: форма со строкой состояния, форма с кнопками [OK]/[Отмена/Закрыть]/[Применить], форма с кнопками и набором вкладок (PageControl) – для этих форм можно не делать визард, а достаточно поместить их в репозитарий IDE (правой кнопкой на форме в дизайнере – Add to Repository).

Базовая фрейма

Базовая фрейма нужна для того же, для чего и базовая форма – возможность реализации общих вещей для всех фрейм в одном месте. Вообще, фрейма ^{(правильно говорить “фрейм”, но пусть слово “фрейма” будет женского рода, Вы не против?)} чаще всего используется, как контейнер для грида и панелей управления данными – фильтры, поиск и действия над табличными данными. Т.е. когда я в самом начала писал, что мол “создаём форму с гридом”, на самом деле я создаю фрейму с гридом. А фрейм уже легко поместить на базовую форму… хочешь – на форму с кнопкой “Закрыть”, хочешь – на форму со строкой состояния, а хочешь – на Master-Detail форму.

Исходники

Исходники пока не выкладываю. Ибо хочу:

• выкинуть лишнее и оставить только то, что будет полезно всем;
• накидать пару примеров и написать отдельную заметку/руководство;
• хочу опробовать выложить исходники в Git, чтобы не обновлять каждый раз архивы на файлообменнике.

Ваши комментарии:

• послужат дополнительным стимулом поскорее подготовить исходники;
• могут повлиять на содержание следующей заметки;
• интересно узнать Ваш ответ на озвученный вопрос.

Читать дальше