#include <staticdisplay.h>

Inheritance diagram for StaticDisplay:

Public Member Functions
virtual void	draw (void)

virtual std::string	text (void)

virtual void	setText (std::string t)

virtual Justification	justification (void)

virtual void	setJustification (Justification j)

virtual bool	multiLine (void)

virtual void	setMultiLine (bool multi)

virtual Size	textMargins (void)

virtual void	setTextMargins (const Size &s)

virtual void	setScroller (Scroller *s)

virtual GFXColor	textColor (void)

virtual void	setTextColor (const GFXColor &c)

virtual Font	font (void)

virtual void	setFont (const Font &f)

virtual void	setRect (const Rect &r)

virtual bool	processMouseDown (const InputEvent &event)

virtual bool	processCommand (const EventCommandId &command, Control *control)

	StaticDisplay (void)

virtual	~StaticDisplay (void)

Public Member Functions inherited from Control
virtual Rect	rect (void)

virtual bool	hitTest (const Point &p)

virtual bool	hidden (void)

virtual void	setHidden (bool h=true)

virtual const std::string &	id (void)

virtual void	setId (const std::string &newId)

virtual GFXColor	color (void)

virtual void	setColor (const GFXColor &c)

virtual GFXColor	outlineColor (void)

virtual void	setOutlineColor (const GFXColor &c)

virtual bool	hasGroupChildren (void)

	Control (void)

virtual	~Control (void)

Public Member Functions inherited from EventResponder
virtual bool	processKeyDown (const InputEvent &event)

virtual bool	processKeyUp (const InputEvent &event)

virtual void	processUnfocus (const InputEvent &event)

virtual bool	processMouseUp (const InputEvent &event)

virtual bool	processMouseMove (const InputEvent &event)

virtual bool	processMouseDrag (const InputEvent &event)

virtual void	sendCommand (const EventCommandId &command, Control *control)

virtual void	setCommandTarget (EventResponder *responder)

virtual void	setModal (bool modal)

	EventResponder (void)

virtual	~EventResponder (void)

Protected Member Functions
void	setPaintTextRect (void)

Protected Member Functions inherited from Control
virtual void	drawBackground (void)

Protected Attributes
PaintText	m_paintText

Size	m_textMargins

int	m_scrollPosition

int	m_layoutVersion

Scroller *	m_scroller

Protected Attributes inherited from Control
Rect	m_rect

std::string	m_id

GFXColor	m_color

GFXColor	m_outlineColor

GFXColor	m_textColor

Font	m_font

bool	m_hidden

Protected Attributes inherited from EventResponder
bool	m_modal

EventResponder *	m_commandTarget

Detailed Description

Definition at line 39 of file staticdisplay.h.

Constructor & Destructor Documentation

StaticDisplay::StaticDisplay ( void )

Definition at line 112 of file staticdisplay.cpp.

                                    :
     m_textMargins( Size( 0.0, 0.0 ) )
     , m_scrollPosition( 0 )
     , m_layoutVersion( m_paintText.layoutVersion() )
     , m_scroller( NULL )
 {}

virtual StaticDisplay::~StaticDisplay ( void )

inlinevirtual

Definition at line 118 of file staticdisplay.h.

118 {}

Member Function Documentation

void StaticDisplay::draw ( void )

virtual

Implements Control.

Reimplemented in TextInputDisplay.

Definition at line 60 of file staticdisplay.cpp.

References Control::drawBackground(), PaintText::drawLines(), Size::height, PaintText::layoutVersion(), PaintText::lineCount(), m_layoutVersion, m_paintText, Control::m_rect, m_scroller, m_scrollPosition, Scroller::setRangeValues(), Scroller::setScrollPosition(), Rect::size, and PaintText::visibleLineCountStartingWith().

Referenced by TextInputDisplay::draw().

 {
     //Draw the background.
     drawBackground();
     //If we have a scroller and the layout has changed, need to reset the scroller.
     if ( m_scroller && m_layoutVersion != m_paintText.layoutVersion() ) {
         const int lineCount = m_paintText.lineCount();
         const int visible   = m_paintText.visibleLineCountStartingWith( m_scrollPosition, m_rect.size.height );
         m_scroller->setRangeValues( lineCount-1, visible );
         if (m_scrollPosition > lineCount-2 && lineCount > visible)
             m_scrollPosition = lineCount-1;
         m_scroller->setScrollPosition( m_scrollPosition );
         m_layoutVersion = m_paintText.layoutVersion();         //Remember layout version for next time.
     }
     m_paintText.drawLines( m_scrollPosition );
 }

virtual Font StaticDisplay::font ( void )

inlinevirtual

Reimplemented from Control.

Definition at line 98 of file staticdisplay.h.

References PaintText::font(), and m_paintText.

     {
         return m_paintText.font();
     }

virtual Justification StaticDisplay::justification ( void )

inlinevirtual

Definition at line 56 of file staticdisplay.h.

References PaintText::justification(), and m_paintText.

     {
         return m_paintText.justification();
     }

virtual bool StaticDisplay::multiLine ( void )

inlinevirtual

Definition at line 66 of file staticdisplay.h.

References m_paintText, PaintText::MULTI_LINE, and PaintText::widthExceeded().

     {
         return m_paintText.widthExceeded() == PaintText::MULTI_LINE;
     }

bool StaticDisplay::processCommand	(	const EventCommandId &	command,
		Control *	control
	)

virtual

Reimplemented from EventResponder.

Definition at line 85 of file staticdisplay.cpp.

References m_scroller, m_scrollPosition, EventResponder::processCommand(), and Scroller::scrollPosition().

 {
     if (command == "Scroller::PositionChanged") {
         assert( control == m_scroller );
         m_scrollPosition = m_scroller->scrollPosition();
         return true;
     }
     return Control::processCommand( command, control );
 }

bool StaticDisplay::processMouseDown ( const InputEvent & event)

virtual

Reimplemented from EventResponder.

Reimplemented in TextInputDisplay.

Definition at line 96 of file staticdisplay.cpp.

References InputEvent::code, VegaConfig::getVariable(), Control::hitTest(), InputEvent::loc, m_scroller, XMLSupport::parse_int(), EventResponder::processMouseDown(), Scroller::scrollPosition(), Scroller::setScrollPosition(), vs_config, WHEELDOWN_MOUSE_BUTTON, and WHEELUP_MOUSE_BUTTON.

Referenced by TextInputDisplay::processMouseDown().

 {
     static int zoominc = XMLSupport::parse_int( vs_config->getVariable( "general", "wheel_increment_lines", "3" ) );
     if (m_scroller) {
         if (event.code == WHEELUP_MOUSE_BUTTON) {
             if ( hitTest( event.loc ) )
                 m_scroller->setScrollPosition( m_scroller->scrollPosition()-zoominc );
         } else if (event.code == WHEELDOWN_MOUSE_BUTTON) {
             if ( hitTest( event.loc ) )
                 m_scroller->setScrollPosition( m_scroller->scrollPosition()+zoominc );
         }
     }
     return Control::processMouseDown( event );
 }

virtual void StaticDisplay::setFont ( const Font & f)

inlinevirtual

Reimplemented from Control.

Definition at line 102 of file staticdisplay.h.

References m_paintText, and PaintText::setFont().

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), and BaseComputer::LoadSaveQuitConfirm::init().

     {
         m_paintText.setFont( f );
     }

virtual void StaticDisplay::setJustification ( Justification j)

inlinevirtual

Definition at line 60 of file staticdisplay.h.

References m_paintText, and PaintText::setJustification().

Referenced by BaseComputer::constructControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), and CreateControlsForYesNoWindow().

     {
         m_paintText.setJustification( j );
     }

virtual void StaticDisplay::setMultiLine ( bool multi)

inlinevirtual

Definition at line 70 of file staticdisplay.h.

References PaintText::ELLIPSIS, m_paintText, PaintText::MULTI_LINE, and PaintText::setWidthExceeded().

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), and BaseComputer::LoadSaveQuitConfirm::init().

     {
         m_paintText.setWidthExceeded( multi ? PaintText::MULTI_LINE : PaintText::ELLIPSIS );
     }

void StaticDisplay::setPaintTextRect ( void )

protected

Definition at line 39 of file staticdisplay.cpp.

References Rect::copyAndInset(), m_paintText, Control::m_rect, m_textMargins, and PaintText::setRect().

Referenced by setRect(), and setTextMargins().

 {
     const Rect textRect = m_rect.copyAndInset( m_textMargins );
     m_paintText.setRect( textRect );
 }

void StaticDisplay::setRect ( const Rect & r)

virtual

Reimplemented from Control.

Definition at line 53 of file staticdisplay.cpp.

References setPaintTextRect(), and Control::setRect().

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), and BaseComputer::LoadSaveQuitConfirm::init().

 {
     Control::setRect( r );
     setPaintTextRect();
 }

void StaticDisplay::setScroller ( Scroller * s)

virtual

Definition at line 78 of file staticdisplay.cpp.

References m_scroller, and EventResponder::setCommandTarget().

Referenced by NavComputer::constructControls(), and BaseComputer::constructControls().

 {
     m_scroller = s;
     s->setCommandTarget( this );
 }

virtual void StaticDisplay::setText ( std::string t)

inlinevirtual

Definition at line 50 of file staticdisplay.h.

References m_paintText, and PaintText::setText().

Referenced by BaseComputer::actionNewGame(), BaseComputer::configureCargoCommitControls(), NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), GameMenu::createNetworkControls(), TextInputDisplay::draw(), BaseComputer::hideCommitControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), QuestionDialog::init(), BaseComputer::LoadSaveQuitConfirm::init(), BaseComputer::loadLoadSaveControls(), BaseComputer::loadNewsControls(), NavComputer::loadPathLister(), BaseComputer::loadSavePickerChangedSelection(), BaseComputer::newsPickerChangedSelection(), NavComputer::recalcTitle(), BaseComputer::recalcTitle(), BaseComputer::showPlayerInfo(), BaseComputer::showShipStats(), NavComputer::updateDescription(), NavComputer::updateNodeDescription(), and BaseComputer::updateTransactionControlsForSelection().

     {
         m_paintText.setText( t );
     }

virtual void StaticDisplay::setTextColor ( const GFXColor & c)

inlinevirtual

Reimplemented from Control.

Definition at line 92 of file staticdisplay.h.

References m_paintText, and PaintText::setColor().

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), and BaseComputer::LoadSaveQuitConfirm::init().

     {
         m_paintText.setColor( c );
     }

void StaticDisplay::setTextMargins ( const Size & s)

virtual

Definition at line 46 of file staticdisplay.cpp.

References m_textMargins, and setPaintTextRect().

Referenced by NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createNetworkControls(), and NavComputer::RenameConfirm::init().

 {
     m_textMargins = s;
     setPaintTextRect();
 }

virtual std::string StaticDisplay::text ( void )

inlinevirtual

Definition at line 46 of file staticdisplay.h.

References m_paintText, and PaintText::text().

Referenced by NavComputer::actionAnd(), BaseComputer::actionConfirmedLoadGame(), BaseComputer::actionConfirmedSaveGame(), BaseComputer::actionLoadGame(), NavComputer::actionOr(), BaseComputer::actionSaveGame(), TextInputDisplay::draw(), and NavComputer::RenameConfirm::processWindowCommand().

     {
         return m_paintText.text();
     }

virtual GFXColor StaticDisplay::textColor ( void )

inlinevirtual

Reimplemented from Control.

Definition at line 88 of file staticdisplay.h.

References PaintText::color(), and m_paintText.

     {
         return m_paintText.color();
     }

virtual Size StaticDisplay::textMargins ( void )

inlinevirtual

Definition at line 76 of file staticdisplay.h.

References m_textMargins.

     {
         return m_textMargins;
     }

Member Data Documentation

int StaticDisplay::m_layoutVersion

protected

Definition at line 131 of file staticdisplay.h.

Referenced by draw().

PaintText StaticDisplay::m_paintText

protected

Definition at line 128 of file staticdisplay.h.

Referenced by draw(), font(), justification(), multiLine(), setFont(), setJustification(), setMultiLine(), setPaintTextRect(), setText(), setTextColor(), text(), and textColor().

Scroller* StaticDisplay::m_scroller

protected

Definition at line 132 of file staticdisplay.h.

Referenced by draw(), processCommand(), processMouseDown(), and setScroller().

int StaticDisplay::m_scrollPosition

protected

Definition at line 130 of file staticdisplay.h.

Referenced by draw(), and processCommand().

Size StaticDisplay::m_textMargins

protected

Definition at line 129 of file staticdisplay.h.

Referenced by setPaintTextRect(), setTextMargins(), and textMargins().

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

src/gui/staticdisplay.h
src/gui/staticdisplay.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation