CARMA C++
carma::ui::rtd::RtVBox Class Reference

RtBox with vertical layout. More...

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

Inheritance diagram for carma::ui::rtd::RtVBox:
carma::ui::rtd::RtBox carma::ui::rtd::RtContainer carma::ui::rtd::RtTitledObj carma::ui::rtd::RtObject

Public Member Functions

 RtVBox (const std::string &title)
 Constructor. More...
 
 RtVBox (Border border)
 Constructor. More...
 
 RtVBox (const std::string &title, Border border)
 Constructor. More...
 
- Public Member Functions inherited from carma::ui::rtd::RtBox
virtual void serialize (bool initialize, int fontSize,::rtdproto::RtObject *rtobj)
 Creates static description of container to stdout. More...
 
void setProp ()
 Set stretchType to proportional. More...
 
void setSpring ()
 Set stretchType to SPRING. More...
 
void setStretchFactor (double stretchFactor)
 Set stretch factor. More...
 
- Public Member Functions inherited from carma::ui::rtd::RtContainer
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)
 
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...
 

Additional Inherited Members

- Public Types inherited from carma::ui::rtd::RtBox
enum  BoxType { BOX_HORIZONTAL, BOX_VERTICAL, BOX_FOLDER }
 
enum  StretchType { STRETCH_PROPORTIONAL, STRETCH_SPRING }
 
- Protected Types inherited from carma::ui::rtd::RtContainer
typedef ::std::vector
< RtObjectPtr > 
ObjectContainerType
 
- Protected Member Functions inherited from carma::ui::rtd::RtBox
 RtBox (BoxType type, const std::string &title)
 Constructor. More...
 
 RtBox (BoxType type, Border border)
 Constructor. More...
 
 RtBox (BoxType type, const std::string &title, Border border)
 Constructor. More...
 
- Protected Member Functions inherited from carma::ui::rtd::RtContainer
 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 inherited from carma::ui::rtd::RtContainer
size_t numObjects_
 
ObjectContainerType objects_
 
- Protected Attributes inherited from carma::ui::rtd::RtTitledObj
std::string title_
 Object title. More...
 

Detailed Description

RtBox with vertical layout.

Definition at line 1979 of file RtDisplay.h.

Constructor & Destructor Documentation

carma::ui::rtd::RtVBox::RtVBox ( const std::string &  title)
explicit

Constructor.

Parameters
titletitle for box
See Also
RtContainer
carma::ui::rtd::RtVBox::RtVBox ( Border  border)
explicit

Constructor.

Parameters
bordersingle character codes for the border.
See Also
RtContainer
carma::ui::rtd::RtVBox::RtVBox ( const std::string &  title,
Border  border 
)

Constructor.

Parameters
titletitle for box
bordersingle character codes for the border.
See Also
RtContainer

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