layout.hh

Go to the documentation of this file.

/*
 * Dillo Widget
 *
 * Copyright 2005-2007 Sebastian Geerken <sgeerken@dillo.org>
 * Copyright 2025 Rodrigo Arias Mallo <rodarima@gmail.com>
 *
 * This program 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.
 *
 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef __DW_LAYOUT_HH__
#define __DW_LAYOUT_HH__
 
#ifndef __INCLUDED_FROM_DW_CORE_HH__
#   error Do not include this file directly, use "core.hh" instead.
#endif
 
namespace dw {
namespace core {
 
class Layout: public lout::object::Object
{
   friend class Widget;
 
private:
   class LayoutImgRenderer: public style::StyleImage::ExternalImgRenderer
   {
      Layout *layout;
 
   public:
      LayoutImgRenderer (Layout *layout) { this->layout = layout; }
 
      bool readyToDraw ();
      void getBgArea (int *x, int *y, int *width, int *height);
      void getRefArea (int *xRef, int *yRef, int *widthRef, int *heightRef);
      style::StyleImage *getBackgroundImage ();
      style::BackgroundRepeat getBackgroundRepeat ();
      style::BackgroundAttachment getBackgroundAttachment ();
      style::Length getBackgroundPositionX ();
      style::Length getBackgroundPositionY ();
      void draw (int x, int y, int width, int height);
   };
 
   LayoutImgRenderer *layoutImgRenderer;
 
public:
   class Receiver: public lout::signal::Receiver
   {
   public:
      virtual void resizeQueued (bool extremesChanged);
      virtual void canvasSizeChanged (int width, int ascent, int descent);
   };
 
   class LinkReceiver: public lout::signal::Receiver
   {
   public:
      virtual bool enter (Widget *widget, int link, int img, int x, int y);
 
      virtual bool press (Widget *widget, int link, int img, int x, int y,
                          EventButton *event);
 
      virtual bool release (Widget *widget, int link, int img, int x, int y,
                            EventButton *event);
 
      virtual bool click (Widget *widget, int link, int img, int x, int y,
                          EventButton *event);
   };
 
   class LinkEmitter: public lout::signal::Emitter
   {
   private:
      enum { ENTER, PRESS, RELEASE, CLICK };
 
   protected:
      bool emitToReceiver (lout::signal::Receiver *receiver, int signalNo,
                           int argc, lout::object::Object **argv);
 
   public:
      inline void connectLink (LinkReceiver *receiver) { connect (receiver); }
 
      bool emitEnter (Widget *widget, int link, int img, int x, int y);
      bool emitPress (Widget *widget, int link, int img, int x, int y,
                      EventButton *event);
      bool emitRelease (Widget *widget, int link, int img, int x, int y,
                        EventButton *event);
      bool emitClick (Widget *widget, int link, int img, int x, int y,
                      EventButton *event);
   };
 
   LinkEmitter linkEmitter;
 
private:
   class Emitter: public lout::signal::Emitter
   {
   private:
      enum { RESIZE_QUEUED, CANVAS_SIZE_CHANGED };
 
   protected:
      bool emitToReceiver (lout::signal::Receiver *receiver, int signalNo,
                           int argc, lout::object::Object **argv);
 
   public:
      inline void connectLayout (Receiver *receiver) { connect (receiver); }
 
      void emitResizeQueued (bool extremesChanged);
      void emitCanvasSizeChanged (int width, int ascent, int descent);
   };
 
   Emitter emitter;
 
   class Anchor: public lout::object::Object
   {
   public:
      char *name;
      Widget *widget;
      int y;
 
      ~Anchor ();
   };
 
   Platform *platform;
   View *view;
   Widget *topLevel, *widgetAtPoint;
   lout::container::typed::Vector<Widget> *queueResizeList;
 
   /* The state, which must be projected into the view. */
   style::Color *bgColor;
   style::StyleImage *bgImage;
   style::BackgroundRepeat bgRepeat;
   style::BackgroundAttachment bgAttachment;
   style::Length bgPositionX, bgPositionY;
 
   style::Cursor cursor;
   int canvasWidth, canvasAscent, canvasDescent;
 
   bool usesViewport, drawAfterScrollReq;
   int scrollX, scrollY, viewportWidth, viewportHeight;
   bool canvasHeightGreater;
   int hScrollbarThickness, vScrollbarThickness;
 
   HPosition scrollTargetHpos;
   VPosition scrollTargetVpos;
   int scrollTargetX, scrollTargetY, scrollTargetWidth, scrollTargetHeight;
 
   char *requestedAnchor;
   int scrollIdleId, resizeIdleId;
   bool scrollIdleNotInterrupted;
 
   /* Anchors of the widget tree */
   lout::container::typed::HashTable <lout::object::String, Anchor>
                                     *anchorsTable;
 
   SelectionState selectionState;
   FindtextState findtextState;
 
   enum ButtonEventType { BUTTON_PRESS, BUTTON_RELEASE, MOTION_NOTIFY };
 
   void detachWidget (Widget *widget);
 
   Widget *getWidgetAtPoint (int x, int y);
   void moveToWidget (Widget *newWidgetAtPoint, ButtonState state);
 
   void moveToWidgetAtPoint (int x, int y, ButtonState state)
   { moveToWidget (getWidgetAtPoint (x, y), state); }
 
   void moveOutOfView (ButtonState state) { moveToWidget (NULL, state); }
 
   bool processMouseEvent (MousePositionEvent *event, ButtonEventType type);
   bool buttonEvent (ButtonEventType type, View *view,
                     int numPressed, int x, int y, ButtonState state,
                     int button);
   void resizeIdle ();
   void setSizeHints ();
   void draw (View *view, Rectangle *area);
 
   void scrollTo0(HPosition hpos, VPosition vpos,
                  int x, int y, int width, int height,
                  bool scrollingInterrupted);
   void scrollIdle ();
   void adjustScrollPos ();
   static bool calcScrollInto (int targetValue, int requestedSize,
                               int *value, int viewportSize);
   int currHScrollbarThickness();
   int currVScrollbarThickness();
 
   void updateAnchor ();
 
   /* Widget */
 
   char *addAnchor (Widget *widget, const char* name);
   char *addAnchor (Widget *widget, const char* name, int y);
   void changeAnchor (Widget *widget, char* name, int y);
   void removeAnchor (Widget *widget, char* name);
   void setCursor (style::Cursor cursor);
   void updateCursor ();
   void queueDraw (int x, int y, int width, int height);
   void queueDrawExcept (int x, int y, int width, int height,
      int ex, int ey, int ewidth, int eheight);
   void queueResize (bool extremesChanged);
   void removeWidget ();
 
   /* For tests regarding the respective Layout and (mostly) Widget
      methods. Accessed by respective methods (enter..., leave...,
      ...Entered) defined here and in Widget. */
 
   int resizeIdleCounter, queueResizeCounter, sizeAllocateCounter,
      sizeRequestCounter, getExtremesCounter, resizeCounter;
   bool resizeLimit;
 
   void enterResizeIdle () { resizeIdleCounter++; }
   void leaveResizeIdle () { resizeIdleCounter--; }
 
public:
   Layout (Platform *platform, bool limit=true);
   ~Layout ();
 
   inline void connectLink (LinkReceiver *receiver)
   { linkEmitter.connectLink (receiver); }
 
   inline bool emitLinkEnter (Widget *w, int link, int img, int x, int y)
   { return linkEmitter.emitEnter (w, link, img, x, y); }
 
   inline bool emitLinkPress (Widget *w, int link, int img,
                              int x, int y, EventButton *event)
   { return linkEmitter.emitPress (w, link, img, x, y, event); }
 
   inline bool emitLinkRelease (Widget *w, int link, int img,
                                int x, int y, EventButton *event)
   { return linkEmitter.emitRelease (w, link, img, x, y, event); }
 
   inline bool emitLinkClick (Widget *w, int link, int img,
                              int x, int y, EventButton *event)
   { return linkEmitter.emitClick (w, link, img, x, y, event); }
 
   lout::misc::ZoneAllocator *textZone;
 
   void addWidget (Widget *widget);
   void setWidget (Widget *widget);
 
   void attachView (View *view);
   void detachView (View *view);
 
   inline bool getUsesViewport () { return usesViewport; }
   inline int getWidthViewport () { return viewportWidth; }
   inline int getHeightViewport ()  { return viewportHeight; }
   inline int getScrollPosX ()  { return scrollX; }
   inline int getScrollPosY ()  { return scrollY; }
 
   /* public */
 
   void scrollTo (HPosition hpos, VPosition vpos,
                  int x, int y, int width, int height);
   void scroll (ScrollCommand);
   void setAnchor (const char *anchor);
 
   /* View */
 
   inline void expose (View *view, Rectangle *area) {
      DBG_OBJ_ENTER ("draw", 0, "expose", "%d, %d, %d * %d",
                     area->x, area->y, area->width, area->height);
      draw (view, area);
      DBG_OBJ_LEAVE ();
   }
 
   inline bool buttonPress (View *view, int numPressed, int x, int y,
                            ButtonState state, int button)
   {
      return buttonEvent (BUTTON_PRESS, view, numPressed, x, y, state, button);
   }
 
   void containerSizeChanged ();
 
   inline bool buttonRelease (View *view, int numPressed, int x, int y,
                              ButtonState state, int button)
   {
      return buttonEvent (BUTTON_RELEASE, view, numPressed, x, y, state,
                          button);
   }
 
   bool motionNotify (View *view, int x, int y, ButtonState state);
   void enterNotify (View *view, int x, int y, ButtonState state);
   void leaveNotify (View *view, ButtonState state);
 
   void scrollPosChanged (View *view, int x, int y);
   void viewportSizeChanged (View *view, int width, int height);
 
   inline Platform *getPlatform ()
   {
      return platform;
   }
 
   /* delegated */
 
   inline int textWidth (style::Font *font, const char *text, int len)
   {
      return platform->textWidth (font, text, len);
   }
 
   inline char *textToUpper (const char *text, int len)
   {
      return platform->textToUpper (text, len);
   }
 
   inline char *textToLower (const char *text, int len)
   {
      return platform->textToLower (text, len);
   }
 
   inline int nextGlyph (const char *text, int idx)
   {
      return platform->nextGlyph (text, idx);
   }
 
   inline int prevGlyph (const char *text, int idx)
   {
      return platform->prevGlyph (text, idx);
   }
 
   inline float dpiX ()
   {
      return platform->dpiX ();
   }
 
   inline float dpiY ()
   {
      return platform->dpiY ();
   }
 
   inline style::Font *createFont (style::FontAttrs *attrs, bool tryEverything)
   {
      return platform->createFont (attrs, tryEverything);
   }
 
   inline bool fontExists (const char *name)
   {
      return platform->fontExists (name);
   }
 
   inline style::Color *createColor (int color)
   {
      return platform->createColor (color);
   }
 
   inline style::Tooltip *createTooltip (const char *text)
   {
      return platform->createTooltip (text);
   }
 
   inline void cancelTooltip ()
   {
      return platform->cancelTooltip ();
   }
 
   inline Imgbuf *createImgbuf (Imgbuf::Type type, int width, int height,
                                double gamma)
   {
      return platform->createImgbuf (type, width, height, gamma);
   }
 
   inline void copySelection(const char *text, int destination)
   {
      platform->copySelection(text, destination);
   }
 
   inline void copyCurrentSelection(int destination)
   {
      selectionState.copy(destination);
   }
 
   inline ui::ResourceFactory *getResourceFactory ()
   {
      return platform->getResourceFactory ();
   }
 
   inline void connect (Receiver *receiver) {
      emitter.connectLayout (receiver); }
 
   inline FindtextState::Result search (const char *str, bool caseSens,
                                        int backwards)
      { return findtextState.search (str, caseSens, backwards); }
 
   inline void resetSearch () { findtextState.resetSearch (); }
 
   void setBgColor (style::Color *color);
   void setBgImage (style::StyleImage *bgImage,
                    style::BackgroundRepeat bgRepeat,
                    style::BackgroundAttachment bgAttachment,
                    style::Length bgPositionX, style::Length bgPositionY);
 
   inline style::Color* getBgColor () { return bgColor; }
   inline style::StyleImage* getBgImage () { return bgImage; }
};
 
} // namespace core
} // namespace dw
 
#endif // __DW_LAYOUT_HH__