khtml Library API Documentation

html_form.h

00001 /*
00002  * This file is part of the DOM implementation for KDE.
00003  *
00004  * (C) 1999 Lars Knoll (knoll@kde.org)
00005  *
00006  * This library is free software; you can redistribute it and/or
00007  * modify it under the terms of the GNU Library General Public
00008  * License as published by the Free Software Foundation; either
00009  * version 2 of the License, or (at your option) any later version.
00010  *
00011  * This library is distributed in the hope that it will be useful,
00012  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00013  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014  * Library General Public License for more details.
00015  *
00016  * You should have received a copy of the GNU Library General Public License
00017  * along with this library; see the file COPYING.LIB.  If not, write to
00018  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00019  * Boston, MA 02111-1307, USA.
00020  *
00021  * This file includes excerpts from the Document Object Model (DOM)
00022  * Level 1 Specification (Recommendation)
00023  * http://www.w3.org/TR/REC-DOM-Level-1/
00024  * Copyright © World Wide Web Consortium , (Massachusetts Institute of
00025  * Technology , Institut National de Recherche en Informatique et en
00026  * Automatique , Keio University ). All Rights Reserved.
00027  *
00028  */
00029 #ifndef HTML_FORM_H
00030 #define HTML_FORM_H
00031 
00032 // --------------------------------------------------------------------------
00033 #include <dom/html_element.h>
00034 #include <dom/html_misc.h>
00035 
00036 #include <kdemacros.h>
00037 
00038 namespace DOM {
00039 
00040 class HTMLButtonElementImpl;
00041 class HTMLFormElement;
00042 class DOMString;
00043 
00050 class HTMLButtonElement : public HTMLElement
00051 {
00052 public:
00053     HTMLButtonElement();
00054     HTMLButtonElement(const HTMLButtonElement &other);
00055     HTMLButtonElement(const Node &other) : HTMLElement()
00056          {(*this)=other;}
00057 protected:
00058     HTMLButtonElement(HTMLButtonElementImpl *impl);
00059 public:
00060 
00061     HTMLButtonElement & operator = (const HTMLButtonElement &other);
00062     HTMLButtonElement & operator = (const Node &other);
00063 
00064     ~HTMLButtonElement();
00065 
00072     HTMLFormElement form() const;
00073 
00081     DOMString accessKey() const;
00082 
00086     void setAccessKey( const DOMString & );
00087 
00094     bool disabled() const;
00095 
00099     void setDisabled( bool );
00100 
00108     DOMString name() const;
00109 
00113     void setName( const DOMString & );
00114 
00122     long tabIndex() const;
00123 
00127     void setTabIndex( long );
00128 
00135     DOMString type() const;
00136 
00143     DOMString value() const;
00144 
00148     void setValue( const DOMString & );
00149 };
00150 
00151 // --------------------------------------------------------------------------
00152 
00153 class HTMLFieldSetElementImpl;
00160 class HTMLFieldSetElement : public HTMLElement
00161 {
00162 public:
00163     HTMLFieldSetElement();
00164     HTMLFieldSetElement(const HTMLFieldSetElement &other);
00165     HTMLFieldSetElement(const Node &other) : HTMLElement()
00166          {(*this)=other;}
00167 protected:
00168     HTMLFieldSetElement(HTMLFieldSetElementImpl *impl);
00169 public:
00170 
00171     HTMLFieldSetElement & operator = (const HTMLFieldSetElement &other);
00172     HTMLFieldSetElement & operator = (const Node &other);
00173 
00174     ~HTMLFieldSetElement();
00175 
00179     HTMLFormElement form() const;
00180 };
00181 
00182 // --------------------------------------------------------------------------
00183 
00184 class HTMLFormElementImpl;
00194 class HTMLFormElement : public HTMLElement
00195 {
00196     friend class HTMLButtonElement;
00197     friend class HTMLFieldSetElement;
00198     friend class HTMLInputElement;
00199     friend class HTMLLabelElement;
00200     friend class HTMLLegendElement;
00201     friend class HTMLSelectElement;
00202     friend class HTMLTextAreaElement;
00203     friend class HTMLOptionElement;
00204     friend class HTMLIsIndexElement;
00205     friend class HTMLObjectElement;
00206 
00207 public:
00208     HTMLFormElement();
00209     HTMLFormElement(const HTMLFormElement &other);
00210     HTMLFormElement(const Node &other) : HTMLElement()
00211          {(*this)=other;}
00212 protected:
00213     HTMLFormElement(HTMLFormElementImpl *impl);
00214 public:
00215 
00216     HTMLFormElement & operator = (const HTMLFormElement &other);
00217     HTMLFormElement & operator = (const Node &other);
00218 
00219     ~HTMLFormElement();
00220 
00225     HTMLCollection elements() const;
00226 
00231     long length() const;
00232 
00237     DOMString name() const;
00238 
00242     void setName( const DOMString & );
00243 
00250     DOMString acceptCharset() const;
00251 
00255     void setAcceptCharset( const DOMString & );
00256 
00263     DOMString action() const;
00264 
00268     void setAction( const DOMString & );
00269 
00277     DOMString enctype() const;
00278 
00282     void setEnctype( const DOMString & );
00283 
00290     DOMString method() const;
00291 
00295     void setMethod( const DOMString & );
00296 
00303     DOMString target() const;
00304 
00308     void setTarget( const DOMString & );
00309 
00315     void submit (  );
00316 
00322     void reset (  );
00323 };
00324 
00325 // --------------------------------------------------------------------------
00326 
00327 class HTMLInputElementImpl;
00337 class HTMLInputElement : public HTMLElement
00338 {
00339 public:
00340     HTMLInputElement();
00341     HTMLInputElement(const HTMLInputElement &other);
00342     HTMLInputElement(const Node &other) : HTMLElement()
00343          {(*this)=other;}
00344 protected:
00345     HTMLInputElement(HTMLInputElementImpl *impl);
00346 public:
00347 
00348     HTMLInputElement & operator = (const HTMLInputElement &other);
00349     HTMLInputElement & operator = (const Node &other);
00350 
00351     ~HTMLInputElement();
00352 
00358     DOMString defaultValue() const;
00359 
00363     void setDefaultValue( const DOMString & );
00364 
00371     bool defaultChecked() const;
00372 
00376     void setDefaultChecked( bool );
00377 
00381     HTMLFormElement form() const;
00382 
00390     DOMString accept() const;
00391 
00395     void setAccept( const DOMString & );
00396 
00404     DOMString accessKey() const;
00405 
00409     void setAccessKey( const DOMString & );
00410 
00419     DOMString align() const;
00420 
00424     void setAlign( const DOMString & );
00425 
00433     DOMString alt() const;
00434 
00438     void setAlt( const DOMString & );
00439 
00449     bool checked() const;
00450 
00454     void setChecked( bool );
00455 
00462     bool disabled() const;
00463 
00467     void setDisabled( bool );
00468 
00476     long maxLength() const;
00477 
00481     void setMaxLength( long );
00482 
00490     DOMString name() const;
00491 
00495     void setName( const DOMString & );
00496 
00504     bool readOnly() const;
00505 
00506     // ### remove in 4.0
00510     void setReadOnly( bool );
00511 
00515     DOMString size() const KDE_DEPRECATED;
00516 
00520     void setSize( const DOMString & ) KDE_DEPRECATED;
00521 
00529     long getSize() const;
00530 
00534     void setSize( long );
00535 
00544     DOMString src() const;
00545 
00549     void setSrc( const DOMString & );
00550 
00558     long tabIndex() const;
00559 
00563     void setTabIndex( long );
00564 
00571     DOMString type() const;
00572 
00576     void setType(const DOMString&);
00577 
00584     DOMString useMap() const;
00585 
00589     void setUseMap( const DOMString & );
00590 
00598     DOMString value() const;
00599 
00603     void setValue( const DOMString & );
00604 
00609     void blur (  );
00610 
00615     void focus (  );
00616 
00623     void select (  );
00624 
00630     void click (  );
00631 };
00632 
00633 // --------------------------------------------------------------------------
00634 
00635 class HTMLLabelElementImpl;
00642 class HTMLLabelElement : public HTMLElement
00643 {
00644 public:
00645     HTMLLabelElement();
00646     HTMLLabelElement(const HTMLLabelElement &other);
00647     HTMLLabelElement(const Node &other) : HTMLElement()
00648          {(*this)=other;}
00649 protected:
00650     HTMLLabelElement(HTMLLabelElementImpl *impl);
00651 public:
00652 
00653     HTMLLabelElement & operator = (const HTMLLabelElement &other);
00654     HTMLLabelElement & operator = (const Node &other);
00655 
00656     ~HTMLLabelElement();
00657 
00665     DOMString accessKey() const;
00666 
00670     void setAccessKey( const DOMString & );
00671 
00679     DOMString htmlFor() const;
00680 
00684     void setHtmlFor( const DOMString & );
00685 };
00686 
00687 // --------------------------------------------------------------------------
00688 
00689 class HTMLLegendElementImpl;
00697 class HTMLLegendElement : public HTMLElement
00698 {
00699 public:
00700     HTMLLegendElement();
00701     HTMLLegendElement(const HTMLLegendElement &other);
00702     HTMLLegendElement(const Node &other) : HTMLElement()
00703          {(*this)=other;}
00704 protected:
00705     HTMLLegendElement(HTMLLegendElementImpl *impl);
00706 public:
00707 
00708     HTMLLegendElement & operator = (const HTMLLegendElement &other);
00709     HTMLLegendElement & operator = (const Node &other);
00710 
00711     ~HTMLLegendElement();
00712 
00716     HTMLFormElement form() const;
00717 
00725     DOMString accessKey() const;
00726 
00730     void setAccessKey( const DOMString & );
00731 
00739     DOMString align() const;
00740 
00744     void setAlign( const DOMString & );
00745 };
00746 
00747 // --------------------------------------------------------------------------
00748 
00749 class HTMLOptGroupElementImpl;
00756 class HTMLOptGroupElement : public HTMLElement
00757 {
00758 public:
00759     HTMLOptGroupElement();
00760     HTMLOptGroupElement(const HTMLOptGroupElement &other);
00761     HTMLOptGroupElement(const Node &other) : HTMLElement()
00762          {(*this)=other;}
00763 protected:
00764     HTMLOptGroupElement(HTMLOptGroupElementImpl *impl);
00765 public:
00766 
00767     HTMLOptGroupElement & operator = (const HTMLOptGroupElement &other);
00768     HTMLOptGroupElement & operator = (const Node &other);
00769 
00770     ~HTMLOptGroupElement();
00771 
00778     bool disabled() const;
00779 
00783     void setDisabled( bool );
00784 
00791     DOMString label() const;
00792 
00796     void setLabel( const DOMString & );
00797 };
00798 
00799 // --------------------------------------------------------------------------
00800 
00801 class HTMLSelectElementImpl;
00810 class HTMLSelectElement : public HTMLElement
00811 {
00812 public:
00813     HTMLSelectElement();
00814     HTMLSelectElement(const HTMLSelectElement &other);
00815     HTMLSelectElement(const Node &other) : HTMLElement()
00816          {(*this)=other;}
00817 protected:
00818     HTMLSelectElement(HTMLSelectElementImpl *impl);
00819 public:
00820 
00821     HTMLSelectElement & operator = (const HTMLSelectElement &other);
00822     HTMLSelectElement & operator = (const Node &other);
00823 
00824     ~HTMLSelectElement();
00825 
00830     DOMString type() const;
00831 
00838     long selectedIndex() const;
00839 
00843     void setSelectedIndex( long );
00844 
00849     DOMString value() const;
00850 
00854     void setValue( const DOMString & );
00855 
00860     long length() const;
00861 
00865     HTMLFormElement form() const;
00866 
00872     HTMLCollection options() const;
00873 
00880     bool disabled() const;
00881 
00885     void setDisabled( bool );
00886 
00894     bool multiple() const;
00895 
00899     void setMultiple( bool );
00900 
00908     DOMString name() const;
00909 
00913     void setName( const DOMString & );
00914 
00921     long size() const;
00922 
00926     void setSize( long );
00927 
00935     long tabIndex() const;
00936 
00940     void setTabIndex( long );
00941 
00952     void add ( const HTMLElement &element, const HTMLElement &before );
00953 
00962     void remove ( long index );
00963 
00968     void blur (  );
00969 
00974     void focus (  );
00975 };
00976 
00977 // --------------------------------------------------------------------------
00978 
00979 class HTMLTextAreaElementImpl;
00986 class HTMLTextAreaElement : public HTMLElement
00987 {
00988 public:
00989     HTMLTextAreaElement();
00990     HTMLTextAreaElement(const HTMLTextAreaElement &other);
00991     HTMLTextAreaElement(const Node &other) : HTMLElement()
00992          {(*this)=other;}
00993 protected:
00994     HTMLTextAreaElement(HTMLTextAreaElementImpl *impl);
00995 public:
00996 
00997     HTMLTextAreaElement & operator = (const HTMLTextAreaElement &other);
00998     HTMLTextAreaElement & operator = (const Node &other);
00999 
01000     ~HTMLTextAreaElement();
01001 
01007     DOMString defaultValue() const;
01008 
01012     void setDefaultValue( const DOMString & );
01013 
01017     HTMLFormElement form() const;
01018 
01026     DOMString accessKey() const;
01027 
01031     void setAccessKey( const DOMString & );
01032 
01039     long cols() const;
01040 
01044     void setCols( long );
01045 
01052     bool disabled() const;
01053 
01057     void setDisabled( bool );
01058 
01066     DOMString name() const;
01067 
01071     void setName( const DOMString & );
01072 
01079     bool readOnly() const;
01080 
01084     void setReadOnly( bool );
01085 
01092     long rows() const;
01093 
01097     void setRows( long );
01098 
01106     long tabIndex() const;
01107 
01111     void setTabIndex( long );
01112 
01117     DOMString type() const;
01118 
01125     DOMString value() const;
01126 
01130     void setValue( const DOMString & );
01131 
01135     void blur (  );
01136 
01140     void focus (  );
01141 
01145     void select (  );
01146 };
01147 
01148 // --------------------------------------------------------------------------
01149 
01150 class HTMLOptionElementImpl;
01157 class HTMLOptionElement : public HTMLElement
01158 {
01159 public:
01160     HTMLOptionElement();
01161     HTMLOptionElement(const HTMLOptionElement &other);
01162     HTMLOptionElement(const Node &other) : HTMLElement()
01163          {(*this)=other;}
01164 protected:
01165     HTMLOptionElement(HTMLOptionElementImpl *impl);
01166 public:
01167 
01168     HTMLOptionElement & operator = (const HTMLOptionElement &other);
01169     HTMLOptionElement & operator = (const Node &other);
01170 
01171     ~HTMLOptionElement();
01172 
01176     HTMLFormElement form() const;
01177 
01183     bool defaultSelected() const;
01184 
01188     void setDefaultSelected( bool );
01189 
01194     DOMString text() const;
01195 
01201     long index() const;
01202 
01209     void setIndex( long );
01210 
01217     bool disabled() const;
01218 
01222     void setDisabled( bool );
01223 
01230     DOMString label() const;
01231 
01235     void setLabel( const DOMString & );
01236 
01243     bool selected() const;
01244 
01248     void setSelected( bool );
01249 
01256     DOMString value() const;
01257 
01261     void setValue( const DOMString & );
01262 };
01263 
01264 
01265 // --------------------------------------------------------------------------
01266 
01267 class HTMLIsIndexElementImpl;
01268 class HTMLFormElement;
01269 
01277 class HTMLIsIndexElement : public HTMLElement
01278 {
01279 public:
01280     HTMLIsIndexElement();
01281     HTMLIsIndexElement(const HTMLIsIndexElement &other);
01282     HTMLIsIndexElement(const Node &other) : HTMLElement()
01283          {(*this)=other;}
01284 protected:
01285     HTMLIsIndexElement(HTMLIsIndexElementImpl *impl);
01286 public:
01287 
01288     HTMLIsIndexElement & operator = (const HTMLIsIndexElement &other);
01289     HTMLIsIndexElement & operator = (const Node &other);
01290 
01291     ~HTMLIsIndexElement();
01292 
01296     HTMLFormElement form() const;
01297 
01305     DOMString prompt() const;
01306 
01310     void setPrompt( const DOMString & );
01311 };
01312 
01313 } //namespace
01314 
01315 #endif
KDE Logo
This file is part of the documentation for khtml Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sun Jan 15 13:34:38 2006 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003