Edit.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_Edit_h_
#define _GG_Edit_h_

#include <GG/TextControl.h>


namespace GG {

class GG_API Edit : public TextControl
{
public: 
    typedef boost::signal<void (const std::string&)> EditedSignalType; 
    typedef boost::signal<void (const std::string&)> FocusUpdateSignalType; 

 
    typedef EditedSignalType::slot_type       EditedSlotType;      
    typedef FocusUpdateSignalType::slot_type  FocusUpdateSlotType; 

 
    Edit(int x, int y, int w, const std::string& str, const boost::shared_ptr<Font>& font, Clr color, Clr text_color = CLR_BLACK, Clr interior = CLR_ZERO, Flags<WndFlag> flags = CLICKABLE); 

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

    const std::pair<int, int>&
                   CursorPosn() const;         
    Clr            InteriorColor() const;      
    Clr            HiliteColor() const;        
    Clr            SelectedTextColor() const;  

    mutable EditedSignalType      EditedSignal;       
    mutable FocusUpdateSignalType FocusUpdateSignal;  

 
    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   LClick(const Pt& pt, Flags<ModKey> mod_keys);
    virtual void   KeyPress(Key key, Flags<ModKey> mod_keys);
    virtual void   GainingFocus();
    virtual void   LosingFocus();

    virtual void   SetColor(Clr c);
    void           SetInteriorColor(Clr c);     
    void           SetHiliteColor(Clr c);       
    void           SetSelectedTextColor(Clr c); 

    virtual void   SelectRange(int from, int to);

    virtual void   SelectAll();

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

    virtual void   DefineAttributes(WndEditor* editor);
   
protected: 
    Edit(); 

 
    virtual bool            MultiSelected() const;          
    int                     FirstCharShown() const;         
    bool                    RecentlyEdited() const;         
    int                     CharIndexOf(int x) const;       
    int                     FirstCharOffset() const;        
    int                     ScreenPosOfChar(int idx) const; 
    int                     LastVisibleChar() const;        
    int                     LastButtonDownTime() const;     
    bool                    InDoubleButtonDownMode() const; 
    std::pair<int, int>     DoubleButtonDownCursorPos() const; 

 

    std::pair<int, int>     GetDoubleButtonDownWordIndices(int char_index);

    std::pair<int, int>     GetDoubleButtonDownDragWordIndices(int char_index);

    void                    ClearDoubleButtonDownMode();

    static const int PIXEL_MARGIN; 

private:
    void         ClearSelected();       
    void         AdjustView();          

    std::pair<int, int> m_cursor_pos;

    int                 m_first_char_shown; 
    Clr                 m_int_color;        
    Clr                 m_hilite_color;     
    Clr                 m_sel_text_color;   

    bool                m_recently_edited;  

    int                 m_last_button_down_time;
    bool                m_in_double_click_mode;
    std::pair<int, int> m_double_click_cursor_pos;

    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::Edit::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_BASE_OBJECT_NVP(TextControl)
        & BOOST_SERIALIZATION_NVP(m_cursor_pos)
        & BOOST_SERIALIZATION_NVP(m_first_char_shown)
        & BOOST_SERIALIZATION_NVP(m_int_color)
        & BOOST_SERIALIZATION_NVP(m_hilite_color)
        & BOOST_SERIALIZATION_NVP(m_sel_text_color);
}

#endif // _GG_Edit_h_

---