ubox.hpp

/************************************************************************
 *
 *  ubox.hpp: Box Elements (elements that manage 1 or N screen UView(s))
 *  Ubit GUI Toolkit - Version 6
 *  (C) 2009 | Eric Lecolinet | TELECOM ParisTech | 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.
 * ***********************************************************************/

#ifndef _ubox_hpp_
#define _ubox_hpp_ 1
#include <ubit/uelem.hpp>
namespace ubit {
  
  class UBox: public UElem {
  public:
    UCLASS(UBox)
    
    UBox(UArgs args = UArgs::none);  
    virtual ~UBox() {destructs();}
    virtual UBox* toBox() {return this;}
    virtual const UBox* toBox() const {return this;}
    
    static UStyle* createStyle();
    virtual int getDisplayType() const {return BLOCK;} // redefined
    
    void repaint() {update(UUpdate::paint);}           // redefined    
    void update() {update(UUpdate::layoutAndPaint);}   // redefined
    virtual void update(const UUpdate& update_options, UDisp* = null);  // redefined
    virtual void doUpdate(const UUpdate&, UDisp* = null);  // redefined
    
    // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

    virtual int getViewCount() const;
    
    virtual int getViews(std::vector<UView*>&) const;
    virtual UView* getView(int n = 0) const;
    virtual UView* getView(const UInputEvent&) const;
      
    virtual UView* getView(UWin&, const UPoint& pos_in_win, UDisp* = null) const;

    virtual UView* getViewContaining(const UView& child_view) const;
    virtual UView* getFirstViewInside(const UView& parent_view) const;
    // - - - Impl. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    
#ifndef NO_DOC
    
    virtual int retrieveRelatedViews(std::vector<UView*>& collating_vector) const;
    /* returns the views that are related to this box.
     * retrieves all the views that are currently controlled by this UBox.
     *
     * - this function does the same as getViews() except that 'collating_vector' 
     *   is not emptied: the views are added to the end of what it already contains.
     * - the function returns the number of views that were added (which may thus differ
     *   from the total size of 'collating_vector')
     *
     * Note that elements and boxes can have several parents, so that multiple wiews
     * can be associated to the same widget (see UElem and UBox classes for details)
     */
    
    virtual UView* getViewInImpl(UView* parent_view);
    
    virtual UView* getViewInImpl(UView* parent_view, UDimension&);
    /* returns the object's view that is contained in this DIRECT parent view.
     * 'parent_view' will contain several views of this object if it has been added
     * several times to this parent.
     */
    
    void setViewModes(int view_modes, bool);
    
  protected:
    friend class UElem;
    friend class UWin;
    friend class UView;
    friend class UAppliImpl;
    UView* views;

    virtual void addViewImpl(UView*);
    virtual void initView(UView* parent_view);
    virtual void initChildViews(UElem*);
    virtual void deleteViewsInside(const std::vector<UView*>& parent_views);
 #endif
  };
  
  inline UBox& ubox(const UArgs& args = UArgs::none) {return *new UBox(args);}
  UBox& uvbox(UArgs args = UArgs::none);
  
  UBox& uhbox(UArgs args = UArgs::none);

}
#endif