CommonC++Lib RiscOSC++Lib ToolboxC++Lib
Toolbox Library for use with the RiscOS DDE C++/CFront compiler
Loading...
Searching...
No Matches
WimpObj Class Reference

#include <WimpObj.h>

Inheritance diagram for WimpObj:
Object ErrorReport ToolboxTask

Classes

struct  WindDefStr

Public Types

typedef struct WimpObj::WindDefStr WindDefStr
Public Types inherited from ErrorReport
enum  errorEnv { CONSOLE , WIMP }

Public Member Functions

 WimpObj ()
 ~WimpObj ()
unsigned int init ()
void closeDown ()
unsigned int pollIdle ()
unsigned int poll ()
int runIdle ()
int run ()
void setTaskname (char *taskname)
void setMask (unsigned int mask)
void addMessages (int *)
void removeMessages (int *)
virtual void nullReason ()
virtual void redrawWindowRequest ()
virtual void openWindowRequest ()
virtual void closeWindowRequest ()
virtual void pointerLeavingWindow ()
virtual void pointerEnteringWindow ()
virtual void mouseClick ()
virtual void userDragBox ()
virtual void keyPressed ()
virtual void menuSelection ()
virtual void scrollRequest ()
virtual void loseCaret ()
virtual void gainCaret ()
virtual void pollWordNonZero ()
virtual void userMessage ()
virtual void userMessageRecorded ()
virtual void userMessageAcknowledge ()
virtual void eToolboxEvent ()
virtual void preCloseDown ()
virtual void unknownWimpEvent ()
virtual int errorHandler ()
void showProperties ()
char * getClassName ()
int getClassType ()
Public Member Functions inherited from Object
 Object ()
Public Member Functions inherited from ErrorReport
 ErrorReport ()
 ~ErrorReport ()

Static Public Member Functions

static unsigned int * getPollBlock ()
static void setHandle (unsigned int)
static unsigned int getHandle ()
static unsigned int getEvent ()
static void setPollIdleInterval (unsigned int)
static unsigned int getPollIdleInterval ()
static void setPollWord (int *)
static int * getPollWord ()
static unsigned int * getWorkspace ()
static void redrawIconBar ()
static void redrawScreen ()
static void openWindow ()
static void closeWindow ()
static WimpRedrawWindowBlock * updateWindow (WimpRedrawWindowBlock *)
static void closeWindow (int)
static void openTemplate (char *)
static void closeTemplate ()
Static Public Member Functions inherited from ErrorReport
static void setLastError (_kernel_oserror *, unsigned int)
static void setLastError (_kernel_oserror *, unsigned int, char *location)
static _kernel_oserror * getLastError ()
static void setErrFlags (unsigned int)
static unsigned int getErrFlags ()
static void setAsWimpTask (char *)
static void setAsConsoleTask ()
static void setLocation (char *)
static char * getLocation ()
static char * getTaskName ()
static void clearError ()
static int getEnvironment ()
static void setTrap (int, int *)
static void clearTrap ()

Static Public Attributes

static int quit = 0

Additional Inherited Members

Protected Member Functions inherited from Object
 ~Object ()

Detailed Description

WimpObj

RiscOSC++Lib

Class which underlays all Wimp applications which uses this library. Has all the member functions which can be overloaded to handle Wimp events. The class also has within it member functions which call WimpPoll from which events are dispatched to the overloaded event member functions.

Member Typedef Documentation

◆ WindDefStr

typedef struct WimpObj::WindDefStr WimpObj::WindDefStr

Constructor & Destructor Documentation

◆ WimpObj()

WimpObj::WimpObj ( )

◆ ~WimpObj()

WimpObj::~WimpObj ( )

Member Function Documentation

◆ addMessages()

void WimpObj::addMessages ( int * messages)

◆ closeDown()

void WimpObj::closeDown ( )

Call to remove the Wimp task, the handle to use is taken from the private member variable.

◆ closeTemplate()

void WimpObj::closeTemplate ( )
static

◆ closeWindow() [1/2]

void WimpObj::closeWindow ( )
static

◆ closeWindow() [2/2]

void WimpObj::closeWindow ( int handle)
static

◆ closeWindowRequest()

virtual void WimpObj::closeWindowRequest ( )
inlinevirtual

◆ errorHandler()

int WimpObj::errorHandler ( )
virtual

◆ eToolboxEvent()

virtual void WimpObj::eToolboxEvent ( )
inlinevirtual

Reimplemented in ToolboxTask.

◆ gainCaret()

virtual void WimpObj::gainCaret ( )
inlinevirtual

◆ getClassName()

char * WimpObj::getClassName ( )
inlinevirtual

Implements Object.

◆ getClassType()

int WimpObj::getClassType ( )
inlinevirtual

Implements Object.

◆ getEvent()

unsigned int WimpObj::getEvent ( )
static

◆ getHandle()

unsigned int WimpObj::getHandle ( )
static

◆ getPollBlock()

unsigned int * WimpObj::getPollBlock ( )
static

◆ getPollIdleInterval()

unsigned int WimpObj::getPollIdleInterval ( )
static

◆ getPollWord()

int * WimpObj::getPollWord ( )
static

◆ getWorkspace()

unsigned int * WimpObj::getWorkspace ( )
static

◆ init()

unsigned int WimpObj::init ( )

Used to initialise the Wimp, returns the task handle. The returned task handle is also stored in a private member variable of an object of WimpObj. Not needed to be called if the application uses the Toolbox.

◆ keyPressed()

virtual void WimpObj::keyPressed ( )
inlinevirtual

◆ loseCaret()

virtual void WimpObj::loseCaret ( )
inlinevirtual

◆ menuSelection()

virtual void WimpObj::menuSelection ( )
inlinevirtual

◆ mouseClick()

virtual void WimpObj::mouseClick ( )
inlinevirtual

◆ nullReason()

virtual void WimpObj::nullReason ( )
inlinevirtual

◆ openTemplate()

void WimpObj::openTemplate ( char * filename)
static

◆ openWindow()

void WimpObj::openWindow ( )
static

◆ openWindowRequest()

virtual void WimpObj::openWindowRequest ( )
inlinevirtual

◆ pointerEnteringWindow()

virtual void WimpObj::pointerEnteringWindow ( )
inlinevirtual

◆ pointerLeavingWindow()

virtual void WimpObj::pointerLeavingWindow ( )
inlinevirtual

◆ poll()

unsigned int WimpObj::poll ( )

Enters a Wimp Poll routine, returning an event number, no dispatch to any overloaded event handlers being made.

◆ pollIdle()

unsigned int WimpObj::pollIdle ( )

Enters a Wimp Poll routine, returning an event number on an idle poll, no dispatch to any overloaded event handlers being made.

◆ pollWordNonZero()

virtual void WimpObj::pollWordNonZero ( )
inlinevirtual

◆ preCloseDown()

virtual void WimpObj::preCloseDown ( )
inlinevirtual

◆ redrawIconBar()

void WimpObj::redrawIconBar ( )
static

◆ redrawScreen()

void WimpObj::redrawScreen ( )
static

◆ redrawWindowRequest()

virtual void WimpObj::redrawWindowRequest ( )
inlinevirtual

◆ removeMessages()

void WimpObj::removeMessages ( int * messages)

◆ run()

int WimpObj::run ( )

Enters a Wimp Poll routine, returning an event number on an poll, dispatches to overloaded event handlers are made.

◆ runIdle()

int WimpObj::runIdle ( )

Enters a Wimp Poll routine, returning an event number on an idle poll, dispatches to overloaded event handlers are made.

◆ scrollRequest()

virtual void WimpObj::scrollRequest ( )
inlinevirtual

◆ setHandle()

void WimpObj::setHandle ( unsigned int handle)
static

◆ setMask()

void WimpObj::setMask ( unsigned int mask)

Sets the tasks poll mask.

Parameters
[in]maskUsed.

◆ setPollIdleInterval()

void WimpObj::setPollIdleInterval ( unsigned int idleInterval)
static

◆ setPollWord()

void WimpObj::setPollWord ( int * pollWord)
static

◆ setTaskname()

void WimpObj::setTaskname ( char * taskname)

Sets the tasks name.

Parameters
[in]*tasknamepointer to a zero terminated array of characters holding the name of the task.

◆ showProperties()

void WimpObj::showProperties ( )
inlinevirtual

Implements Object.

◆ unknownWimpEvent()

virtual void WimpObj::unknownWimpEvent ( )
inlinevirtual

◆ updateWindow()

WimpRedrawWindowBlock * WimpObj::updateWindow ( WimpRedrawWindowBlock * block)
static

◆ userDragBox()

virtual void WimpObj::userDragBox ( )
inlinevirtual

◆ userMessage()

virtual void WimpObj::userMessage ( )
inlinevirtual

◆ userMessageAcknowledge()

virtual void WimpObj::userMessageAcknowledge ( )
inlinevirtual

◆ userMessageRecorded()

virtual void WimpObj::userMessageRecorded ( )
inlinevirtual

Member Data Documentation

◆ quit

int WimpObj::quit = 0
static
The documentation for this class was generated from the following files: