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

#include <ToolboxTask.h>

Inheritance diagram for ToolboxTask:
WimpObj ToolboxCoreObj Object ErrorReport ToolboxEvents Object ErrorReport

Public Member Functions

 ToolboxTask ()
 ~ToolboxTask ()
void eToolboxEvent ()
int initTask (char *resourcePath)
void showProperties ()
char * getClassName ()
int getClassType ()
Public Member Functions inherited from WimpObj
 WimpObj ()
 ~WimpObj ()
unsigned int init ()
void closeDown ()
unsigned int pollIdle ()
unsigned int poll ()
int runIdle ()
int run ()
void setTaskname (char *)
void setMask (unsigned int)
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 preCloseDown ()
virtual void unknownWimpEvent ()
virtual int errorHandler ()
void showProperties ()
char * getClassName ()
int getClassType ()
Public Member Functions inherited from Object
 Object ()
 ~Object ()
Public Member Functions inherited from ErrorReport
 ErrorReport ()
 ~ErrorReport ()
Public Member Functions inherited from ToolboxCoreObj
virtual void eToolboxEventHandler (void *pollBlock)
virtual void toolboxError ()
Public Member Functions inherited from ToolboxEvents
virtual void colourDboxObjectAutoCreated ()
virtual void colourMenuObjectAutoCreated ()
virtual void dcsObjectAutoCreated ()
virtual void fileInfoObjectAutoCreated ()
virtual void fontDboxObjectAutoCreated ()
virtual void fontMenuObjectAutoCreated ()
virtual void iconbarObjectAutoCreated ()
virtual void menuObjectAutoCreated ()
virtual void printDboxObjectAutoCreated ()
virtual void progInfoObjectAutoCreated ()
virtual void quitObjectAutoCreated ()
virtual void saveAsObjectAutoCreated ()
virtual void scaleObjectAutoCreated ()
virtual void windowObjectAutoCreated ()
virtual void unknownClassObjectAutoCreated ()
virtual void toolboxObjectAutoCreated (int objClass)
virtual void toolboxObjectDeleted ()
virtual void toolboxUserEvent ()
virtual void colourDboxAboutToBeShown ()
virtual void colourDboxDialogueCompleted ()
virtual void colourDboxColourSelected ()
virtual void colourMenuAboutToBeShown ()
virtual void colourMenuHasBeenHidden ()
virtual void colourMenuSelection ()
virtual void dcsAboutToBeShown ()
virtual void dcsDiscard ()
virtual void dcsSave ()
virtual void dcsDialogueCompleted ()
virtual void dcsCancel ()
virtual void fileInfoAboutToBeShown ()
virtual void fileInfoDialogueCompleted ()
virtual void fontDboxAboutToBeShown ()
virtual void fontDboxDialogueCompleted ()
virtual void fontDboxApplyFont ()
virtual void fontMenuAboutToBeShown ()
virtual void fontMenuHasBeenHidden ()
virtual void fontMenuFontSelection ()
virtual void iconbarClicked ()
virtual void iconbarSelectAboutToBeShown ()
virtual void iconbarAdjustAboutToBeShown ()
virtual void menuAboutToBeShown ()
virtual void menuHasBeenHidden ()
virtual void menuSubMenu ()
virtual void menuSelection ()
virtual void printDboxAboutToBeShown ()
virtual void printDboxDialogueCompleted ()
virtual void printDboxSetUpAboutToBeShown ()
virtual void printDboxSave ()
virtual void printDboxSetUp ()
virtual void printDboxPrint ()
virtual void progInfoAboutToBeShown ()
virtual void progInfoDialogueCompleted ()
virtual void quitAboutToBeShown ()
virtual void quitQuit ()
virtual void quitDialogueCompleted ()
virtual void quitCancel ()
virtual void saveAsAboutToBeShown ()
virtual void saveAsDialogueCompleted ()
virtual void saveAsSaveToFile ()
virtual void saveAsFillBuffer ()
virtual void saveAsSaveCompleted ()
virtual void scaleAboutToBeShown ()
virtual void scaleDialogueCompleted ()
virtual void scaleApplyFactor ()
virtual void windowAboutToBeShown ()
virtual void windowHasBeenHidden ()
virtual void actionButtonSelected ()
virtual void adjusterClicked ()
virtual void draggableDragStarted ()
virtual void draggableDragEnded ()
virtual void numberRangeValueChanged ()
virtual void optionButtonStateChanged ()
virtual void popUpAboutToBeShown ()
virtual void radioButtonStateChanged ()
virtual void sliderValueChanged ()
virtual void stringSetValueChanged ()
virtual void stringSetAboutToBeShown ()
virtual void writableFieldValueChanged ()
virtual void scrollListSelection ()
virtual void treeViewNodeSelected ()
virtual void treeViewNodeExpanded ()
virtual void treeViewNodeRenamed ()
virtual void treeViewNodeClicked ()
virtual void treeViewNodeDragged ()
virtual void treeViewScroll ()
virtual void tabsSelection ()
virtual void toolActionSelection ()
virtual void reservedToolboxInterApplicationProtocol ()
virtual void reservedToolboxModuleEvent ()
virtual void unknownToolboxEvent ()
virtual void toolboxEventHandler (int event)=0

Additional Inherited Members

Public Types inherited from WimpObj
typedef struct WimpObj::WindDefStr WindDefStr
Public Types inherited from ErrorReport
enum  errorEnv { CONSOLE , WIMP }
Public Types inherited from ToolboxEvents
enum  Toolbox_Event {
  Error = 0x44ec0 , ObjectAutoCreated , ObjectDeleted , WindowAboutToBeShown = 0x82880 ,
  ActionButtonSelected , OptionButtonStateChanged , RadioButtonStateChanged , WritableFieldValueChanged = 0x82885 ,
  SliderValueChanged , DraggableDragStarted , DraggableDragEnded , PopUpAboutToBeShown = 0x8288b ,
  AdjusterClicked , NumberRangeValueChanged , StringSetValueChanged , StringSetAboutToBeShown ,
  WindowHasBeenHidden , MenuAboutToBeShown = 0x828c0 , MenuHasBeenHidden , MenuSubMenu ,
  MenuSelection , IconbarClicked = 0x82900 , IconbarSelectAboutToBeShown , IconbarAdjustAboutToBeShown ,
  ColourMenuAboutToBeShown = 0x82980 , ColourMenuHasBeenHidden , ColourMenuSelection , ColourDboxAboutToBeShown = 0x829c0 ,
  ColourDboxDialogueCompleted , ColourDboxColourSelected , FontDboxAboutToBeShown = 0x82a00 , FontDboxDialogueCompleted ,
  FontDboxApplyFont , FontMenuAboutToBeShown = 0x82a40 , FontMenuHasBeenHidden , FontMenuFontSelection ,
  DCSAboutToBeShown = 0x82a80 , DCSDiscard , DCSSave , DCSDialogueCompleted ,
  DCSCancel , QuitAboutToBeShown = 0x82a90 , QuitQuit , QuitDialogueCompleted ,
  QuitCancel , FileInfoAboutToBeShown = 0x82ac0 , FileInfoDialogueCompleted , PrintDboxAboutToBeShown = 0x82b00 ,
  PrintDboxDialogueCompleted , PrintDboxSetUpAboutToBeShown , PrintDboxSave , PrintDboxSetUp ,
  PrintDboxPrint , ProgInfoAboutToBeShown = 0x82b40 , ProgInfoDialogueCompleted , SaveAsAboutToBeShown = 0x82bc0 ,
  SaveAsDialogueCompleted , SaveAsSaveToFile , SaveAsFillBuffer , SaveAsSaveCompleted ,
  ScaleAboutToBeShown = 0x82c00 , ScaleDialogueCompleted , ScaleApplyFactor , ToolActionSelection = 0x140140 ,
  ScrollListSelection = 0x140181 , TreeViewNodeSelected = 0x140280 , TreeViewNodeExpanded , TreeViewNodeRenamed ,
  TreeViewNodeClicked , TreeViewNodeDragged , TreeViewScroll , TabsSelection = 0x1402c0
}
enum  Toolbox_ObjectClass {
  WindowObjectClass = 0x82880 , MenuObjectClass = 0x828c0 , IconbarObjectClass = 0x82900 , ColourMenuObjectClass = 0x82980 ,
  ColourDboxObjectClass = 0x829c0 , FontDboxObjectClass = 0x82a00 , FontMenuObjectClass = 0x82a40 , DCSObjectClass = 0x82a80 ,
  QuitObjectClass = 0x82a90 , FileInfoObjectClass = 0x82ac0 , PrintDboxObjectClass = 0x82b00 , ProgInfoObjectClass = 0x82b40 ,
  SaveAsObjectClass = 0x82bc0 , ScaleObjectClass = 0x82c00
}
Static Public Member Functions inherited from WimpObj
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 Member Functions inherited from ToolboxCoreObj
static void getSysInfo (unsigned int reason_code, _kernel_swi_regs *regs)
static ObjectId createObject (unsigned int flags, void *name_or_template)
static void deleteObject (unsigned int flags, ObjectId id)
static void showObject (unsigned int flags, ObjectId id, int show_type, void *type, ObjectId parent, ComponentId parent_component)
static void hideObject (unsigned int flags, ObjectId id)
static unsigned int getObjectState (unsigned int flags, ObjectId id, unsigned int *state)
static void setClientHandle (unsigned int flags, ObjectId id, void *client_handle)
static unsigned int getClientHandle (unsigned int flags, ObjectId id, void *client_handle)
static ObjectClass getObjectClass (unsigned int flags, ObjectId id)
static ObjectClass getObjectClass (unsigned int flags, ObjectId id, ObjectClass *object_class)
static void getParent (unsigned int flags, ObjectId id, ObjectId *parent, ComponentId *parent_component)
static void getAncestor (unsigned int flags, ObjectId id, ObjectId *parent, ComponentId *ancestor_component)
static void raiseToolboxEvent (unsigned int flags, ObjectId id, ComponentId component, ToolboxEvent *event)
static void toolboxLoadResources (unsigned int flags, char *resources)
static void * templateLookup (unsigned int flags, char *name)
static int init (unsigned int flags, int *wimpMessages, int *toolboxEvents, char *directory, MessagesFD *mfd, IdBlock *idb)
static int getWimpVersion ()
static void setWimpVersion (int version)
static int getTaskHandle ()
static void * getSpriteAreaPtr ()
static void getPointerInfo (unsigned int flags, int &x_pos, int &y_pos, int &buttons, ObjectId &window, ComponentId &component)
Static Public Attributes inherited from WimpObj
static int quit = 0
Static Public Attributes inherited from ToolboxCoreObj
static IdBlock idBlock
static int wimpMessages = 0
static int toolboxEvents = 0
static MessagesFD mfd
static WimpPollBlock pollBlock
static int eventCode

Detailed Description

ToolboxTask

Library ToolboxC++Lib

Class which to needs to be extended when creating a Toolbox application. By extending this class Wimp and Toolbox events which are inherited from WimpObj and ToolboxCoreObj may be overloaded and handled by the overloaded member functions.

Constructor & Destructor Documentation

◆ ToolboxTask()

ToolboxTask::ToolboxTask ( )
inline

◆ ~ToolboxTask()

ToolboxTask::~ToolboxTask ( )
inline

Member Function Documentation

◆ eToolboxEvent()

void ToolboxTask::eToolboxEvent ( )
virtual

Reimplemented from WimpObj.

◆ getClassName()

char * ToolboxTask::getClassName ( )
inlinevirtual

Returns the classname of the object Returns a pointer to a zero terminated character field containing "ToolboxTask"

Implements Object.

◆ getClassType()

int ToolboxTask::getClassType ( )
inlinevirtual

Returns an integer representing a value for an object of class BitField Value returned is ClassType_ToolboxTask

Implements Object.

◆ initTask()

int ToolboxTask::initTask ( char * resourcePath)

Initialisation of where the applications resources are stored

Parameters
[in]*resourcePathpointer to a character string with the name of a directory where resources are stored.

◆ showProperties()

void ToolboxTask::showProperties ( )
inlinevirtual

Currently unused

Implements Object.

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