#include <guiTypes.h>

Inheritance diagram for GuiCursor:

Public Member Functions
Point2I	getHotSpot ()
Point2I	getExtent ()
Point2F	getRenderOffset ()
void	setHotSpot (const Point2I &hotSpot)
void	setRenderOffset (const Point2F &renderOffset)
StringTableEntry	getBitmapName () const
	DECLARE_CONOBJECT (GuiCursor)
	GuiCursor (void)
	~GuiCursor (void)
bool	onAdd (void)
	Called when the object is added to the sim.
void	onRemove ()
	Called when the object is removed from the sim.
void	render (const Point2I &pos)
const Point2I &	resolve ()
StringTableEntry	getRelativeBitmapName (void) const
void	setTheme (GuiProfileTheme *theme, bool preserveOverrides=false)
GuiProfileTheme *	getTheme () const
bool	isThemeFieldOverridden (StringTableEntry field) const
void	clearThemeFieldOverride (StringTableEntry field)
void	clearAllThemeOverrides ()
virtual void	onStaticModified (const char slotName, const char newValue=NULL)
virtual bool	writeField (StringTableEntry fieldname, const char *value)
virtual void	onDeleteNotify (SimObject *object)
Public Member Functions inherited from SimObject
StringTableEntry	getClassNamespace () const
StringTableEntry	getSuperClassNamespace () const
void	setClassNamespace (const char *classNamespace)
void	setSuperClassNamespace (const char *superClassNamespace)
void	pushScriptCallbackGuard (void)
void	popScriptCallbackGuard (void)
S32	getScriptCallbackGuard (void)
virtual SimObject *	findObject (const char *name)
Namespace *	getNamespace ()
	Return the object's namespace.
const char *	tabComplete (const char *prevText, S32 baseLen, bool)
virtual void	dump ()
virtual void	dumpClassHierarchy ()
SimObject *	clone (const bool copyDynamicFields)
virtual void	copyTo (SimObject *object)
SimObject *	deepClone ()
template<typename T>
bool	isType (void)
virtual bool	handlesConsoleMethod (const char fname, S32 routingId)
	DECLARE_CONOBJECT (SimObject)
virtual void	write (Stream &stream, U32 tabStop, U32 flags=0)
virtual void	writeFields (Stream &stream, U32 tabStop)
virtual bool	writeObject (Stream *stream)
virtual bool	readObject (Stream *stream)
virtual void	buildFilterList ()
void	addFieldFilter (const char *fieldName)
void	removeFieldFilter (const char *fieldName)
void	clearFieldFilters ()
bool	isFiltered (const char *fieldName)
void	assignFieldsFrom (SimObject *obj)
void	copyFieldsFrom (SimObject *obj, const U32 flags)
void	assignDynamicFieldsFrom (SimObject *obj)
Notify *	removeNotify (void *ptr, Notify::Type)
	Remove a notification from the list.
void	deleteNotify (SimObject *obj)
	Notify an object when we are deleted.
void	clearNotify (SimObject *obj)
	Notify an object when we are cleared.
void	clearAllNotifications ()
	Remove all notifications for this object.
void	processDeleteNotifies ()
	Send out deletion notifications.
void	registerReference (SimObject **obj)
void	unregisterReference (SimObject **obj)
void	addListener (std::string objID)
void	removeListener (std::string objID)
void	removeAllListeners ()
void	postEvent (std::string eventName, std::string data)
const char *	getDataField (StringTableEntry slotName, const char *array)
virtual void	setDataField (StringTableEntry slotName, const char array, const char value)
const char *	getPrefixedDataField (StringTableEntry fieldName, const char *array)
void	setPrefixedDataField (StringTableEntry fieldName, const char array, const char value)
const char *	getPrefixedDynamicDataField (StringTableEntry fieldName, const char *array, const S32 fieldType=-1)
void	setPrefixedDynamicDataField (StringTableEntry fieldName, const char array, const char value, const S32 fieldType=-1)
StringTableEntry	getDataFieldPrefix (StringTableEntry fieldName)
U32	getDataFieldType (StringTableEntry slotName, const char *array)
SimFieldDictionary *	getFieldDictionary ()
void	clearDynamicFields (void)
	Clear all dynamic fields.
void	setCanSaveDynamicFields (bool bCanSave)
	Set whether fields created at runtime should be saved. Default is true.
bool	getCanSaveDynamicFields (void) const
	Get whether fields created at runtime should be saved. Default is true.
void	setInternalName (const char *newname)
StringTableEntry	getInternalName ()
	Get the internal of of this control.
virtual bool	save (const char *pcFilePath, bool bOnlySelected=false)
	Save object as a TorqueScript File.
virtual bool	isMethod (const char *methodName)
	Check if a method exists in the objects current namespace.
SimObjectId	getId (void) const
StringTableEntry	getIdString (void) const
U32	getType () const
const StringTableEntry	getName (void) const
void	setId (SimObjectId id)
void	assignName (const char *name)
SimGroup *	getGroup () const
bool	isChildOfGroup (SimGroup *pGroup)
bool	isProperlyAdded () const
bool	isDeleted () const
bool	isRemoved () const
bool	isLocked () const
void	setLocked (bool b)
bool	isHidden () const
void	setHidden (bool b)
void	setProgenitorFile (const char *pFile)
StringTableEntry	getProgenitorFile (void) const
void	setPeriodicTimerID (const S32 timerID)
S32	getPeriodicTimerID (void) const
bool	isPeriodicTimerActive (void) const
bool	isSelected () const
bool	isExpanded () const
void	setSelected (bool sel)
void	setExpanded (bool exp)
void	setModDynamicFields (bool dyn)
void	setModStaticFields (bool sta)
	SimObject ()
virtual	~SimObject ()
virtual bool	processArguments (S32 argc, const char **argv)
	Process constructor options. (ie, new SimObject(1,2,3)).
virtual void	onGroupAdd ()
	Called when the object is added to a SimGroup.
virtual void	onGroupRemove ()
	Called when the object is removed from a SimGroup.
virtual void	onNameChange (const char *name)
	Called when the object's name is changed.
virtual void	inspectPreApply ()
virtual void	inspectPostApply ()
virtual void	onEditorEnable ()
	Called when the editor is activated.
virtual void	onEditorDisable ()
	Called when the editor is deactivated.
bool	registerObject ()
bool	registerObject (U32 id)
bool	registerObject (const char *name)
bool	registerObject (const char *name, U32 id)
void	unregisterObject ()
void	deleteObject ()
bool	addToSet (SimObjectId)
bool	addToSet (const char *)
bool	removeFromSet (SimObjectId)
bool	removeFromSet (const char *)
Public Member Functions inherited from ConsoleObject
const AbstractClassRep::Field *	findField (StringTableEntry fieldName) const
	Get a reference to a field by name.
virtual AbstractClassRep *	getClassRep () const
	Gets the ClassRep.
bool	setField (const char fieldName, const char value)
	Set the value of a field.
virtual	~ConsoleObject ()
const AbstractClassRep::FieldList &	getFieldList () const
	Get a list of all the fields. This information cannot be modified.
AbstractClassRep::FieldList &	getModifiableFieldList ()
bool &	getDynamicGroupExpand ()
S32	getClassId (U32 netClassGroup) const
const char *	getClassName () const

Static Public Member Functions
static void	initPersistFields ()
Static Public Member Functions inherited from SimObject
static void	initPersistFields ()
Static Public Member Functions inherited from ConsoleObject
static const char *	lookupClassName (const U32 in_classTag)
	Get the classname from a class tag.
static void	initPersistFields ()
static void	consoleInit ()
static AbstractClassRep *	getStaticClassRep ()
	Get the abstract class information for this class.
static AbstractClassRep *	getParentStaticClassRep ()
	Get the abstract class information for this class's superclass.
static ConsoleObject *	create (const char *in_pClassName)
static ConsoleObject *	create (const U32 groupId, const U32 typeId, const U32 in_classId)

Public Attributes
ColorI	mColor
StringTableEntry	mCategory
	The theme category this cursor belongs to. See GuiProfileTheme.

Static Protected Member Functions
static bool	setThemeOverrides (void obj, const char data)
static const char *	getThemeOverrides (void obj, const char data)
static const char *	getBitmapName (void obj, const char data)
Static Protected Member Functions inherited from SimObject
static bool	setClass (void obj, const char data)
static bool	setSuperClass (void obj, const char data)
static bool	writeObjectName (void *obj, StringTableEntry pFieldName)
static bool	writeCanSaveDynamicFields (void *obj, StringTableEntry pFieldName)
static bool	writeInternalName (void *obj, StringTableEntry pFieldName)
static bool	setParentGroup (void obj, const char data)
static bool	writeParentGroup (void *obj, StringTableEntry pFieldName)
static bool	writeSuperclass (void *obj, StringTableEntry pFieldName)
static bool	writeClass (void *obj, StringTableEntry pFieldName)
static bool	setProtectedName (void obj, const char data)
static const char *	getProtectedName (void obj, const char data)
static SimObject::Notify *	allocNotify ()
	Get a free Notify structure.
static void	freeNotify (SimObject::Notify *)
	Mark a Notify structure as free.
static void	addGroup (const char in_pGroupname, const char in_pGroupDocs=NULL)
static void	endGroup (const char *in_pGroupname)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, const char in_pFieldDocs)
static void	addField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::WriteDataNotify in_writeDataFn, const char in_pFieldDocs)
static void	addFieldV (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, ConsoleTypeValidator v, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const U32 in_elementCount=1, EnumTable in_table=NULL, const char *in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, const char in_pFieldDocs=NULL)
static void	addProtectedField (const char in_pFieldname, const U32 in_fieldType, const dsize_t in_fieldOffset, AbstractClassRep::SetDataNotify in_setDataFn, AbstractClassRep::GetDataNotify in_getDataFn=&defaultProtectedGetFn, AbstractClassRep::WriteDataNotify in_writeDataFn=&defaultProtectedWriteFn, const char in_pFieldDocs=NULL)
static void	addDepricatedField (const char *fieldName)
static bool	removeField (const char *in_pFieldname)

Additional Inherited Members
Public Types inherited from SimObject
enum	WriteFlags { SelectedOnly = BIT(0) }
enum	CopyFieldsFlags { CopyFields_SkipName = BIT(0) , CopyFields_SkipParentGroup = BIT(1) , CopyFields_SkipScriptClass = BIT(2) }
	What copyFieldsFrom may be told to leave alone. More...
static bool	disableNameChanging = false
Protected Member Functions inherited from SimObject
virtual void	onTamlPreWrite (void)
	Taml callbacks.
virtual void	onTamlPostWrite (void)
	Called after Taml has finished writing the object.
virtual void	onTamlPreRead (void)
	Called prior to Taml reading the object.
virtual void	onTamlPostRead (const TamlCustomNodes &customNodes)
virtual void	onTamlAddParent (SimObject *pParentObject)
	Called after Taml has finished reading the object and has added the object to any parent.
virtual void	onTamlCustomWrite (TamlCustomNodes &customNodes)
	Called during the writing of the object to allow custom properties to be written.
virtual void	onTamlCustomRead (const TamlCustomNodes &customNodes)
	Called during the reading of the object to allow custom properties to be read.
void	linkNamespaces ()
void	unlinkNamespaces ()
virtual SimObject *	allocClone ()
	A registered but empty object of this object's class.
void	cloneInto (SimObject *clone)
virtual void	deepCloneChildren (SimObject *clone)
Protected Member Functions inherited from ConsoleObject
	ConsoleObject ()
	ConsoleObject (const ConsoleObject &)
Protected Attributes inherited from SimObject
SimObjectId	mId
	Id number for this object.
StringTableEntry	mIdString
Namespace *	mNameSpace
U32	mTypeMask
S32	mScriptCallbackGuard
	Whether the object is executing a script callback.
bool	mCanSaveFieldDictionary
	true if dynamic fields (added at runtime) should be saved, defaults to true
StringTableEntry	mInternalName
	Stores object Internal Name.
StringTableEntry	mClassName
	Stores the class name to link script class namespaces.
StringTableEntry	mSuperClassName
	Stores super class name to link script class namespaces.
static SimObject::Notify *	mNotifyFreeList = NULL

Detailed Description

The pointer the canvas draws. A control names one through a TypeGuiCursor field (a text edit's editCursor, a window's resize cursors); anything that names none falls back to the canonical name for its kind - "EditCursor", "LeftRightCursor" and the rest - which is what a GuiProfileTheme's cursor members are installed under. See GuiProfileTheme::smCursorCategories.

Constructor & Destructor Documentation

◆ GuiCursor()

GuiCursor ( void )

◆ ~GuiCursor()

~GuiCursor ( void )

Member Function Documentation

◆ clearAllThemeOverrides()

void clearAllThemeOverrides ( )

inline

◆ clearThemeFieldOverride()

void clearThemeFieldOverride ( StringTableEntry field )

inline

◆ DECLARE_CONOBJECT()

DECLARE_CONOBJECT ( GuiCursor )

◆ getBitmapName() [1/2]

StringTableEntry getBitmapName ( ) const

inline

◆ getBitmapName() [2/2]

const char * getBitmapName	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ getExtent()

Point2I getExtent ( )

inline

◆ getHotSpot()

Point2I getHotSpot ( )

inline

◆ getRelativeBitmapName()

StringTableEntry getRelativeBitmapName ( void ) const

The bitmap path as it should be written down: relative to the game root when it points inside the game, and unchanged when it does not. As with GuiControlProfile's bitmap, mBitmapName itself is always absolute - TypeFilename expands whatever it is given the moment it is set - and an absolute path in a saved theme names a folder on one machine only.

◆ getRenderOffset()

Point2F getRenderOffset ( )

inline

◆ getTheme()

GuiProfileTheme * getTheme ( ) const

inline

◆ getThemeOverrides()

const char * getThemeOverrides	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ initPersistFields()

void initPersistFields ( )

static

◆ isThemeFieldOverridden()

bool isThemeFieldOverridden ( StringTableEntry field ) const

inline

◆ onAdd()

bool onAdd ( void )

virtual

Called when the object is added to the sim.

Reimplemented from SimObject.

◆ onDeleteNotify()

void onDeleteNotify ( SimObject * object )

virtual

Called when a SimObject is deleted.

When you are on the notification list for another object and it is deleted, this method is called.

Reimplemented from SimObject.

◆ onRemove()

void onRemove ( )

virtual

Called when the object is removed from the sim.

Reimplemented from SimObject.

◆ onStaticModified()

void onStaticModified	(	const char *	slotName,
		const char *	newValue = NULL )

virtual

Called when a static field is modified.

Reimplemented from SimObject.

◆ render()

void render ( const Point2I & pos )

◆ resolve()

const Point2I & resolve ( )

Load the bitmap now and answer its real size. render() does this on its first pass, so until a cursor has been drawn once its extent is (1,1) - no use to an editor that has to lay out and measure before drawing.

◆ setHotSpot()

void setHotSpot ( const Point2I & hotSpot )

inline

◆ setRenderOffset()

void setRenderOffset ( const Point2F & renderOffset )

inline

◆ setTheme()

void setTheme	(	GuiProfileTheme *	theme,
		bool	preserveOverrides = false )

◆ setThemeOverrides()

bool setThemeOverrides	(	void *	obj,
		const char *	data )

inlinestaticprotected

◆ writeField()

bool writeField	(	StringTableEntry	fieldname,
		const char *	value )

virtual

Determine whether or not a field should be written.

Parameters

fieldname	The name of the field being written.
value	The value of the field.

Reimplemented from SimObject.

Member Data Documentation

◆ mCategory

StringTableEntry mCategory

The theme category this cursor belongs to. See GuiProfileTheme.

◆ mColor

ColorI mColor

Multiplied into the bitmap as it is drawn. The stock art is grayscale - black outline, white body - so a tint colors the body and leaves the outline alone, which is what lets a theme skin the stock cursors without anyone drawing new ones. White is the identity (dglClearBitmapModulation is exactly white), so a cursor that never sets this renders as it always did.

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

gui/guiTypes.h
gui/guiTypes.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GuiCursor()

◆ ~GuiCursor()

Member Function Documentation

◆ clearAllThemeOverrides()

◆ clearThemeFieldOverride()

◆ DECLARE_CONOBJECT()

◆ getBitmapName() [1/2]

◆ getBitmapName() [2/2]

◆ getExtent()

◆ getHotSpot()

◆ getRelativeBitmapName()

◆ getRenderOffset()

◆ getTheme()

◆ getThemeOverrides()

◆ initPersistFields()

◆ isThemeFieldOverridden()

◆ onAdd()

◆ onDeleteNotify()

◆ onRemove()

◆ onStaticModified()

◆ render()

◆ resolve()

◆ setHotSpot()

◆ setRenderOffset()

◆ setTheme()

◆ setThemeOverrides()

◆ writeField()

Member Data Documentation

◆ mCategory

◆ mColor