html_object.h 15.9 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/*
 * 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.
 *
21 22 23 24 25 26 27
 * 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.
 *
28 29 30 31 32 33 34
 */

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

#ifndef HTML_OBJECT_H
#define HTML_OBJECT_H

Lars Knoll's avatar
Lars Knoll committed
35 36
#include <dom/html_element.h>
#include <dom/html_form.h>
Frerich Raabe's avatar
Frerich Raabe committed
37
#include <kdemacros.h>
38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

namespace DOM {

class HTMLAppletElementImpl;

/**
 * An embedded Java applet. See the <a
 * href="http://www.w3.org/TR/REC-html40/struct/objects.html#edef-APPLET">
 * APPLET element definition </a> in HTML 4.0. This element is
 * deprecated in HTML 4.0.
 *
 */
class HTMLAppletElement : public HTMLElement
{
public:
    HTMLAppletElement();
    HTMLAppletElement(const HTMLAppletElement &other);
55 56
    HTMLAppletElement(const Node &other) : HTMLElement()
         {(*this)=other;}
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76
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 <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-align-IMG">
     * align attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString align() const;

    /**
77
     * see align
78 79 80 81 82 83 84 85 86 87 88 89 90 91
     */
    void setAlign( const DOMString & );

    /**
     * Alternate text for user agents not rendering the normal content
     * of this element. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-alt">
     * alt attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString alt() const;

    /**
92
     * see alt
93 94 95 96 97 98 99 100 101 102 103 104 105
     */
    void setAlt( const DOMString & );

    /**
     * Comma-separated archive list. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-archive-APPLET">
     * archive attribute definition </a> in HTML 4.0. This attribute
     * is deprecated in HTML 4.0.
     *
     */
    DOMString archive() const;

    /**
106
     * see archive
107 108 109 110 111 112 113 114 115 116 117 118 119
     */
    void setArchive( const DOMString & );

    /**
     * Applet class file. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-code">
     * code attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString code() const;

    /**
120
     * see code
121 122 123 124 125 126 127 128 129 130 131 132 133
     */
    void setCode( const DOMString & );

    /**
     * Optional base URI for applet. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-codebase-APPLET">
     * codebase attribute definition </a> in HTML 4.0. This attribute
     * is deprecated in HTML 4.0.
     *
     */
    DOMString codeBase() const;

    /**
134
     * see codeBase
135 136 137 138 139 140 141 142 143 144 145 146 147
     */
    void setCodeBase( const DOMString & );

    /**
     * Override height. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-height-APPLET">
     * height attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString height() const;

    /**
148
     * see height
149 150 151 152
     */
    void setHeight( const DOMString & );

    /**
153
     * Horizontal space, in pixels, to the left and right of this image, applet,
154 155 156 157 158 159
     * or object. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-hspace">
     * hspace attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
160 161 162
    long getHspace() const;

     /**
163
      * see hspace
164 165 166 167 168 169
      */
    void setHspace( long );

    /**
     * @deprecated
     */
Frerich Raabe's avatar
Frerich Raabe committed
170
    DOMString hspace() const KDE_DEPRECATED;
171 172

    /**
173
     * @deprecated
174
     */
Frerich Raabe's avatar
Frerich Raabe committed
175
    void setHspace( const DOMString & ) KDE_DEPRECATED;
176 177 178 179 180 181 182 183 184 185 186

    /**
     * The name of the applet. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-name-APPLET">
     * name attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString name() const;

    /**
187
     * see name
188 189 190 191 192 193 194 195 196 197 198 199 200
     */
    void setName( const DOMString & );

    /**
     * Serialized applet file. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-object">
     * object attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString object() const;

    /**
201
     * see object
202 203 204 205
     */
    void setObject( const DOMString & );

    /**
206
     * Vertical space, in pixels, above and below this image, applet, or object.
207 208 209 210 211 212
     * See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-vspace">
     * vspace attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
213 214 215
    long getVspace() const;

     /**
216
      * see vspace
217 218 219 220 221 222
      */
    void setVspace( long );

    /**
     * @deprecated
     */
Frerich Raabe's avatar
Frerich Raabe committed
223
    DOMString vspace() const KDE_DEPRECATED;
224 225

    /**
226
     * @deprecated
227
     */
Frerich Raabe's avatar
Frerich Raabe committed
228
    void setVspace( const DOMString & ) KDE_DEPRECATED;
229 230 231 232 233 234 235 236 237 238 239

    /**
     * Override width. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-width-APPLET">
     * width attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString width() const;

    /**
240
     * see width
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
     */
    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 <a
 * href="http://www.w3.org/TR/REC-html40/struct/objects.html#edef-OBJECT">
 * OBJECT element definition </a> in HTML 4.0.
 *
 */
class HTMLObjectElement : public HTMLElement
{
public:
    HTMLObjectElement();
    HTMLObjectElement(const HTMLObjectElement &other);
263 264
    HTMLObjectElement(const Node &other) : HTMLElement()
         {(*this)=other;}
265 266 267 268 269 270 271 272 273 274
protected:
    HTMLObjectElement(HTMLObjectElementImpl *impl);
public:

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

    ~HTMLObjectElement();

    /**
275
     * Returns the \c FORM element containing this
276 277 278 279 280 281 282
     * control. Returns null if this control is not within the context
     * of a form.
     *
     */
    HTMLFormElement form() const;

    /**
283
     * Applet class file. See the \c code attribute for
284 285 286 287 288 289
     * HTMLAppletElement.
     *
     */
    DOMString code() const;

    /**
290
     * see code
291 292 293 294 295 296 297 298 299 300 301 302 303 304
     */
    void setCode( const DOMString & );

    /**
     * Aligns this object (vertically or horizontally) with respect to
     * its surrounding text. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-align-IMG">
     * align attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString align() const;

    /**
305
     * see align
306 307 308 309 310 311 312 313 314 315 316 317
     */
    void setAlign( const DOMString & );

    /**
     * Space-separated list of archives. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-archive-OBJECT">
     * archive attribute definition </a> in HTML 4.0.
     *
     */
    DOMString archive() const;

    /**
318
     * see archive
319 320 321 322 323 324 325 326 327 328 329 330 331
     */
    void setArchive( const DOMString & );

    /**
     * Width of border around the object. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-border">
     * border attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString border() const;

    /**
332
     * see border
333 334 335 336
     */
    void setBorder( const DOMString & );

    /**
337 338
     * Base URI for \c classid , \c data , and
     * \c archive attributes. See the <a
339 340 341 342 343 344 345
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-codebase-OBJECT">
     * codebase attribute definition </a> in HTML 4.0.
     *
     */
    DOMString codeBase() const;

    /**
346
     * see codeBase
347 348 349 350
     */
    void setCodeBase( const DOMString & );

    /**
351
     * Content type for data downloaded via \c classid
352 353 354 355 356 357 358 359
     * attribute. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-codetype">
     * codetype attribute definition </a> in HTML 4.0.
     *
     */
    DOMString codeType() const;

    /**
360
     * see codeType
361 362 363 364 365 366 367 368 369 370 371 372
     */
    void setCodeType( const DOMString & );

    /**
     * A URI specifying the location of the object's data. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-data">
     * data attribute definition </a> in HTML 4.0.
     *
     */
    DOMString data() const;

    /**
373
     * see data
374 375 376 377 378 379 380 381 382 383 384 385 386
     */
    void setData( const DOMString & );

    /**
     * Declare (for future reference), but do not instantiate, this
     * object. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-declare">
     * declare attribute definition </a> in HTML 4.0.
     *
     */
    bool declare() const;

    /**
387
     * see declare
388 389 390 391 392 393 394 395 396 397 398 399
     */
    void setDeclare( bool );

    /**
     * Override height. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-height-IMG">
     * height attribute definition </a> in HTML 4.0.
     *
     */
    DOMString height() const;

    /**
400
     * see height
401 402 403 404
     */
    void setHeight( const DOMString & );

    /**
405
     * Horizontal space, in pixels, to the left and right of this image, applet,
406 407 408 409 410 411
     * or object. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-hspace">
     * hspace attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
412 413 414
    long getHspace() const;

     /**
415
      * see hspace
416 417 418 419 420 421
      */
    void setHspace( long );

    /**
     * @deprecated
     */
Frerich Raabe's avatar
Frerich Raabe committed
422
    DOMString hspace() const KDE_DEPRECATED;
423 424

    /**
425
     * @deprecated
426
     */
Frerich Raabe's avatar
Frerich Raabe committed
427
    void setHspace( const DOMString & ) KDE_DEPRECATED;
428 429 430 431 432 433 434 435 436 437 438

    /**
     * Form control or object name when submitted with a form. See the
     * <a
     * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-name-INPUT">
     * name attribute definition </a> in HTML 4.0.
     *
     */
    DOMString name() const;

    /**
439
     * see name
440 441 442 443 444 445 446 447 448 449 450 451
     */
    void setName( const DOMString & );

    /**
     * Message to render while loading the object. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-standby">
     * standby attribute definition </a> in HTML 4.0.
     *
     */
    DOMString standby() const;

    /**
452
     * see standby
453 454 455 456 457 458 459 460 461 462 463 464 465
     */
    void setStandby( const DOMString & );

    /**
     * Index that represents the element's position in the tabbing
     * order. See the <a
     * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-tabindex">
     * tabindex attribute definition </a> in HTML 4.0.
     *
     */
    long tabIndex() const;

    /**
466
     * see tabIndex
467 468 469 470
     */
    void setTabIndex( long );

    /**
471
     * Content type for data downloaded via \c data
472 473 474 475 476 477 478 479
     * attribute. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-type-OBJECT">
     * type attribute definition </a> in HTML 4.0.
     *
     */
    DOMString type() const;

    /**
480
     * see type
481 482 483 484 485 486 487 488 489 490 491 492
     */
    void setType( const DOMString & );

    /**
     * Use client-side image map. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-usemap">
     * usemap attribute definition </a> in HTML 4.0.
     *
     */
    DOMString useMap() const;

    /**
493
     * see useMap
494 495 496 497
     */
    void setUseMap( const DOMString & );

    /**
498
     * Vertical space, in pixels, above and below this image, applet, or object.
499 500 501 502 503 504
     * See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-vspace">
     * vspace attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
505 506 507
    long getVspace() const;

     /**
508
      * see vspace
509 510 511 512 513 514
      */
    void setVspace( long );

    /**
     * @deprecated
     */
Frerich Raabe's avatar
Frerich Raabe committed
515
    DOMString vspace() const KDE_DEPRECATED;
516 517

    /**
518
     * @deprecated
519
     */
Frerich Raabe's avatar
Frerich Raabe committed
520
    void setVspace( const DOMString & ) KDE_DEPRECATED;
521 522 523 524 525 526 527 528 529 530

    /**
     * Override width. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-width-IMG">
     * width attribute definition </a> in HTML 4.0.
     *
     */
    DOMString width() const;

    /**
531
     * see width
532 533
     */
    void setWidth( const DOMString & );
534 535 536 537 538 539 540 541 542 543 544

    /**
     * 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;
545 546 547 548 549 550 551
};

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

class HTMLParamElementImpl;

/**
552
 * Parameters fed to the \c OBJECT element. See the <a
553 554 555 556 557 558 559 560 561
 * href="http://www.w3.org/TR/REC-html40/struct/objects.html#edef-PARAM">
 * PARAM element definition </a> in HTML 4.0.
 *
 */
class HTMLParamElement : public HTMLElement
{
public:
    HTMLParamElement();
    HTMLParamElement(const HTMLParamElement &other);
562 563
    HTMLParamElement(const Node &other) : HTMLElement()
         {(*this)=other;}
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581
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 <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-name-PARAM">
     * name attribute definition </a> in HTML 4.0.
     *
     */
    DOMString name() const;

    /**
582
     * see name
583 584 585 586
     */
    void setName( const DOMString & );

    /**
587 588
     * Content type for the \c value attribute when
     * \c valuetype has the value "ref". See the <a
589 590 591 592 593 594 595
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-type-PARAM">
     * type attribute definition </a> in HTML 4.0.
     *
     */
    DOMString type() const;

    /**
596
     * see type
597 598 599 600 601 602 603 604 605 606 607 608
     */
    void setType( const DOMString & );

    /**
     * The value of a run-time parameter. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-value-PARAM">
     * value attribute definition </a> in HTML 4.0.
     *
     */
    DOMString value() const;

    /**
609
     * see value
610 611 612 613
     */
    void setValue( const DOMString & );

    /**
614
     * Information about the meaning of the \c value
615 616 617 618 619 620 621 622
     * attribute value. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-valuetype">
     * valuetype attribute definition </a> in HTML 4.0.
     *
     */
    DOMString valueType() const;

    /**
623
     * see valueType
624 625 626 627
     */
    void setValueType( const DOMString & );
};

Dirk Mueller's avatar
Dirk Mueller committed
628
} // namespace
629 630

#endif