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