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
  34 #include "surface.h"
  35 #include "tvmedia.h"
  36 #include "osdvector.h"
  37
  38 class Bitmap;
  39
  40 class Boxx
  41 {
  42   friend class Wwss;
  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 DrawStyle& 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 bool mouseAndroidScroll(int x, int y,int sx, int sy) { return false; }
  67     virtual void deactivateAllControls() {}
  68
  69     /* preDelete
  70
  71      I think it's functionally equivalent to e.g. delete timers in Boxx::preDelete
  72      because the only place where a Boxx is deleted is in
  73      BoxStack::remove. There is now a call in BoxStack::remove to Boxx::preDelete
  74      The reason for this is to stop timercalls calling BoxStack::update at the
  75      same time BoxStack::remove is locked trying to delete the Boxx
  76     */
  77
  78     // Get functions
  79     int getScreenX();        // where is it on screen
  80     int getScreenY();
  81     int getRootBoxOffsetX(); // where is it relative to the top-parent in the boxstack
  82     int getRootBoxOffsetY();
  83     int getX();              // where is it relative to its parent
  84     int getX2();             // .. and the right edge
  85     int getY();
  86     int getY2();
  87     UINT getWidth();
  88     UINT getHeight();
  89     bool getVisible();
  90     Region* getRegion();     // Not to be used for changing the region
  91     Region getRegionR();     // Same but as an object
  92     void getRootBoxRegion(Region*);
  93
  94     // Drawing functions level 1
  95     void fillColour(const DrawStyle & colour);
  96     int drawPara(const char* text, int x, int y, const DrawStyle& colour, unsigned int skiplines=0);
  97
  98     // Drawing functions level 0
  99     void rectangle(UINT x, UINT y, UINT w, UINT h, const DrawStyle& colour);
 100     void rectangle(Region& region, const DrawStyle& colour);
 101
 102     void drawText(const char* text, int x, int y, const DrawStyle& colour);
 103     void drawText(const char* text, int x, int y, int width, const DrawStyle& colour);
 104     void drawTextRJ(const char* text, int x, int y, const DrawStyle& colour);
 105     void drawTextCentre(const char* text, int x, int y, const DrawStyle& colour);
 106     //Now deprecated
 107     //void drawPixel(UINT x, UINT y, const Colour& colour, bool fastdraw=false);
 108     void drawBitmap(UINT x, UINT y, const Bitmap& bm, const DisplayRegion & region);
 109    //Now deprecated
 110     // void drawPixelAlpha(UINT x, UINT y, const Colour& colour,bool fastdraw=false);
 111     void drawTVMedia(TVMediaInfo & tvmedia,float x, float y, float width, float height, Corner corner=TopLeft);
 112     void drawClippingRectangle(float x, float y, float w, float h);
 113     int getFontHeight();
 114
 115     void drawJpeg(const char *fileName,int x, int y,int *width, int *height);
 116
 117     void drawTTChar(int ox, int oy,int x, int y, cTeletextChar c);
 118     void drawMonoBitmap(UCHAR*base, int dx, int dy, unsigned int height,unsigned int width, DrawStyle& nextColour);
 119
 120     /* This is for system which need a locking of the drawing surface to speed up drawing */
 121     void startFastDraw();
 122     void endFastDraw();
 123
 124     float charWidth(wchar_t c);
 125     wchar_t getWChar(const char* str, unsigned int *length);
 126
 127     void add(Boxx*); // a boxx has a set of child boxxs
 128     void remove(Boxx*);
 129
 130     /*
 131     The following function sets the child's parent pointer without adding the child to the children vector.
 132     It's a hack (that should be deprecated?) to allow things like WSymbol to be created, do some drawing on
 133     the surface and then be deleted again, leaving the drawing present.
 134     A better design would be to create many WSymbols - one per symbol and leave them created - then the
 135     automatic draw code will be able to redraw the symbols without all that code needing
 136     to be in the derived boxx's draw method.
 137     */
 138     void TEMPADD(Boxx* child) { child->setParent(this); }
 139
 140   friend class BoxStack;
 141   protected:
 142     //get the surface this box is drawing to
 143     Surface *getSurface();
 144     Boxx* parent;
 145     Region area;
 146     vector<Boxx*> children;
 147
 148     void setParent(Boxx*);
 149     void blt(Region& r);
 150
 151     static const int paraMargin = 10;
 152     UINT paraVSpace;
 153
 154     DrawStyle backgroundColour;
 155     bool backgroundColourSet;
 156     bool visible;
 157
 158     static char numBoxxes;
 159     Surface* surface;
 160 };
 161
 162 #endif
 163
 164
 165 /*
 166
 167 New Boxx design
 168
 169 It's "Boxx" because "Box" was already taken.
 170
 171 BoxStack replaces Viewman and handles displaying a stack of root boxxs (boxxs with surfaces) on the screen.
 172
 173 Boxx relaces Box, Widget and parts of View and represents a box with or without a surface.
 174 Let's call a Boxx with a surface a root box, and a boxx without a surface a child box.
 175
 176 A boxx with a surface (root) is like an old View and is handled by BoxStack.
 177 A boxx without a surface (child) is like and old Widget and needs to be a child box of another boxx (root or not).
 178
 179 Don't add a boxx with a surface to another boxx. That isn't the design.
 180
 181 So, when you create a boxx, either that boxx calls createBuffer() on itself,
 182 or some other box add()s the new box to itself.
 183
 184 Root boxxs can overlap each other - this is managed by boxstack.
 185 Child boxxs within a parent boxx do not overlap each other.
 186 However, a grandchild box can overlap a child box (but must be entirely contained within the child box).
 187
 188 TBBoxx replaces View but is now only a convenience class for the window dressing stuff. It isn't required anymore since
 189 all the real work that view used to do is done in Boxx now.
 190
 191 Obseleted classes: Box, View, Viewman, Widget, others?
 192 No code outside boxx should talk about surfaces anymore. Hopefully.
 193
 194 */
 195