Vegastrike 0.5.1 rc1  1.0
Original sources for Vegastrike Evolved
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Control Class Referenceabstract

#include <control.h>

Inheritance diagram for Control:
EventResponder GroupControl NewButton Picker Slider StaticDisplay StaticImageDisplay Scroller ScrollerButton SimplePicker TextInputDisplay

Public Member Functions

virtual Rect rect (void)
 
virtual void setRect (const Rect &r)
 
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 GFXColor textColor (void)
 
virtual void setTextColor (const GFXColor &c)
 
virtual Font font (void)
 
virtual void setFont (const Font &f)
 
virtual bool hasGroupChildren (void)
 
virtual void draw (void)=0
 
 Control (void)
 
virtual ~Control (void)
 
- Public Member Functions inherited from EventResponder
virtual bool processCommand (const EventCommandId &command, Control *control)
 
virtual bool processKeyDown (const InputEvent &event)
 
virtual bool processKeyUp (const InputEvent &event)
 
virtual bool processMouseDown (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

virtual void drawBackground (void)
 

Protected Attributes

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 34 of file control.h.

Constructor & Destructor Documentation

Control::Control ( void  )

Definition at line 48 of file control.cpp.

48  :
49  m_rect( 0.0, 0.0, 0.0, 0.0 )
50  , m_id()
51  , m_color( GUI_OPAQUE_WHITE() )
52  , m_outlineColor( GUI_CLEAR )
53  , m_textColor( GUI_OPAQUE_BLACK() )
54  , m_font( 0.1 )
55  , m_hidden( false )
56 {}
virtual Control::~Control ( void  )
inlinevirtual

Definition at line 125 of file control.h.

125 {}

Member Function Documentation

virtual GFXColor Control::color ( void  )
inlinevirtual

Definition at line 74 of file control.h.

References m_color.

Referenced by Scroller::createControls(), NewButton::draw(), and Slider::setThumbColor().

75  {
76  return m_color;
77  }
virtual void Control::draw ( void  )
pure virtual

Implemented in NewButton, StaticImageDisplay, ScrollerButton, Picker, GroupControl, Slider, Scroller, TextInputDisplay, and StaticDisplay.

Referenced by GroupControl::draw().

void Control::drawBackground ( void  )
protectedvirtual

Definition at line 39 of file control.cpp.

References DEFAULT_OUTLINE_LINE_WIDTH, drawRect(), drawRectOutline(), isClear(), m_color, m_outlineColor, and m_rect.

Referenced by StaticDisplay::draw(), Scroller::draw(), Slider::draw(), and Picker::draw().

40 {
41  if ( !isClear( m_color ) )
42  drawRect( m_rect, m_color );
43  if ( !isClear( m_outlineColor ) )
44  drawRectOutline( m_rect, m_outlineColor, DEFAULT_OUTLINE_LINE_WIDTH );
45 }
virtual Font Control::font ( void  )
inlinevirtual

Reimplemented in StaticDisplay.

Definition at line 104 of file control.h.

References m_font.

Referenced by NewButton::draw().

105  {
106  return m_font;
107  }
virtual bool Control::hasGroupChildren ( void  )
inlinevirtual

Reimplemented in GroupControl.

Definition at line 114 of file control.h.

Referenced by GroupControl::deleteControl(), GroupControl::findControlById(), GroupControl::processMouseDown(), GroupControl::processMouseDrag(), GroupControl::processMouseMove(), GroupControl::processMouseUp(), and GroupControl::removeControlFromGroup().

115  {
116  return false;
117  }
virtual bool Control::hidden ( void  )
inlinevirtual

Definition at line 52 of file control.h.

References m_hidden.

Referenced by GroupControl::draw(), GroupControl::processMouseDown(), GroupControl::processMouseDrag(), GroupControl::processMouseMove(), GroupControl::processMouseUp(), and GameMenu::readJoinGameControls().

53  {
54  return m_hidden;
55  }
bool Control::hitTest ( const Point &  p)
virtual

Definition at line 30 of file control.cpp.

References Size::height, m_rect, Rect::origin, Rect::size, Size::width, Point::x, and Point::y.

Referenced by TextInputDisplay::processMouseDown(), Slider::processMouseDown(), GroupControl::processMouseDown(), StaticDisplay::processMouseDown(), Picker::processMouseDown(), GroupControl::processMouseDrag(), GroupControl::processMouseMove(), Slider::processMouseUp(), GroupControl::processMouseUp(), and NewButton::processMouseUp().

31 {
32  const float maxX = m_rect.origin.x+m_rect.size.width;
33  const float maxY = m_rect.origin.y+m_rect.size.height;
34 
35  return p.x >= m_rect.origin.x && p.x < maxX && p.y >= m_rect.origin.y && p.y < maxY;
36 }
virtual const std::string& Control::id ( void  )
inlinevirtual

Definition at line 63 of file control.h.

References m_id.

Referenced by GroupControl::findControlById(), NavComputer::processWindowCommand(), WctlBase< BaseComputer >::processWindowCommand(), and NewButton::setCommand().

64  {
65  return m_id;
66  }
virtual GFXColor Control::outlineColor ( void  )
inlinevirtual

Definition at line 84 of file control.h.

References m_outlineColor.

85  {
86  return m_outlineColor;
87  }
virtual Rect Control::rect ( void  )
inlinevirtual

Definition at line 39 of file control.h.

References m_rect.

Referenced by Scroller::calcLayout(), BaseComputer::createModeButtons(), and Picker::draw().

40  {
41  return m_rect;
42  }
virtual void Control::setColor ( const GFXColor &  c)
inlinevirtual

Reimplemented in Scroller, and Slider.

Definition at line 78 of file control.h.

References c, and m_color.

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

79  {
80  m_color = c;
81  }
virtual void Control::setFont ( const Font &  f)
inlinevirtual

Reimplemented in StaticDisplay.

Definition at line 108 of file control.h.

References m_font.

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

109  {
110  m_font = f;
111  }
virtual void Control::setHidden ( bool  h = true)
inlinevirtual

Definition at line 56 of file control.h.

References h, and m_hidden.

Referenced by BaseComputer::actionShowAccountMenu(), BaseComputer::actionShowServerMenu(), BaseComputer::configureCargoCommitControls(), BaseComputer::configureUpgradeCommitControls(), BaseComputer::constructControls(), GameMenu::createControls(), BaseComputer::createModeButtons(), GameMenu::createNetworkControls(), BaseComputer::hideCommitControls(), GameMenu::processMainMenuButton(), GameMenu::processMultiPlayerAcctButton(), GameMenu::processMultiPlayerButton(), GameMenu::processMultiPlayerHostButton(), BaseComputer::showNetworkStatus(), UniverseUtil::startMenuInterface(), and BaseComputer::updateTransactionControlsForSelection().

57  {
58  m_hidden = h;
59  }
virtual void Control::setId ( const std::string &  newId)
inlinevirtual

Definition at line 67 of file control.h.

References m_id.

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

68  {
69  m_id = newId;
70  }
virtual void Control::setOutlineColor ( const GFXColor &  c)
inlinevirtual

Definition at line 88 of file control.h.

References c, and m_outlineColor.

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

89  {
90  m_outlineColor = c;
91  }
virtual void Control::setRect ( const Rect &  r)
inlinevirtual

Reimplemented in StaticDisplay, Slider, and Scroller.

Definition at line 43 of file control.h.

References m_rect.

Referenced by Scroller::calcLayout(), NavComputer::constructControls(), BaseComputer::constructControls(), GameMenu::createControls(), CreateControlsForAlertWindow(), ListQuestionDialog::CreateControlsForListWindow(), CreateControlsForYesNoWindow(), BaseComputer::createModeButtons(), GameMenu::createNetworkControls(), NetActionConfirm::init(), NavComputer::RenameConfirm::init(), BaseComputer::LoadSaveQuitConfirm::init(), Scroller::setRect(), Slider::setRect(), and StaticDisplay::setRect().

44  {
45  m_rect = r;
46  }
virtual void Control::setTextColor ( const GFXColor &  c)
inlinevirtual

Reimplemented in StaticDisplay, and Scroller.

Definition at line 98 of file control.h.

References c, and m_textColor.

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

99  {
100  m_textColor = c;
101  }
virtual GFXColor Control::textColor ( void  )
inlinevirtual

Reimplemented in StaticDisplay.

Definition at line 94 of file control.h.

References m_textColor.

Referenced by Scroller::createControls(), Picker::draw(), ScrollerButton::draw(), and NewButton::draw().

95  {
96  return m_textColor;
97  }

Member Data Documentation

GFXColor Control::m_color
protected

Definition at line 137 of file control.h.

Referenced by color(), drawBackground(), and setColor().

Font Control::m_font
protected

Definition at line 140 of file control.h.

Referenced by Picker::draw(), font(), setFont(), and Picker::totalCellHeight().

bool Control::m_hidden
protected

Definition at line 141 of file control.h.

Referenced by hidden(), and setHidden().

std::string Control::m_id
protected

Definition at line 136 of file control.h.

Referenced by id(), and setId().

GFXColor Control::m_outlineColor
protected

Definition at line 138 of file control.h.

Referenced by drawBackground(), outlineColor(), and setOutlineColor().

Rect Control::m_rect
protected

Definition at line 135 of file control.h.

Referenced by Scroller::calcLayout(), Picker::cellForMouse(), StaticDisplay::draw(), Slider::draw(), Picker::draw(), ScrollerButton::draw(), StaticImageDisplay::draw(), NewButton::draw(), drawBackground(), NewButton::drawCycleBorder(), hitTest(), Slider::processMouseDrag(), Picker::recalcDisplay(), rect(), Picker::scrollToCell(), StaticDisplay::setPaintTextRect(), setRect(), Scroller::setRect(), Slider::setRect(), and Slider::setThumbLength().

GFXColor Control::m_textColor
protected

Definition at line 139 of file control.h.

Referenced by Picker::draw(), setTextColor(), and textColor().

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