summaryrefslogtreecommitdiff
path: root/src/gui/widgets/dropdown.h
blob: 1e6dc821aa4637b9897985499eb69cdc4a7b77a6 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*
 *  The Mana World
 *  Copyright (C) 2006  The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  This program 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 2 of the License, or
 *  any later version.
 *
 *  This program 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 this program; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef DROPDOWN_H
#define DROPDOWN_H

#include <guichan/widgets/dropdown.hpp>

class Image;
class ImageRect;

    /**
     * A drop down box from which you can select different values. It is one of
     * the most complicated Widgets you will find in Guichan. For drawing the
     * DroppedDown box it uses one ScrollArea and one ListBox. It also uses an
     * internal FocusHandler to handle the focus of the internal ScollArea and
     * ListBox. DropDown uses a ListModel to handle the list. To be able to use
     * DropDown you must give DropDown an implemented ListModel which represents
     * your list.
     */
class DropDown : public gcn::DropDown
{
    public:
        /**
         * Contructor.
         *
         * @param listModel the ListModel to use.
         * @param scrollArea the ScrollArea to use.
         * @param listBox the listBox to use.
         * @see ListModel, ScrollArea, ListBox.
         */
        DropDown(gcn::ListModel *listModel = NULL,
                 gcn::ScrollArea *scrollArea = NULL,
                 gcn::ListBox *listBox = NULL,
                 bool opacity = true);

        /**
         * Destructor.
         */
        ~DropDown();

        void draw(gcn::Graphics* graphics);

        void drawFrame(gcn::Graphics* graphics);

        /**
         * Sets the widget to be opaque, that is sets the widget to display its
         * background.
         *
         * @param opaque True if the widget should be opaque, false otherwise.
         */
        void setOpaque(bool opaque) {mOpaque = opaque;}

        /**
         * Checks if the widget is opaque, that is if the widget area displays
         * its background.
         *
         * @return True if the widget is opaque, false otherwise.
         */
        bool isOpaque() const {return mOpaque;}


    protected:
        /**
         * Draws the button with the little down arrow.
         *
         * @param graphics a Graphics object to draw with.
         */
        void drawButton(gcn::Graphics *graphics);

        // Add own Images.
        static int instances;
        static Image *buttons[2][2];
        static ImageRect skin;
        static float mAlpha;

        bool mOpaque;
};

#endif // end DROPDOWN_H