ToolboxWindowObj Class Reference

#include <ToolboxWindowObj.h>

Inheritance diagram for ToolboxWindowObj:

Public Member Functions
	ToolboxWindowObj ()
	ToolboxWindowObj (ObjectId objectId)
	ToolboxWindowObj (IdBlock *)
	~ToolboxWindowObj ()
int	getWimpHandle ()
int	readWimpHandle ()
int	addGadget (Gadget *gadget)
ToolboxWindowObj &	removeGadget (ComponentId gadget)
ToolboxWindowObj &	setMenu (ObjectId menu_id)
ToolboxWindowObj &	removeMenu ()
ObjectId	getMenu ()
ToolboxWindowObj &	setPointer (char *sprite_name, int x_hot_spot, int y_hot_spot)
ToolboxWindowObj &	detachPointer ()
int	getPointer ()
int	getPointer (char *buffer, int buff_size, int *nbytes, int *x_hot_spot, int *y_hot_spot)
ToolboxWindowObj &	setHelpMessage (char *message_text)
ToolboxWindowObj &	removeHelpMessage ()
int	getHelpMessage ()
int	getHelpMessage (char *buffer, int buff_size, int *nbytes)
ToolboxWindowObj &	addKeyboardShortcuts (int num_shortcuts, KeyboardShortcut *shortcuts)
ToolboxWindowObj &	removeKeyboardShortcuts (int num_shortcuts, KeyboardShortcut *shortcuts)
ToolboxWindowObj &	removeAllKeyboardShortcuts ()
ToolboxWindowObj &	setTitle (char *title)
int	getTitle ()
int	getTitle (char *buffer, int buff_size, int *nbytes)
ToolboxWindowObj &	clearDefaultFocus ()
ToolboxWindowObj &	setDefaultFocus (ComponentId focus)
ToolboxWindowObj &	setDefaultFocusToWindow ()
ComponentId	getDefaultFocus ()
ComponentId	getDefaultFocus (ComponentId *focus)
ToolboxWindowObj &	setExtent (BBox *extent)
void	getExtent (BBox *extent)
ToolboxWindowObj &	forceRedraw (BBox *redraw_box)
ToolboxWindowObj &	setToolbar (int location, ObjectId toolbar_id)
ToolboxWindowObj &	setToolbar (int mask, ObjectId toolbar_ibl_id, ObjectId toolbar_itl_id, ObjectId toolbar_ebl_id, ObjectId toolbar_etl_id)
ObjectId	getToolbar (int location)
void	getToolbar (int mask, ObjectId *toolbar_ibl_id, ObjectId *toolbar_itl_id, ObjectId *toolbar_ebl_id, ObjectId *toolbar_etl_id)
int	isWindow (char *title)
int	isWindowTemplate (char *templateName)
ToolboxWindowObj &	setObjectId (ObjectId objectId)
ToolboxWindowObj &	setFlags (unsigned int flags)
ToolboxWindowObj &	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)
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

ToolboxWindowObj() [1/3]

ToolboxWindowObj::ToolboxWindowObj

(

)

ToolboxWindowObj() [2/3]

ToolboxWindowObj::ToolboxWindowObj

(

ObjectId

objectId

)

ToolboxWindowObj() [3/3]

ToolboxWindowObj::ToolboxWindowObj

(

IdBlock *

idBlock

)

~ToolboxWindowObj()

ToolboxWindowObj::~ToolboxWindowObj

(

)

Member Function Documentation

addGadget()

int ToolboxWindowObj::addGadget

(

Gadget *

gadget

)

addKeyboardShortcuts()

ToolboxWindowObj & ToolboxWindowObj::addKeyboardShortcuts	(	int	num_shortcuts,
		KeyboardShortcut *	shortcuts )

clearDefaultFocus()

ToolboxWindowObj & ToolboxWindowObj::clearDefaultFocus

(

)

clearFlags()

ToolboxWindowObj & ToolboxWindowObj::clearFlags

(

)

detachPointer()

ToolboxWindowObj & ToolboxWindowObj::detachPointer

(

)

forceRedraw()

ToolboxWindowObj & ToolboxWindowObj::forceRedraw

(

BBox *

redraw_box

)

getClassName()

char * ToolboxWindowObj::getClassName ( )

inlinevirtual

Reimplemented from ToolboxObj.

getClassType()

int ToolboxWindowObj::getClassType ( )

inlinevirtual

Reimplemented from ToolboxObj.

getDefaultFocus() [1/2]

ComponentId ToolboxWindowObj::getDefaultFocus

(

)

getDefaultFocus() [2/2]

ComponentId ToolboxWindowObj::getDefaultFocus

(

ComponentId *

focus

)

getExtent()

void ToolboxWindowObj::getExtent

(

BBox *

extent

)

getHelpMessage() [1/2]

int ToolboxWindowObj::getHelpMessage

(

)

getHelpMessage() [2/2]

int ToolboxWindowObj::getHelpMessage	(	char *	buffer,
		int	buff_size,
		int *	nbytes )

getMenu()

ObjectId ToolboxWindowObj::getMenu

(

)

getPointer() [1/2]

int ToolboxWindowObj::getPointer

(

)

getPointer() [2/2]

int ToolboxWindowObj::getPointer	(	char *	buffer,
		int	buff_size,
		int *	nbytes,
		int *	x_hot_spot,
		int *	y_hot_spot )

getTitle() [1/2]

int ToolboxWindowObj::getTitle

(

)

getTitle() [2/2]

int ToolboxWindowObj::getTitle	(	char *	buffer,
		int	buff_size,
		int *	nbytes )

getToolbar() [1/2]

ObjectId ToolboxWindowObj::getToolbar

(

int

location

)

getToolbar() [2/2]

void ToolboxWindowObj::getToolbar	(	int	mask,
		ObjectId *	toolbar_ibl_id,
		ObjectId *	toolbar_itl_id,
		ObjectId *	toolbar_ebl_id,
		ObjectId *	toolbar_etl_id )

getWimpHandle()

int ToolboxWindowObj::getWimpHandle

(

)

isWindow()

int ToolboxWindowObj::isWindow

(

char *

title

)

isWindowTemplate()

int ToolboxWindowObj::isWindowTemplate

(

char *

templateName

)

readWimpHandle()

int ToolboxWindowObj::readWimpHandle

(

)

removeAllKeyboardShortcuts()

ToolboxWindowObj & ToolboxWindowObj::removeAllKeyboardShortcuts

(

)

removeGadget()

ToolboxWindowObj & ToolboxWindowObj::removeGadget

(

ComponentId

gadget

)

removeHelpMessage()

ToolboxWindowObj & ToolboxWindowObj::removeHelpMessage

(

)

removeKeyboardShortcuts()

ToolboxWindowObj & ToolboxWindowObj::removeKeyboardShortcuts	(	int	num_shortcuts,
		KeyboardShortcut *	shortcuts )

removeMenu()

ToolboxWindowObj & ToolboxWindowObj::removeMenu

(

)

setDefaultFocus()

ToolboxWindowObj & ToolboxWindowObj::setDefaultFocus

(

ComponentId

focus

)

setDefaultFocusToWindow()

ToolboxWindowObj & ToolboxWindowObj::setDefaultFocusToWindow

(

)

setExtent()

ToolboxWindowObj & ToolboxWindowObj::setExtent

(

BBox *

extent

)

setFlags()

ToolboxWindowObj & ToolboxWindowObj::setFlags

(

unsigned int

flags

)

setHelpMessage()

ToolboxWindowObj & ToolboxWindowObj::setHelpMessage

(

char *

message_text

)

setMenu()

ToolboxWindowObj & ToolboxWindowObj::setMenu

(

ObjectId

menu_id

)

setObjectId()

ToolboxWindowObj & ToolboxWindowObj::setObjectId

(

ObjectId

objectId

)

setPointer()

ToolboxWindowObj & ToolboxWindowObj::setPointer	(	char *	sprite_name,
		int	x_hot_spot,
		int	y_hot_spot )

setTitle()

ToolboxWindowObj & ToolboxWindowObj::setTitle

(

char *

title

)

setToolbar() [1/2]

ToolboxWindowObj & ToolboxWindowObj::setToolbar	(	int	location,
		ObjectId	toolbar_id )

setToolbar() [2/2]

ToolboxWindowObj & ToolboxWindowObj::setToolbar	(	int	mask,
		ObjectId	toolbar_ibl_id,
		ObjectId	toolbar_itl_id,
		ObjectId	toolbar_ebl_id,
		ObjectId	toolbar_etl_id )

showProperties()

void ToolboxWindowObj::showProperties ( )

inlinevirtual

Reimplemented from ToolboxObj.

---

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

• h/ToolboxWindowObj.h
• c++/ToolboxWindowObj.c++