InfoBox Class Reference

This class is displaying a box with information text inside the game. More...

#include <info_box.hpp>

List of all members.

Public Member Functions
	InfoBox (const std::string &text)
	~InfoBox ()
void	draw (DrawingContext &context)
void	scrolldown ()
void	scrollup ()
void	pagedown ()
void	pageup ()
Private Member Functions
	InfoBox (const InfoBox &)
InfoBox &	operator= (const InfoBox &)
Private Attributes
size_t	firstline
std::vector< InfoBoxLine * >	lines
std::map< std::string, Surface * >	images
SurfacePtr	arrow_scrollup
SurfacePtr	arrow_scrolldown

---

Detailed Description

This class is displaying a box with information text inside the game.

Definition at line 31 of file info_box.hpp.

---

Constructor & Destructor Documentation

InfoBox::InfoBox

(

const std::string &

text

)

Definition at line 25 of file info_box.cpp.

References arrow_scrolldown, arrow_scrollup, Surface::create(), lines, log_warning, and InfoBoxLine::split().

                                      :
  firstline(0),
  lines(),
  images(),
  arrow_scrollup(),
  arrow_scrolldown()
{
  // Split text string lines into a vector
  lines = InfoBoxLine::split(text, 400);

  try
  {
    // get the arrow sprites
    arrow_scrollup   = Surface::create("images/engine/menu/scroll-up.png");
    arrow_scrolldown = Surface::create("images/engine/menu/scroll-down.png");
  }
  catch (std::exception& e)
  {
    log_warning << "Could not load scrolling images: " << e.what() << std::endl;
    arrow_scrollup.reset();
    arrow_scrolldown.reset();
  }
}

InfoBox::~InfoBox

(

)

Definition at line 49 of file info_box.cpp.

References lines.

{
  for(std::vector<InfoBoxLine*>::iterator i = lines.begin();
      i != lines.end(); i++)
    delete *i;
}

InfoBox::InfoBox

(

const InfoBox &

)

[private]

---

Member Function Documentation

void InfoBox::draw

(

DrawingContext &

context

)

Definition at line 57 of file info_box.cpp.

References arrow_scrolldown, arrow_scrollup, DrawingContext::draw_filled_rect(), DrawingContext::draw_surface(), firstline, LAYER_GUI, lines, SCREEN_HEIGHT, and SCREEN_WIDTH.

{
  float x1 = SCREEN_WIDTH/2-200;
  float y1 = SCREEN_HEIGHT/2-200;
  float width = 400;
  float height = 200;

  context.draw_filled_rect(Vector(x1, y1), Vector(width, height),
                           Color(0.6f, 0.7f, 0.8f, 0.5f), LAYER_GUI-1);

  float y = y1;
  bool linesLeft = false;
  for(size_t i = firstline; i < lines.size(); ++i) {
    if(y >= y1 + height) {
      linesLeft = true;
      break;
    }

    lines[i]->draw(context, Rectf(x1, y, x1+width, y), LAYER_GUI);
    y += lines[i]->get_height();
  }

  {
    // draw the scrolling arrows
    if (arrow_scrollup.get() && firstline > 0)
      context.draw_surface(arrow_scrollup,
                           Vector( x1 + width  - arrow_scrollup->get_width(),  // top-right corner of box
                                   y1), LAYER_GUI);

    if (arrow_scrolldown.get() && linesLeft && firstline < lines.size()-1)
      context.draw_surface(arrow_scrolldown,
                           Vector( x1 + width  - arrow_scrolldown->get_width(),  // bottom-light corner of box
                                   y1 + height - arrow_scrolldown->get_height()),
                           LAYER_GUI);
  }
}

void InfoBox::scrolldown

(

)

Definition at line 102 of file info_box.cpp.

References firstline, and lines.

{
  if(firstline < lines.size()-1)
    firstline++;
}

void InfoBox::scrollup

(

)

Definition at line 95 of file info_box.cpp.

References firstline.

{
  if(firstline > 0)
    firstline--;
}

void InfoBox::pagedown

(

)

Definition at line 114 of file info_box.cpp.

{
}

void InfoBox::pageup

(

)

Definition at line 109 of file info_box.cpp.

{
}

InfoBox& InfoBox::operator=

(

const InfoBox &

)

[private]

---

Member Data Documentation

size_t InfoBox::firstline [private]

Definition at line 44 of file info_box.hpp.

Referenced by draw(), scrolldown(), and scrollup().

std::vector<InfoBoxLine*> InfoBox::lines [private]

Definition at line 45 of file info_box.hpp.

Referenced by draw(), InfoBox(), scrolldown(), and ~InfoBox().

std::map<std::string, Surface*> InfoBox::images [private]

Definition at line 46 of file info_box.hpp.

SurfacePtr InfoBox::arrow_scrollup [private]

Definition at line 47 of file info_box.hpp.

Referenced by draw(), and InfoBox().

SurfacePtr InfoBox::arrow_scrolldown [private]

Definition at line 48 of file info_box.hpp.

Referenced by draw(), and InfoBox().

---

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

• src/supertux/info_box.hpp
• src/supertux/info_box.cpp

---