AbiWord: UT_Worker Class Reference

#include <ut_worker.h>

Inheritance diagram for UT_Worker:

List of all members.

Public Member Functions
virtual	~UT_Worker ()
virtual void	stop (void)=0
virtual void	start (void)=0
	suspend events
virtual void	fire (void)
	resume events
UT_WorkerCallback	getCallback () const
	fire off an event
void *	getInstanceData () const
Protected Member Functions
	UT_Worker ()
	UT_Worker (UT_WorkerCallback cb, void *data)
void	_setCallback (UT_WorkerCallback cb)
void	_setInstanceData (void *data)
Private Member Functions
	UT_Worker (UT_Worker &)
Private Attributes
void *	m_pInstanceData
UT_WorkerCallback	m_pCallback

Detailed Description

This class is a generic "worker" class which will serve as a base-class for UT_Timers and UT_Idles

Constructor & Destructor Documentation

UT_Worker::~UT_Worker ( ) [virtual]

Public virtual destructor

UT_Worker::UT_Worker ( ) [protected]

Protected constructor for this base-class

UT_Worker::UT_Worker	(	UT_WorkerCallback	cb,
		void *	data
	)			`[protected]`

Protected constructor for this base-class, accepts instance data and callback

UT_Worker::UT_Worker ( UT_Worker & ) [private]

Member Function Documentation

void UT_Worker::_setCallback ( UT_WorkerCallback cb ) [protected]

Sets the worker's callback function to

Parameters:

cb

References m_pCallback.

Referenced by UT_Timer::setCallback().

void UT_Worker::_setInstanceData ( void * data ) [protected]

Sets the worker's instance data to

Parameters:

data

References m_pInstanceData.

Referenced by UT_Timer::setInstanceData().

void UT_Worker::fire ( void ) [virtual]

resume events

Fires off the event with the proper callback data

References m_pCallback, and UT_ASSERT.

Referenced by UT_Win32Idle::_fireall(), _Timer_Proc(), FV_View::endDrag(), and Global_Win32TimerProc().

UT_WorkerCallback UT_Worker::getCallback ( ) const

fire off an event

Gets the worker's callback function

References m_pCallback.

void * UT_Worker::getInstanceData ( ) const

Gets the worker's instance data

References m_pInstanceData.

Referenced by FV_VisualDragText::_actuallyScroll(), FV_View::_actuallyScroll(), FV_VisualInlineImage::_actuallyScroll(), FV_FrameEdit::_actuallyScroll(), FV_VisualDragText::_autoScroll(), FV_View::_autoScroll(), FV_VisualInlineImage::_autoScroll(), FV_FrameEdit::_autoScroll(), AP_TopRuler::_autoScroll(), fl_DocSectionLayout::_HdrFtrChangeCallback(), FL_DocLayout::_redrawUpdate(), _sFrequentRepeat(), autoSaveCallback(), AP_Dialog_Stylist::autoUpdate(), AP_Dialog_FormatTOC::autoUpdate(), AP_Win32Dialog_Lists::autoupdateLists(), AP_UnixDialog_Lists::autoupdateLists(), AP_CocoaDialog_Lists::autoupdateLists, AP_Dialog_SplitCells::autoUpdateMC(), AP_Dialog_MergeCells::autoUpdateMC(), AP_Dialog_FormatTable::autoUpdateMC(), AP_Dialog_FormatFrame::autoUpdateMC(), AP_Dialog_Border_Shading::autoUpdateMC(), AP_Win32Dialog_WordCount::autoupdateWC(), AP_UnixDialog_WordCount::autoupdateWC(), AP_CocoaDialog_WordCount::autoupdateWC, GR_Caret::s_enable(), GR_Caret::s_work(), and XAP_FrameImpl::viewAutoUpdater().

virtual void UT_Worker::start ( void ) [pure virtual]

suspend events

Implemented in UT_UnixIdle, UT_UNIXTimer, UT_Win32Idle, UT_Win32Timer, UT_Idle, and UT_Timer.

Referenced by FV_VisualDragText::_autoScroll(), FV_View::_autoScroll(), FV_VisualInlineImage::_autoScroll(), FV_FrameEdit::_autoScroll(), Defun(), Defun1(), and fl_DocSectionLayout::setHdrFtrHeightChange().

virtual void UT_Worker::stop ( void ) [pure virtual]

Implemented in UT_UnixIdle, UT_UNIXTimer, UT_Win32Idle, UT_Win32Timer, UT_Idle, and UT_Timer.

Referenced by FV_VisualDragText::_actuallyScroll(), FV_View::_actuallyScroll(), FV_VisualInlineImage::_actuallyScroll(), FV_FrameEdit::_actuallyScroll(), fl_DocSectionLayout::_HdrFtrChangeCallback(), _sFrequentRepeat(), FL_DocLayout::~FL_DocLayout(), and fl_DocSectionLayout::~fl_DocSectionLayout().

Member Data Documentation

UT_WorkerCallback UT_Worker::m_pCallback [private]

Referenced by _setCallback(), fire(), and getCallback().

void* UT_Worker::m_pInstanceData [private]

Referenced by _setInstanceData(), and getInstanceData().

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