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);
 106     void drawBitmap(UINT x, UINT y, const Bitmap& bm);
 107
 108     /* This is for system which need a locking of the drawing surface to speed up drawing */
 109     void startFastDraw();
 110     void endFastDraw();
 111
 112     int charWidth(char c);
 113
 114     void add(Boxx*); // a boxx has a set of child boxxs
 115     void remove(Boxx*);
 116
 117     /*
 118     The following function sets the child's parent pointer without adding the child to the children vector.
 119     It's a hack (that should be deprecated?) to allow things like WSymbol to be created, do some drawing on
 120     the surface and then be deleted again, leaving the drawing present.
 121     A better design would be to create many WSymbols - one per symbol and leave them created - then the
 122     automatic draw code will be able to redraw the symbols without all that code needing
 123     to be in the derived boxx's draw method.
 124     */
 125     void TEMPADD(Boxx* child) { child->setParent(this); }
 126
 127   friend class BoxStack;
 128   protected:
 129     //get the surface this box is drawing to
 130     Surface *getSurface();
 131     Boxx* parent;
 132     Region area;
 133     vector<Boxx*> children;
 134
 135     void setParent(Boxx*);
 136     void blt(Region& r);
 137
 138     static const int paraMargin = 10;
 139     UINT paraVSpace;
 140
 141     Colour backgroundColour;
 142     bool backgroundColourSet;
 143     bool visible;
 144
 145     static char numBoxxes;
 146     Surface* surface;
 147 };
 148
 149 #endif
 150
 151
 152 /*
 153
 154 New Boxx design
 155
 156 It's "Boxx" because "Box" was already taken.
 157
 158 BoxStack replaces Viewman and handles displaying a stack of root boxxs (boxxs with surfaces) on the screen.
 159
 160 Boxx relaces Box, Widget and parts of View and represents a box with or without a surface.
 161 Let's call a Boxx with a surface a root box, and a boxx without a surface a child box.
 162
 163 A boxx with a surface (root) is like an old View and is handled by BoxStack.
 164 A boxx without a surface (child) is like and old Widget and needs to be a child box of another boxx (root or not).
 165
 166 Don't add a boxx with a surface to another boxx. That isn't the design.
 167
 168 So, when you create a boxx, either that boxx calls createBuffer() on itself,
 169 or some other box add()s the new box to itself.
 170
 171 Root boxxs can overlap each other - this is managed by boxstack.
 172 Child boxxs within a parent boxx do not overlap each other.
 173 However, a grandchild box can overlap a child box (but must be entirely contained within the child box).
 174
 175 TBBoxx replaces View but is now only a convenience class for the window dressing stuff. It isn't required anymore since
 176 all the real work that view used to do is done in Boxx now.
 177
 178 Obseleted classes: Box, View, Viewman, Widget, others?
 179 No code outside boxx should talk about surfaces anymore. Hopefully.
 180
 181 */
 182