ak::uiAPI::object Namespace Reference

Functions
UICORE_API_EXPORT void	destroy (UID _objectUID, bool _ignoreIfObjectHasChildObjects=false)
	Will destroy the specifed object.
UICORE_API_EXPORT void	setObjectUniqueName (UID _objectUID, const QString &_name)
	Will set an object name to the specified object so it can be accessed later. The name must be unique!
UICORE_API_EXPORT QString	getObjectUniqueName (UID _objectUID)
	Will return the unique name set to the object.
UICORE_API_EXPORT UID	getUidFromObjectUniqueName (const QString &_name)
	Will return the UID of the object with the specified name Will return ak::invalidUID if there is no object with the specified name.
UICORE_API_EXPORT void	setToolTip (UID _objectUID, const QString &_toolTip)
	Will set the objects ToolTip For the list of suitable objects refer to the documentation.
UICORE_API_EXPORT void	setEnabled (UID _objectUID, bool _enabled=true)
	Will set the objects enabeld state For the list of suitable objects refer to the documentation.
UICORE_API_EXPORT bool	getIsEnabled (UID _objectUID)
	Will return the objects enabeld state For the list of suitable objects refer to the documentation.
UICORE_API_EXPORT bool	exists (UID _objectUID)
	Will return true if the specified object exists.
UICORE_API_EXPORT objectType	type (UID _objectUID)
	Will return the object type of the specified object.
template<class T >
T *	get (UID _objectUID)
	Will cast and return the object with the specified id.

Function Documentation

destroy()

void ak::uiAPI::object::destroy	(	UID	_objectUID,
		bool	_ignoreIfObjectHasChildObjects = false )

Will destroy the specifed object.

Parameters

_objectUID	The UID of the object to destroy
_ignoreIfObjectHasChildObjects	If true, will not destroy the specified object if it still has child objects

exists()

bool ak::uiAPI::object::exists

(

UID

_objectUID

)

Will return true if the specified object exists.

Parameters

_objectUID

The UID of the object

get()

template<class T >

T * ak::uiAPI::object::get

(

UID

_objectUID

)

Will cast and return the object with the specified id.

Parameters

_objectUID

The UID of the object

getIsEnabled()

bool ak::uiAPI::object::getIsEnabled

(

UID

_objectUID

)

Will return the objects enabeld state For the list of suitable objects refer to the documentation.

Parameters

_objectUID

The UID of the object

getObjectUniqueName()

QString ak::uiAPI::object::getObjectUniqueName

(

UID

_objectUID

)

Will return the unique name set to the object.

Parameters

_objectUID

The UID of the object

getUidFromObjectUniqueName()

ak::UID ak::uiAPI::object::getUidFromObjectUniqueName

(

const QString &

_name

)

Will return the UID of the object with the specified name Will return ak::invalidUID if there is no object with the specified name.

Parameters

_name

The name of the object

setEnabled()

void ak::uiAPI::object::setEnabled	(	UID	_objectUID,
		bool	_enabled = true )

Will set the objects enabeld state For the list of suitable objects refer to the documentation.

Parameters

_objectUID	The UID of the object
_enabled	The enabled state to set

setObjectUniqueName()

void ak::uiAPI::object::setObjectUniqueName	(	UID	_objectUID,
		const QString &	_name )

Will set an object name to the specified object so it can be accessed later. The name must be unique!

Parameters

_objectUID	The UID of the object to set the name at
_name	The name to set

setToolTip()

void ak::uiAPI::object::setToolTip	(	UID	_objectUID,
		const QString &	_toolTip )

Will set the objects ToolTip For the list of suitable objects refer to the documentation.

Parameters

_objectUID	The UID of the object
_toolTip	The toop tip to set

type()

ak::objectType ak::uiAPI::object::type

(

UID

_objectUID

)

Will return the object type of the specified object.

Parameters

_objectUID

The UID of the object