ak::aTtbContainer Class Reference

This class provides a interface that represents a tab toolbar container. More...

#include "aTtbContainer.h"

Inheritance diagram for ak::aTtbContainer:

Public Member Functions
	aTtbContainer (aMessenger *_messenger, objectType _type, UID _UID=ak::invalidUID)
	Constructor, initializes the uid of this container.
virtual	~aTtbContainer ()
	Deconstructor.
int	subContainerCount (void) const
	Returns the count of sub containers.
virtual void	addChild (aObject *_child)=0
	Will add the provided child to this container.
virtual aTtbContainer *	createSubContainer (const QString &_text=QString(""))=0
	Will add a new sub container to this container.
virtual void	setEnabled (bool _enabled)
	Will set the enabled state of this container.
bool	enabled (void) const
	Will return the enabled state of this container.
aTtbContainer *	getSubContainer (const QString &_text)
	Will return the sub container with the specified text Returns nullptr if no sub container with the specified text exists.
virtual void	destroyAllSubContainer (void)=0
QString	text (void) const
	Will return the text of this ttb container.
Public Member Functions inherited from ak::aObject
	aObject (objectType _type=otNone, UID _UID=ak::invalidUID)
	Constructor.
	aObject (const aObject &_other)
	Copy constructor.
aObject &	operator= (const aObject &_other)
	Assignment operator.
virtual	~aObject ()
	Deconstructor.
virtual void	removeChildObject (aObject *_child)
	Will remove the child from this object (not destroy it) This function should be called from the deconstructor of a child.
virtual void	addChildObject (aObject *_child)
	Will add the child to this object.
void	setUniqueName (const QString &_name)
	Will set this objects unique name.
virtual void	setParentObject (aObject *_parentObject)
	Will set the parent object of this object.
QString	uniqueName (void) const
	Will return the unique name of this object.
aObject *	parentObject (void) const
	Will return a pointer to the parent object.
int	childObjectCount (void) const
	Will return the count of sub objects.
aObject *	childObject (UID _childUID)
	Will return the child with the specified UID.
void	setOwner (aObject *_object)
	Will set the owner of this object.
aObject *	owner (void) const
	Will return the owner of this object.
void	setUid (UID _UID)
	Will set the objects UID.
UID	uid (void) const
	Returns the objects UID.
objectType	type (void) const
	Returns the objects type.
virtual bool	isWidgetType (void) const
	Returns true if the object is an object derived from aWidget.

Protected Attributes
aMessenger *	m_messenger
std::vector< aTtbContainer * >	m_subContainer
QString	m_text
bool	m_isEnabled
Protected Attributes inherited from ak::aObject
UID	m_uid
int	m_references
	The objects UID.
objectType	m_objectType
	The objects references.
QString	m_uniqueName
	The object type of this object.
aObject *	m_parentObject
aObject *	m_owner
std::map< UID, aObject * >	m_childObjects

Detailed Description

This class provides a interface that represents a tab toolbar container.

Constructor & Destructor Documentation

aTtbContainer()

ak::aTtbContainer::aTtbContainer	(	aMessenger *	_messenger,
		objectType	_type,
		UID	_UID = ak::invalidUID )

Constructor, initializes the uid of this container.

Parameters

_UID	The initial UID of this object
_references	The initial reference count for this object

~aTtbContainer()

ak::aTtbContainer::~aTtbContainer ( )

virtual

Deconstructor.

Member Function Documentation

addChild()

virtual void ak::aTtbContainer::addChild ( aObject * _child )

pure virtual

Will add the provided child to this container.

Parameters

_child

The child to add

Implemented in ak::aTtbGroup, ak::aTtbPage, and ak::aTtbSubGroup.

createSubContainer()

virtual aTtbContainer * ak::aTtbContainer::createSubContainer ( const QString & _text = QString("") )

pure virtual

Will add a new sub container to this container.

Parameters

_text

The initial text of the container

Implemented in ak::aTtbGroup, ak::aTtbPage, and ak::aTtbSubGroup.

destroyAllSubContainer()

virtual void ak::aTtbContainer::destroyAllSubContainer ( void )

pure virtual

Implemented in ak::aTtbGroup, ak::aTtbPage, and ak::aTtbSubGroup.

enabled()

bool ak::aTtbContainer::enabled ( void ) const

inline

Will return the enabled state of this container.

getSubContainer()

ak::aTtbContainer * ak::aTtbContainer::getSubContainer

(

const QString &

_text

)

Will return the sub container with the specified text Returns nullptr if no sub container with the specified text exists.

Parameters

_text

The text of the sub container to find

setEnabled()

virtual void ak::aTtbContainer::setEnabled ( bool _enabled )

inlinevirtual

Will set the enabled state of this container.

Parameters

_enbaled

The enabled state to set

Reimplemented in ak::aTtbGroup, ak::aTtbPage, and ak::aTtbSubGroup.

subContainerCount()

int ak::aTtbContainer::subContainerCount

(

void

)

const

Returns the count of sub containers.

text()

QString ak::aTtbContainer::text ( void ) const

inline

Will return the text of this ttb container.

Member Data Documentation

m_isEnabled

bool ak::aTtbContainer::m_isEnabled

protected

m_messenger

aMessenger* ak::aTtbContainer::m_messenger

protected

m_subContainer

std::vector<aTtbContainer *> ak::aTtbContainer::m_subContainer

protected

m_text

QString ak::aTtbContainer::m_text

protected

---

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

• Libraries/uiCore/include/akGui/aTtbContainer.h
• Libraries/uiCore/src/akGui/aTtbContainer.cpp