ugroup.hpp

/* ==================================================== ======== ======= *
 *
 *  ugroup.hpp : Logical "grouping" container.
 *  Ubit Project
 *  Author: Eric Lecolinet
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 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 _ugroup_hpp_
#define _ugroup_hpp_
//pragma ident  "@(#)ugroup.hpp ubit:05.05.00"
#include <ubit/ucontrol.hpp>
#include <ubit/uargs.hpp>
#include <ubit/ustr.hpp>
namespace ubit {

/* ==================================================== ======== ======= */
class UGroup: public UControl {
public:
  UBIT_ELEMENT_CLASS(UGroup, UControl)
  static UStyle* createStyle();
  const UStyle& getStyle(UContext*) const;
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  UGroup(const UArgs& = UArgs::none);

  friend UGroup& ugroup(const UArgs& a = UArgs::none) {return *new UGroup(a);}
  virtual ~UGroup();
  virtual UGroup* groupCast() {return this;}
  
  virtual unsigned short getNodeType() const {return ELEMENT_NODE;}
  
  virtual const UStr* getNodeName() const;
    
  virtual const UStr* getNodeValue() const {return null;}

  //virtual const UStr* getName() const; // ambigu avec subclasses

  virtual void initNode(UDoc* context) {}

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // parents: see the UBrick superclass.
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // children

  virtual bool isParentOf(const UBrick& possible_child) const;
    
  virtual UGroup& addlist(const UArgs& child_list);
  virtual UChildIter add(const UChild&);
  virtual UChildIter add(const UChild&, int position);
  /* inserts an object (deriving from UBrick) before this position in the child list.
    * the position is an integer (0 is the position of the first child).
    * Returns an iterator that points to the inserted object.
    * Note that the same object can be added several times to the same parent.
    */
  
  virtual UChildIter add(const UChild&, UChildIter position);
  /* inserts an object (deriving from UBrick) before this position in the child list.
    * the position is a Child Iterator (@see: cbegin()).
    * Returns an iterator that points to the inserted object.
    * Note that the same object can be added several times to the same parent.
    */
  
  virtual UChildIter remove(UBrick&, bool auto_delete = true);
  virtual UChildIter removeNC(UBrick&, bool auto_delete = true);
  virtual UChildIter remove(int position, bool auto_delete = true);
  virtual UChildIter remove(UChildIter position, bool auto_delete = true);
  virtual void removeAll(bool auto_delete = true);
  UChildIter cbegin() const {return children().begin();}
  UChildIter cend() const {return children().end();}
  
  UChildReverseIter crbegin() const {return children().rbegin();}
  UChildReverseIter crend() const {return children().rend();}
  
  virtual UChildren& children() const {return _children;}
  UChildIter child(int position) const {return children().at(position);}

  UBrick* getChild(int position) const;
      
  virtual UStr retrieveText(bool recursive = true) const;
  virtual void retrieveText(UStr& to, bool recursive = true) const;
  // - - - - attributes - - - - - - - - - - -- - - - - - - - - - - - - - - -
  
  virtual void addAttr(const UChild& attribute);
  virtual void removeAttr(UBrick& attribute, bool auto_delete = true);
  virtual void removeAttrNC(UBrick& attr, bool auto_delete = true);
    
  virtual void removeAllAttrs(bool auto_del = true);
  UChildIter abegin() const {return attributes().begin();}
  
  UChildIter aend() const {return attributes().end();}
  
  virtual UChildren& attributes() const {return _attributes;}
  // doc inherited from UBrick.
  
  virtual const UStr* getAttr(const UStr& name, bool ignore_case = true) const;
  
  virtual const UProp* getAttrNode(const UStr& name, bool ignore_case = true) const;

  virtual UProp* getAttrNode(const UStr& name, bool ignore_case = true);

  virtual UProp* setAttrNode(UProp*);

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  virtual void repaint() {update(UUpdate::paint);}
  virtual void update() {update(UUpdate::layoutAndPaint);}
  virtual void update(const UUpdate&);
  UGroup& autoUpdate(bool state) {UBrick::autoUpdate(state); return *this;}
  
  virtual void show(bool = true);
  void hide() {show(false);}
  
  virtual void close(int status = 0);
  virtual void closeWin(int status = 0);
  static void closeWinCB(UEvent&, int status);
  
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // implementation
  
  virtual const UStr* getTextSeparator() const;
    
  enum {REMOVE_FROM_PARENTS=-1};

  virtual UChildIter addImpl(UChildren&, const UChild&, UChildIter, 
                             bool update, bool* should_update);

  virtual UChildIter removeImpl(UChildren&, UChildIter, int rem_mode,
                                bool update, bool* should_update);
      
  virtual bool fire(UEvent&, const UOn&) const;

  virtual int getRelatedViews(std::vector<UView*>&) const;

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

#ifndef NO_DOC 
  friend class UBrick;
  friend class UWin;

  bool isBrowsingGroup() {return (cmodes & UMode::CAN_BROWSE_CHILDREN) != 0;}
  virtual UGroup* getBrowsingGroup() {return (cmodes & UMode::CAN_BROWSE_CHILDREN) ? this : null;}

  virtual void highlight(bool state) {};
  virtual void initView(UChild* selflink, UView *ancestor_view);
  virtual void initChildViews(UGroup*, UChild *childlink);
  virtual void updateView(UEvent&, UView*, const UUpdate&);
  
protected:
  mutable UChildren _children;
  virtual void  destructs();
  virtual void  deleteRelatedViews(UView* parview, UChild*);
  virtual void  deleteRelatedViews2(UView* parview);
  virtual int   getTextLength(bool recursive) const;
  virtual char* getTextData(char *ptr, bool recursive) const;
#endif
};

}
#endif
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [-c-Elc] ======= */

---