listbox.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ENGINES_NWN_GUI_WIDGETS_LISTBOX_H
#define ENGINES_NWN_GUI_WIDGETS_LISTBOX_H

#include <vector>

#include "src/common/types.h"
#include "src/common/scopedptr.h"

#include "src/graphics/aurora/types.h"

#include "src/engines/nwn/gui/widgets/modelwidget.h"

namespace Common {
    class UString;
}

namespace Engines {

class GUI;

namespace NWN {

class WidgetButton;
class WidgetScrollbar;

class WidgetListItem : public NWNWidget {
public:
    WidgetListItem(::Engines::GUI &gui);
    ~WidgetListItem();

    bool operator<(const WidgetListItem &item) const;
    void mouseUp   (uint8 state, float x, float y);
    void mouseWheel(uint8 state, int x, int y);

    void mouseDblClick(uint8 state, float x, float y);

    void select();

    size_t getItemNumber() const;

protected:
    bool getState();

    virtual bool activate();
    virtual bool deactivate();

    void signalGroupMemberActive();

private:
    size_t _itemNumber;
    bool _state;

    friend class WidgetListBox;
};

class WidgetListItemTextLine : public WidgetListItem {
public:
    WidgetListItemTextLine(::Engines::GUI &gui, const Common::UString &font,
                           const Common::UString &text, float spacing = 0.0f);
    ~WidgetListItemTextLine();

    void show();
    void hide();

    void setPosition(float x, float y, float z);

    void setUnselectedColor(float r, float g, float b, float a);
    void setSelectedColor(float r, float g, float b, float a);

    float getWidth () const;
    float getHeight() const;

    void setTag(const Common::UString &tag);

protected:
    bool activate();
    bool deactivate();

private:
    Common::ScopedPtr<Graphics::Aurora::Text> _text;

    float _uR, _uG, _uB, _uA;
    float _sR, _sG, _sB, _sA;

    float _fontHeight;
    float _spacing;
};

class WidgetListBox : public ModelWidget {
public:
    enum Mode {
        kModeStatic     = 0,
        kModeSelectable
    };

    WidgetListBox(::Engines::GUI &gui, const Common::UString &tag,
                  const Common::UString &model);
    ~WidgetListBox();

    Mode getMode() const;
    void setMode(Mode mode);

    void show();
    void hide();

    void setPosition(float x, float y, float z);

    float getContentWidth () const;
    float getContentHeight() const;

    void lock();
    void clear();
    void reserve(size_t n);
    void add(WidgetListItem *item, bool noTag = false);
    void remove(WidgetListItem *item);
    void unlock();
    void sortByTag();

    void setText(const Common::UString &font, const Common::UString &text,
                 float spacing = 0.0f);

    void select(size_t item);
    size_t getSelected() const;
    WidgetListItem *getSelectedItem() const;
    void deselect();

    void setStartItem(size_t firstItem);
    size_t getStartItem() const;

    std::vector<WidgetListItem *>::iterator begin();
    std::vector<WidgetListItem *>::iterator end();

    bool wasDblClicked();

    void mouseDown(uint8 state, float x, float y);
    void mouseWheel(uint8 state, int x, int y);

    void subActive(Widget &widget);

protected:
    virtual void updateScrollbarLength();
    virtual void updateScrollbarPosition();

    virtual void scrollUp(size_t n);
    virtual void scrollDown(size_t n);

    virtual void updateVisible();

    float _contentX;
    float _contentY;
    float _contentZ;

    float _contentWidth;
    float _contentHeight;

    std::vector<WidgetListItem *> _items;
    std::vector<WidgetListItem *> _visibleItems;

    size_t _startItem;
    size_t _selectedItem;
    WidgetButton    *_up;
    WidgetButton    *_down;
    WidgetScrollbar *_scrollbar;

    bool _locked;

private:
    Mode _mode;

    bool _hasScrollbar;
    bool _dblClicked;

    void getProperties();
    void createScrollbar();
    void itemDblClicked();

    friend class WidgetListItem;
};

} // End of namespace NWN

} // End of namespace Engines

#endif // ENGINES_NWN_GUI_WIDGETS_LISTBOX_H