ui_screen.H

Go to the documentation of this file.

/*
 *  This file is part of the Home2L project.
 *
 *  (C) 2015-2021 Gundolf Kiefer
 *
 *  Home2L is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Home2L is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with Home2L. If not, see <https://www.gnu.org/licenses/>.
 *
 */
 
 
#ifndef _SCREEN_
#define _SCREEN_
 
 
#include "ui_base.H"
 
 
/* Some pieces of the code are intentionally robust enough to tolerate 'this == NULL'.
 * GCC 6 by default emits warnings in this case. We disable them.
 */
#if defined(__GNUC__) && !ANDROID
#pragma GCC diagnostic ignored "-Wnonnull-compare"
#endif
 
 
 
 
 
// *************************** General *****************************************
 
 
 
 
#define UI_BUTTONS_HEIGHT 64    
#define UI_BUTTONS_SPACE 8      
 
#define UI_BUTTONS_RECT Rect (0, UI_RES_Y - UI_BUTTONS_HEIGHT, UI_RES_X, UI_BUTTONS_HEIGHT)
#define UI_BUTTONS_BACKWIDTH (UI_BUTTONS_HEIGHT + UI_BUTTONS_HEIGHT/2)
 
#define UI_USER_RECT Rect (0, 0, UI_RES_X, UI_RES_Y - UI_BUTTONS_HEIGHT - UI_BUTTONS_SPACE)
 
 
 
 
class CScreen;
 
 
 
 
 
// *************************** CWidget *****************************************
 
 
class CWidget {
  public:
    CWidget ();
    virtual ~CWidget () { ClearTexture (); }
 
    void Set (SDL_Surface *_surf, int x0, int y0) {
      SetArea (Rect (_surf)); RectMove (&area, x0, y0); SetSurface (_surf);
    }
 
    void SetArea (SDL_Rect _area) { area = _area; }
    SDL_Rect *GetArea () { return &area; }
 
    class CScreen *GetScreen () { return screen; }
    bool IsOnScreen (class CScreen *_screen) { return screen == _screen; }
    class CCanvas *GetCanvas () { return canvas; }
 
    void LocalToScreenCoords (int *x, int *y);
    void ScreenToLocalCoords (int *x, int *y);
 
    void GetMouseEventPos (SDL_Event *ev, int *x, int *y);
 
    void SetSurface (SDL_Surface *_surface) { surface = _surface; ChangedSurface (); }
    virtual SDL_Surface *GetSurface () { return surface; }
 
    void GetRenderArea (SDL_Rect *ra) { *ra = area; LocalToScreenCoords (&ra->x, &ra->y); }
    virtual SDL_Texture *GetTexture ();
    void SetTextureBlendMode (SDL_BlendMode _sdlBlendMode) { sdlBlendMode = _sdlBlendMode; }
    virtual void Render (SDL_Renderer *ren);
    void ClearTexture ();
 
    virtual bool HandleEvent (SDL_Event *ev) { return false; }
 
  protected:
    friend class CScreen;
    friend class CCanvas;
 
    CWidget *next;
    class CScreen *screen;
    class CCanvas *canvas;
    int screenLayer;      // for use by 'CScreen::AddWidget ()': layer of widget in the current context
 
    SDL_Rect area;
    SDL_Surface *surface;
    SDL_Texture *texture;
    SDL_BlendMode sdlBlendMode;
 
    void ChangedSurface () { Changed (); }  
    void Changed ();                        
 
  private:
 
    // Helpers...
    static void RenderList (CWidget *list, SDL_Renderer *ren);
      // Render this and all widgets of the linked list behind 'next'; first widgets appear on top
};
 
 
 
 
 
// *************************** CCanvas *****************************************
 
 
class CCanvas: public virtual CWidget {
  public:
    CCanvas () { virtArea = Rect (0, 0, 0, 0); firstWidget = NULL; SetDefaults (); }
    //~ virtual ~CCanvas () {}
 
    void SetDefaults () { SetColors (); SetScrollbarWidth (); }   
    void SetColors (TColor _backColor = BLACK, TColor _scrollbarColor = ToColor (255, 255, 255, 32)) {
      backColor = _backColor; scrollbarColor = _scrollbarColor; Changed ();
    }
    void SetScrollbarWidth (int width = 8) { scrollbarWidth = width; Changed (); }
 
    void SetArea (SDL_Rect _area) { CWidget::SetArea (_area); SetVirtArea (_area); }
 
    void SetVirtArea (SDL_Rect r);
    SDL_Rect *GetVirtArea () { return &virtArea; }
    void MoveVirtArea (int toX0, int toY0) { SetVirtArea (Rect (toX0, toY0, virtArea.w, virtArea.h)); }
    void LimitVirtArea (SDL_Rect *r = NULL);
    void ScrollTo (SDL_Rect r, int hAlign = 0, int vAlign = -1);
    void ScrollIn (SDL_Rect r);
 
    void WidgetToScreenCoords (int *x, int *y);
    void ScreenToWidgetCoords (int *x, int *y);
 
    void AddWidget (CWidget *widget) { DoAddWidget (&firstWidget, widget); }
    void DelWidget (CWidget *widget) { DoDelWidget (&firstWidget, widget); }
    void DelAllWidgets ();
 
    bool IsVisible (SDL_Rect *r);
    bool IsVisible (CWidget *w) { return IsVisible (w->GetArea ()); }
 
    virtual void Render (SDL_Renderer *ren);
    virtual bool HandleEvent (SDL_Event *ev);
 
  protected:
    SDL_Rect virtArea;
    CWidget *firstWidget;
    TColor backColor, scrollbarColor;
    int scrollbarWidth;
 
  private:
 
    // Helpers...
    void DoAddWidget (CWidget **pFirst, CWidget *widget);
    void DoDelWidget (CWidget **pFirst, CWidget *widget);
};
 
 
 
 
 
// *************************** CScreen *****************************************
 
 
class CScreen {
  public:
    CScreen () { firstWidget = NULL; changed = true; withKeyboard = false; }
    virtual ~CScreen ();
 
    static void ClassInit () { /* activeScreen = NULL; */ }
    static void ClassDone () {}
 
    static void Refresh () { Changed (); }
 
    static void EmulateOff (bool off) { emulateOff = off; Changed (); }
    static void EmulateStandby (bool standby) { emulateStandby = standby; Changed (); }
 
    bool IsActive () { return this == activeScreen; }
    static class CScreen *ActiveScreen () { return activeScreen; }
    virtual void Activate (bool on = true);
    void Deactivate () { Activate (false); }
 
    void AddWidget (CWidget *widget, int layer = 0) { DoAddWidget (&firstWidget, widget, layer); }
    void DelWidget (CWidget *widget) { DoDelWidget (&firstWidget, widget); }
    void DelAllWidgets ();
 
    void Run ();
    void Return () { running = false; }
 
    void SetKeyboard (bool on);
    bool HasKeyboard () { return withKeyboard; }
 
  protected:
    friend class CWidget;
    friend void UiIterate (bool noWait);
 
    static class CScreen *activeScreen;
    static bool changed;
    static bool emulateOff, emulateStandby;
    static bool keyboardOn;
 
    CWidget *firstWidget;
    bool running, withKeyboard;
 
    // Callbacks...
    virtual bool HandleEvent (SDL_Event *ev);
 
    // Change management & rendering...
    static void Changed () { changed = true; }
    static void RenderUpdate ();
 
  private:
 
    // Helpers...
    void DoAddWidget (CWidget **pFirst, CWidget *widget, int layer);
    void DoDelWidget (CWidget **pFirst, CWidget *widget);
};
 
 
 
 
 
// *************************** Layout helpers **********************************
 
 
 
 
SDL_Rect *LayoutRow (SDL_Rect container, const int *format, int items = -1, int space = UI_BUTTONS_SPACE);
SDL_Rect *LayoutRow (SDL_Rect container, int space = UI_BUTTONS_SPACE, ...);
static inline SDL_Rect *LayoutRowEqually (SDL_Rect container, int items, int space = UI_BUTTONS_SPACE) { return LayoutRow (container, (const int *) NULL, items, space); }
 
SDL_Rect *LayoutCol (SDL_Rect container, const int *format, int items = -1, int space = UI_BUTTONS_SPACE);
SDL_Rect *LayoutCol (SDL_Rect container, int space = UI_BUTTONS_SPACE, ...);
static inline SDL_Rect *LayoutColEqually (SDL_Rect container, int items, int space = UI_BUTTONS_SPACE) { return LayoutRow (container, (const int *) NULL, items, space); }
 
SDL_Rect *LayoutMatrix (SDL_Rect container, const int *hFormat, const int *vFormat, int hItems = -1, int vItems = -1, int hSpace = UI_BUTTONS_SPACE, int vSpace = UI_BUTTONS_SPACE);
 
 
 
 
 
 
 
// *************************** Init/Done ***************************************
 
 
 
 
static inline void ScreenInit () { CScreen::ClassInit (); }
static inline void ScreenDone () { CScreen::ClassDone (); }
 
 
 
 
 
 
 
#endif