BrowseInfoWnd.h

Go to the documentation of this file.

// -*- C++ -*-
/* GG is a GUI for SDL and OpenGL.
   Copyright (C) 2003 T. Zachary Laine

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public License
   as published by the Free Software Foundation; either version 2.1
   of the License, or (at your option) any later version.
   
   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Lesser General Public License for more details.
    
   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA

   If you do not wish to comply with the terms of the LGPL please
   contact the author as other terms are available for a fee.
    
   Zach Laine
   whatwasthataddress@hotmail.com */

#ifndef _GG_BrowseInfoWnd_h_
#define _GG_BrowseInfoWnd_h_

#include <GG/Wnd.h>
#include <GG/Font.h>

#include <boost/serialization/is_abstract.hpp>
#include <boost/serialization/version.hpp>


namespace GG {

class Font;
class TextControl;

class GG_API BrowseInfoWnd : public Wnd
{
public: 

    virtual bool WndHasBrowseInfo(const Wnd* wnd, int mode) const = 0;
 
    virtual void Render() = 0;

    void Update(int mode, const Wnd* target);

    void SetCursorPosition(const Pt& cursor_pos);

protected: 
    BrowseInfoWnd(); 
    BrowseInfoWnd(int x, int y, int w, int h); 


private:
    Pt m_cursor_pos;

    virtual void UpdateImpl(int mode, const Wnd* target);

    friend class boost::serialization::access;
    template <class Archive>
    void serialize(Archive& ar, const unsigned int version);
};


class GG_API TextBoxBrowseInfoWnd : public BrowseInfoWnd
{
public: 

    TextBoxBrowseInfoWnd(int w, const boost::shared_ptr<Font>& font, Clr color, Clr border_color, Clr text_color,
                         Flags<TextFormat> format = FORMAT_LEFT | FORMAT_WORDBREAK, int border_width = 2, int text_margin = 4);
 
    virtual bool                   WndHasBrowseInfo(const Wnd* wnd, int mode) const;

    bool                           TextFromTarget() const; 
    const std::string&             Text () const;          
    const boost::shared_ptr<Font>& GetFont() const;        
    Clr                            Color() const;          
    Clr                            BorderColor() const;    
    Clr                            TextColor() const;      
    Flags<TextFormat>              GetTextFormat() const;  
    int                            BorderWidth() const;    
    int                            TextMargin() const;     

 
    void         SetText (const std::string& str);
    virtual void Render();

    void SetTextFromTarget(bool b);                    
    void SetFont(const boost::shared_ptr<Font>& font); 
    void SetColor(Clr color);                          
    void SetBorderColor(Clr border_color);             
    void SetTextColor(Clr text_color);                 
    void SetTextFormat(Flags<TextFormat> format);      
    void SetBorderWidth(int border_width);             
    void SetTextMargin(int text_margin);               


protected: 
    TextBoxBrowseInfoWnd(); 


private:
    virtual void UpdateImpl(int mode, const Wnd* target);

    bool                    m_text_from_target;
    boost::shared_ptr<Font> m_font;
    Clr                     m_color;
    Clr                     m_border_color;
    int                     m_border_width;
    int                     m_preferred_width;
    TextControl*            m_text_control;

    friend class boost::serialization::access;
    template <class Archive>
    void serialize(Archive& ar, const unsigned int version);
};

} // namespace GG

BOOST_IS_ABSTRACT(GG::BrowseInfoWnd);
BOOST_CLASS_VERSION(GG::BrowseInfoWnd, 1);
BOOST_CLASS_VERSION(GG::TextBoxBrowseInfoWnd, 1);

// template implementations
template <class Archive>
void GG::BrowseInfoWnd::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_BASE_OBJECT_NVP(Wnd);
    if (1 <= version)
        ar & BOOST_SERIALIZATION_NVP(m_cursor_pos);
}

template <class Archive>
void GG::TextBoxBrowseInfoWnd::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_BASE_OBJECT_NVP(BrowseInfoWnd)
        & BOOST_SERIALIZATION_NVP(m_text_from_target)
        & BOOST_SERIALIZATION_NVP(m_font)
        & BOOST_SERIALIZATION_NVP(m_color)
        & BOOST_SERIALIZATION_NVP(m_border_color)
        & BOOST_SERIALIZATION_NVP(m_border_width)
        & BOOST_SERIALIZATION_NVP(m_text_control);
    if (1 <= version)
        ar & BOOST_SERIALIZATION_NVP(m_preferred_width);
}

#endif // _GG_BrowseInfoWnd_h_

---