---

listbox_generic.h

Go to the documentation of this file.

/*
        ClanGUI, copyrights by various people. Have a look in the CREDITS file.
        
        This sourcecode is distributed using the Library GNU Public Licence,
        version 2 or (at your option) any later version. Please read LICENSE
        for details.
*/

#ifndef header_listbox_generic
#define header_listbox_generic

#include <string>
#include <list>

#include <API/Display/Input/key.h>
#include <API/Display/Input/inputdevice.h>
#include <API/Core/Math/rect.h>
#include <API/signals.h>

class CL_ListBox;
class CL_ScrollBar;
class CL_Component;
class CL_ComponentOptions;
class CL_StyleManager;

class CL_ListBox_Generic
{
// Construction:
public:
        static CL_ComponentOptions create_options(
                const CL_Rect &pos);

        CL_ListBox_Generic(CL_ListBox *self, const CL_ComponentOptions &options, CL_StyleManager *style);
        ~CL_ListBox_Generic() {};

// Attributes:
public:
        int get_count() const;

        std::list<std::string> &get_items();
        std::string get_text(int index) const;
        std::string get_current_text() const;
        int get_current_item() const;
        bool is_selected(int index) const;

        int get_item_height() const;
        int get_top_item() const;

        int max_visible_items;

        CL_Component *client_area;

// Operations:
public:
        int insert_item(const std::string &text, int index);
        void remove_item(int index);
        void change_item(const std::string &text, int index);

        void set_current_item(int index);
        void clear_selection();

        void set_item_height(int height);
        void set_max_visible_items(int count);
        void set_top_item(int index);

        void sort(bool ascending);

        void clear();

// Signals:
public:
        CL_Signal_v1<int> sig_highlighted;
        CL_Signal_v1<int> sig_activated;

// Slots:
private:
        CL_Slot slot_on_key_down;
        CL_Slot slot_on_scroll_change;
        CL_Slot slot_child_add, slot_child_remove;

// Callbacks:
private:
        void on_key_down(CL_Component *comp, CL_InputDevice *device, CL_Key key);
        void on_scroll_change(int new_offset);
        void on_child_add(CL_Component *child);
        void on_child_remove(CL_Component *child);

// Implementation:
protected:
        void update_scrollbar();

        int highlighted_item;
        int item_height;
        int scroll_offset;

        bool has_scrollbar;

        CL_ListBox *listbox;
        CL_ScrollBar *scrollbar;

        std::list<std::string> items;
};

#endif

---