textbox.h

Go to the documentation of this file.

//            Copyright (C) 2004-2007 by The Allacrost Project
//                         All Rights Reserved
//
// This code is licensed under the GNU GPL version 2. It is free software
// and you may modify it and/or redistribute it under the terms of this license.
// See http://www.gnu.org/copyleft/gpl.html for details.

#ifndef __TEXTBOX_HEADER__
#define __TEXTBOX_HEADER__

#include "defs.h"
#include "utils.h"
#include "gui.h"

namespace hoa_video {

namespace private_video {

const uint16 NEWLINE_CHARACTER = static_cast<uint16>('\n');

const uint32 CHARS_PER_LINE = 30;

} // namespace private_video

enum TEXT_DISPLAY_MODE {
  VIDEO_TEXT_INSTANT    = 0,
  VIDEO_TEXT_CHAR       = 1,
  VIDEO_TEXT_FADELINE   = 2,
  VIDEO_TEXT_FADECHAR   = 3,
  VIDEO_TEXT_REVEAL     = 4,
  VIDEO_TEXT_TOTAL      = 5
};


class TextBox : public private_video::GUIControl {
public:
  TextBox();
  
  TextBox(float x, float y, float width, float height, const TEXT_DISPLAY_MODE &mode = VIDEO_TEXT_INSTANT);

  ~TextBox();

  void ClearText();

  void Update(uint32 frame_time);

  void Draw();

  void ForceFinish()
    { if (_text.empty() == true) return; _finished = true; }

  void SetDimensions(float w, float h);

  void SetTextAlignment(int32 xalign, int32 yalign);

  void SetFont(const std::string &font_name);

  void SetDisplayMode(const TEXT_DISPLAY_MODE &mode);

  void SetDisplaySpeed(float display_speed);

  void SetDisplayText(const hoa_utils::ustring& text);

  void SetDisplayText(const std::string& text);

  void GetDimensions(float& w, float& h)
    { w = _width; h = _height; }

  void GetTextAlignment(int32& xalign, int32& yalign)
    { xalign = _text_xalign; yalign = _text_yalign; }

  std::string GetFont() const
    { return _font; }

  TEXT_DISPLAY_MODE GetDisplayMode() const
    { return _mode; }

  float GetDisplaySpeed() const
    { return _display_speed; }

  void GetText(std::vector<hoa_utils::ustring>& text) const
    { text = _text; }

  bool IsFinished() const
    { return _finished; }

  bool IsEmpty() const
    { return _text.empty(); }

  bool IsInitialized(std::string& errors);


  void SetTextColor(Color &color)
    { _text_color = color; }

private:
  float _width, _height;

  float _display_speed;

  int32 _text_xalign, _text_yalign;

  uint32 _num_chars;

  bool _finished;

  uint32 _current_time;

  uint32 _end_time;

  std::string _font;

  FontProperties* _font_properties;

  TEXT_DISPLAY_MODE _mode;

  std::vector<hoa_utils::ustring> _text;

  hoa_utils::ustring _text_save;
  
  Color _text_color;

  int32 _CalculateTextHeight();

  bool _IsBreakableChar(uint16 character);

  void _AddLine(const hoa_utils::ustring &line);

  void _DrawTextLines(float text_x, float text_y, ScreenRect scissor_rect);

  void _ReformatText();

}; // class TextBox : public GUIControl

} // namespace hoa_video

#endif  // __TEXTBOX_HEADER__

---