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 Bitmap;
  40
  41 class Boxx
  42 {
  43   public:
  44     Boxx();
  45     virtual ~Boxx();
  46
  47     virtual void setSize(UINT w, UINT h);  // virtual? really?
  48     void setPosition(UINT x, UINT y); // Set position on parent. Even numbers only!!!
  49     void createBuffer(); // Make this a root view that goes in the BoxStack
  50     virtual void draw();
  51
  52
  53     void setGap(UINT gap);
  54     void setBackgroundColour(const Colour& colour);
  55     void setVisible(bool isVisible);
  56
  57
  58     // The following are supposed to be abstract functions
  59     // However, it is useful to be able to make instances of Boxx
  60     // Therefore the following stubs are provided.
  61     virtual void preDelete() {}
  62     virtual int handleCommand(int x) { return 0; }
  63     virtual void processMessage(Message* m) {}
  64     virtual bool mouseMove(int x, int y) { return false; }
  65     virtual bool mouseLBDOWN(int x, int y) { return false; }
  66     virtual void deactivateAllControls() {}
  67
  68     /* preDelete
  69
  70      I think it's functionally equivalent to e.g. delete timers in Boxx::preDelete
  71      because the only place where a Boxx is deleted is in
  72      BoxStack::remove. There is now a call in BoxStack::remove to Boxx::preDelete
  73      The reason for this is to stop timercalls calling BoxStack::update at the
  74      same time BoxStack::remove is locked trying to delete the Boxx
  75     */
  76
  77     // Get functions
  78     int getScreenX();        // where is it on screen
  79     int getScreenY();
  80     int getRootBoxOffsetX(); // where is it relative to the top-parent in the boxstack
  81     int getRootBoxOffsetY();
  82     int getX();              // where is it relative to its parent
  83     int getX2();             // .. and the right edge
  84     int getY();
  85     int getY2();
  86     UINT getWidth();
  87     UINT getHeight();
  88     bool getVisible();
  89     Region* getRegion();     // Not to be used for changing the region
  90     Region getRegionR();     // Same but as an object
  91     void getRootBoxRegion(Region*);
  92
  93     // Drawing functions level 1
  94     void fillColour(const Colour& colour);
  95     void drawPara(const char* text, int x, int y, const Colour& colour);
  96
  97     // Drawing functions level 0
  98     void rectangle(UINT x, UINT y, UINT w, UINT h, const Colour& colour);
  99     void rectangle(Region& region, const Colour& colour);
 100
 101     void drawText(const char* text, int x, int y, const Colour& colour);
 102     void drawText(const char* text, int x, int y, int width, const Colour& colour);
 103     void drawTextRJ(const char* text, int x, int y, const Colour& colour);
 104     void drawTextCentre(const char* text, int x, int y, const Colour& colour);
 105     void drawPixel(UINT x, UINT y, const Colour& colour, bool fastdraw=false);
 106     void drawBitmap(UINT x, UINT y, const Bitmap& bm);
 107     void drawPixelAlpha(UINT x, UINT y, const Colour& colour,bool fastdraw=false);
 108
 109     /* This is for system which need a locking of the drawing surface to speed up drawing */
 110     void startFastDraw();
 111     void endFastDraw();
 112
 113     int charWidth(char c);
 114
 115     void add(Boxx*); // a boxx has a set of child boxxs
 116     void remove(Boxx*);
 117
 118     /*
 119     The following function sets the child's parent pointer without adding the child to the children vector.
 120     It's a hack (that should be deprecated?) to allow things like WSymbol to be created, do some drawing on
 121     the surface and then be deleted again, leaving the drawing present.
 122     A better design would be to create many WSymbols - one per symbol and leave them created - then the
 123     automatic draw code will be able to redraw the symbols without all that code needing
 124     to be in the derived boxx's draw method.
 125     */
 126     void TEMPADD(Boxx* child) { child->setParent(this); }
 127
 128   friend class BoxStack;
 129   protected:
 130     //get the surface this box is drawing to
 131     Surface *getSurface();
 132     Boxx* parent;
 133     Region area;
 134     vector<Boxx*> children;
 135
 136     void setParent(Boxx*);
 137     void blt(Region& r);
 138
 139     static const int paraMargin = 10;
 140     UINT paraVSpace;
 141
 142     Colour backgroundColour;
 143     bool backgroundColourSet;
 144     bool visible;
 145
 146     static char numBoxxes;
 147     Surface* surface;
 148 };
 149
 150 #endif
 151
 152
 153 /*
 154
 155 New Boxx design
 156
 157 It's "Boxx" because "Box" was already taken.
 158
 159 BoxStack replaces Viewman and handles displaying a stack of root boxxs (boxxs with surfaces) on the screen.
 160
 161 Boxx relaces Box, Widget and parts of View and represents a box with or without a surface.
 162 Let's call a Boxx with a surface a root box, and a boxx without a surface a child box.
 163
 164 A boxx with a surface (root) is like an old View and is handled by BoxStack.
 165 A boxx without a surface (child) is like and old Widget and needs to be a child box of another boxx (root or not).
 166
 167 Don't add a boxx with a surface to another boxx. That isn't the design.
 168
 169 So, when you create a boxx, either that boxx calls createBuffer() on itself,
 170 or some other box add()s the new box to itself.
 171
 172 Root boxxs can overlap each other - this is managed by boxstack.
 173 Child boxxs within a parent boxx do not overlap each other.
 174 However, a grandchild box can overlap a child box (but must be entirely contained within the child box).
 175
 176 TBBoxx replaces View but is now only a convenience class for the window dressing stuff. It isn't required anymore since
 177 all the real work that view used to do is done in Boxx now.
 178
 179 Obseleted classes: Box, View, Viewman, Widget, others?
 180 No code outside boxx should talk about surfaces anymore. Hopefully.
 181
 182 */
 183