DropDownList.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_DropDownList_h_
#define _GG_DropDownList_h_

#include <GG/ListBox.h>


namespace GG {

class GG_API DropDownList : public Control
{
public:
    typedef ListBox::Row Row;
 
    typedef boost::signal<void (int)>   SelChangedSignalType;   

 
    typedef SelChangedSignalType::slot_type   SelChangedSlotType;  

 

    DropDownList(int x, int y, int w, int h, int drop_ht, Clr color, Flags<WndFlag> flags = CLICKABLE);

    ~DropDownList(); 

 
    const Row*     CurrentItem() const;      
    int            CurrentItemIndex() const; 

    bool           Empty() const;            
    const Row&     GetItem(int n) const;     
    bool           Selected(int n) const;    
    Clr            InteriorColor() const;    

    int            DropHeight() const; 

    Flags<ListBoxStyle> Style() const;

    int            NumRows() const;          
    int            NumCols() const;          

    int            SortCol() const;

    int            ColWidth(int n) const;     
    Alignment      ColAlignment(int n) const; 
    Alignment      RowAlignment(int n) const; 

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

    mutable SelChangedSignalType SelChangedSignal; 

 
    virtual void   Render();
    virtual void   LClick(const Pt& pt, Flags<ModKey> mod_keys);
    virtual void   KeyPress(Key key, Flags<ModKey> mod_keys);

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

    virtual void   SetColor(Clr c);

    int            Insert(Row* row, int at = -1); 
    Row*           Erase(int idx);                
    void           Clear();                       
    Row&           GetRow(int n);                 

    void           Select(int row);               

    void           SetInteriorColor(Clr c);       
    void           SetDropHeight(int h);          

    void           SetStyle(Flags<ListBoxStyle> s);

    void           SetNumCols(int n);         
    void           SetSortCol(int n);         
    void           SetColWidth(int n, int w); 

    void           LockColWidths();

    void           UnLockColWidths();

    void           SetColAlignment(int n, Alignment align); 
    void           SetRowAlignment(int n, Alignment align); 

    virtual void   DefineAttributes(WndEditor* editor);

protected: 
    DropDownList(); 

 
    ListBox*       LB();                


private:
    int            m_current_item_idx;  
    ListBox*       m_LB;                

    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::DropDownList::serialize(Archive& ar, const unsigned int version)
{
    ar  & BOOST_SERIALIZATION_BASE_OBJECT_NVP(Control)
        & BOOST_SERIALIZATION_NVP(m_current_item_idx)
        & BOOST_SERIALIZATION_NVP(m_LB);
}

#endif // _GG_DropDownList_h_

---