ToolboxMenuObj Class Reference

#include <ToolboxMenuObj.h>

Inheritance diagram for ToolboxMenuObj:

Public Member Functions
	ToolboxMenuObj ()
	ToolboxMenuObj (ObjectId objectId)
	ToolboxMenuObj (IdBlock *)
ToolboxMenuObj &	setTick (ComponentId entry, int value)
int	getTick (ComponentId entry)
ToolboxMenuObj &	setFade (ComponentId entry, int fade)
int	getFade (ComponentId entry)
ToolboxMenuObj &	setEntryText (ComponentId entry, char *text)
int	getEntryText (ComponentId entry)
int	getEntryText (ComponentId entry, char *buffer, int bufSize)
ToolboxMenuObj &	setEntrySprite (ComponentId entry, char *spriteName)
int	getEntrySprite (ComponentId entry)
int	getEntrySprite (ComponentId entry, char *buffer, int bufSize)
ToolboxMenuObj &	setSubMenuShow (ComponentId entry, ObjectId subMenu)
ObjectId	getSubMenuShow (ComponentId entry)
ToolboxMenuObj &	setSubMenuEvent (ComponentId entry, int toolboxEvent)
int	getSubMenuEvent (ComponentId entry)
ToolboxMenuObj &	setClickShow (ComponentId entry, ObjectId object, int showFlags)
int	getClickShowObjectId (ComponentId entry)
int	getClickShowFlags (ComponentId entry)
ToolboxMenuObj &	setClickEvent (ComponentId entry, int toolboxEvent)
int	getClickEvent (ComponentId entry)
ToolboxMenuObj &	setHelpMessage (char *helpMessage)
int	getHelpMessage ()
int	getHelpMessage (char *buffer, int bufSize)
ToolboxMenuObj &	setEntryHelpMessage (ComponentId entry, char *helpMessage)
int	getEntryHelpMessage (ComponentId entry)
int	getEntryHelpMessage (ComponentId entry, char *buffer, int bufSize)
ComponentId	addEntry (ComponentId entryId, char *entryDescription)
ToolboxMenuObj &	removeEntry (ComponentId entry)
int	getHeight ()
int	getWidth ()
ToolboxMenuObj &	setTitle (char *title)
int	getTitle ()
int	getTitle (char *buffer, int bufSize)
ToolboxMenuObj &	setObjectId (ObjectId objectId)
ToolboxMenuObj &	setFlags (unsigned int flags)
ToolboxMenuObj &	clearFlags ()
void	showProperties ()
char *	getClassName ()
int	getClassType ()
Public Member Functions inherited from ToolboxObj
	ToolboxObj ()
	ToolboxObj (ObjectId id)
	ToolboxObj (IdBlock *)
	ToolboxObj (unsigned int, IdBlock *)
	ToolboxObj (unsigned int flags, void *name_or_template)
	~ToolboxObj ()
int	getTemplateName ()
void	getTemplateName (char *buffer, int buff_size, int *nbytes)
virtual ToolboxObj &	showObject (int show_type, void *type, ObjectId parent, ComponentId parent_component)
virtual ToolboxObj &	hideObject ()
unsigned int	getObjectState (unsigned int *state)
virtual ToolboxObj &	setClientHandle (void *client_handle)
unsigned int	getClientHandle (void *client_handle)
ObjectId	getParent ()
ObjectId	getAncestor ()
virtual ToolboxObj &	raiseToolboxEvent (ComponentId component, ToolboxEvent *event)
ObjectClass	getObjectClass ()
ObjectClass	readObjectClass ()
virtual ToolboxObj &	objectMiscOp (_kernel_swi_regs *regs)
ObjectId	readObjectId ()
ObjectId	readParentObjectId ()
ObjectId	readAncestorObjectId ()
ToolboxObj &	setFlags (unsigned int flags)
ToolboxObj &	clearFlags ()
unsigned int	getFlags ()
ToolboxObj &	setObjectId (ObjectId id)
void	deleteObject ()
int	isTemplate (char *templateName)
virtual ObjectId	createObject (void *name_or_template)
void	showProperties ()
char *	getClassName ()
int	getClassType ()
Public Member Functions inherited from Object
	Object ()
Public Member Functions inherited from ErrorReport
	ErrorReport ()
	~ErrorReport ()

Additional Inherited Members
Public Types inherited from ErrorReport
enum	errorEnv { CONSOLE , WIMP }
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 inherited from ToolboxObj
static _kernel_oserror	ToolboxObjectIdNotSet = {0x8888,"Toolbox ObjectId not set"}
Protected Member Functions inherited from Object
	~Object ()

Constructor & Destructor Documentation

ToolboxMenuObj() [1/3]

ToolboxMenuObj::ToolboxMenuObj ( )

inline

ToolboxMenuObj() [2/3]

ToolboxMenuObj::ToolboxMenuObj

(

ObjectId

objectId

)

ToolboxMenuObj() [3/3]

ToolboxMenuObj::ToolboxMenuObj

(

IdBlock *

idBlock

)

Member Function Documentation

addEntry()

ComponentId ToolboxMenuObj::addEntry	(	ComponentId	entryId,
		char *	entryDescription )

clearFlags()

ToolboxMenuObj & ToolboxMenuObj::clearFlags

(

)

getClassName()

char * ToolboxMenuObj::getClassName ( )

inlinevirtual

Implements Object.

getClassType()

int ToolboxMenuObj::getClassType ( )

inlinevirtual

Implements Object.

getClickEvent()

int ToolboxMenuObj::getClickEvent

(

ComponentId

entry

)

getClickShowFlags()

int ToolboxMenuObj::getClickShowFlags

(

ComponentId

entry

)

getClickShowObjectId()

int ToolboxMenuObj::getClickShowObjectId

(

ComponentId

entry

)

getEntryHelpMessage() [1/2]

int ToolboxMenuObj::getEntryHelpMessage

(

ComponentId

entry

)

getEntryHelpMessage() [2/2]

int ToolboxMenuObj::getEntryHelpMessage	(	ComponentId	entry,
		char *	buffer,
		int	bufSize )

getEntrySprite() [1/2]

int ToolboxMenuObj::getEntrySprite

(

ComponentId

entry

)

getEntrySprite() [2/2]

int ToolboxMenuObj::getEntrySprite	(	ComponentId	entry,
		char *	buffer,
		int	bufSize )

getEntryText() [1/2]

int ToolboxMenuObj::getEntryText

(

ComponentId

entry

)

getEntryText() [2/2]

int ToolboxMenuObj::getEntryText	(	ComponentId	entry,
		char *	buffer,
		int	bufSize )

getFade()

int ToolboxMenuObj::getFade

(

ComponentId

entry

)

getHeight()

int ToolboxMenuObj::getHeight

(

)

getHelpMessage() [1/2]

int ToolboxMenuObj::getHelpMessage

(

)

getHelpMessage() [2/2]

int ToolboxMenuObj::getHelpMessage	(	char *	buffer,
		int	bufSize )

getSubMenuEvent()

int ToolboxMenuObj::getSubMenuEvent

(

ComponentId

entry

)

getSubMenuShow()

ObjectId ToolboxMenuObj::getSubMenuShow

(

ComponentId

entry

)

getTick()

int ToolboxMenuObj::getTick

(

ComponentId

entry

)

getTitle() [1/2]

int ToolboxMenuObj::getTitle

(

)

getTitle() [2/2]

int ToolboxMenuObj::getTitle	(	char *	buffer,
		int	bufSize )

getWidth()

int ToolboxMenuObj::getWidth

(

)

removeEntry()

ToolboxMenuObj & ToolboxMenuObj::removeEntry

(

ComponentId

entry

)

setClickEvent()

ToolboxMenuObj & ToolboxMenuObj::setClickEvent	(	ComponentId	entry,
		int	toolboxEvent )

setClickShow()

ToolboxMenuObj & ToolboxMenuObj::setClickShow	(	ComponentId	entry,
		ObjectId	object,
		int	showFlags )

setEntryHelpMessage()

ToolboxMenuObj & ToolboxMenuObj::setEntryHelpMessage	(	ComponentId	entry,
		char *	helpMessage )

setEntrySprite()

ToolboxMenuObj & ToolboxMenuObj::setEntrySprite	(	ComponentId	entry,
		char *	spriteName )

setEntryText()

ToolboxMenuObj & ToolboxMenuObj::setEntryText	(	ComponentId	entry,
		char *	text )

setFade()

ToolboxMenuObj & ToolboxMenuObj::setFade	(	ComponentId	entry,
		int	fade )

setFlags()

ToolboxMenuObj & ToolboxMenuObj::setFlags

(

unsigned int

flags

)

setHelpMessage()

ToolboxMenuObj & ToolboxMenuObj::setHelpMessage

(

char *

helpMessage

)

setObjectId()

ToolboxMenuObj & ToolboxMenuObj::setObjectId

(

ObjectId

objectId

)

setSubMenuEvent()

ToolboxMenuObj & ToolboxMenuObj::setSubMenuEvent	(	ComponentId	entry,
		int	toolboxEvent )

setSubMenuShow()

ToolboxMenuObj & ToolboxMenuObj::setSubMenuShow	(	ComponentId	entry,
		ObjectId	subMenu )

setTick()

ToolboxMenuObj & ToolboxMenuObj::setTick	(	ComponentId	entry,
		int	value )

setTitle()

ToolboxMenuObj & ToolboxMenuObj::setTitle

(

char *

title

)

showProperties()

void ToolboxMenuObj::showProperties ( )

inlinevirtual

Implements Object.

---

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

• h/ToolboxMenuObj.h
• c++/ToolboxMenuObj.c++