ubox.hpp

/* ==================================================== ======== ======= *
 *
 *  ubox.hpp : UBox container.
 *  Ubit Project
 *  Author: Eric Lecolinet
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 /s EricLecolinet / ENST Paris / http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE : 
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE 
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 
 * 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 2 OF THE LICENSE, OR (AT YOUR OPTION) ANY LATER VERSION.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************
 * ==================================================== [(c)Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _ubox_hpp_
#define _ubox_hpp_
//pragma ident  "@(#)ubox.hpp           ubit:05.05.00"
#include <ubit/ugroup.hpp>
namespace ubit {

/* ==================================================== ===== ======= */
class UBox: public UGroup {
public:
  UBIT_ELEMENT_CLASS(UBox, UGroup)
  static UStyle* createStyle();
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  UBox(const UArgs& a = UArgs::none);  

  friend UBox& ubox(const UArgs& a = UArgs::none) {return *new UBox(a);}
  virtual ~UBox() {destructs();}
  virtual UBox* boxCast() {return this;}

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual UBorder* getBorder() const;
  virtual UBorder* getBorder(bool create_if_none);
  virtual UBox& addlist(const UArgs& a) {UGroup::addlist(a); return *this;}
  virtual UBox* getChildAt(const UPoint&, UView* box_view = null) const;
  virtual UBox* findChildAt(const UPoint&, UView* box_view = null) const;
  virtual UDimension getViewSize(UView* box_view = null) const; 
  virtual UPoint getViewPos(UView* box_view = null) const;  
  virtual UPoint getEventPos(const UMouseEvent&) const;
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual int getViewCount() const;

  virtual int getViews(std::vector<UView*>&) const;
  virtual int getRelatedViews(std::vector<UView*>& v) const {return getViews(v);}

  virtual UView* getView(int n = 0) const;
  virtual UView* getViewAt(const UMouseEvent&) const;
 
  virtual UView* getViewContaining(const UView* child_view) const;
  virtual UView* getFirstViewInside(const UView* parent_view) const;
  void setViewModes(int view_modes, bool);

  virtual void repaint() {update(UUpdate::paint);}          // redefined from UGroup
  virtual void update() {update(UUpdate::layoutAndPaint);}  // redefined from UGroup
  virtual void update(const UUpdate&);                      // redefined from UGroup
  
  // - - - Impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

#ifndef NO_DOC
  virtual UView* getViewInImpl(UView* parent_view, UChild*);
  virtual UView* getViewInImpl(UView* parent_view, UChild*, int& w, int& h);
  virtual void addView(UView*);
  virtual void updateView(UEvent&, UView*, const UUpdate&);
  virtual UBox* getChildAtImpl(const UPoint&, UView* box_view) const;

protected:
  friend class UGroup;
  friend class UWin;
  UView* views;

  virtual void initView(UChild* self, UView *ancestor_view);
  virtual void initChildViews(UGroup*, UChild* childlink);
  virtual void deleteRelatedViews(UView* parview, UChild*);
  //NB: link can be null (but not parview) for UBox::deleteRelatedViews
  
  static void updateImpl(const class UUpdate& upmode, 
                         UView* winview, UView* layoutview, UView* showview,
                         bool impose_size, int w, int h); 
public:
  UBox& onChildEvent(const UArgs&);
  /* [obsolete] detects events that have been received by children.
    * Example:
    * <pre>
    *   box->onChildEvent(UOn::mmove / ucall(...) + UOn::mpress / ucall(...))
    * </pre>
    *
    * See also:
    * - UOn::filterEvent to detect and filter events *before* they reach children.
    *
    * Notes:
    * - abstracts events can't be detected by this function, except if they were
    *   actually processed by the child target.
    * -  UEvent methods (such as getSource(), getX(), getY() ...) are relative
    *    to the child target that received the event.
    */
  
#endif
};

}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */

---