HTMLElement.h

Go to the documentation of this file.

/* -*-mode:c++; c-file-style: "gnu";-*- */
/*
 *  $Id: HTMLElement_8h-source.html,v 1.3 2008/01/19 21:53:41 sebdiaz Exp $
 *
 *  Copyright (C) 1996 - 2004 Stephen F. Booth <sbooth@gnu.org>
 *                       2007 Sebastien DIAZ <sebastien.diaz@gmail.com>
 *  Part of the GNU cgicc library, http://www.gnu.org/software/cgicc
 *
 *  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 3 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110, 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"

namespace cgicc {

  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 std::string
    getData()                                   const
    { return fData; }
    
    inline EElementType
    getType()                                   const
    { return fType; }
    
    // ============================================================
    
    
    inline void
    setData(const std::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 std::string& name);
    
    HTMLElement&
    set(const std::string& name,
        const std::string& value);
    
    // ============================================================
    
    
    virtual void 
    swapState()                                 const
    {}
    
    virtual bool 
    getState()                                  const
    { return false; }
    
    virtual void 
    render(std::ostream& out)                   const;
    
  protected:
    
    HTMLElement(const HTMLAttributeList *attributes,
                const HTMLElement *embedded,
                const std::string *data,
                EElementType type);
    
    inline bool
    dataSpecified()                             const
    { return fDataSpecified; }
    
  private:
    HTMLElement() {}
    
    HTMLAttributeList   *fAttributes;
    HTMLElementList     *fEmbedded;
    std::string         fData;
    EElementType        fType;
    bool                fDataSpecified;
  };
  
} // namespace cgicc

#endif /* ! _HTMLELEMENT_H_ */

---