#include <ToolboxCoreObj.h>

Inheritance diagram for ToolboxCoreObj:

Public Member Functions
virtual void	eToolboxEventHandler (void *pollBlock)
virtual void	toolboxError ()
char *	getClassName ()
int	getClassType ()
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
Public Member Functions inherited from Object
	Object ()
	~Object ()
virtual void	showProperties ()=0
Public Member Functions inherited from ErrorReport
	ErrorReport ()
	~ErrorReport ()

Static Public Member Functions
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 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 IdBlock	idBlock
static int	wimpMessages = 0
static int	toolboxEvents = 0
static MessagesFD	mfd
static WimpPollBlock	pollBlock
static int	eventCode

Additional Inherited Members
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 }
Public Types inherited from ErrorReport
enum	errorEnv { CONSOLE , WIMP }

Detailed Description

ToolboxCoreObj

Library ToolboxC++Lib

Class which defines a number of static member variables holding important values for a Toolbox/Wimp task. It also defines a number of static methods not linked to any particular Toolbox window type or gadget. All the Toolbox event methods which can be overloaded by a users Toolbox application are defined in this class. This class is extended by ToolboxTask, it is ToolboxTask which needs to be exended by users application.

Member Function Documentation

◆ createObject()

ObjectId ToolboxCoreObj::createObject	(	unsigned int	flags,
		void *	name_or_template )

static

◆ deleteObject()

void ToolboxCoreObj::deleteObject	(	unsigned int	flags,
		ObjectId	id )

static

◆ eToolboxEventHandler()

void ToolboxCoreObj::eToolboxEventHandler ( void * pollBlock )

virtual

◆ getAncestor()

void ToolboxCoreObj::getAncestor	(	unsigned int	flags,
		ObjectId	id,
		ObjectId *	parent,
		ComponentId *	ancestor_component )

static

◆ getClassName()

char * ToolboxCoreObj::getClassName ( )

inlinevirtual

Implements Object.

Reimplemented in ToolboxTask.

◆ getClassType()

int ToolboxCoreObj::getClassType ( )

inlinevirtual

Implements Object.

Reimplemented in ToolboxTask.

◆ getClientHandle()

unsigned int ToolboxCoreObj::getClientHandle	(	unsigned int	flags,
		ObjectId	id,
		void *	client_handle )

static

◆ getObjectClass() [1/2]

ObjectClass ToolboxCoreObj::getObjectClass	(	unsigned int	flags,
		ObjectId	id )

static

◆ getObjectClass() [2/2]

ObjectClass ToolboxCoreObj::getObjectClass	(	unsigned int	flags,
		ObjectId	id,
		ObjectClass *	object_class )

static

◆ getObjectState()

unsigned int ToolboxCoreObj::getObjectState	(	unsigned int	flags,
		ObjectId	id,
		unsigned int *	state )

static

◆ getParent()

void ToolboxCoreObj::getParent	(	unsigned int	flags,
		ObjectId	id,
		ObjectId *	parent,
		ComponentId *	parent_component )

static

◆ getPointerInfo()

void ToolboxCoreObj::getPointerInfo	(	unsigned int	flags,
		int &	x_pos,
		int &	y_pos,
		int &	buttons,
		ObjectId &	window,
		ComponentId &	component )

static

◆ getSpriteAreaPtr()

void * ToolboxCoreObj::getSpriteAreaPtr ( )

static

◆ getSysInfo()

void ToolboxCoreObj::getSysInfo	(	unsigned int	reason_code,
		_kernel_swi_regs *	regs )

static

◆ getTaskHandle()

int ToolboxCoreObj::getTaskHandle ( )

static

◆ getWimpVersion()

int ToolboxCoreObj::getWimpVersion ( )

static

◆ hideObject()

void ToolboxCoreObj::hideObject	(	unsigned int	flags,
		ObjectId	id )

static

◆ init()

int ToolboxCoreObj::init	(	unsigned int	flags,
		int *	wimpMessages,
		int *	toolboxEvents,
		char *	directory,
		MessagesFD *	mfd,
		IdBlock *	idb )

static

◆ raiseToolboxEvent()

void ToolboxCoreObj::raiseToolboxEvent	(	unsigned int	flags,
		ObjectId	id,
		ComponentId	component,
		ToolboxEvent *	event )

static

◆ setClientHandle()

void ToolboxCoreObj::setClientHandle	(	unsigned int	flags,
		ObjectId	id,
		void *	client_handle )

static

◆ setWimpVersion()

void ToolboxCoreObj::setWimpVersion ( int version )

static

◆ showObject()

void ToolboxCoreObj::showObject	(	unsigned int	flags,
		ObjectId	id,
		int	show_type,
		void *	type,
		ObjectId	parent,
		ComponentId	parent_component )

static

◆ templateLookup()

void * ToolboxCoreObj::templateLookup	(	unsigned int	flags,
		char *	name )

static

◆ toolboxError()

virtual void ToolboxCoreObj::toolboxError ( )

inlinevirtual

◆ toolboxLoadResources()

void ToolboxCoreObj::toolboxLoadResources	(	unsigned int	flags,
		char *	resources )

static

Member Data Documentation

◆ eventCode

int ToolboxCoreObj::eventCode

static

◆ idBlock

IdBlock ToolboxCoreObj::idBlock

static

◆ mfd

MessagesFD ToolboxCoreObj::mfd

static

◆ pollBlock

WimpPollBlock ToolboxCoreObj::pollBlock

static

◆ toolboxEvents

int ToolboxCoreObj::toolboxEvents = 0

static

◆ wimpMessages

int ToolboxCoreObj::wimpMessages = 0

static

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

h/ToolboxCoreObj.h
c++/ToolboxCoreObj.c++

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ createObject()

◆ deleteObject()

◆ eToolboxEventHandler()

◆ getAncestor()

◆ getClassName()

◆ getClassType()

◆ getClientHandle()

◆ getObjectClass() [1/2]

◆ getObjectClass() [2/2]

◆ getObjectState()

◆ getParent()

◆ getPointerInfo()

◆ getSpriteAreaPtr()

◆ getSysInfo()

◆ getTaskHandle()

◆ getWimpVersion()

◆ hideObject()

◆ init()

◆ raiseToolboxEvent()

◆ setClientHandle()

◆ setWimpVersion()

◆ showObject()

◆ templateLookup()

◆ toolboxError()

◆ toolboxLoadResources()

Member Data Documentation

◆ eventCode

◆ idBlock

◆ mfd

◆ pollBlock

◆ toolboxEvents

◆ wimpMessages