khtml/dom/html_form.h

   1 /*
   2  * This file is part of the DOM implementation for KDE.
   3  *
   4  * Copyright 1999 Lars Knoll (knoll@kde.org)
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Library General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Library General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Library General Public License
  17  * along with this library; see the file COPYING.LIB.  If not, write to
  18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  19  * Boston, MA 02110-1301, USA.
  20  *
  21  * This file includes excerpts from the Document Object Model (DOM)
  22  * Level 1 Specification (Recommendation)
  23  * http://www.w3.org/TR/REC-DOM-Level-1/
  24  * Copyright © World Wide Web Consortium , (Massachusetts Institute of
  25  * Technology , Institut National de Recherche en Informatique et en
  26  * Automatique , Keio University ). All Rights Reserved.
  27  *
  28  */
  29 #ifndef HTML_FORM_H
  30 #define HTML_FORM_H
  31
  32 // --------------------------------------------------------------------------
  33 #include <dom/html_element.h>
  34 #include <dom/html_misc.h>
  35
  36 #include <kdemacros.h>
  37
  38 namespace DOM {
  39
  40 class HTMLButtonElementImpl;
  41 class HTMLFormElement;
  42 class DOMString;
  43
  44 /**
  45  * Push button. See the <a
  46  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-BUTTON">
  47  * BUTTON element definition </a> in HTML 4.0.
  48  *
  49  */
  50 class KHTML_EXPORT HTMLButtonElement : public HTMLElement
  51 {
  52 public:
  53     HTMLButtonElement();
  54     HTMLButtonElement(const HTMLButtonElement &other);
  55     HTMLButtonElement(const Node &other) : HTMLElement()
  56          {(*this)=other;}
  57 protected:
  58     HTMLButtonElement(HTMLButtonElementImpl *impl);
  59 public:
  60
  61     HTMLButtonElement & operator = (const HTMLButtonElement &other);
  62     HTMLButtonElement & operator = (const Node &other);
  63
  64     ~HTMLButtonElement();
  65
  66     /**
  67      * Returns the \c FORM element containing this
  68      * control. Returns null if this control is not within the context
  69      * of a form.
  70      *
  71      */
  72     HTMLFormElement form() const;
  73
  74     /**
  75      * A single character access key to give access to the form
  76      * control. See the <a
  77      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-accesskey">
  78      * accesskey attribute definition </a> in HTML 4.0.
  79      *
  80      */
  81     DOMString accessKey() const;
  82
  83     /**
  84      * see accessKey
  85      */
  86     void setAccessKey( const DOMString & );
  87
  88     /**
  89      * The control is unavailable in this context. See the <a
  90      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-disabled">
  91      * disabled attribute definition </a> in HTML 4.0.
  92      *
  93      */
  94     bool disabled() const;
  95
  96     /**
  97      * see disabled
  98      */
  99     void setDisabled( bool );
 100
 101     /**
 102      * Form control or object name when submitted with a form. See the
 103      * <a
 104      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-name-BUTTON">
 105      * name attribute definition </a> in HTML 4.0.
 106      *
 107      */
 108     DOMString name() const;
 109
 110     /**
 111      * see name
 112      */
 113     void setName( const DOMString & );
 114
 115     /**
 116      * Index that represents the element's position in the tabbing
 117      * order. See the <a
 118      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-tabindex">
 119      * tabindex attribute definition </a> in HTML 4.0.
 120      *
 121      */
 122     long tabIndex() const;
 123
 124     /**
 125      * see tabIndex
 126      */
 127     void setTabIndex( long );
 128
 129     /**
 130      * The type of button. See the <a
 131      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-type-BUTTON">
 132      * type attribute definition </a> in HTML 4.0.
 133      *
 134      */
 135     DOMString type() const;
 136
 137     /**
 138      * The current form control value. See the <a
 139      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-value-BUTTON">
 140      * value attribute definition </a> in HTML 4.0.
 141      *
 142      */
 143     DOMString value() const;
 144
 145     /**
 146      * see value
 147      */
 148     void setValue( const DOMString & );
 149
 150     /**
 151      * Removes keyboard focus from this element.
 152      *
 153      */
 154     void blur (  );
 155
 156     /**
 157      * Gives keyboard focus to this element.
 158      *
 159      */
 160     void focus (  );
 161 };
 162
 163 // --------------------------------------------------------------------------
 164
 165 class HTMLFieldSetElementImpl;
 166 /**
 167  * Organizes form controls into logical groups. See the <a
 168  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-FIELDSET">
 169  * FIELDSET element definition </a> in HTML 4.0.
 170  *
 171  */
 172 class KHTML_EXPORT HTMLFieldSetElement : public HTMLElement
 173 {
 174 public:
 175     HTMLFieldSetElement();
 176     HTMLFieldSetElement(const HTMLFieldSetElement &other);
 177     HTMLFieldSetElement(const Node &other) : HTMLElement()
 178          {(*this)=other;}
 179 protected:
 180     HTMLFieldSetElement(HTMLFieldSetElementImpl *impl);
 181 public:
 182
 183     HTMLFieldSetElement & operator = (const HTMLFieldSetElement &other);
 184     HTMLFieldSetElement & operator = (const Node &other);
 185
 186     ~HTMLFieldSetElement();
 187
 188     /**
 189      * ### KDE 4.0: remove.
 190      */
 191     HTMLFormElement form() const;
 192 };
 193
 194 // --------------------------------------------------------------------------
 195
 196 class HTMLFormElementImpl;
 197 /**
 198  * The \c FORM element encompasses behavior similar to a
 199  * collection and an element. It provides direct access to the
 200  * contained input elements as well as the attributes of the form
 201  * element. See the <a
 202  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-FORM">
 203  * FORM element definition </a> in HTML 4.0.
 204  *
 205  */
 206 class KHTML_EXPORT HTMLFormElement : public HTMLElement
 207 {
 208     friend class HTMLButtonElement;
 209     friend class HTMLFieldSetElement;
 210     friend class HTMLInputElement;
 211     friend class HTMLLabelElement;
 212     friend class HTMLLegendElement;
 213     friend class HTMLSelectElement;
 214     friend class HTMLTextAreaElement;
 215     friend class HTMLOptionElement;
 216     friend class HTMLIsIndexElement;
 217     friend class HTMLObjectElement;
 218
 219 public:
 220     HTMLFormElement();
 221     HTMLFormElement(const HTMLFormElement &other);
 222     HTMLFormElement(const Node &other) : HTMLElement()
 223          {(*this)=other;}
 224 protected:
 225     HTMLFormElement(HTMLFormElementImpl *impl);
 226 public:
 227
 228     HTMLFormElement & operator = (const HTMLFormElement &other);
 229     HTMLFormElement & operator = (const Node &other);
 230
 231     ~HTMLFormElement();
 232
 233     /**
 234      * Returns a collection of all control elements in the form.
 235      *
 236      */
 237     HTMLCollection elements() const;
 238
 239     /**
 240      * The number of form controls in the form.
 241      *
 242      */
 243     long length() const;
 244
 245     /**
 246      * Names the form.
 247      *
 248      */
 249     DOMString name() const;
 250
 251     /**
 252      * see name
 253      */
 254     void setName( const DOMString & );
 255
 256     /**
 257      * List of character sets supported by the server. See the <a
 258      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-accept-charset">
 259      * accept-charset attribute definition </a> in HTML 4.0.
 260      *
 261      */
 262     DOMString acceptCharset() const;
 263
 264     /**
 265      * see acceptCharset
 266      */
 267     void setAcceptCharset( const DOMString & );
 268
 269     /**
 270      * Server-side form handler. See the <a
 271      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-action">
 272      * action attribute definition </a> in HTML 4.0.
 273      *
 274      */
 275     DOMString action() const;
 276
 277     /**
 278      * see action
 279      */
 280     void setAction( const DOMString & );
 281
 282     /**
 283      * The content type of the submitted form, generally
 284      * "application/x-www-form-urlencoded". See the <a
 285      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-enctype">
 286      * enctype attribute definition </a> in HTML 4.0.
 287      *
 288      */
 289     DOMString enctype() const;
 290
 291     /**
 292      * see enctype
 293      */
 294     void setEnctype( const DOMString & );
 295
 296     /**
 297      * HTTP method used to submit form. See the <a
 298      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-method">
 299      * method attribute definition </a> in HTML 4.0.
 300      *
 301      */
 302     DOMString method() const;
 303
 304     /**
 305      * see method
 306      */
 307     void setMethod( const DOMString & );
 308
 309     /**
 310      * Frame to render the resource in. See the <a
 311      * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-target">
 312      * target attribute definition </a> in HTML 4.0.
 313      *
 314      */
 315     DOMString target() const;
 316
 317     /**
 318      * see target
 319      */
 320     void setTarget( const DOMString & );
 321
 322     /**
 323      * Submits the form. It performs the same action as a submit
 324      * button.
 325      *
 326      */
 327     void submit (  );
 328
 329     /**
 330      * Restores a form element's default values. It performs the same
 331      * action as a reset button.
 332      *
 333      */
 334     void reset (  );
 335 };
 336
 337 // --------------------------------------------------------------------------
 338
 339 class HTMLInputElementImpl;
 340 /**
 341  * Form control. Note. Depending upon the environment the page is
 342  * being viewed, the value property may be read-only for the file
 343  * upload input type. For the "password" input type, the actual value
 344  * returned may be masked to prevent unauthorized use. See the <a
 345  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-INPUT">
 346  * INPUT element definition </a> in HTML 4.0.
 347  *
 348  */
 349 class KHTML_EXPORT HTMLInputElement : public HTMLElement
 350 {
 351 public:
 352     HTMLInputElement();
 353     HTMLInputElement(const HTMLInputElement &other);
 354     HTMLInputElement(const Node &other) : HTMLElement()
 355          {(*this)=other;}
 356 protected:
 357     HTMLInputElement(HTMLInputElementImpl *impl);
 358 public:
 359
 360     HTMLInputElement & operator = (const HTMLInputElement &other);
 361     HTMLInputElement & operator = (const Node &other);
 362
 363     ~HTMLInputElement();
 364
 365     /**
 366      * Stores the initial control value (i.e., the initial value of
 367      * \c value ).
 368      *
 369      */
 370     DOMString defaultValue() const;
 371
 372     /**
 373      * see defaultValue
 374      */
 375     void setDefaultValue( const DOMString & );
 376
 377     /**
 378      * When \c type has the value "Radio" or "Checkbox",
 379      * stores the initial value of the \c checked
 380      * attribute.
 381      *
 382      */
 383     bool defaultChecked() const;
 384
 385     /**
 386      * see defaultChecked
 387      */
 388     void setDefaultChecked( bool );
 389
 390     /**
 391      * ### KDE 4.0: remove.
 392      */
 393     HTMLFormElement form() const;
 394
 395     /**
 396      * A comma-separated list of content types that a server
 397      * processing this form will handle correctly. See the <a
 398      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-accept">
 399      * accept attribute definition </a> in HTML 4.0.
 400      *
 401      */
 402     DOMString accept() const;
 403
 404     /**
 405      * see accept
 406      */
 407     void setAccept( const DOMString & );
 408
 409     /**
 410      * A single character access key to give access to the form
 411      * control. See the <a
 412      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-accesskey">
 413      * accesskey attribute definition </a> in HTML 4.0.
 414      *
 415      */
 416     DOMString accessKey() const;
 417
 418     /**
 419      * see accessKey
 420      */
 421     void setAccessKey( const DOMString & );
 422
 423     /**
 424      * Aligns this object (vertically or horizontally) with respect to
 425      * its surrounding text. See the <a
 426      * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-align-IMG">
 427      * align attribute definition </a> in HTML 4.0. This attribute is
 428      * deprecated in HTML 4.0.
 429      *
 430      */
 431     DOMString align() const;
 432
 433     /**
 434      * see align
 435      */
 436     void setAlign( const DOMString & );
 437
 438     /**
 439      * Alternate text for user agents not rendering the normal content
 440      * of this element. See the <a
 441      * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-alt">
 442      * alt attribute definition </a> in HTML 4.0.
 443      *
 444      */
 445     DOMString alt() const;
 446
 447     /**
 448      * see alt
 449      */
 450     void setAlt( const DOMString & );
 451
 452     /**
 453      * Describes whether a radio or check box is checked, when
 454      * \c type has the value "Radio" or "Checkbox". The value is
 455      * true if explicitly set. Represents the current state of the
 456      * checkbox or radio button. See the <a
 457      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-checked">
 458      * checked attribute definition </a> in HTML 4.0.
 459      *
 460      */
 461     bool checked() const;
 462
 463     /**
 464      * see checked
 465      */
 466     void setChecked( bool );
 467
 468     /**
 469      * Describes whether a radio box is indeterminate
 470      */
 471     bool indeterminate() const;
 472
 473     /**
 474      * see indeterminate
 475      */
 476     void setIndeterminate( bool );
 477
 478     /**
 479      * The control is unavailable in this context. See the <a
 480      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-disabled">
 481      * disabled attribute definition </a> in HTML 4.0.
 482      *
 483      */
 484     bool disabled() const;
 485
 486     /**
 487      * see disabled
 488      */
 489     void setDisabled( bool );
 490
 491     /**
 492      * Maximum number of characters for text fields, when \c type
 493      * has the value "Text" or "Password". See the <a
 494      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-maxlength">
 495      * maxlength attribute definition </a> in HTML 4.0.
 496      *
 497      */
 498     long maxLength() const;
 499
 500     /**
 501      * see maxLength
 502      */
 503     void setMaxLength( long );
 504
 505     /**
 506      * Form control or object name when submitted with a form. See the
 507      * <a
 508      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-name-INPUT">
 509      * name attribute definition </a> in HTML 4.0.
 510      *
 511      */
 512     DOMString name() const;
 513
 514     /**
 515      * see name
 516      */
 517     void setName( const DOMString & );
 518
 519     /**
 520      * This control is read-only. When \c type has the
 521      * value "text" or "password" only. See the <a
 522      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-readonly">
 523      * readonly attribute definition </a> in HTML 4.0.
 524      *
 525      */
 526     bool readOnly() const;
 527
 528     // ### remove in 4.0
 529     /**
 530      * see readOnly
 531      */
 532     void setReadOnly( bool );
 533
 534     /**
 535      * @deprecated
 536      */
 537     KDE_DEPRECATED DOMString size() const;
 538
 539     /**
 540      * @deprecated
 541      */
 542     KDE_DEPRECATED void setSize( const DOMString & );
 543
 544     /**
 545      * Size information. The precise meaning is specific to each type
 546      * of field. See the <a
 547      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-size-INPUT">
 548      * size attribute definition </a> in HTML 4.0.
 549      *
 550      */
 551     long getSize() const;
 552
 553     /**
 554      * see getSize
 555      */
 556     void setSize( long );
 557
 558     /**
 559      * When the \c type attribute has the value "Image",
 560      * this attribute specifies the location of the image to be used
 561      * to decorate the graphical submit button. See the <a
 562      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-src">
 563      * src attribute definition </a> in HTML 4.0.
 564      *
 565      */
 566     DOMString src() const;
 567
 568     /**
 569      * see src
 570      */
 571     void setSrc( const DOMString & );
 572
 573     /**
 574      * Index that represents the element's position in the tabbing
 575      * order. See the <a
 576      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-tabindex">
 577      * tabindex attribute definition </a> in HTML 4.0.
 578      *
 579      */
 580     long tabIndex() const;
 581
 582     /**
 583      * see tabIndex
 584      */
 585     void setTabIndex( long );
 586
 587     /**
 588      * The type of control created. See the <a
 589      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-type-INPUT">
 590      * type attribute definition </a> in HTML 4.0.
 591      *
 592      */
 593     DOMString type() const;
 594
 595     /**
 596      * see type
 597      */
 598     void setType(const DOMString&);
 599
 600     /**
 601      * Use client-side image map. See the <a
 602      * href="http://www.w3.org/TR/REC-html40/struct/objects.html#adef-usemap">
 603      * usemap attribute definition </a> in HTML 4.0.
 604      *
 605      */
 606     DOMString useMap() const;
 607
 608     /**
 609      * see useMap
 610      */
 611     void setUseMap( const DOMString & );
 612
 613     /**
 614      * The current form control value. Used for radio buttons and
 615      * check boxes. See the <a
 616      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-value-INPUT">
 617      * value attribute definition </a> in HTML 4.0.
 618      *
 619      */
 620     DOMString value() const;
 621
 622     /**
 623      * see value
 624      */
 625     void setValue( const DOMString & );
 626
 627     /**
 628      * Removes keyboard focus from this element.
 629      *
 630      */
 631     void blur (  );
 632
 633     /**
 634      * Gives keyboard focus to this element.
 635      *
 636      */
 637     void focus (  );
 638
 639     /**
 640      * Select the contents of the text area. For \c INPUT
 641      * elements whose \c type attribute has one of the
 642      * following values: "Text", "File", or "Password".
 643      *
 644      */
 645     void select (  );
 646
 647     /**
 648      * Simulate a mouse-click. For \c INPUT elements whose
 649      * \c type attribute has one of the following values:
 650      * "Button", "Checkbox", "Radio", "Reset", or "Submit".
 651      */
 652     void click (  );
 653
 654
 655     /**
 656      * Returns the character offset of beginning of selection, or if none,
 657      * the cursor position.
 658      * This operation is only supported if the type of this element is text;
 659      * otherwise -1 is returned.
 660      * NOTE: this method is not part of the DOM, but a Mozilla extension
 661      */
 662     long selectionStart();
 663
 664      /**
 665       * Move the beginning of the selection to the given offset in text
 666       * This call has no effect if the type of this input element isn't text
 667       * NOTE: this method is not part of the DOM, but a Mozilla extension
 668       */
 669     void setSelectionStart(long offset);
 670
 671     /**
 672      * Returns the character offset of end of selection, or if none,
 673      * the cursor position.
 674      * This operation is only supported if the type of this element is text;
 675      * otherwise -1 is returned.
 676      * NOTE: this method is not part of the DOM, but a Mozilla extension
 677      */
 678      long selectionEnd();
 679
 680      /**
 681       * Move the end of the selection (and the cursor) to the given offset in text
 682       * This call has no effect if the type of this input element isn't text
 683       * NOTE: this method is not part of the DOM, but a Mozilla extension
 684       */
 685     void setSelectionEnd(long offset);
 686
 687      /**
 688       * Makes the position span from start to end, and positions the cursor after the selection.
 689       * This call has no effect if the type of this input element isn't text or if it is not rendered.
 690       * NOTE: this method is not part of the DOM, but a Mozilla extension
 691       */
 692     void setSelectionRange(long start, long end);
 693
 694 };
 695
 696 // --------------------------------------------------------------------------
 697
 698 class HTMLLabelElementImpl;
 699 /**
 700  * Form field label text. See the <a
 701  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-LABEL">
 702  * LABEL element definition </a> in HTML 4.0.
 703  *
 704  */
 705 class KHTML_EXPORT HTMLLabelElement : public HTMLElement
 706 {
 707 public:
 708     HTMLLabelElement();
 709     HTMLLabelElement(const HTMLLabelElement &other);
 710     HTMLLabelElement(const Node &other) : HTMLElement()
 711          {(*this)=other;}
 712 protected:
 713     HTMLLabelElement(HTMLLabelElementImpl *impl);
 714 public:
 715
 716     HTMLLabelElement & operator = (const HTMLLabelElement &other);
 717     HTMLLabelElement & operator = (const Node &other);
 718
 719     ~HTMLLabelElement();
 720
 721     /**
 722      * A single character access key to give access to the form
 723      * control. See the <a
 724      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-accesskey">
 725      * accesskey attribute definition </a> in HTML 4.0.
 726      *
 727      */
 728     DOMString accessKey() const;
 729
 730     /**
 731      * see accessKey
 732      */
 733     void setAccessKey( const DOMString & );
 734
 735     /**
 736      * This attribute links this label with another form control by
 737      * \c id attribute. See the <a
 738      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-for">
 739      * for attribute definition </a> in HTML 4.0.
 740      *
 741      */
 742     DOMString htmlFor() const;
 743
 744     /**
 745      * see htmlFor
 746      */
 747     void setHtmlFor( const DOMString & );
 748 };
 749
 750 // --------------------------------------------------------------------------
 751
 752 class HTMLLegendElementImpl;
 753 /**
 754  * Provides a caption for a \c FIELDSET grouping. See the
 755  * <a
 756  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-LEGEND">
 757  * LEGEND element definition </a> in HTML 4.0.
 758  *
 759  */
 760 class KHTML_EXPORT HTMLLegendElement : public HTMLElement
 761 {
 762 public:
 763     HTMLLegendElement();
 764     HTMLLegendElement(const HTMLLegendElement &other);
 765     HTMLLegendElement(const Node &other) : HTMLElement()
 766          {(*this)=other;}
 767 protected:
 768     HTMLLegendElement(HTMLLegendElementImpl *impl);
 769 public:
 770
 771     HTMLLegendElement & operator = (const HTMLLegendElement &other);
 772     HTMLLegendElement & operator = (const Node &other);
 773
 774     ~HTMLLegendElement();
 775
 776     /**
 777      * ### KDE 4.0: remove
 778      */
 779     HTMLFormElement form() const;
 780
 781     /**
 782      * A single character access key to give access to the form
 783      * control. See the <a
 784      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-accesskey">
 785      * accesskey attribute definition </a> in HTML 4.0.
 786      *
 787      */
 788     DOMString accessKey() const;
 789
 790     /**
 791      * see accessKey
 792      */
 793     void setAccessKey( const DOMString & );
 794
 795     /**
 796      * Text alignment relative to \c FIELDSET . See the <a
 797      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-align-LEGEND">
 798      * align attribute definition </a> in HTML 4.0. This attribute is
 799      * deprecated in HTML 4.0.
 800      *
 801      */
 802     DOMString align() const;
 803
 804     /**
 805      * see align
 806      */
 807     void setAlign( const DOMString & );
 808 };
 809
 810 // --------------------------------------------------------------------------
 811
 812 class HTMLOptGroupElementImpl;
 813 /**
 814  * Group options together in logical subdivisions. See the <a
 815  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTGROUP">
 816  * OPTGROUP element definition </a> in HTML 4.0.
 817  *
 818  */
 819 class KHTML_EXPORT HTMLOptGroupElement : public HTMLElement
 820 {
 821 public:
 822     HTMLOptGroupElement();
 823     HTMLOptGroupElement(const HTMLOptGroupElement &other);
 824     HTMLOptGroupElement(const Node &other) : HTMLElement()
 825          {(*this)=other;}
 826 protected:
 827     HTMLOptGroupElement(HTMLOptGroupElementImpl *impl);
 828 public:
 829
 830     HTMLOptGroupElement & operator = (const HTMLOptGroupElement &other);
 831     HTMLOptGroupElement & operator = (const Node &other);
 832
 833     ~HTMLOptGroupElement();
 834
 835     /**
 836      * The control is unavailable in this context. See the <a
 837      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-disabled">
 838      * disabled attribute definition </a> in HTML 4.0.
 839      *
 840      */
 841     bool disabled() const;
 842
 843     /**
 844      * see disabled
 845      */
 846     void setDisabled( bool );
 847
 848     /**
 849      * Assigns a label to this option group. See the <a
 850      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-label-OPTGROUP">
 851      * label attribute definition </a> in HTML 4.0.
 852      *
 853      */
 854     DOMString label() const;
 855
 856     /**
 857      * see label
 858      */
 859     void setLabel( const DOMString & );
 860 };
 861
 862 // --------------------------------------------------------------------------
 863
 864 class HTMLSelectElementImpl;
 865 /**
 866  * The select element allows the selection of an option. The contained
 867  * options can be directly accessed through the select element as a
 868  * collection. See the <a
 869  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-SELECT">
 870  * SELECT element definition </a> in HTML 4.0.
 871  *
 872  */
 873 class KHTML_EXPORT HTMLSelectElement : public HTMLElement
 874 {
 875 public:
 876     HTMLSelectElement();
 877     HTMLSelectElement(const HTMLSelectElement &other);
 878     HTMLSelectElement(const Node &other) : HTMLElement()
 879          {(*this)=other;}
 880 protected:
 881     HTMLSelectElement(HTMLSelectElementImpl *impl);
 882 public:
 883
 884     HTMLSelectElement & operator = (const HTMLSelectElement &other);
 885     HTMLSelectElement & operator = (const Node &other);
 886
 887     ~HTMLSelectElement();
 888
 889     /**
 890      * The type of control created.
 891      *
 892      */
 893     DOMString type() const;
 894
 895     /**
 896      * The ordinal index of the selected option. The value -1 is
 897      * returned if no element is selected. If multiple options are
 898      * selected, the index of the first selected option is returned.
 899      *
 900      */
 901     long selectedIndex() const;
 902
 903     /**
 904      * see selectedIndex
 905      */
 906     void setSelectedIndex( long );
 907
 908     /**
 909      * The current form control value.
 910      *
 911      */
 912     DOMString value() const;
 913
 914     /**
 915      * see value
 916      */
 917     void setValue( const DOMString & );
 918
 919     /**
 920      * The number of options in this \c SELECT .
 921      *
 922      */
 923     long length() const;
 924
 925     /**
 926      * ### KDE 4.0: remove.
 927      */
 928     HTMLFormElement form() const;
 929
 930     /**
 931      * The collection of \c OPTION elements contained by
 932      * this element.
 933      *
 934      */
 935     HTMLCollection options() const;
 936
 937     /**
 938      * The control is unavailable in this context. See the <a
 939      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-disabled">
 940      * disabled attribute definition </a> in HTML 4.0.
 941      *
 942      */
 943     bool disabled() const;
 944
 945     /**
 946      * see disabled
 947      */
 948     void setDisabled( bool );
 949
 950     /**
 951      * If true, multiple \c OPTION elements may be
 952      * selected in this \c SELECT . See the <a
 953      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-multiple">
 954      * multiple attribute definition </a> in HTML 4.0.
 955      *
 956      */
 957     bool multiple() const;
 958
 959     /**
 960      * see multiple
 961      */
 962     void setMultiple( bool );
 963
 964     /**
 965      * Form control or object name when submitted with a form. See the
 966      * <a
 967      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-name-SELECT">
 968      * name attribute definition </a> in HTML 4.0.
 969      *
 970      */
 971     DOMString name() const;
 972
 973     /**
 974      * see name
 975      */
 976     void setName( const DOMString & );
 977
 978     /**
 979      * Number of visible rows. See the <a
 980      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-size-SELECT">
 981      * size attribute definition </a> in HTML 4.0.
 982      *
 983      */
 984     long size() const;
 985
 986     /**
 987      * see size
 988      */
 989     void setSize( long );
 990
 991     /**
 992      * Index that represents the element's position in the tabbing
 993      * order. See the <a
 994      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-tabindex">
 995      * tabindex attribute definition </a> in HTML 4.0.
 996      *
 997      */
 998     long tabIndex() const;
 999
1000     /**
1001      * see tabIndex
1002      */
1003     void setTabIndex( long );
1004
1005     /**
1006      * Add a new element to the collection of \c OPTION
1007      * elements for this \c SELECT .
1008      *
1009      * @param element The element to add.
1010      *
1011      * @param before The element to insert before, or 0 for the
1012      * tail of the list.
1013      *
1014      */
1015     void add ( const HTMLElement &element, const HTMLElement &before );
1016
1017     /**
1018      * Remove an element from the collection of \c OPTION
1019      * elements for this \c SELECT . Does nothing if no
1020      * element has the given index.
1021      *
1022      * @param index The index of the item to remove.
1023      *
1024      */
1025     void remove ( long index );
1026
1027     /**
1028      * Removes keyboard focus from this element.
1029      *
1030      */
1031     void blur (  );
1032
1033     /**
1034      * Gives keyboard focus to this element.
1035      *
1036      */
1037     void focus (  );
1038 };
1039
1040 // --------------------------------------------------------------------------
1041
1042 class HTMLTextAreaElementImpl;
1043 /**
1044  * Multi-line text field. See the <a
1045  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-TEXTAREA">
1046  * TEXTAREA element definition </a> in HTML 4.0.
1047  *
1048  */
1049 class KHTML_EXPORT HTMLTextAreaElement : public HTMLElement
1050 {
1051 public:
1052     HTMLTextAreaElement();
1053     HTMLTextAreaElement(const HTMLTextAreaElement &other);
1054     HTMLTextAreaElement(const Node &other) : HTMLElement()
1055          {(*this)=other;}
1056 protected:
1057     HTMLTextAreaElement(HTMLTextAreaElementImpl *impl);
1058 public:
1059
1060     HTMLTextAreaElement & operator = (const HTMLTextAreaElement &other);
1061     HTMLTextAreaElement & operator = (const Node &other);
1062
1063     ~HTMLTextAreaElement();
1064
1065     /**
1066      * Stores the initial control value (i.e., the initial value of
1067      * \c value ).
1068      *
1069      */
1070     DOMString defaultValue() const;
1071
1072     /**
1073      * see defaultValue
1074      */
1075     void setDefaultValue( const DOMString & );
1076
1077     /**
1078      * ### KDE 4.0: remove.
1079      */
1080     HTMLFormElement form() const;
1081
1082     /**
1083      * A single character access key to give access to the form
1084      * control. See the <a
1085      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-accesskey">
1086      * accesskey attribute definition </a> in HTML 4.0.
1087      *
1088      */
1089     DOMString accessKey() const;
1090
1091     /**
1092      * see accessKey
1093      */
1094     void setAccessKey( const DOMString & );
1095
1096     /**
1097      * Width of control (in characters). See the <a
1098      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-cols-TEXTAREA">
1099      * cols attribute definition </a> in HTML 4.0.
1100      *
1101      */
1102     long cols() const;
1103
1104     /**
1105      * see cols
1106      */
1107     void setCols( long );
1108
1109     /**
1110      * The control is unavailable in this context. See the <a
1111      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-disabled">
1112      * disabled attribute definition </a> in HTML 4.0.
1113      *
1114      */
1115     bool disabled() const;
1116
1117     /**
1118      * see disabled
1119      */
1120     void setDisabled( bool );
1121
1122     /**
1123      * Form control or object name when submitted with a form. See the
1124      * <a
1125      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-name-TEXTAREA">
1126      * name attribute definition </a> in HTML 4.0.
1127      *
1128      */
1129     DOMString name() const;
1130
1131     /**
1132      * see name
1133      */
1134     void setName( const DOMString & );
1135
1136     /**
1137      * This control is read-only. See the <a
1138      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-readonly">
1139      * readonly attribute definition </a> in HTML 4.0.
1140      *
1141      */
1142     bool readOnly() const;
1143
1144     /**
1145      * see readOnly
1146      */
1147     void setReadOnly( bool );
1148
1149     /**
1150      * Number of text rows. See the <a
1151      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-rows-TEXTAREA">
1152      * rows attribute definition </a> in HTML 4.0.
1153      *
1154      */
1155     long rows() const;
1156
1157     /**
1158      * see rows
1159      */
1160     void setRows( long );
1161
1162     /**
1163      * Index that represents the element's position in the tabbing
1164      * order. See the <a
1165      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-tabindex">
1166      * tabindex attribute definition </a> in HTML 4.0.
1167      *
1168      */
1169     long tabIndex() const;
1170
1171     /**
1172      * see tabIndex
1173      */
1174     void setTabIndex( long );
1175
1176     /**
1177      * The type of this form control.
1178      *
1179      */
1180     DOMString type() const;
1181
1182     /**
1183      * The current textual content of the multi-line text field. If
1184      * the entirety of the data can not fit into a single wstring, the
1185      * implementation may truncate the data.
1186      *
1187      */
1188     DOMString value() const;
1189
1190     /**
1191      * see value
1192      */
1193     void setValue( const DOMString & );
1194
1195     /**
1196      * Removes keyboard focus from this element.
1197      */
1198     void blur (  );
1199
1200     /**
1201      * Gives keyboard focus to this element.
1202      */
1203     void focus (  );
1204
1205     /**
1206      * Select the contents of the \c TEXTAREA .
1207      */
1208     void select (  );
1209
1210     /**
1211      * Returns the character offset of beginning of selection, or if none,
1212      * the cursor position.
1213      * NOTE: this method is not part of the DOM, but a Mozilla extension
1214      */
1215     long selectionStart();
1216
1217      /**
1218       * Move the beginning of the selection to the given offset in text
1219       * NOTE: this method is not part of the DOM, but a Mozilla extension
1220       */
1221     void setSelectionStart(long offset);
1222
1223     /**
1224      * Returns the character offset of end of selection, or if none,
1225      * the cursor position.
1226      * NOTE: this method is not part of the DOM, but a Mozilla extension
1227      */
1228      long selectionEnd();
1229
1230      /**
1231       * Move the end of the selection (and the cursor) to the given offset in text
1232       * NOTE: this method is not part of the DOM, but a Mozilla extension
1233       */
1234     void setSelectionEnd(long offset);
1235
1236      /**
1237       * Selects the text from start to end, and positions the cursor after the selection.
1238       * NOTE: this method is not part of the DOM, but a Mozilla extension
1239       */
1240     void setSelectionRange(long start, long end);
1241
1242      /**
1243       * Returns the length of the text.
1244       * NOTE: this method is not part of the DOM, but a Mozilla extension
1245       */
1246       long textLength();
1247 };
1248
1249 // --------------------------------------------------------------------------
1250
1251 class HTMLOptionElementImpl;
1252 /**
1253  * A selectable choice. See the <a
1254  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-OPTION">
1255  * OPTION element definition </a> in HTML 4.0.
1256  *
1257  */
1258 class KHTML_EXPORT HTMLOptionElement : public HTMLElement
1259 {
1260 public:
1261     HTMLOptionElement();
1262     HTMLOptionElement(const HTMLOptionElement &other);
1263     HTMLOptionElement(const Node &other) : HTMLElement()
1264          {(*this)=other;}
1265 protected:
1266     HTMLOptionElement(HTMLOptionElementImpl *impl);
1267 public:
1268
1269     HTMLOptionElement & operator = (const HTMLOptionElement &other);
1270     HTMLOptionElement & operator = (const Node &other);
1271
1272     ~HTMLOptionElement();
1273
1274     /**
1275      * ### KDE 4.0: remove
1276      */
1277     HTMLFormElement form() const;
1278
1279     /**
1280      * Stores the initial value of the \c selected
1281      * attribute.
1282      *
1283      */
1284     bool defaultSelected() const;
1285
1286     /**
1287      * see defaultSelected
1288      */
1289     void setDefaultSelected( bool );
1290
1291     /**
1292      * The text contained within the option element.
1293      *
1294      */
1295     DOMString text() const;
1296
1297     /**
1298      * The index of this \c OPTION in its parent
1299      * \c SELECT .
1300      *
1301      */
1302     long index() const;
1303
1304     /**
1305      * see index
1306      *
1307      * This function is obsolete - the index property is actually supposed to be read-only
1308      * (http://www.w3.org/DOM/updates/REC-DOM-Level-1-19981001-errata.html)
1309      */
1310     void setIndex( long );
1311
1312     /**
1313      * The control is unavailable in this context. See the <a
1314      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-disabled">
1315      * disabled attribute definition </a> in HTML 4.0.
1316      *
1317      */
1318     bool disabled() const;
1319
1320     /**
1321      * see disabled
1322      */
1323     void setDisabled( bool );
1324
1325     /**
1326      * Option label for use in hierarchical menus. See the <a
1327      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-label-OPTION">
1328      * label attribute definition </a> in HTML 4.0.
1329      *
1330      */
1331     DOMString label() const;
1332
1333     /**
1334      * see label
1335      */
1336     void setLabel( const DOMString & );
1337
1338     /**
1339      * Means that this option is initially selected. See the <a
1340      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-selected">
1341      * selected attribute definition </a> in HTML 4.0.
1342      *
1343      */
1344     bool selected() const;
1345
1346     /**
1347      * see selected
1348      */
1349     void setSelected( bool );
1350
1351     /**
1352      * The current form control value. See the <a
1353      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-value-OPTION">
1354      * value attribute definition </a> in HTML 4.0.
1355      *
1356      */
1357     DOMString value() const;
1358
1359     /**
1360      * see value
1361      */
1362     void setValue( const DOMString & );
1363 };
1364
1365
1366 // --------------------------------------------------------------------------
1367
1368 class HTMLIsIndexElementImpl;
1369 class HTMLFormElement;
1370
1371 /**
1372  * This element is used for single-line text input. See the <a
1373  * href="http://www.w3.org/TR/REC-html40/interact/forms.html#edef-ISINDEX">
1374  * ISINDEX element definition </a> in HTML 4.0. This element is
1375  * deprecated in HTML 4.0.
1376  *
1377  */
1378 class KHTML_EXPORT HTMLIsIndexElement : public HTMLElement
1379 {
1380 public:
1381     HTMLIsIndexElement();
1382     HTMLIsIndexElement(const HTMLIsIndexElement &other);
1383     HTMLIsIndexElement(const Node &other) : HTMLElement()
1384          {(*this)=other;}
1385 protected:
1386     HTMLIsIndexElement(HTMLIsIndexElementImpl *impl);
1387 public:
1388
1389     HTMLIsIndexElement & operator = (const HTMLIsIndexElement &other);
1390     HTMLIsIndexElement & operator = (const Node &other);
1391
1392     ~HTMLIsIndexElement();
1393
1394     /**
1395      * ### KDE 4.0: remove
1396      */
1397     HTMLFormElement form() const;
1398
1399     /**
1400      * The prompt message. See the <a
1401      * href="http://www.w3.org/TR/REC-html40/interact/forms.html#adef-prompt">
1402      * prompt attribute definition </a> in HTML 4.0. This attribute is
1403      * deprecated in HTML 4.0.
1404      *
1405      */
1406     DOMString prompt() const;
1407
1408     /**
1409      * see prompt
1410      */
1411     void setPrompt( const DOMString & );
1412 };
1413
1414 } //namespace
1415
1416 #endif