A base bordered container class for RtObjects. More...

#include <carma/ui/rtd/common/RtDisplay.h>

Inheritance diagram for carma::ui::rtd::RtContainer:

Public Member Functions
RtObjectPtr	add (RtObjectPtr rtObject)
	Insert an object into the container. More...

Border	getBorder () const

::size_t	getNumObjects () const
	Get the number of objects in the container. More...

RtObjectPtr	getObj (::size_t index) const
	Get object from the container by index. More...

RtObjectPtr	replace (unsigned int i, RtObjectPtr rtObject)
	Replace an object in the container. More...

RtObjectPtr	replace (RtObjectPtr oldObj, RtObjectPtr newObj)

virtual void	serialize (bool initialize, int fontSize,::rtdproto::RtObject *rtobj)=0
	Creates static description of container to stdout. More...

void	setBorder (Border border)
	Set the border code. More...

virtual void	update ()
	Update all objects contained by container. More...

virtual	~RtContainer ()
	Destructor. More...

Public Member Functions inherited from carma::ui::rtd::RtTitledObj
std::string	getTitle ()
	Get title. More...

void	setTitle (const std::string &title)
	Set title for object. More...

Public Member Functions inherited from carma::ui::rtd::RtObject
void	appendToolTipText (const std::string &text)
	Append more text to the existing tool tip text. More...

Layout	getLayout () const
	Get the layout for this object. More...

std::string	getToolTipText ()

void	setFontSize (int fontSize)
	Set the absolute font size for this object. More...

void	setLayout (Layout layout)
	Set the layout for this object. More...

void	setToolTipText (const std::string &text)
	Set the tool tip text for this RtObject. More...

virtual	~RtObject ()
	Destructor. More...

Protected Types
typedef ::std::vector < RtObjectPtr >	ObjectContainerType

Protected Member Functions
	RtContainer ()
	Constructor. More...

	RtContainer (const ::std::string &title)
	Constructor. More...

	RtContainer (Border border)
	Constructor. More...

	RtContainer (const ::std::string &title, Border border)
	Constructor. More...

Protected Member Functions inherited from carma::ui::rtd::RtTitledObj
	RtTitledObj (const std::string &title)
	Constructor. More...

Protected Member Functions inherited from carma::ui::rtd::RtObject
int	getFontSize (int parentFontSize) const
	Get the absolute font size for this object. More...

int	getFontSize () const
	Get the absolute font size for this object. More...

	RtObject ()
	Constructor. More...

Protected Attributes
size_t	numObjects_

ObjectContainerType	objects_

Protected Attributes inherited from carma::ui::rtd::RtTitledObj
std::string	title_
	Object title. More...

Detailed Description

A base bordered container class for RtObjects.

The default is no border. The new container mode will send the font size with the container while the old does not. Client is compatible with old or new.

Definition at line 1396 of file RtDisplay.h.

Constructor & Destructor Documentation

virtual carma::ui::rtd::RtContainer::~RtContainer ( )

virtual

Destructor.

carma::ui::rtd::RtContainer::RtContainer ( )

explicitprotected

Constructor.

carma::ui::rtd::RtContainer::RtContainer ( const ::std::string & title )

protected

Constructor.

Parameters

title title for the container

carma::ui::rtd::RtContainer::RtContainer ( Border border )

protected

Constructor.

Parameters

border border code

carma::ui::rtd::RtContainer::RtContainer	(	const ::std::string &	title,
		Border	border
	)

protected

Constructor.

Parameters

title	title for the container
border	border code

Member Function Documentation

RtObjectPtr carma::ui::rtd::RtContainer::add ( RtObjectPtr rtObject )

Insert an object into the container.

Parameters

rtObject object to insert into the container

::size_t carma::ui::rtd::RtContainer::getNumObjects ( ) const

Get the number of objects in the container.

RtObjectPtr carma::ui::rtd::RtContainer::getObj ( ::size_t index ) const

Get object from the container by index.

Parameters

index

RtObjectPtr carma::ui::rtd::RtContainer::replace	(	unsigned int	i,
		RtObjectPtr	rtObject
	)

Replace an object in the container.

Parameters

rtObject object to insert into the container

virtual void carma::ui::rtd::RtContainer::serialize	(	bool	initialize,
		int	fontSize,
		::rtdproto::RtObject *	rtobj
	)

pure virtual

Creates static description of container to stdout.

Implements carma::ui::rtd::RtTitledObj.

Implemented in carma::ui::rtd::RtDisplay, carma::ui::rtd::RtBox, carma::ui::rtd::RtTable, and carma::ui::rtd::RtArea.

void carma::ui::rtd::RtContainer::setBorder ( Border border )

Set the border code.

Parameters

border border code

virtual void carma::ui::rtd::RtContainer::update ( )

virtual

Update all objects contained by container.

Reimplemented from carma::ui::rtd::RtTitledObj.

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

carma/ui/rtd/common/RtDisplay.h

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation