owl::THelpContext Class Reference

THelpContext is a class that maintains information about a menu item id and a child control id with a help context id. More...

#include <owl/hlpmanag.h>

Public Member Functions
	THelpContext ()
	Default constructor that initializes every data member to zero.
	THelpContext (TWindow *window, int helpId, int menuId, int controlId)
	Convenient constructor to initialize the context entry with the proper ids.
	THelpContext (const THelpContext &)
	Makes a copy of the context entry.
	~THelpContext ()
THelpContext &	operator= (const THelpContext &)
	Makes a copy of the context entry.
bool	operator== (const THelpContext &) const
	Returns true if the context entries match.
bool	operator< (const THelpContext &) const
int	GetHelpFileContextId () const
	Returns the help file context id for the context entry.
int	GetMenuContextId () const
	Returns the menu id for this context entry.
int	GetControlContextId () const
	Returns the child control id for this context entry.
TWindow *	GetWindow () const
	Returns the window this entry is associated with.
void	SetWindow (TWindow *window)
	Sets the window for this context entry.

Detailed Description

THelpContext is a class that maintains information about a menu item id and a child control id with a help context id.

As particular windows get and lose focus, their context tables are removed from a global context table.

Definition at line 116 of file hlpmanag.h.

Constructor & Destructor Documentation

THelpContext() [1/3]

owl::THelpContext::THelpContext

(

)

Default constructor that initializes every data member to zero.

Definition at line 547 of file hlpmanag.cpp.

THelpContext() [2/3]

owl::THelpContext::THelpContext	(	TWindow *	window,
		int	helpId,
		int	menuId,
		int	controlId )

Convenient constructor to initialize the context entry with the proper ids.

Definition at line 560 of file hlpmanag.cpp.

THelpContext() [3/3]

owl::THelpContext::THelpContext

(

const THelpContext &

other

)

Makes a copy of the context entry.

Definition at line 572 of file hlpmanag.cpp.

References THelpContext().

~THelpContext()

owl::THelpContext::~THelpContext

(

)

Definition at line 580 of file hlpmanag.cpp.

Member Function Documentation

GetControlContextId()

int owl::THelpContext::GetControlContextId ( ) const

inline

Returns the child control id for this context entry.

Definition at line 355 of file hlpmanag.h.

GetHelpFileContextId()

int owl::THelpContext::GetHelpFileContextId ( ) const

inline

Returns the help file context id for the context entry.

Definition at line 337 of file hlpmanag.h.

GetMenuContextId()

int owl::THelpContext::GetMenuContextId ( ) const

inline

Returns the menu id for this context entry.

Definition at line 346 of file hlpmanag.h.

GetWindow()

TWindow * owl::THelpContext::GetWindow ( ) const

inline

Returns the window this entry is associated with.

Definition at line 364 of file hlpmanag.h.

operator<()

bool owl::THelpContext::operator<

(

const THelpContext &

other

)

const

Definition at line 611 of file hlpmanag.cpp.

References THelpContext(), and GetHelpFileContextId().

operator=()

THelpContext & owl::THelpContext::operator=

(

const THelpContext &

other

)

Makes a copy of the context entry.

Definition at line 588 of file hlpmanag.cpp.

References THelpContext(), GetControlContextId(), GetHelpFileContextId(), GetMenuContextId(), and GetWindow().

operator==()

bool owl::THelpContext::operator==

(

const THelpContext &

other

)

const

Returns true if the context entries match.

Definition at line 601 of file hlpmanag.cpp.

References THelpContext(), GetControlContextId(), GetHelpFileContextId(), GetMenuContextId(), and GetWindow().

SetWindow()

void owl::THelpContext::SetWindow ( TWindow * window )

inline

Sets the window for this context entry.

Definition at line 373 of file hlpmanag.h.

---

The documentation for this class was generated from the following files:

• include/owl/hlpmanag.h
• source/owlcore/hlpmanag.cpp