Definition at line 13 of file task.h.
◆ AcknowledgeMessage() [1/2]
Acknowledges a message
- Parameters
-
rumbMessageBlock | The message block to acknowledge. Note that this block is corrupted. |
Definition at line 125 of file task.cpp.
◆ AcknowledgeMessage() [2/2]
void rov2::CTask::AcknowledgeMessage |
( |
const eWimpMessageAction |
kwmaUserAction, |
|
|
tUserMessageBlock & |
rumbMessageBlock |
|
) |
| |
Acknowledges a message
- Parameters
-
kwmaUserAction | The user action to reply with |
rumbMessageBlock | The message block to acknowledge. Note that this block is corrupted. |
Definition at line 132 of file task.cpp.
◆ CurrentTask()
static CTask* rov2::CTask::CurrentTask |
( |
| ) |
|
|
inlinestatic |
Gets the current task
- Returns
- The current task
Definition at line 70 of file task.h.
◆ DeregisterWindow()
void rov2::CTask::DeregisterWindow |
( |
const CWindow * |
kpwWindow | ) |
|
Deregister a window
- Parameters
-
kpwWindow | Pointer to the window |
Definition at line 146 of file task.cpp.
◆ FindWindow()
const CWindow * rov2::CTask::FindWindow |
( |
const tWindowHandle |
kwhWindow | ) |
|
Finds a window based on the window handle
- Parameters
-
kwhWindow | The window handle to look for |
- Returns
- The window that the handle refers to, or NULL if it cannot be found
Definition at line 152 of file task.cpp.
◆ OpenMenu()
void rov2::CTask::OpenMenu |
( |
CMenu * |
kpmMenu, |
|
|
tLocation & |
rlLocation |
|
) |
| |
Set the current menu
- Parameters
-
kpmMenu | The menu which needs to be opened |
rlLocation | The location at which it needs to be opened |
Definition at line 166 of file task.cpp.
◆ Poll()
void rov2::CTask::Poll |
( |
| ) |
|
Enters the main poll loop
Definition at line 35 of file task.cpp.
◆ PollEvent()
bool rov2::CTask::PollEvent |
( |
eWimpEvent |
weEventCode, |
|
|
tWimpBlock & |
rwbWimpBlock |
|
) |
| |
|
virtual |
Called whenever a Wimp_Poll event has occurred
- Parameters
-
weEventCode | The event code |
rwbWimpBlock | The WIMP poll result block |
- Returns
- True if the event was handled
Definition at line 50 of file task.cpp.
◆ PreQuit()
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.
◆ RegisterWindow()
void rov2::CTask::RegisterWindow |
( |
const CWindow * |
kpwWindow | ) |
|
Register a window
- Parameters
-
kpwWindow | Pointer to the window |
Definition at line 140 of file task.cpp.
◆ Stop()
void rov2::CTask::Stop |
( |
| ) |
|
|
inline |
Stops the current poll loop
Definition at line 23 of file task.h.
◆ TaskHandle()
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: