MultiEdit.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_MultiEdit_h_
#define _GG_MultiEdit_h_

#include <GG/Edit.h>


namespace GG {

class Scroll;

GG_FLAG_TYPE(MultiEditStyle);
extern GG_API const MultiEditStyle MULTI_NONE;             
extern GG_API const MultiEditStyle MULTI_WORDBREAK;        
extern GG_API const MultiEditStyle MULTI_LINEWRAP;         
extern GG_API const MultiEditStyle MULTI_VCENTER;          
extern GG_API const MultiEditStyle MULTI_TOP;              
extern GG_API const MultiEditStyle MULTI_BOTTOM;           
extern GG_API const MultiEditStyle MULTI_CENTER;           
extern GG_API const MultiEditStyle MULTI_LEFT;             
extern GG_API const MultiEditStyle MULTI_RIGHT;            
extern GG_API const MultiEditStyle MULTI_READ_ONLY;        
extern GG_API const MultiEditStyle MULTI_TERMINAL_STYLE;   
extern GG_API const MultiEditStyle MULTI_INTEGRAL_HEIGHT;  
extern GG_API const MultiEditStyle MULTI_NO_VSCROLL;       
extern GG_API const MultiEditStyle MULTI_NO_HSCROLL;       
extern GG_API const Flags<MultiEditStyle> MULTI_NO_SCROLL; 


class GG_API MultiEdit : public Edit
{
public: 
    MultiEdit(int x, int y, int w, int h, const std::string& str, const boost::shared_ptr<Font>& font, Clr color, 
              Flags<MultiEditStyle> style = MULTI_LINEWRAP, Clr text_color = CLR_BLACK, Clr interior = CLR_ZERO, 
              Flags<WndFlag> flags = CLICKABLE); 
    virtual ~MultiEdit(); 

 
    virtual Pt MinUsableSize() const;
    virtual Pt ClientLowerRight() const;

    Flags<MultiEditStyle> Style() const; 

    int MaxLinesOfHistory() const;
 
    virtual void   Render();
    virtual void   LButtonDown(const Pt& pt, Flags<ModKey> mod_keys);
    virtual void   LDrag(const Pt& pt, const Pt& move, Flags<ModKey> mod_keys);
    virtual void   MouseWheel(const Pt& pt, int move, Flags<ModKey> mod_keys);
    virtual void   KeyPress(Key key, Flags<ModKey> mod_keys);

    virtual void   SizeMove(const Pt& ul, const Pt& lr);

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

    void           SetStyle(Flags<MultiEditStyle> style); 

    void           SetMaxLinesOfHistory(int max);

    virtual void   DefineAttributes(WndEditor* editor);

protected: 
    MultiEdit(); 

 
    virtual bool MultiSelected() const;     
    int     RightMargin() const;            
    int     BottomMargin() const;           
    std::pair<int, int>
            CharAt(const Pt& pt) const;     
    std::pair<int, int>
            CharAt(int string_idx) const;   

    Pt      ScrollPosition() const;         

    int     StringIndexOf(int row, int char_idx, const std::vector<Font::LineData>* line_data = 0) const;

    int     RowStartX(int row) const;       
    int     CharXOffset(int row, int idx) const; 
    int     RowAt(int y) const;             
    int     CharAt(int row, int x) const;   
    int     FirstVisibleRow() const;        
    int     LastVisibleRow() const;         
    int     FirstFullyVisibleRow() const;   
    int     LastFullyVisibleRow() const;    
    int     FirstVisibleChar(int row) const;
    int     LastVisibleChar(int row) const; 
    std::pair<int, int>
            HighCursorPos() const;          
    std::pair<int, int>
            LowCursorPos() const;           

 
    void    RecreateScrolls();              

    void    PreserveTextPositionOnNextSetText();

    static const int SCROLL_WIDTH;          
    static const int BORDER_THICK;          

private:
    void    Init();
    void    ValidateStyle();
    void    ClearSelected();   
    void    AdjustView();      
    void    AdjustScrolls();   
    void    VScrolled(int upper, int lower, int range_upper, int range_lower);
    void    HScrolled(int upper, int lower, int range_upper, int range_lower);

    Flags<MultiEditStyle> m_style;

    std::pair<int, int>  m_cursor_begin; 
    std::pair<int, int>  m_cursor_end;   
                                         // if m_cursor_begin == m_cursor_end, the caret is draw at m_cursor_end

    Pt          m_contents_sz;          

    int         m_first_col_shown;      
    int         m_first_row_shown;      

    int         m_max_lines_history;

    Scroll*     m_vscroll;
    Scroll*     m_hscroll;

    bool        m_preserve_text_position_on_next_set_text;

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

} // namespace GG

// template implementations
template <class Archive>
void GG::MultiEdit::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_BASE_OBJECT_NVP(Edit)
        & BOOST_SERIALIZATION_NVP(m_style)
        & BOOST_SERIALIZATION_NVP(m_cursor_begin)
        & BOOST_SERIALIZATION_NVP(m_cursor_end)
        & BOOST_SERIALIZATION_NVP(m_contents_sz)
        & BOOST_SERIALIZATION_NVP(m_first_col_shown)
        & BOOST_SERIALIZATION_NVP(m_first_row_shown)
        & BOOST_SERIALIZATION_NVP(m_max_lines_history)
        & BOOST_SERIALIZATION_NVP(m_vscroll)
        & BOOST_SERIALIZATION_NVP(m_hscroll);

    if (Archive::is_loading::value)
        ValidateStyle();
}

#endif // _GG_MultiEdit_h_

---