Source: dom/html_object.h

# Source: dom/html_object.h |
Annotated List
Files
Globals
Hierarchy
Index

    /*
     * This file is part of the DOM implementation for KDE.
     *
     * (C) 1999 Lars Knoll (knoll@kde.org)
     *
     * This library is free software; you can redistribute it and/or
     * modify it under the terms of the GNU Library General Public
     * License as published by the Free Software Foundation; either
     * version 2 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
     * Library General Public License for more details.
     *
     * You should have received a copy of the GNU Library General Public License
     * along with this library; see the file COPYING.LIB.  If not, write to
     * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
     * Boston, MA 02111-1307, USA.
     *
     * This file includes excerpts from the Document Object Model (DOM)
     * Level 1 Specification (Recommendation)
     * http://www.w3.org/TR/REC-DOM-Level-1/
     * Copyright © World Wide Web Consortium , (Massachusetts Institute of
     * Technology , Institut National de Recherche en Informatique et en
     * Automatique , Keio University ). All Rights Reserved.
     *
     * $Id: html_object.h,v 1.9.4.2 2003/05/18 12:34:37 mueller Exp $
     */

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

    #ifndef HTML_OBJECT_H
    #define HTML_OBJECT_H

    #include
    #include

    namespace DOM {

    class HTMLAppletElementImpl;

    /**
     * An embedded Java applet. See the
     * APPLET element definition  in HTML 4.0. This element is
     * deprecated in HTML 4.0.
     *
     */
    class HTMLAppletElement : public HTMLElement
    {
    public:
        HTMLAppletElement();
        HTMLAppletElement(const HTMLAppletElement &other);
        HTMLAppletElement(const Node &other) : HTMLElement()
             {(*this)=other;}
    protected:
        HTMLAppletElement(HTMLAppletElementImpl *impl);
    public:

        HTMLAppletElement & operator = (const HTMLAppletElement &other);
        HTMLAppletElement & operator = (const Node &other);

        ~HTMLAppletElement();

        /**
         * Aligns this object (vertically or horizontally) with respect to
         * its surrounding text. See the
         * align attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString align() const;

        /**
         * see @ref align
         */
        void setAlign( const DOMString & );

        /**
         * Alternate text for user agents not rendering the normal content
         * of this element. See the
         * alt attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString alt() const;

        /**
         * see @ref alt
         */
        void setAlt( const DOMString & );

        /**
         * Comma-separated archive list. See the
         * archive attribute definition  in HTML 4.0. This attribute
         * is deprecated in HTML 4.0.
         *
         */
        DOMString archive() const;

        /**
         * see @ref archive
         */
        void setArchive( const DOMString & );

        /**
         * Applet class file. See the
         * code attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString code() const;

        /**
         * see @ref code
         */
        void setCode( const DOMString & );

        /**
         * Optional base URI for applet. See the
         * codebase attribute definition  in HTML 4.0. This attribute
         * is deprecated in HTML 4.0.
         *
         */
        DOMString codeBase() const;

        /**
         * see @ref codeBase
         */
        void setCodeBase( const DOMString & );

        /**
         * Override height. See the
         * height attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString height() const;

        /**
         * see @ref height
         */
        void setHeight( const DOMString & );

        /**
         * Horizontal space, in pixels, to the left and right of this image, applet,
         * or object. See the
         * hspace attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        long getHspace() const;

         /**
          * see @ref hspace
          */
        void setHspace( long );

        /**
         * @deprecated
         */
        DOMString hspace() const;

        /**
         * @deprecated
         */
        void setHspace( const DOMString & );

        /**
         * The name of the applet. See the
         * name attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString name() const;

        /**
         * see @ref name
         */
        void setName( const DOMString & );

        /**
         * Serialized applet file. See the
         * object attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString object() const;

        /**
         * see @ref object
         */
        void setObject( const DOMString & );

        /**
         * Vertical space, in pixels, above and below this image, applet, or object.
         * See the
         * vspace attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        long getVspace() const;

         /**
          * see @ref vspace
          */
        void setVspace( long );

        /**
         * @deprecated
         */
        DOMString vspace() const;

        /**
         * @deprecated
         */
        void setVspace( const DOMString & );

        /**
         * Override width. See the
         * width attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString width() const;

        /**
         * see @ref width
         */
        void setWidth( const DOMString & );
    };

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

    class HTMLObjectElementImpl;

    /**
     * Generic embedded object. Note. In principle, all properties on the
     * object element are read-write but in some environments some
     * properties may be read-only once the underlying object is
     * instantiated. See the
     * OBJECT element definition  in HTML 4.0.
     *
     */
    class HTMLObjectElement : public HTMLElement
    {
    public:
        HTMLObjectElement();
        HTMLObjectElement(const HTMLObjectElement &other);
        HTMLObjectElement(const Node &other) : HTMLElement()
             {(*this)=other;}
    protected:
        HTMLObjectElement(HTMLObjectElementImpl *impl);
    public:

        HTMLObjectElement & operator = (const HTMLObjectElement &other);
        HTMLObjectElement & operator = (const Node &other);

        ~HTMLObjectElement();

        /**
         * Returns the  FORM  element containing this
         * control. Returns null if this control is not within the context
         * of a form.
         *
         */
        HTMLFormElement form() const;

        /**
         * Applet class file. See the  code  attribute for
         * HTMLAppletElement.
         *
         */
        DOMString code() const;

        /**
         * see @ref code
         */
        void setCode( const DOMString & );

        /**
         * Aligns this object (vertically or horizontally) with respect to
         * its surrounding text. See the
         * align attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString align() const;

        /**
         * see @ref align
         */
        void setAlign( const DOMString & );

        /**
         * Space-separated list of archives. See the
         * archive attribute definition  in HTML 4.0.
         *
         */
        DOMString archive() const;

        /**
         * see @ref archive
         */
        void setArchive( const DOMString & );

        /**
         * Width of border around the object. See the
         * border attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        DOMString border() const;

        /**
         * see @ref border
         */
        void setBorder( const DOMString & );

        /**
         * Base URI for  classid  ,  data  , and
         *  archive  attributes. See the
         * codebase attribute definition  in HTML 4.0.
         *
         */
        DOMString codeBase() const;

        /**
         * see @ref codeBase
         */
        void setCodeBase( const DOMString & );

        /**
         * Content type for data downloaded via  classid
         * attribute. See the
         * codetype attribute definition  in HTML 4.0.
         *
         */
        DOMString codeType() const;

        /**
         * see @ref codeType
         */
        void setCodeType( const DOMString & );

        /**
         * A URI specifying the location of the object's data. See the
         * data attribute definition  in HTML 4.0.
         *
         */
        DOMString data() const;

        /**
         * see @ref data
         */
        void setData( const DOMString & );

        /**
         * Declare (for future reference), but do not instantiate, this
         * object. See the
         * declare attribute definition  in HTML 4.0.
         *
         */
        bool declare() const;

        /**
         * see @ref declare
         */
        void setDeclare( bool );

        /**
         * Override height. See the
         * height attribute definition  in HTML 4.0.
         *
         */
        DOMString height() const;

        /**
         * see @ref height
         */
        void setHeight( const DOMString & );

        /**
         * Horizontal space, in pixels, to the left and right of this image, applet,
         * or object. See the
         * hspace attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        long getHspace() const;

         /**
          * see @ref hspace
          */
        void setHspace( long );

        /**
         * @deprecated
         */
        DOMString hspace() const;

        /**
         * @deprecated
         */
        void setHspace( const DOMString & );

        /**
         * Form control or object name when submitted with a form. See the
         *
         * name attribute definition  in HTML 4.0.
         *
         */
        DOMString name() const;

        /**
         * see @ref name
         */
        void setName( const DOMString & );

        /**
         * Message to render while loading the object. See the
         * standby attribute definition  in HTML 4.0.
         *
         */
        DOMString standby() const;

        /**
         * see @ref standby
         */
        void setStandby( const DOMString & );

        /**
         * Index that represents the element's position in the tabbing
         * order. See the
         * tabindex attribute definition  in HTML 4.0.
         *
         */
        long tabIndex() const;

        /**
         * see @ref tabIndex
         */
        void setTabIndex( long );

        /**
         * Content type for data downloaded via  data
         * attribute. See the
         * type attribute definition  in HTML 4.0.
         *
         */
        DOMString type() const;

        /**
         * see @ref type
         */
        void setType( const DOMString & );

        /**
         * Use client-side image map. See the
         * usemap attribute definition  in HTML 4.0.
         *
         */
        DOMString useMap() const;

        /**
         * see @ref useMap
         */
        void setUseMap( const DOMString & );

        /**
         * Vertical space, in pixels, above and below this image, applet, or object.
         * See the
         * vspace attribute definition  in HTML 4.0. This attribute is
         * deprecated in HTML 4.0.
         *
         */
        long getVspace() const;

         /**
          * see @ref vspace
          */
        void setVspace( long );

        /**
         * @deprecated
         */
        DOMString vspace() const;

        /**
         * @deprecated
         */
        void setVspace( const DOMString & );

        /**
         * Override width. See the
         * width attribute definition  in HTML 4.0.
         *
         */
        DOMString width() const;

        /**
         * see @ref width
         */
        void setWidth( const DOMString & );

        /**
         * Introduced in DOM Level 2
         *
         * Returns the document this iframe contains, if there is any and
         * it is available, a Null document otherwise. The attribute is
         * read-only.
         *
         * @return The content Document if available.
         */
        Document contentDocument() const;
    };

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

    class HTMLParamElementImpl;

    /**
     * Parameters fed to the  OBJECT  element. See the
     * PARAM element definition  in HTML 4.0.
     *
     */
    class HTMLParamElement : public HTMLElement
    {
    public:
        HTMLParamElement();
        HTMLParamElement(const HTMLParamElement &other);
        HTMLParamElement(const Node &other) : HTMLElement()
             {(*this)=other;}
    protected:
        HTMLParamElement(HTMLParamElementImpl *impl);
    public:

        HTMLParamElement & operator = (const HTMLParamElement &other);
        HTMLParamElement & operator = (const Node &other);

        ~HTMLParamElement();

        /**
         * The name of a run-time parameter. See the
         * name attribute definition  in HTML 4.0.
         *
         */
        DOMString name() const;

        /**
         * see @ref name
         */
        void setName( const DOMString & );

        /**
         * Content type for the  value  attribute when
         * valuetype  has the value "ref". See the
         * type attribute definition  in HTML 4.0.
         *
         */
        DOMString type() const;

        /**
         * see @ref type
         */
        void setType( const DOMString & );

        /**
         * The value of a run-time parameter. See the
         * value attribute definition  in HTML 4.0.
         *
         */
        DOMString value() const;

        /**
         * see @ref value
         */
        void setValue( const DOMString & );

        /**
         * Information about the meaning of the  value
         * attribute value. See the
         * valuetype attribute definition  in HTML 4.0.
         *
         */
        DOMString valueType() const;

        /**
         * see @ref valueType
         */
        void setValueType( const DOMString & );
    };

    }

    #endif

Generated by: root on macppc.ports.openbsd.org on Sat Sep 6 10:37:43 2003, using kdoc 2.0a54.