ROVLib2
RISCOSC++applicationdevelopmentlibrary
Public Member Functions | Static Public Member Functions | List of all members
rov2::CTask Class Reference
Inheritance diagram for rov2::CTask:
Inheritance graph
[legend]
Collaboration diagram for rov2::CTask:
Collaboration graph
[legend]

Public Member Functions

 CTask (const std::string &rksTaskName)
 
void Poll ()
 
void Stop ()
 
virtual bool PollEvent (eWimpEvent weEventCode, tWimpBlock &rwbWimpBlock)
 
virtual bool PreQuit ()
 
const tTaskHandle TaskHandle ()
 
void RegisterWindow (const CWindow *kpwWindow)
 
void DeregisterWindow (const CWindow *kpwWindow)
 
const CWindowFindWindow (const tWindowHandle kwhWindow)
 
void AcknowledgeMessage (tUserMessageBlock &rumbMessageBlock)
 
void AcknowledgeMessage (const eWimpMessageAction kwmaUserAction, tUserMessageBlock &rumbMessageBlock)
 
void OpenMenu (CMenu *kpmMenu, tLocation &rlLocation)
 
- Public Member Functions inherited from rov2::CUnassignable
 CUnassignable (const CUnassignable &)=delete
 
CUnassignableoperator= (const CUnassignable &)=delete
 
 CUnassignable ()
 

Static Public Member Functions

static CTaskCurrentTask ()
 

Detailed Description

Definition at line 13 of file task.h.

Member Function Documentation

void rov2::CTask::AcknowledgeMessage ( tUserMessageBlock rumbMessageBlock)

Acknowledges a message

Parameters
rumbMessageBlockThe message block to acknowledge. Note that this block is corrupted.

Definition at line 120 of file task.cpp.

void rov2::CTask::AcknowledgeMessage ( const eWimpMessageAction  kwmaUserAction,
tUserMessageBlock rumbMessageBlock 
)

Acknowledges a message

Parameters
kwmaUserActionThe user action to reply with
rumbMessageBlockThe message block to acknowledge. Note that this block is corrupted.

Definition at line 127 of file task.cpp.

static CTask* rov2::CTask::CurrentTask ( )
inlinestatic

Gets the current task

Returns
The current task

Definition at line 70 of file task.h.

void rov2::CTask::DeregisterWindow ( const CWindow kpwWindow)

Deregister a window

Parameters
kpwWindowPointer to the window

Definition at line 141 of file task.cpp.

const CWindow * rov2::CTask::FindWindow ( const tWindowHandle  kwhWindow)

Finds a window based on the window handle

Parameters
kwhWindowThe window handle to look for
Returns
The window that the handle refers to, or NULL if it cannot be found

Definition at line 147 of file task.cpp.

void rov2::CTask::OpenMenu ( CMenu kpmMenu,
tLocation rlLocation 
)

Set the current menu

Parameters
kpmMenuThe menu which needs to be opened
rlLocationThe location at which it needs to be opened

Definition at line 161 of file task.cpp.

void rov2::CTask::Poll ( )

Enters the main poll loop

Definition at line 35 of file task.cpp.

bool rov2::CTask::PollEvent ( eWimpEvent  weEventCode,
tWimpBlock rwbWimpBlock 
)
virtual

Called whenever a Wimp_Poll event has occurred

Parameters
weEventCodeThe event code
rwbWimpBlockThe WIMP poll result block
Returns
True if the event was handled

Definition at line 45 of file task.cpp.

virtual bool rov2::CTask::PreQuit ( )
inlinevirtual

Called whenever the desktop is going to shut down. Return false to abort the shutdown

Definition at line 33 of file task.h.

void rov2::CTask::RegisterWindow ( const CWindow kpwWindow)

Register a window

Parameters
kpwWindowPointer to the window

Definition at line 135 of file task.cpp.

void rov2::CTask::Stop ( )
inline

Stops the current poll loop

Definition at line 23 of file task.h.

const tTaskHandle rov2::CTask::TaskHandle ( )
inline

Gets the current task handle

Returns
The current task handle

Definition at line 38 of file task.h.


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