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