summaryrefslogtreecommitdiffstats
path: root/khtml/dom/html_base.h
blob: 9811b1ea469203bedd530607c15c136ffd7d41db (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
/*
 * 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., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, 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.
 *
 */

#ifndef HTML_BASE_H
#define HTML_BASE_H

#include <dom/html_element.h>

#include <kdelibs_export.h>

namespace DOM {

class HTMLBodyElementImpl;
class DOMString;

/**
 * The HTML document body. This element is always present in the DOM
 * API, even if the tags are not present in the source document. See
 * the <a
 * href="http://www.w3.org/TR/REC-html40/struct/global.html#edef-BODY">
 * BODY element definition </a> in HTML 4.0.
 *
 */
class KHTML_EXPORT HTMLBodyElement : public HTMLElement
{
public:
    HTMLBodyElement();
    HTMLBodyElement(const HTMLBodyElement &other);
    HTMLBodyElement(const Node &other) : HTMLElement()
         {(*this)=other;}
protected:
    HTMLBodyElement(HTMLBodyElementImpl *impl);
public:

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

    ~HTMLBodyElement();

    /**
     * Color of active links (after mouse-button down, but before
     * mouse-button up). See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/global.html#adef-alink">
     * alink attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString aLink() const;

    /**
     * see aLink
     */
    void setALink( const DOMString & );

    /**
     * URI of the background texture tile image. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/global.html#adef-background">
     * background attribute definition </a> in HTML 4.0. This
     * attribute is deprecated in HTML 4.0.
     *
     */
    DOMString background() const;

    /**
     * see background
     */
    void setBackground( const DOMString & );

    /**
     * Document background color. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/graphics.html#adef-bgcolor">
     * bgcolor attribute definition </a> in HTML 4.0. This attribute
     * is deprecated in HTML 4.0.
     *
     */
    DOMString bgColor() const;

    /**
     * see bgColor
     */
    void setBgColor( const DOMString & );

    /**
     * Color of links that are not active and unvisited. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/global.html#adef-link">
     * link attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString link() const;

    /**
     * see link
     */
    void setLink( const DOMString & );

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

    /**
     * see text
     */
    void setText( const DOMString & );

    /**
     * Color of links that have been visited by the user. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/global.html#adef-vlink">
     * vlink attribute definition </a> in HTML 4.0. This attribute is
     * deprecated in HTML 4.0.
     *
     */
    DOMString vLink() const;

    /**
     * see vLink
     */
    void setVLink( const DOMString & );
};

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

class HTMLFrameElementImpl;
class DOMString;

/**
 * Create a frame. See the <a
 * href="http://www.w3.org/TR/REC-html40/present/frames.html#edef-FRAME">
 * FRAME element definition </a> in HTML 4.0.
 *
 */
class KHTML_EXPORT HTMLFrameElement : public HTMLElement
{
public:
    HTMLFrameElement();
    HTMLFrameElement(const HTMLFrameElement &other);
    HTMLFrameElement(const Node &other) : HTMLElement()
         {(*this)=other;}
protected:
    HTMLFrameElement(HTMLFrameElementImpl *impl);
public:

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

    ~HTMLFrameElement();

    /**
     * Request frame borders. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-frameborder">
     * frameborder attribute definition </a> in HTML 4.0.
     *
     */
    DOMString frameBorder() const;

    /**
     * see frameBorder
     */
    void setFrameBorder( const DOMString & );

    /**
     * URI designating a long description of this image or frame. See
     * the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-longdesc-FRAME">
     * longdesc attribute definition </a> in HTML 4.0.
     *
     */
    DOMString longDesc() const;

    /**
     * see longDesc
     */
    void setLongDesc( const DOMString & );

    /**
     * Frame margin height, in pixels. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-marginheight">
     * marginheight attribute definition </a> in HTML 4.0.
     *
     */
    DOMString marginHeight() const;

    /**
     * see marginHeight
     */
    void setMarginHeight( const DOMString & );

    /**
     * Frame margin width, in pixels. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-marginwidth">
     * marginwidth attribute definition </a> in HTML 4.0.
     *
     */
    DOMString marginWidth() const;

    /**
     * see marginWidth
     */
    void setMarginWidth( const DOMString & );

    /**
     * The frame name (object of the \c target attribute).
     * See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-name-FRAME">
     * name attribute definition </a> in HTML 4.0.
     *
     */
    DOMString name() const;

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

    /**
     * When true, forbid user from resizing frame. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-noresize">
     * noresize attribute definition </a> in HTML 4.0.
     *
     */
    bool noResize() const;

    /**
     * see noResize
     */
    void setNoResize( bool );

    /**
     * Specify whether or not the frame should have scrollbars. See
     * the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-scrolling">
     * scrolling attribute definition </a> in HTML 4.0.
     *
     */
    DOMString scrolling() const;

    /**
     * see scrolling
     */
    void setScrolling( const DOMString & );

    /**
     * A URI designating the initial frame contents. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-src-FRAME">
     * src attribute definition </a> in HTML 4.0.
     *
     */
    DOMString src() const;

    /**
     * see src
     */
    void setSrc( const DOMString & );

    /**
     * Introduced in DOM Level 2
     *
     * Returns the document this frame tqcontains, 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 HTMLFrameSetElementImpl;
class DOMString;

/**
 * Create a grid of frames. See the <a
 * href="http://www.w3.org/TR/REC-html40/present/frames.html#edef-FRAMESET">
 * FRAMESET element definition </a> in HTML 4.0.
 *
 */
class KHTML_EXPORT HTMLFrameSetElement : public HTMLElement
{
public:
    HTMLFrameSetElement();
    HTMLFrameSetElement(const HTMLFrameSetElement &other);
    HTMLFrameSetElement(const Node &other) : HTMLElement()
         {(*this)=other;}
protected:
    HTMLFrameSetElement(HTMLFrameSetElementImpl *impl);
public:

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

    ~HTMLFrameSetElement();

    /**
     * The number of columns of frames in the frameset. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-cols-FRAMESET">
     * cols attribute definition </a> in HTML 4.0.
     *
     */
    DOMString cols() const;

    /**
     * see cols
     */
    void setCols( const DOMString & );

    /**
     * The number of rows of frames in the frameset. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-rows-FRAMESET">
     * rows attribute definition </a> in HTML 4.0.
     *
     */
    DOMString rows() const;

    /**
     * see rows
     */
    void setRows( const DOMString & );
};

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

class HTMLIFrameElementImpl;

/**
 * Inline subwindows. See the <a
 * href="http://www.w3.org/TR/REC-html40/present/frames.html#edef-IFRAME">
 * IFRAME element definition </a> in HTML 4.0.
 *
 */
class KHTML_EXPORT HTMLIFrameElement : public HTMLElement
{
public:
    HTMLIFrameElement();
    HTMLIFrameElement(const HTMLIFrameElement &other);
    HTMLIFrameElement(const Node &other) : HTMLElement()
         {(*this)=other;}
protected:
    HTMLIFrameElement(HTMLIFrameElementImpl *impl);
public:

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

    ~HTMLIFrameElement();

    /**
     * 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;

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

    /**
     * Request frame borders. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-frameborder">
     * frameborder attribute definition </a> in HTML 4.0.
     *
     */
    DOMString frameBorder() const;

    /**
     * see frameBorder
     */
    void setFrameBorder( const DOMString & );

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

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

    /**
     * URI designating a long description of this image or frame. See
     * the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-longdesc-IFRAME">
     * longdesc attribute definition </a> in HTML 4.0.
     *
     */
    DOMString longDesc() const;

    /**
     * see longDesc
     */
    void setLongDesc( const DOMString & );

    /**
     * Frame margin height, in pixels. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-marginheight">
     * marginheight attribute definition </a> in HTML 4.0.
     *
     */
    DOMString marginHeight() const;

    /**
     * see marginHeight
     */
    void setMarginHeight( const DOMString & );

    /**
     * Frame margin width, in pixels. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-marginwidth">
     * marginwidth attribute definition </a> in HTML 4.0.
     *
     */
    DOMString marginWidth() const;

    /**
     * see marginWidth
     */
    void setMarginWidth( const DOMString & );

    /**
     * The frame name (object of the \c target attribute).
     * See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-name-IFRAME">
     * name attribute definition </a> in HTML 4.0.
     *
     */
    DOMString name() const;

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

    /**
     * Specify whether or not the frame should have scrollbars. See
     * the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-scrolling">
     * scrolling attribute definition </a> in HTML 4.0.
     *
     */
    DOMString scrolling() const;

    /**
     * see scrolling
     */
    void setScrolling( const DOMString & );

    /**
     * A URI designating the initial frame contents. See the <a
     * href="http://www.w3.org/TR/REC-html40/present/frames.html#adef-src-FRAME">
     * src attribute definition </a> in HTML 4.0.
     *
     */
    DOMString src() const;

    /**
     * see src
     */
    void setSrc( const DOMString & );

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

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

    /**
     * Introduced in DOM Level 2
     *
     * Returns the document this iframe tqcontains, 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 HTMLHeadElementImpl;
class DOMString;

/**
 * Document head information. See the <a
 * href="http://www.w3.org/TR/REC-html40/struct/global.html#edef-HEAD">
 * HEAD element definition </a> in HTML 4.0.
 *
 */
class KHTML_EXPORT HTMLHeadElement : public HTMLElement
{
public:
    HTMLHeadElement();
    HTMLHeadElement(const HTMLHeadElement &other);
    HTMLHeadElement(const Node &other) : HTMLElement()
         {(*this)=other;}
protected:
    HTMLHeadElement(HTMLHeadElementImpl *impl);
public:

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

    ~HTMLHeadElement();

    /**
     * URI designating a metadata profile. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/global.html#adef-profile">
     * profile attribute definition </a> in HTML 4.0.
     *
     */
    DOMString profile() const;

    /**
     * see profile
     */
    void setProfile( const DOMString & );
};

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

class HTMLHtmlElementImpl;
class DOMString;

/**
 * Root of an HTML document. See the <a
 * href="http://www.w3.org/TR/REC-html40/struct/global.html#edef-HTML">
 * HTML element definition </a> in HTML 4.0.
 *
 */
class KHTML_EXPORT HTMLHtmlElement : public HTMLElement
{
public:
    HTMLHtmlElement();
    HTMLHtmlElement(const HTMLHtmlElement &other);
    HTMLHtmlElement(const Node &other) : HTMLElement()
         {(*this)=other;}
protected:
    HTMLHtmlElement(HTMLHtmlElementImpl *impl);
public:

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

    ~HTMLHtmlElement();

    /**
     * Version information about the document's DTD. See the <a
     * href="http://www.w3.org/TR/REC-html40/struct/global.html#adef-version">
     * version attribute definition </a> in HTML 4.0. This attribute
     * is deprecated in HTML 4.0.
     *
     */
    DOMString version() const;

    /**
     * see version
     */
    void setVersion( const DOMString & );
};

} //namespace

#endif