boxx.h

   1 /*
   2     Copyright 2004-2005 Chris Tallon
   3
   4     This file is part of VOMP.
   5
   6     VOMP is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     VOMP is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with VOMP; if not, write to the Free Software
  18     Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  19 */
  20
  21 #ifndef BOXX_H
  22 #define BOXX_H
  23
  24 #include <stdio.h>
  25 #include <vector>
  26
  27 using namespace std;
  28
  29 #include "colour.h"
  30 #include "region.h"
  31 #include "message.h"
  32
  33 #ifdef WIN32
  34 #include "surfacewin.h"
  35 #else
  36 #include "surfacemvp.h"
  37 #endif
  38
  39 class Boxx
  40 {
  41   public:
  42     Boxx();
  43     virtual ~Boxx();
  44
  45     virtual void setSize(UINT w, UINT h);  // virtual? really?
  46     void setPosition(UINT x, UINT y); // Set position on parent. Even numbers only!!!
  47     void createBuffer(); // Make this a root view that goes in the BoxStack
  48     virtual void draw();
  49
  50
  51     void setGap(UINT gap);
  52     void setBackgroundColour(const Colour& colour);
  53     void setVisible(bool isVisible);
  54
  55
  56     // The following are supposed to be abstract functions
  57     // However, it is useful to be able to make instances of Boxx
  58     // Therefore the following stubs are provided.
  59     virtual void preDelete() {}
  60     virtual int handleCommand(int x) { return 0; }
  61     virtual void processMessage(Message* m) {}
  62     virtual bool mouseMove(int x, int y) { return false; }
  63     virtual bool mouseLBDOWN(int x, int y) { return false; }
  64     virtual void deactivateAllControls() {}
  65
  66     /* preDelete
  67
  68      I think it's functionally equivalent to e.g. delete timers in Boxx::preDelete
  69      because the only place where a Boxx is deleted is in
  70      BoxStack::remove. There is now a call in BoxStack::remove to Boxx::preDelete
  71      The reason for this is to stop timercalls calling BoxStack::update at the
  72      same time BoxStack::remove is locked trying to delete the Boxx
  73     */
  74
  75     // Get functions
  76     int getScreenX();        // where is it on screen
  77     int getScreenY();
  78     int getRootBoxOffsetX(); // where is it relative to the top-parent in the boxstack
  79     int getRootBoxOffsetY();
  80     int getX();              // where is it relative to its parent
  81     int getX2();             // .. and the right edge
  82     int getY();
  83     int getY2();
  84     UINT getWidth();
  85     UINT getHeight();
  86     bool getVisible();
  87     Region* getRegion();     // Not to be used for changing the region
  88     Region getRegionR();     // Same but as an object
  89     void getRootBoxRegion(Region*);
  90
  91     // Drawing functions level 1
  92     void fillColour(const Colour& colour);
  93     void drawPara(const char* text, int x, int y, const Colour& colour);
  94
  95     // Drawing functions level 0
  96     void rectangle(UINT x, UINT y, UINT w, UINT h, const Colour& colour);
  97     void rectangle(Region& region, const Colour& colour);
  98
  99     void drawText(const char* text, int x, int y, const Colour& colour);
 100     void drawText(const char* text, int x, int y, int width, const Colour& colour);
 101     void drawTextRJ(const char* text, int x, int y, const Colour& colour);
 102     void drawTextCentre(const char* text, int x, int y, const Colour& colour);
 103     void drawPixel(UINT x, UINT y, const Colour& colour);
 104
 105     /* This is for system which need a locking of the drawing surface to speed up drawing */
 106     void startFastDraw();
 107     void endFastDraw();
 108
 109     int charWidth(char c);
 110
 111     void add(Boxx*); // a boxx has a set of child boxxs
 112     void remove(Boxx*);
 113
 114     /*
 115     The following function sets the child's parent pointer without adding the child to the children vector.
 116     It's a hack (that should be deprecated?) to allow things like WSymbol to be created, do some drawing on
 117     the surface and then be deleted again, leaving the drawing present.
 118     A better design would be to create many WSymbols - one per symbol and leave them created - then the
 119     automatic draw code will be able to redraw the symbols without all that code needing
 120     to be in the derived boxx's draw method.
 121     */
 122     void TEMPADD(Boxx* child) { child->setParent(this); }
 123
 124   friend class BoxStack;
 125   protected:
 126     Boxx* parent;
 127     Region area;
 128     vector<Boxx*> children;
 129
 130     void setParent(Boxx*);
 131     void blt(Region& r);
 132
 133     static const int paraMargin = 10;
 134     UINT paraVSpace;
 135
 136     Colour backgroundColour;
 137     bool backgroundColourSet;
 138     bool visible;
 139
 140     static char numBoxxes;
 141     Surface* surface;
 142 };
 143
 144 #endif
 145
 146
 147 /*
 148
 149 New Boxx design
 150
 151 It's "Boxx" because "Box" was already taken.
 152
 153 BoxStack replaces Viewman and handles displaying a stack of root boxxs (boxxs with surfaces) on the screen.
 154
 155 Boxx relaces Box, Widget and parts of View and represents a box with or without a surface.
 156 Let's call a Boxx with a surface a root box, and a boxx without a surface a child box.
 157
 158 A boxx with a surface (root) is like an old View and is handled by BoxStack.
 159 A boxx without a surface (child) is like and old Widget and needs to be a child box of another boxx (root or not).
 160
 161 Don't add a boxx with a surface to another boxx. That isn't the design.
 162
 163 So, when you create a boxx, either that boxx calls createBuffer() on itself,
 164 or some other box add()s the new box to itself.
 165
 166 Root boxxs can overlap each other - this is managed by boxstack.
 167 Child boxxs within a parent boxx do not overlap each other.
 168 However, a grandchild box can overlap a child box (but must be entirely contained within the child box).
 169
 170 TBBoxx replaces View but is now only a convenience class for the window dressing stuff. It isn't required anymore since
 171 all the real work that view used to do is done in Boxx now.
 172
 173 Obseleted classes: Box, View, Viewman, Widget, others?
 174 No code outside boxx should talk about surfaces anymore. Hopefully.
 175
 176 */
 177