hlpmanag.h File Reference

Declares THelpContext and THelpFileManager. More...

#include <owl/private/defs.h>
#include <owl/window.h>
#include <htmlhelp.h>
#include <owl/preclass.h>
#include <owl/posclass.h>

Go to the source code of this file.

Classes
struct	owl::THelpHitInfo
class	owl::THlpNotify
class	owl::THlpPopup
class	owl::THlpAklink
class	owl::THlpEnumIt
class	owl::THlpSetInfoType
class	owl::THlpFtsQuery
class	owl::THlpWinType
class	owl::THlpTrack
class	owl::THelpContext
	THelpContext is a class that maintains information about a menu item id and a child control id with a help context id. More...
class	owl::THelpFileManager
	THelpFileManager, which is designed to be a mix-in for TApplication, uses the global context table. More...
class	owl::THtmlHelpDll
	Wrapper for the HHCTRL.OCX itself. More...

Namespaces
namespace	owl
	Object Windows Library (OWLNext Core)

Macros
#define	DECLARE_HELPCONTEXT(cls)    static THelpContext __hcEntries[]
#define	DEFINE_HELPCONTEXT(cls)    THelpContext cls::__hcEntries[] = {
#define	END_HELPCONTEXT
#define	HCENTRY_MENU(hcId, menuId)    THelpContext(0, hcId, menuId, 0)
#define	HCENTRY_CONTROL(hcId, ctlId)    THelpContext(0, hcId, 0, ctlId)
#define	HCENTRY_MENU_AND_CONTROL(hcId, menuId, ctlId)    THelpContext(0, hcId, menuId, ctlId)
#define	SETUP_HELPCONTEXT(appCls, cls)
#define	CLEANUP_HELPCONTEXT(appCls, cls)

Typedefs
typedef TDllLoader< THtmlHelpDll >	owl::THtmlHelp
	Loader for the HHCTRL.OCX.

Functions
bool	owl::IsIndirectHelpContext (const THelpContext &context)
	Return true if the context entry is a pointer to another table.
bool	owl::IsLastIndirectContext (const THelpContext &context)
	Return true if this entry is the last entry.

Variables
const int	owl::TablePtr = -1

Detailed Description

Declares THelpContext and THelpFileManager.

Definition in file hlpmanag.h.

Macro Definition Documentation

CLEANUP_HELPCONTEXT

#define CLEANUP_HELPCONTEXT	(		appCls,
			cls )

Value:

  {                                                               \
    appCls* app = TYPESAFE_DOWNCAST(GetApplication(), appCls);    \
    if (app)                                                      \
      app->RemoveContextInfo(this);                               \
  }

Definition at line 275 of file hlpmanag.h.

DECLARE_HELPCONTEXT

#define DECLARE_HELPCONTEXT

(

cls

)

static THelpContext __hcEntries[]

Definition at line 243 of file hlpmanag.h.

DEFINE_HELPCONTEXT

#define DEFINE_HELPCONTEXT

(

cls

)

THelpContext cls::__hcEntries[] = {

Definition at line 246 of file hlpmanag.h.

END_HELPCONTEXT

#define END_HELPCONTEXT

Value:

    THelpContext(0, 0, 0, 0)   \
  }

Definition at line 249 of file hlpmanag.h.

HCENTRY_CONTROL

#define HCENTRY_CONTROL	(		hcId,
			ctlId )    THelpContext(0, hcId, 0, ctlId)

Definition at line 256 of file hlpmanag.h.

HCENTRY_MENU

#define HCENTRY_MENU	(		hcId,
			menuId )    THelpContext(0, hcId, menuId, 0)

Definition at line 253 of file hlpmanag.h.

HCENTRY_MENU_AND_CONTROL

#define HCENTRY_MENU_AND_CONTROL	(		hcId,
			menuId,
			ctlId )    THelpContext(0, hcId, menuId, ctlId)

Definition at line 259 of file hlpmanag.h.

SETUP_HELPCONTEXT

#define SETUP_HELPCONTEXT	(		appCls,
			cls )

Value:

  {                                                                     \
    appCls* app = TYPESAFE_DOWNCAST(GetApplication(), appCls);          \
    if (app) {                                                          \
      for (THelpContext* hc = &__hcEntries[0]; !IsLastIndirectContext(*hc); hc++) { \
        app->AddContextInfo(this,                                       \
                            hc->GetHelpFileContextId(),                 \
                            hc->GetMenuContextId(),                     \
                            hc->GetControlContextId());                 \
      }                                                                 \
    }                                                                   \
  }

Definition at line 262 of file hlpmanag.h.