TTooltipEnabler is the object forwarded along the command-chain to retrieve the tip text of a tool. More...

#include <owl/tooltip.h>

Inheritance diagram for owl::TTooltipEnabler:

Public Member Functions
	TTooltipEnabler (TTooltipText &tt, HWND hReceiver)
	Constructs enabler object to be sent to a window so that the latter can provide the text of the specified tool.

virtual void	SetText (LPCTSTR text)
	Sets the text of the tool specified by the TTooltipEnabler object.

virtual void	SetCheck (int check)
	SetCheck does nothing but serve as a place-holder function.

void	SetText (const tstring &text)

Public Member Functions inherited from owl::TCommandEnabler
	TCommandEnabler (uint id, HWND hWndReceiver=0)
	Constructs the TCommandEnabler object with the specified command ID.

uint	GetId () const
	Retrieves the id of the command.

virtual void	Enable (bool enable=true)
	Enables or disables the command sender.

void	SetText (const tstring &s)

void	SetCheck (bool isChecked)
	Overload; allows you to pass a bool safely.

bool	SendsCommand () const
	Returns true if this command enabler sends a command message.

bool	GetHandled ()
	Return true if the command enabler has been handled.

bool	IsReceiver (HWND hReceiver)
	Returns true if receiver is the same as the message responder originally set up in the constructor.

HWND	GetReceiver () const
	Returns the handle of the window that this enabler was destined for.

void	SetReceiver (HWND hReceiver)
	Sets the receiver for the enabler.

Additional Inherited Members
Public Types inherited from owl::TCommandEnabler
enum	TCommandState { Unchecked , Checked , Indeterminate }
	Enumeration describing the 3-states or availability of a command. More...

Protected Types inherited from owl::TCommandEnabler
enum	TCommandStatus { WasHandled = 1 , NonSender = 2 }
	Enumeration describing whether the associated command has been enabled or disabled, and whether the command generates WM_COMMAND messages. More...

Protected Member Functions inherited from owl::TCommandEnabler
void	SetHandled ()
	Marks that the enabler has been handled.

Protected Attributes inherited from owl::TCommandEnabler
uint	Flags
	TCommandStatus flags Is TCommandStatus::WasHandled if the command enabler has been handled.

	DECLARE_CASTABLE

Detailed Description

TTooltipEnabler is the object forwarded along the command-chain to retrieve the tip text of a tool.

The object is not a 'true' command enabler [i.e. invoking SetCheck or Enable do not modify the state of the command associated with the tool]; however, by using the 'CommandEnabler' setup retrieving the text of tools, the potential of the commands are given first crack at customizing the text.

Definition at line 149 of file tooltip.h.

Constructor & Destructor Documentation

◆ TTooltipEnabler()

owl::TTooltipEnabler::TTooltipEnabler	(	TTooltipText &	tt,
		HWND	hReceiver )

Constructs enabler object to be sent to a window so that the latter can provide the text of the specified tool.

Definition at line 348 of file tooltip.cpp.

References owl::TCommandEnabler::Flags, and owl::TCommandEnabler::NonSender.

Member Function Documentation

◆ SetCheck()

void owl::TTooltipEnabler::SetCheck ( int check )

virtual

SetCheck does nothing but serve as a place-holder function.

Implements owl::TCommandEnabler.

Definition at line 375 of file tooltip.cpp.

◆ SetText() [1/2]

void owl::TTooltipEnabler::SetText ( const tstring & text )

inline

Definition at line 158 of file tooltip.h.

References SetText().

◆ SetText() [2/2]

void owl::TTooltipEnabler::SetText ( LPCTSTR text )

virtual

Sets the text of the tool specified by the TTooltipEnabler object.

Note: The text is copied to the internal buffer in the TTooltipText structure. This buffer can only handle 80 characters including the null-terminator. Longer strings will be truncated.

Implements owl::TCommandEnabler.

Definition at line 365 of file tooltip.cpp.

References owl::TTooltipText::CopyText(), and owl::TCommandEnabler::Enable().

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

include/owl/tooltip.h
source/owlcore/tooltip.cpp

Public Member Functions