summaryrefslogtreecommitdiff
path: root/src/gui/window.h
blob: c78de2f42daf6b3acc10e3061b477c8ef24fb079 (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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
 *  The Mana World
 *  Copyright 2004 The Mana World Development Team
 *
 *  This file is part of The Mana World.
 *
 *  The Mana World 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.
 *
 *  The Mana World 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 The Mana World; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  $Id$
 */

#ifndef _TMW_WINDOW_H__
#define _TMW_WINDOW_H__

#include <iostream>
#include <guichan.hpp>
#include "windowcontainer.h"
#include "../resources/image.h"

/**
 * A window. This window can be dragged around and has a title bar.
 *
 * \ingroup GUI
 */
class Window : public gcn::Container, public gcn::MouseListener
{
    protected:
        gcn::Container *chrome;    /**< Contained container */
        Window *parent;            /**< The parent window */
        std::string caption;       /**< Title bar caption */
        int z;                     /**< Z position of the window */
        int mousePX;               /**< Mouse down location */
        int mousePY;               /**< Mouse down location */
        int snapSize;              /**< Snap distance to window edge */
        bool mouseDown;            /**< Mouse button state */
        bool modal;                /**< Window is modal */
        gcn::Color titlebarColor;  /**< Title bar color */
        int titlebarHeight;        /**< Height of title bar */
        int padding;               /**< Space between contents and border */

        Image *dBackground;        /**< Left side of title bar */
        Image *dBorders;           /**< Middle of title bar */
        Image *dUpperBorder;       /**< Upper border */
        Image *dLowerBorder;       /**< Lower Border */
        Image *dLeftBorder;        /**< Left Border */
        Image *dRightBorder;       /**< Right Border */

        /** The window container windows add themselves to. */
        static WindowContainer* windowContainer;

    public:
        /**
         * Constructor. Initializes the title to the given text and hooks
         * itself into the window container.
         *
         * @param text   The initial window title, "Window" by default.
         * @param modal  Block input to other windows.
         * @param parent The parent window. This is the window standing above
         *               this one in the window hiearchy. When reordering,
         *               a window will never go below its parent window.
         */
        Window(const std::string& text = "Window", bool modal = false,
                Window *parent = NULL);

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

        /**
         * Sets the window container to be used by new windows.
         */
        static void setWindowContainer(WindowContainer *windowContainer);

        /**
         * Draws the window.
         */
        void draw(gcn::Graphics *graphics);

        /**
         * Adds a widget to the window.
         */
        void add(gcn::Widget *w);

        /**
         * Adds a widget to the window and also specifices its position.
         */
        void add(gcn::Widget *w, int x, int y);

        /**
         * Sets the title of the window.
         */
        void setTitle(const std::string& text);

        /**
         * Sets the dimension of the window contents.
         */
        void setDimension(const gcn::Rectangle& dimension);

        /**
         * Sets the width of the window contents.
         */
        void setWidth(int width);

        /**
         * Sets the height of the window contents.
         */
        void setHeight(int height);

        /**
         * Sets the location relative to the given widget.
         */
        void setLocationRelativeTo(gcn::Widget* widget);

        /**
         * Sets the size of this window.
         */
        void setSize(int width, int height);

        /**
         * Returns the parent window.
         *
         * @return The parent window or <code>NULL</code> if there is none.
         */
        Window *getParentWindow();

        /**
         * Returns wether this window is modal. This doesn't necessarily mean
         * that is gets input as a child modal window could get it.
         */
        bool isModal();

        // Mouse handling

        void mousePress(int mx, int my, int button);
        void mouseRelease(int mx, int my, int button);
        void mouseMotion(int mx, int my);
        void mouseOut();

        void _mouseInputMessage(const gcn::MouseInput &mouseInput);
};

#endif