unode.hpp

/************************************************************************
 *
 *  unode.hpp: base class for objects that can be added to the scene graph
 *  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 _unode_hpp_
#define _unode_hpp_ 1
#include <ubit/udefs.hpp>
#include <ubit/uobject.hpp>
#include <ubit/uchild.hpp>
#include <ubit/uparent.hpp>
namespace ubit {

class UNode : public UObject {
  UNode(const UNode&); 
  
  UNode& operator=(const UNode&); 
    
public:
  //UCLASS("unode", UNode, null)
  UCLASS(UNode)

  
  enum NodeType {
    ELEMENT_NODE                   = 1,
    ATTRIBUTE_NODE                 = 2,
    TEXT_NODE                      = 3,
    CDATA_SECTION_NODE             = 4,
    ENTITY_REFERENCE_NODE          = 5,
    ENTITY_NODE                    = 6,
    PROCESSING_INSTRUCTION_NODE    = 7,
    COMMENT_NODE                   = 8,
    DOCUMENT_NODE                  = 9,
    DOCUMENT_TYPE_NODE             = 10,
    DOCUMENT_FRAGMENT_NODE         = 11,
    NOTATION_NODE                  = 12
  };
  
  enum DisplayType {
    WINLIST=-1, UNDISPLAYBLE=0, ATTRIBUTE, DATA, INLINE, BLOCK, BORDER, HARDWIN, SOFTWIN
  };

protected:
  explicit UNode();
  
  virtual ~UNode() {destructs();}
  
public:
  virtual int getNodeType() const {return 0;}
  
  virtual const UStr& getNodeName() const;

  virtual UStr getNodeValue() const;

  virtual int getDisplayType() const {return UNDISPLAYBLE;}
  virtual int isDisplayable() const {return getDisplayType() > 0;}

  virtual UNode* toNode() {return this;}
  virtual const UNode* toNode() const {return this;}
 
   // - - - parents - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual bool isChildOf(const UElem& parent, bool indirect = true) const;
  UParentIter pbegin() const {return parents().begin();}
  UParentIter pend() const {return parents().end();}

  virtual UParents& parents() const {return _parents;}
  
  virtual UElem* getParent(int pos = 0) const;
  virtual bool hasSceneGraphParent() const;   // redifined from UObject
  template <class CC>
    CC* findParent() const {
      for (UParentIter p = pbegin(); p != pend(); ++p) {
        if (dynamic_cast<CC*>(*p)) {return (CC*)*p;}
        else return ((UNode*)(*p))->findParent<CC>();
      }
      return null;
    }

  virtual int getBoxParents(std::vector<UBox*>& parvect) const;

  virtual UBox* getParent(const UView*) const;
  virtual UView* getParentView(const UView*) const;
  virtual UBox*  getParent(const UInputEvent&) const;
  
  
  virtual UView* getParentView(const UInputEvent&) const;
  /* returns the direct or *indirect* UBox parent (resp. parent's view) that contains this event.
    * intermediate UElem parents are ignored (ie. traversed) by this function.
    */
     
  virtual void removeFromParents(bool update_parents = true);
  // - - - misc.  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  
  friend UChild operator/(const UCond&, UNode&);  
  friend UChild operator/(const UCond&, UNode*);
  
  virtual bool fire(UEvent&) const;

  virtual UNode& removeAllAttrs(bool autodel = true);
      
  virtual void update() {}

  bool isAutoUpdate() const {return !omodes.DONT_AUTO_UPDATE;}
  
  UNode& setAutoUpdate(bool state = true);
protected:
  virtual void addingTo(UChild&, UElem& parent) {}
  
  virtual void removingFrom(UChild&, UElem& parent) {}
  virtual void destructs();
    
  // - - - Impl - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
#ifndef NO_DOC 
public:
  void fireParents(const UCond& c, UNode* n) const {_parents.fireParents(c,n);}
  
  void updateAutoParents(const UUpdate& m) {_parents.updateAutoParents(m);}    
  virtual void addChangeCall(UCall&);
  virtual UElem* getSubGroup() const {return null;}
  
  void _addAttr(const UChild& attribute);

  UChildIter _abegin() const {return _attributes.begin();}

  UChildIter _aend() const {return _attributes.end();}
  
protected:
  friend class UChild;
  friend class UArgs;
  friend class UParents;
  friend class UElem;
  mutable UParents _parents;
  mutable UChildren _attributes;  // attributes (including callbacks)
#endif
};

}
#endif