Интеграция контекстно-зависимой помощи в приложения Delphi с использованием символьных имен

Delphi , Файловая система , Help файлы

При разработке приложений на Delphi часто возникает необходимость интеграции системы контекстно-зависимой помощи, которая позволяет пользователям получать информацию о текущем элементе интерфейса при нажатии клавиши F1. Вопрос, который мы рассмотрим, заключается в использовании символьных имен для вызова соответствующих страниц помощи, вместо использования HelpID и его алиасов.

Проблема

Разработчик работает над системой помощи в своем приложении и хочет, чтобы при нажатии клавиши F1 открывалась соответствующая страница помощи для активного элемента управления. Существует два основных способа настройки контекстной помощи: использование HelpID или HelpID Alias. Однако в системе помощи Dr. Explain используется концепция символьных имен, которые отличаются от HelpID и его алиасов и доступны через метод Application.HelpJump(SymbolicName).

Разработчик хочет использовать поле HelpContext для хранения символьных имен, что упрощает управление и поддерживает систему помощи без необходимости создания дополнительного набора HelpID Alias или работы с файлом карты помощи.

Решение

Ключевым моментом является модификация стандартной обработки F1, которая производится через метод TApplication.HelpKeyword. Вместо стандартной обработки, разработчик может заменить ее на вызов метода Application.HelpJump, который напрямую обращается к символьным именам.

Однако, для реализации такой модификации без изменения исходного кода модуля Forms, можно использовать обработчик события OnHelp формы или глобального объекта Application. В этом обработчике можно перехватить команду HELP_COMMAND и выполнить свою логику, например, вызвать Application.HelpSystem.ShowTopicHelp.

function TForm1.FormHelp(Command: Word; Data: Integer; var CallHelp: Boolean): Boolean;
begin
  if Command = HELP_COMMAND then
  begin
    CallHelp := False; // Отмена стандартной обработки
    Application.HelpSystem.ShowTopicHelp(PChar(Data), Application.CurrentHelpFile);
    Result := True; // Указываем, что обработка выполнена
  end;
end;

Подтвержденный ответ

Пользователь сообщает, что предложенное решение с использованием обработчика OnHelp работает, но с некоторыми корректировками. В частности, параметр Data является адресом строкового объекта, поэтому для его использования необходимо применить функцию string(PObject(Data)). Также, метод ShowTopicHelp может не работать для всех систем просмотра помощи, но после изменения значения CallHelp на false и использования PChar для Data, контекстно-зависимая помощь начинает работать корректно.

Заключение

требует понимания работы стандартных методов и обработчиков событий, а также возможности их модификации для реализации нужного поведения. Использование обработчика OnHelp позволяет избежать необходимости изменения исходного кода и обеспечивает гибкость в настройке системы помощи.

Создано по материалам из источника по ссылке.

Разработчик хочет интегрировать систему контекстной помощи в приложение на Delphi с использованием символьных имен вместо HelpID для отображения соответствующих страниц помощи по нажатию клавиши F1.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: Help файлы ::