Visual C++. Описание стандартных классов
Страница 37.


 
HELPINFO
typedef struct tagHELPINFO
{
UINT cbSize;
int iContextType
int iCtrlId;
HANDLE hItemHandle;
DWORD dwContextId;
POINT MousePos;
} HELPINFO, FAR *LPHELPINFO;
Переменные
"sectiontableheader"cbSize - размер структуры в байтах.
"sectiontableheader"iContextType - определяет тип контекста, для которого запрашивается справка. Данный аргумент может принимать одно из следующих значений:
"sectiontableheader"HELPINFO_MENUITEM - справка по команде меню;
"sectiontableheader"HELPINFO_WINDOW - справка по элементу управления или окну.
"sectiontableheader"iCtrlId - если аргумент iContextType имеет значение HELPINFO_WINDOW, то в данном аргументе содержится идентификатор окна или элемента управления. Если аргумент iContextType имеет значение HELPINFO_MENUITEM, то в данном аргументе содержится идентификатор команды меню.
"sectiontableheader"hItemHandle - если аргумент iContextType имеет значение HELPINFO_WINDOW, то в данном аргументе содержится идентификатор дочернего окна или элемента управления. Если аргумент iContextType имеет значение HELPINFO_MENUITEM, то в данном аргументе содержится идентификатор связанного меню.
"sectiontableheader"dwContextId - контекстный идентификатор окна или элемента управления.
"sectiontableheader"MousePos - объект структуры POINT, содержащий экранные координаты курсора мыши. Эта информация используется при выводе справки на основании текущей позиции курсора мыши.
Описание
Данная структура используется для хранения информации о теме контекстной справки.
HH_WINTYPE
typedef struct tagHH_WINTYPE {
  int cbStruct;
  BOOL fUniCodeStrings;
  LPCTSTR pszType;
  DWORD fsValidMembers;
  DWORD fsWinProperties;
  LPCTSTR pszCaption;
  DWORD dwStyles;
  DWORD dwExStyles;
  RECT rcWindowPos;
  int nShowState;
  HWND hwndHelp;
  HWND hwndCaller;
  HH_INFOTYPE* paInfoTypes;
  HWND hwndToolBar;
  HWND hwndNavigation;
  HWND hwndHTML;
  int iNavWidth;
  RECT rcHTML;
  LPCTSTR pszToc;
  LPCTSTR pszIndex;
  LPCTSTR pszFile;
  LPCTSTR pszHome;
  DWORD fsToolBarFlags;
  BOOL fExpanded;
  int curNavType;
  int tabpos;
  int idNotify;
  BYTE tabOrder[HH_MAX_TABS + 1];
} HH_WINTYPE;
Переменные
"sectiontableheader"cbStruct - размер объекта структуры. Значение этой переменной должно быть определено до того, как данный объект структуры будет передан функции HtmlHelp.
"sectiontableheader"fUniCodeStrings - определяет, являются ли строки данной структуры строками Unicode.
"sectiontableheader"pszType - указатель на заканчивающуюся нулем строку, содержащую имя типа окна.
"sectiontableheader"fsValidMembers - используется при изменении свойств сушествующего типа окна и определяет его обновляемые свойства. В данной переменной могут быть установлены следующие флаги.
"sectiontableheader"HHWIN_PARAM_PROPERTIES - используется переменная fsWinProperties.
"sectiontableheader"HHWIN_PARAM_STYLES - используется переменная dwStyles.
"sectiontableheader"HHWIN_PARAM_EXSTYLES - используется переменная dwExStyles.
"sectiontableheader"HHWIN_PARAM_RECT - используется переменная rcWindowPos.
"sectiontableheader"HHWIN_PARAM_NAV_WIDTH - используется переменная rcNavigation.
"sectiontableheader"HHWIN_PARAM_SHOWSTATE - используется переменная nShowState.
"sectiontableheader"HHWIN_PARAM_INFOTYPES - используется переменная ainfoTypes.
"sectiontableheader"HHWIN_PARAM_TB_FLAGS - используется переменная fsToolBarFlags.
"sectiontableheader"HHWIN_PARAM_EXPANSION - используется переменная fExpanded.
"sectiontableheader"HHWIN_PARAM_TABPOS - используется переменная tabpos.
"sectiontableheader"HHWIN_PARAM_TABORDER - используется переменная tabOrder.
"sectiontableheader"HHWIN_PARAM_HISTORY_COUNT - используется переменная cHistory.
"sectiontableheader"fsWinProperties - используется для задания различных свойств окна. В данной переменной могут быть установлены следующие флаги.
"sectiontableheader"HHWIN_PROP_ONTOP - определяет, что окно будет отображаться не только поверх родительского окна, но и поверх всех остальных окон на рабочем столе.
"sectiontableheader"HHWIN_PROP_NOTITLEBAR - запрещает вывод заголовка окна.
"sectiontableheader"HHWIN_PROP_NODEF_STYLES - запрещает использование при создании окна стилей, заданных по умолчанию. По умолчанию задается следующая комбинация стилей: WS_THICKFRAME | WS_OVERLAPPED | WS_VISIBLE.
"sectiontableheader"HHWIN_PROP_NODEF_EXSTYLES - запрещает использование при создании окна расширенных стилей, заданных по умолчанию. При задании этого флага флаг HHWIN_PROP_ONTOP игнорируется.
"sectiontableheader"HHWIN_PROP_TRI_PANE - создает окно с тремя панелями. Этот флаг не изменяет вида уже созданного окна.
"sectiontableheader"HHWIN_PROP_NOTB_TEXT - запрещает вывод текста под кнопками панели инструментов окна с тремя панелями.
"sectiontableheader"HHWIN_PROP_POST_QUIT - при закрытии окна справки оно посылает сообщение WM_QUIT в очередь сообщений вызвавшего приложения, что приведет к его закрытию.
"sectiontableheader"HHWIN_PROP_AUTO_SYNC - определяет, что при выводе вкладок оглавления или индекса в них отображается заголовок темы или ключевое слово, соответствующее текущему URL. Если URL для нового файла HTML отсутствует, в этих вкладках не происходит никаких изменений.
"sectiontableheader"HHWIN_PROP_TRACKING - задает режим посылки вызвавшему приложению следящих извещений.
"sectiontableheader"HHWIN_PROP_TAB_SEARCH - включает вкладку текстового поиска в панель навигации окна с тремя панелями.
"sectiontableheader"HHWIN_PROP_TAB_HISTORY - включает вкладку результатов предыдущего поиска в панель навигации окна с тремя панелями. Это свойство не поддерживается в версии 1.
"sectiontableheader"HHWIN_PROP_TAB_FAVORITES - включает вкладку наиболее часто встречающихся тем в панель навигации окна с тремя панелями. Это свойство не поддерживается в версии 1.
"sectiontableheader"HHWIN_PROP_CHANGE_TITLE - выводит в заголовке окна справочной системы заголовок отображаемого файла HTML.
"sectiontableheader"HHWIN_PROP_TAB_ADVANCED - включает вкладку расширенного поиска в панель навигации окна с тремя панелями.
"sectiontableheader"pszCaption - указатель на заканчивающуюся нулем строку, содержащую заголовок окна.
"sectiontableheader"dwStyles - определяет стили создаваемого окна. Стили могут игнорироваться, комбинироваться со стилями, используемыми по умолчанию или использоваться отдельно, в зависимости от значений переменных fsValidMembers и fsWinProperties.
"sectiontableheader"dwExStyles - определяет дополнительные стили создаваемого окна. Стили могут игнорироваться, комбинироваться со стилями, используемыми по умолчанию или использоваться отдельно, в зависимости от значений переменных fsValidMembers и fsWinProperties.
"sectiontableheader"rcWindowPos - содержит координаты окна. При задании координат все отрицательные значения игнорируются. Например, для перемещения окна с сохранением его размеров необходимо задать позицию левого верхнего угла прямоугольника, а координатам его правого нижнего угла присвоить значения -1.
"sectiontableheader"nShowState - определяет исходный режим отображения окна.
"sectiontableheader"hwndHelp - содержит дескриптор создаваемого окна справочной системы.
"sectiontableheader"hwndCaller - содержит дескриптор окна, которому будут посылаться сообщения.
"sectiontableheader"paInfoTypes - определяет типы выводимой информации. Каждый тип выводимой информации представляет собой флаг. Если не установлен нулевой флаг, то все команды HTML Help, использующие различные типы выводимой информации, будут использовать эти флаги для определения того, какой UI необходимо отображать и когда следует произвести переход по гиперссылке.
"sectiontableheader"hwndToolBar - дескриптор окна Панель инструментов окна справочной системы, содержащей три панели.
"sectiontableheader"hwndNavigation - дескриптор окна, содержащего текущий UI навигации в окне, имеющем три панели.
"sectiontableheader"hwndHTML - дескриптор окна, в которое выводятся файлы HTML в окне, имеющем три панели. Это окно является родительским для SHDOCVW.
"sectiontableheader"iNavWidth - определяет ширину панели навигации в окне, имеющем три панели, при его развертывании.
"sectiontableheader"rcHTML - определяет координаты панели HTML в окне, имеющем три панели.
"sectiontableheader"pszToc - определяет файл или URL, используемый в оглавлении окна, имеющего три панели.
"sectiontableheader"pszIndex - определяет файл или URL, используемый в индексаторе окна, имеющего три панели.
"sectiontableheader"pszFile - определяет файл или URL, используемый в правой панели окна, имеющего три панели. Этот файл будет отображаться при нажатии пользователем кнопки Home (Домой) на панели инструментов.
"sectiontableheader"pszHome - определяет файл или URL, используемый в правой панели окна, имеющего три панели, отображаемый при нажатии пользователем кнопки Home (Домой) на панели инструментов.
"sectiontableheader"fsToolBarFlags - определяет набор кнопок панели инструментов, отображаемой в окне, имеющем три панели. В данной переменной могут быть установлены следующие флаги:
"sectiontableheader"HHWIN_BUTTON_EXPAND - кнопка Expand/contract (Расширить) в панели навигации;
"sectiontableheader"HHWIN_BUTTON_BACK - кнопка Back (Назад);
"sectiontableheader"HHWIN_BUTTON_FORWARD - кнопка Forward (Вперед);
"sectiontableheader"HHWIN_BUTTON_STOP - кнопка Stop (Остановить);
"sectiontableheader"HHWIN_BUTTON_REFRESH - кнопка Refresh (Обновить);
"sectiontableheader"HHWIN_BUTTON_HOME - кнопка Home (Домой) (для файла HTML, заданного для окна);
"sectiontableheader"HHWIN_BUTTON_HISTORY - кнопка History (Журнал);
"sectiontableheader"HHWIN_BUTTON_FAVORITES - кнопка Favorites (Избранное);
"sectiontableheader"HHWIN_BUTTON_TOC - кнопка Table of Contents (Содержание);
"sectiontableheader"HHWIN_BUTTON_INDEX - кнопка Index (Предметный указатель);
"sectiontableheader"HHWIN_BUTTON_SEARCH - кнопка Simple search (Поиск);
"sectiontableheader"HHWIN_BUTTON_JUMP1 - кнопка Jump1 (Переход1);
"sectiontableheader"HHWIN_BUTTON_JUMP2 - кнопка Jump2 (Переход2).
"sectiontableheader"fExpanded - определяет необходимость вывода панели навигации в окне, имеющем три панели.

"sectiontableheader"curNavType - определяет навигационный UI, выводимый в панели навигации окна, имеющего три панели. Эта переменная может принимать одно из следующих значений:
"sectiontableheader"HHWIN_NAVTYPE_TOC - выводится вкладка Contents (Содержание);
"sectiontableheader"HHWIN_NAVTYPE_INDEX - выводится вкладка Index (Предметный указатель).
"sectiontableheader"tabpos - определяет положение вкладок в навигационной панели окна, имеющего три панели. Эта переменная может принимать одно из следующих значений:
"sectiontableheader"HHWIN_NAVTAB_TOP - вкладки выводятся сверху;
"sectiontableheader"HHWIN_NAVTAB_LEFT - вкладки выводятся слева;
"sectiontableheader"HHWIN_NAVTAB_BOTTOM - вкладки выводятся снизу.
"sectiontableheader"idNotify - определяет идентификатор, указываемый в аргументе WPARAM сообщения WM_NOTIFY.
"sectiontableheader"tabOrder - определяет порядок вкладок в навигационной панели окна, имеющего три панели. Для использования этой переменной следует установить флаг HHWIN_PARAM_TABORDER. Первые десять позиций зарезервированы для стандартных вкладок HTML Help: Contents (Содержание), Index (Предметный указатель), Search (Поиск), History (Журнал), Favorites (Избранное) и Reserved 1-5 (зарезервированы для последующего использования). Каждый байт содержит численное значение, соответствующее позиции, начиная с нулевой. Например, для вывода вкладки Index (Предметный указатель) первой, а вкладки Contents (Содержание) - второй, необходимо произвести следующие присваивания: tabOrder[HH_TAB_CONTENTS] = 1 и tabOrder[HH_TAB_INDEX] = 0.
"sectiontableheader"cHistory - определяет число хранимых результатов последних поисков. В настоящее время значение этой переменной игнорируется.
"sectiontableheader"pszJump1 - содержит URL, по которому будет произведен переход при нажатии кнопки Jump1 (Переход1).
"sectiontableheader"pszJump2 - содержит URL, по которому будет произведен переход при нажатии кнопки Jump2 (Переход2).
Описание
Объекты структуры HH_WINTYPE используются при создании, изменении или получении свойств окон справочной системы HTML. Типы окна могут определяться разработчиком и храниться в скомпилированном файле HTML, или же определяться в программе с использованием функции HtmlHelp. Каждый тип окна должен иметь уникальное имя. Если при обращении к функции HtmlHelp указано имя несуществующего типа окна, то для этого имени будет создан новый тип окна, свойства которого будут установлены по умолчанию.
 
« Предыдущая статья   Следующая статья »