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