cWidget::WithCaption Class Reference

Able to parse and store a Caption node. More...

#include <cWidgetBase.h>

Inheritance diagram for cWidget::WithCaption:

[legend]

Collaboration diagram for cWidget::WithCaption:

[legend]

List of all members.

Public Member Functions
bool	Process (tXmlParser::node cur)
	Default constructor.
Protected Types
enum	location { top, bottom, off }
Protected Member Functions
	WithCaption ()
Protected Attributes
tString	m_caption
	The caption text.
int	m_captionloc
	The caption location.
Private Member Functions
void	ProcessCaption (tXmlParser::node cur)
	Processes the inside of a Caption node.
void	ProcessCaptionLocation (tXmlParser::node cur)
	Processes the location attribute of a Caption node.

---

Detailed Description

Able to parse and store a Caption node.

Definition at line 194 of file cWidgetBase.h.

---

Member Enumeration Documentation

enum cWidget::WithCaption::location [protected]

Enumerator:

top	the possible positions of a caption
bottom
off

Definition at line 198 of file cWidgetBase.h.

                  { 
        top,
        bottom,
        off
    };

---

Constructor & Destructor Documentation

cWidget::WithCaption::WithCaption

(

)

[inline, protected]

Definition at line 205 of file cWidgetBase.h.

: Base(), m_captionloc(off) {}; 

---

Member Function Documentation

void cWidget::WithCaption::ProcessCaption

(

tXmlParser::node

cur

)

[private]

Processes the inside of a Caption node.

Definition at line 488 of file cWidgetBase.cpp.

References m_caption, and ProcessCaptionLocation().

Referenced by Process().

                                                   {
    ProcessCaptionLocation(cur);
    for (cur = cur.GetFirstChild(); cur; ++cur) {
        if(cur.IsOfType("Text")) {
            m_caption = cur.GetProp("value");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

void cWidget::WithCaption::ProcessCaptionLocation

(

tXmlParser::node

cur

)

[private]

Processes the location attribute of a Caption node.

Definition at line 497 of file cWidgetBase.cpp.

References bottom, m_captionloc, off, tERR_WARN, and top.

Referenced by ProcessCaption().

                                                           {
    std::map<tString, int> locations;
    locations[tString("top")] = top;
    locations[tString("bottom")] = bottom;
    locations[tString("off")] = off;

    std::map<tString, int>::iterator iter;
    if((iter = locations.find(cur.GetProp("location"))) != locations.end()) {
        m_captionloc = iter->second;
    } else {
        tERR_WARN("Location '" + cur.GetProp("location") + "' unknown!");
        m_captionloc = bottom;
    }

Here is the caller graph for this function:

bool cWidget::WithCaption::Process

(

tXmlParser::node

cur

)

[virtual]

Default constructor.

Processes a Caption node or passes on to Base::Process()

Reimplemented from cWidget::Base.

Reimplemented in cWidget::BarGauge, and cWidget::Label.

Definition at line 480 of file cWidgetBase.cpp.

References cWidget::Base::Process(), and ProcessCaption().

Referenced by cWidget::Label::Process(), and cWidget::BarGauge::Process().

                                            {
    if(cur.IsOfType("Caption")) {
        ProcessCaption(cur);
        return true;
    }
    return Base::Process(cur);

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Data Documentation

tString cWidget::WithCaption::m_caption [protected]

The caption text.

Definition at line 203 of file cWidgetBase.h.

Referenced by ProcessCaption(), cWidget::Label::Render(), cWidget::VerticalBarGauge::RenderCaption(), and cWidget::BarGauge::RenderCaption().

int cWidget::WithCaption::m_captionloc [protected]

The caption location.

Definition at line 204 of file cWidgetBase.h.

Referenced by ProcessCaptionLocation(), cWidget::Label::Render(), cWidget::VerticalBarGauge::RenderCaption(), and cWidget::BarGauge::RenderCaption().

---

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

• src/tron/cockpit/cWidgetBase.h
• src/tron/cockpit/cWidgetBase.cpp

---