---

HTMLElement.h

Go to the documentation of this file.

/* -*-c++-*- */
/*
 *  $Id: HTMLElement.h,v 1.2 2002/03/06 02:49:55 sbooth Exp $
 *
 *  Copyright (C) 1996 - 2002 Stephen F. Booth
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef _HTMLELEMENT_H_
#define _HTMLELEMENT_H_ 1

#ifdef __GNUG__
#  pragma interface
#endif

#include <string>

#include "cgicc/CgiDefs.h"
#include "cgicc/MStreamable.h"
#include "cgicc/HTMLAttributeList.h"

CGICC_BEGIN_NAMESPACE

class HTMLElementList;

// ============================================================
// Class HTMLElement
// ============================================================

class CGICC_API HTMLElement : public MStreamable 
{
public:

  enum EElementType {
    eAtomic,
    eBoolean
  };
  
  // ============================================================


  HTMLElement(const HTMLElement& element);

  virtual ~HTMLElement();

  // ============================================================


  bool 
  operator== (const HTMLElement& element)               const;

  inline bool 
  operator!= (const HTMLElement& element)               const
    { return ! operator==(element); }

#ifdef WIN32
  /* Dummy operator for MSVC++ */
  inline bool
  operator< (const HTMLElement& element)                const
  { return false; }
#endif

  HTMLElement&
  operator= (const HTMLElement& element);

  // ============================================================
  

  virtual const char*
  getName()                                     const = 0;

  inline STDNS string
  getData()                                     const
  { return fData; }

  inline EElementType
  getType()                                     const
  { return fType; }

  // ============================================================


  inline void
  setData(const STDNS string& data)
  { fData = data; }

  // ============================================================

  virtual HTMLElement*
  clone()                                       const = 0;

  // ============================================================


  inline const HTMLElementList*
  getEmbedded()                                 const
  { return fEmbedded; }

  void 
  setEmbedded(const HTMLElementList& embedded);

  HTMLElement&
  add(const HTMLElement& element);

  HTMLElement&
  add(HTMLElement *element);
  
  // ============================================================


  inline const HTMLAttributeList*
  getAttributes()                               const
  { return fAttributes; }

  void 
  setAttributes(const HTMLAttributeList& attributes);

  HTMLElement&
  set(const STDNS string& name);

  HTMLElement&
  set(const STDNS string& name,
      const STDNS string& value);
  
  // ============================================================


  virtual void 
  swapState()                                   const
  {}
  
  virtual bool 
  getState()                                    const
  { return false; }

  virtual void 
  render(STDNS ostream& out)                    const;
  
protected:

  HTMLElement(const HTMLAttributeList *attributes,
              const HTMLElement *embedded,
              const STDNS string *data,
              EElementType type);

  inline bool
  dataSpecified()                               const
  { return fDataSpecified; }

private:
  HTMLElement() {}

  HTMLAttributeList *fAttributes;
  HTMLElementList   *fEmbedded;
  STDNS string      fData;
  EElementType      fType;
  bool              fDataSpecified;
};

CGICC_END_NAMESPACE

#endif /* ! _HTMLELEMENT_H_ */

---