owl::TWaitCursor Class Reference

TWaitCursor is a simple class used to display a wait cursor. More...

#include <owl/applicat.h>

Public Member Functions
	TWaitCursor ()
	Activates the wait cursor.
	TWaitCursor (const tstring &msg)
	Activates the wait cursor and sends msg to the applications TMessageBar::SetHintText function if it has one.
	TWaitCursor (TCursor *cursor, TAutoDelete=AutoDelete)
	Activates cursor.
	~TWaitCursor ()
	Restores the previous cursor.
void	Restore ()
	Restores old state of cursor.
void	SetCursor (TCursor *cursor, TAutoDelete=AutoDelete)
	Changes the cursor to cursor.
void	Message (const tstring &text)
	Sends text to the applications TMessageBar::SetHintText function if it has one.

Friends
class	TWaitHook

Detailed Description

TWaitCursor is a simple class used to display a wait cursor.

Wait cursors are typically created on the stack so that the prevous cursor is displayed when the wait cursor goes out of scope.

Wait cursors can be nested, but there destruction sequence must be opposite to their construction sequence. Typical Use

...
 {
  TWaitCursor wc;  // Wait cursor displayed.
  ...
  ...
 }
 // Wait cursor out of scope so previous cursor restored.

Definition at line 89 of file applicat.h.

Constructor & Destructor Documentation

TWaitCursor() [1/3]

owl::TWaitCursor::TWaitCursor ( )

inline

Activates the wait cursor.

Definition at line 565 of file applicat.h.

TWaitCursor() [2/3]

owl::TWaitCursor::TWaitCursor ( const tstring & msg )

inline

Activates the wait cursor and sends msg to the applications TMessageBar::SetHintText function if it has one.

Definition at line 573 of file applicat.h.

References Message().

TWaitCursor() [3/3]

owl::TWaitCursor::TWaitCursor ( TCursor * cursor, TAutoDelete del = AutoDelete )

inline

Activates cursor.

If TAutoDelete is set to AutoDelete the cursor resource is deleted when the wait cursor is destoryed.

Definition at line 582 of file applicat.h.

References SetCursor().

~TWaitCursor()

owl::TWaitCursor::~TWaitCursor

(

)

Restores the previous cursor.

Definition at line 1960 of file applicat.cpp.

References _T, LOCKENUMINFO, and WARN.

Member Function Documentation

Message()

void owl::TWaitCursor::Message

(

const tstring &

text

)

Sends text to the applications TMessageBar::SetHintText function if it has one.

Definition at line 1993 of file applicat.cpp.

References owl::TWindow::ChildWithId(), owl::TAppDictionary::GetApplication(), owl::IDW_STATUSBAR, LOCKENUMINFO, owl::OWLGetAppDictionary(), and TYPESAFE_DOWNCAST.

Restore()

void owl::TWaitCursor::Restore

(

)

Restores old state of cursor.

Definition at line 1980 of file applicat.cpp.

References LOCKENUMINFO.

SetCursor()

void owl::TWaitCursor::SetCursor	(	TCursor *	cursor,
		TAutoDelete	del = AutoDelete )

Changes the cursor to cursor.

If TAutoDelete is set to AutoDelete the cursor resource is deleted when the wait cursor is destoryed.

Definition at line 1933 of file applicat.cpp.

References LOCKENUMINFO.

Friends And Related Symbol Documentation

TWaitHook

friend class TWaitHook

friend

Definition at line 105 of file applicat.h.

---

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

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