src/dom/work/css.idl

   1 /*
   2  * Copyright (c) 2000 World Wide Web Consortium,
   3  * (Massachusetts Institute of Technology, Institut National de
   4  * Recherche en Informatique et en Automatique, Keio University). All
   5  * Rights Reserved. This program is distributed under the W3C's Software
   6  * Intellectual Property License. This program is distributed in the
   7  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
   8  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
   9  * PURPOSE.
  10  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  11  */
  12
  13 // File: http://www.w3.org/TR/2000/REC-DOM-Level-2-Style-20001113/css.idl
  14
  15 #ifndef _CSS_IDL_
  16 #define _CSS_IDL_
  17
  18 #include "dom.idl"
  19 #include "stylesheets.idl"
  20 #include "views.idl"
  21
  22 #pragma prefix "dom.w3c.org"
  23 module css
  24 {
  25
  26   typedef dom::DOMString DOMString;
  27   typedef dom::Element Element;
  28   typedef dom::DOMImplementation DOMImplementation;
  29
  30   interface CSSRule;
  31   interface CSSStyleSheet;
  32   interface CSSStyleDeclaration;
  33   interface CSSValue;
  34   interface Counter;
  35   interface Rect;
  36   interface RGBColor;
  37
  38   // Introduced in DOM Level 2:
  39   interface CSSRuleList {
  40     readonly attribute unsigned long    length;
  41     CSSRule            item(in unsigned long index);
  42   };
  43
  44   // Introduced in DOM Level 2:
  45   interface CSSRule {
  46
  47     // RuleType
  48     const unsigned short      UNKNOWN_RULE                   = 0;
  49     const unsigned short      STYLE_RULE                     = 1;
  50     const unsigned short      CHARSET_RULE                   = 2;
  51     const unsigned short      IMPORT_RULE                    = 3;
  52     const unsigned short      MEDIA_RULE                     = 4;
  53     const unsigned short      FONT_FACE_RULE                 = 5;
  54     const unsigned short      PAGE_RULE                      = 6;
  55
  56     readonly attribute unsigned short   type;
  57              attribute DOMString        cssText;
  58                                         // raises(dom::DOMException) on setting
  59
  60     readonly attribute CSSStyleSheet    parentStyleSheet;
  61     readonly attribute CSSRule          parentRule;
  62   };
  63
  64   // Introduced in DOM Level 2:
  65   interface CSSStyleRule : CSSRule {
  66              attribute DOMString        selectorText;
  67                                         // raises(dom::DOMException) on setting
  68
  69     readonly attribute CSSStyleDeclaration  style;
  70   };
  71
  72   // Introduced in DOM Level 2:
  73   interface CSSMediaRule : CSSRule {
  74     readonly attribute stylesheets::MediaList  media;
  75     readonly attribute CSSRuleList      cssRules;
  76     unsigned long      insertRule(in DOMString rule,
  77                                   in unsigned long index)
  78                                         raises(dom::DOMException);
  79     void               deleteRule(in unsigned long index)
  80                                         raises(dom::DOMException);
  81   };
  82
  83   // Introduced in DOM Level 2:
  84   interface CSSFontFaceRule : CSSRule {
  85     readonly attribute CSSStyleDeclaration  style;
  86   };
  87
  88   // Introduced in DOM Level 2:
  89   interface CSSPageRule : CSSRule {
  90              attribute DOMString        selectorText;
  91                                         // raises(dom::DOMException) on setting
  92
  93     readonly attribute CSSStyleDeclaration  style;
  94   };
  95
  96   // Introduced in DOM Level 2:
  97   interface CSSImportRule : CSSRule {
  98     readonly attribute DOMString        href;
  99     readonly attribute stylesheets::MediaList  media;
 100     readonly attribute CSSStyleSheet    styleSheet;
 101   };
 102
 103   // Introduced in DOM Level 2:
 104   interface CSSCharsetRule : CSSRule {
 105              attribute DOMString        encoding;
 106                                         // raises(dom::DOMException) on setting
 107
 108   };
 109
 110   // Introduced in DOM Level 2:
 111   interface CSSUnknownRule : CSSRule {
 112   };
 113
 114   // Introduced in DOM Level 2:
 115   interface CSSStyleDeclaration {
 116              attribute DOMString        cssText;
 117                                         // raises(dom::DOMException) on setting
 118
 119     DOMString          getPropertyValue(in DOMString propertyName);
 120     CSSValue           getPropertyCSSValue(in DOMString propertyName);
 121     DOMString          removeProperty(in DOMString propertyName)
 122                                         raises(dom::DOMException);
 123     DOMString          getPropertyPriority(in DOMString propertyName);
 124     void               setProperty(in DOMString propertyName,
 125                                    in DOMString value,
 126                                    in DOMString priority)
 127                                         raises(dom::DOMException);
 128     readonly attribute unsigned long    length;
 129     DOMString          item(in unsigned long index);
 130     readonly attribute CSSRule          parentRule;
 131   };
 132
 133   // Introduced in DOM Level 2:
 134   interface CSSValue {
 135
 136     // UnitTypes
 137     const unsigned short      CSS_INHERIT                    = 0;
 138     const unsigned short      CSS_PRIMITIVE_VALUE            = 1;
 139     const unsigned short      CSS_VALUE_LIST                 = 2;
 140     const unsigned short      CSS_CUSTOM                     = 3;
 141
 142              attribute DOMString        cssText;
 143                                         // raises(dom::DOMException) on setting
 144
 145     readonly attribute unsigned short   cssValueType;
 146   };
 147
 148   // Introduced in DOM Level 2:
 149   interface CSSPrimitiveValue : CSSValue {
 150
 151     // UnitTypes
 152     const unsigned short      CSS_UNKNOWN                    = 0;
 153     const unsigned short      CSS_NUMBER                     = 1;
 154     const unsigned short      CSS_PERCENTAGE                 = 2;
 155     const unsigned short      CSS_EMS                        = 3;
 156     const unsigned short      CSS_EXS                        = 4;
 157     const unsigned short      CSS_PX                         = 5;
 158     const unsigned short      CSS_CM                         = 6;
 159     const unsigned short      CSS_MM                         = 7;
 160     const unsigned short      CSS_IN                         = 8;
 161     const unsigned short      CSS_PT                         = 9;
 162     const unsigned short      CSS_PC                         = 10;
 163     const unsigned short      CSS_DEG                        = 11;
 164     const unsigned short      CSS_RAD                        = 12;
 165     const unsigned short      CSS_GRAD                       = 13;
 166     const unsigned short      CSS_MS                         = 14;
 167     const unsigned short      CSS_S                          = 15;
 168     const unsigned short      CSS_HZ                         = 16;
 169     const unsigned short      CSS_KHZ                        = 17;
 170     const unsigned short      CSS_DIMENSION                  = 18;
 171     const unsigned short      CSS_STRING                     = 19;
 172     const unsigned short      CSS_URI                        = 20;
 173     const unsigned short      CSS_IDENT                      = 21;
 174     const unsigned short      CSS_ATTR                       = 22;
 175     const unsigned short      CSS_COUNTER                    = 23;
 176     const unsigned short      CSS_RECT                       = 24;
 177     const unsigned short      CSS_RGBCOLOR                   = 25;
 178
 179     readonly attribute unsigned short   primitiveType;
 180     void               setFloatValue(in unsigned short unitType,
 181                                      in float floatValue)
 182                                         raises(dom::DOMException);
 183     float              getFloatValue(in unsigned short unitType)
 184                                         raises(dom::DOMException);
 185     void               setStringValue(in unsigned short stringType,
 186                                       in DOMString stringValue)
 187                                         raises(dom::DOMException);
 188     DOMString          getStringValue()
 189                                         raises(dom::DOMException);
 190     Counter            getCounterValue()
 191                                         raises(dom::DOMException);
 192     Rect               getRectValue()
 193                                         raises(dom::DOMException);
 194     RGBColor           getRGBColorValue()
 195                                         raises(dom::DOMException);
 196   };
 197
 198   // Introduced in DOM Level 2:
 199   interface CSSValueList : CSSValue {
 200     readonly attribute unsigned long    length;
 201     CSSValue           item(in unsigned long index);
 202   };
 203
 204   // Introduced in DOM Level 2:
 205   interface RGBColor {
 206     readonly attribute CSSPrimitiveValue  red;
 207     readonly attribute CSSPrimitiveValue  green;
 208     readonly attribute CSSPrimitiveValue  blue;
 209   };
 210
 211   // Introduced in DOM Level 2:
 212   interface Rect {
 213     readonly attribute CSSPrimitiveValue  top;
 214     readonly attribute CSSPrimitiveValue  right;
 215     readonly attribute CSSPrimitiveValue  bottom;
 216     readonly attribute CSSPrimitiveValue  left;
 217   };
 218
 219   // Introduced in DOM Level 2:
 220   interface Counter {
 221     readonly attribute DOMString        identifier;
 222     readonly attribute DOMString        listStyle;
 223     readonly attribute DOMString        separator;
 224   };
 225
 226   // Introduced in DOM Level 2:
 227   interface ElementCSSInlineStyle {
 228     readonly attribute CSSStyleDeclaration  style;
 229   };
 230
 231   // Introduced in DOM Level 2:
 232   interface CSS2Properties {
 233              attribute DOMString        azimuth;
 234                                         // raises(dom::DOMException) on setting
 235
 236              attribute DOMString        background;
 237                                         // raises(dom::DOMException) on setting
 238
 239              attribute DOMString        backgroundAttachment;
 240                                         // raises(dom::DOMException) on setting
 241
 242              attribute DOMString        backgroundColor;
 243                                         // raises(dom::DOMException) on setting
 244
 245              attribute DOMString        backgroundImage;
 246                                         // raises(dom::DOMException) on setting
 247
 248              attribute DOMString        backgroundPosition;
 249                                         // raises(dom::DOMException) on setting
 250
 251              attribute DOMString        backgroundRepeat;
 252                                         // raises(dom::DOMException) on setting
 253
 254              attribute DOMString        border;
 255                                         // raises(dom::DOMException) on setting
 256
 257              attribute DOMString        borderCollapse;
 258                                         // raises(dom::DOMException) on setting
 259
 260              attribute DOMString        borderColor;
 261                                         // raises(dom::DOMException) on setting
 262
 263              attribute DOMString        borderSpacing;
 264                                         // raises(dom::DOMException) on setting
 265
 266              attribute DOMString        borderStyle;
 267                                         // raises(dom::DOMException) on setting
 268
 269              attribute DOMString        borderTop;
 270                                         // raises(dom::DOMException) on setting
 271
 272              attribute DOMString        borderRight;
 273                                         // raises(dom::DOMException) on setting
 274
 275              attribute DOMString        borderBottom;
 276                                         // raises(dom::DOMException) on setting
 277
 278              attribute DOMString        borderLeft;
 279                                         // raises(dom::DOMException) on setting
 280
 281              attribute DOMString        borderTopColor;
 282                                         // raises(dom::DOMException) on setting
 283
 284              attribute DOMString        borderRightColor;
 285                                         // raises(dom::DOMException) on setting
 286
 287              attribute DOMString        borderBottomColor;
 288                                         // raises(dom::DOMException) on setting
 289
 290              attribute DOMString        borderLeftColor;
 291                                         // raises(dom::DOMException) on setting
 292
 293              attribute DOMString        borderTopStyle;
 294                                         // raises(dom::DOMException) on setting
 295
 296              attribute DOMString        borderRightStyle;
 297                                         // raises(dom::DOMException) on setting
 298
 299              attribute DOMString        borderBottomStyle;
 300                                         // raises(dom::DOMException) on setting
 301
 302              attribute DOMString        borderLeftStyle;
 303                                         // raises(dom::DOMException) on setting
 304
 305              attribute DOMString        borderTopWidth;
 306                                         // raises(dom::DOMException) on setting
 307
 308              attribute DOMString        borderRightWidth;
 309                                         // raises(dom::DOMException) on setting
 310
 311              attribute DOMString        borderBottomWidth;
 312                                         // raises(dom::DOMException) on setting
 313
 314              attribute DOMString        borderLeftWidth;
 315                                         // raises(dom::DOMException) on setting
 316
 317              attribute DOMString        borderWidth;
 318                                         // raises(dom::DOMException) on setting
 319
 320              attribute DOMString        bottom;
 321                                         // raises(dom::DOMException) on setting
 322
 323              attribute DOMString        captionSide;
 324                                         // raises(dom::DOMException) on setting
 325
 326              attribute DOMString        clear;
 327                                         // raises(dom::DOMException) on setting
 328
 329              attribute DOMString        clip;
 330                                         // raises(dom::DOMException) on setting
 331
 332              attribute DOMString        color;
 333                                         // raises(dom::DOMException) on setting
 334
 335              attribute DOMString        content;
 336                                         // raises(dom::DOMException) on setting
 337
 338              attribute DOMString        counterIncrement;
 339                                         // raises(dom::DOMException) on setting
 340
 341              attribute DOMString        counterReset;
 342                                         // raises(dom::DOMException) on setting
 343
 344              attribute DOMString        cue;
 345                                         // raises(dom::DOMException) on setting
 346
 347              attribute DOMString        cueAfter;
 348                                         // raises(dom::DOMException) on setting
 349
 350              attribute DOMString        cueBefore;
 351                                         // raises(dom::DOMException) on setting
 352
 353              attribute DOMString        cursor;
 354                                         // raises(dom::DOMException) on setting
 355
 356              attribute DOMString        direction;
 357                                         // raises(dom::DOMException) on setting
 358
 359              attribute DOMString        display;
 360                                         // raises(dom::DOMException) on setting
 361
 362              attribute DOMString        elevation;
 363                                         // raises(dom::DOMException) on setting
 364
 365              attribute DOMString        emptyCells;
 366                                         // raises(dom::DOMException) on setting
 367
 368              attribute DOMString        cssFloat;
 369                                         // raises(dom::DOMException) on setting
 370
 371              attribute DOMString        font;
 372                                         // raises(dom::DOMException) on setting
 373
 374              attribute DOMString        fontFamily;
 375                                         // raises(dom::DOMException) on setting
 376
 377              attribute DOMString        fontSize;
 378                                         // raises(dom::DOMException) on setting
 379
 380              attribute DOMString        fontSizeAdjust;
 381                                         // raises(dom::DOMException) on setting
 382
 383              attribute DOMString        fontStretch;
 384                                         // raises(dom::DOMException) on setting
 385
 386              attribute DOMString        fontStyle;
 387                                         // raises(dom::DOMException) on setting
 388
 389              attribute DOMString        fontVariant;
 390                                         // raises(dom::DOMException) on setting
 391
 392              attribute DOMString        fontWeight;
 393                                         // raises(dom::DOMException) on setting
 394
 395              attribute DOMString        height;
 396                                         // raises(dom::DOMException) on setting
 397
 398              attribute DOMString        left;
 399                                         // raises(dom::DOMException) on setting
 400
 401              attribute DOMString        letterSpacing;
 402                                         // raises(dom::DOMException) on setting
 403
 404              attribute DOMString        lineHeight;
 405                                         // raises(dom::DOMException) on setting
 406
 407              attribute DOMString        listStyle;
 408                                         // raises(dom::DOMException) on setting
 409
 410              attribute DOMString        listStyleImage;
 411                                         // raises(dom::DOMException) on setting
 412
 413              attribute DOMString        listStylePosition;
 414                                         // raises(dom::DOMException) on setting
 415
 416              attribute DOMString        listStyleType;
 417                                         // raises(dom::DOMException) on setting
 418
 419              attribute DOMString        margin;
 420                                         // raises(dom::DOMException) on setting
 421
 422              attribute DOMString        marginTop;
 423                                         // raises(dom::DOMException) on setting
 424
 425              attribute DOMString        marginRight;
 426                                         // raises(dom::DOMException) on setting
 427
 428              attribute DOMString        marginBottom;
 429                                         // raises(dom::DOMException) on setting
 430
 431              attribute DOMString        marginLeft;
 432                                         // raises(dom::DOMException) on setting
 433
 434              attribute DOMString        markerOffset;
 435                                         // raises(dom::DOMException) on setting
 436
 437              attribute DOMString        marks;
 438                                         // raises(dom::DOMException) on setting
 439
 440              attribute DOMString        maxHeight;
 441                                         // raises(dom::DOMException) on setting
 442
 443              attribute DOMString        maxWidth;
 444                                         // raises(dom::DOMException) on setting
 445
 446              attribute DOMString        minHeight;
 447                                         // raises(dom::DOMException) on setting
 448
 449              attribute DOMString        minWidth;
 450                                         // raises(dom::DOMException) on setting
 451
 452              attribute DOMString        orphans;
 453                                         // raises(dom::DOMException) on setting
 454
 455              attribute DOMString        outline;
 456                                         // raises(dom::DOMException) on setting
 457
 458              attribute DOMString        outlineColor;
 459                                         // raises(dom::DOMException) on setting
 460
 461              attribute DOMString        outlineStyle;
 462                                         // raises(dom::DOMException) on setting
 463
 464              attribute DOMString        outlineWidth;
 465                                         // raises(dom::DOMException) on setting
 466
 467              attribute DOMString        overflow;
 468                                         // raises(dom::DOMException) on setting
 469
 470              attribute DOMString        padding;
 471                                         // raises(dom::DOMException) on setting
 472
 473              attribute DOMString        paddingTop;
 474                                         // raises(dom::DOMException) on setting
 475
 476              attribute DOMString        paddingRight;
 477                                         // raises(dom::DOMException) on setting
 478
 479              attribute DOMString        paddingBottom;
 480                                         // raises(dom::DOMException) on setting
 481
 482              attribute DOMString        paddingLeft;
 483                                         // raises(dom::DOMException) on setting
 484
 485              attribute DOMString        page;
 486                                         // raises(dom::DOMException) on setting
 487
 488              attribute DOMString        pageBreakAfter;
 489                                         // raises(dom::DOMException) on setting
 490
 491              attribute DOMString        pageBreakBefore;
 492                                         // raises(dom::DOMException) on setting
 493
 494              attribute DOMString        pageBreakInside;
 495                                         // raises(dom::DOMException) on setting
 496
 497              attribute DOMString        pause;
 498                                         // raises(dom::DOMException) on setting
 499
 500              attribute DOMString        pauseAfter;
 501                                         // raises(dom::DOMException) on setting
 502
 503              attribute DOMString        pauseBefore;
 504                                         // raises(dom::DOMException) on setting
 505
 506              attribute DOMString        pitch;
 507                                         // raises(dom::DOMException) on setting
 508
 509              attribute DOMString        pitchRange;
 510                                         // raises(dom::DOMException) on setting
 511
 512              attribute DOMString        playDuring;
 513                                         // raises(dom::DOMException) on setting
 514
 515              attribute DOMString        position;
 516                                         // raises(dom::DOMException) on setting
 517
 518              attribute DOMString        quotes;
 519                                         // raises(dom::DOMException) on setting
 520
 521              attribute DOMString        richness;
 522                                         // raises(dom::DOMException) on setting
 523
 524              attribute DOMString        right;
 525                                         // raises(dom::DOMException) on setting
 526
 527              attribute DOMString        size;
 528                                         // raises(dom::DOMException) on setting
 529
 530              attribute DOMString        speak;
 531                                         // raises(dom::DOMException) on setting
 532
 533              attribute DOMString        speakHeader;
 534                                         // raises(dom::DOMException) on setting
 535
 536              attribute DOMString        speakNumeral;
 537                                         // raises(dom::DOMException) on setting
 538
 539              attribute DOMString        speakPunctuation;
 540                                         // raises(dom::DOMException) on setting
 541
 542              attribute DOMString        speechRate;
 543                                         // raises(dom::DOMException) on setting
 544
 545              attribute DOMString        stress;
 546                                         // raises(dom::DOMException) on setting
 547
 548              attribute DOMString        tableLayout;
 549                                         // raises(dom::DOMException) on setting
 550
 551              attribute DOMString        textAlign;
 552                                         // raises(dom::DOMException) on setting
 553
 554              attribute DOMString        textDecoration;
 555                                         // raises(dom::DOMException) on setting
 556
 557              attribute DOMString        textIndent;
 558                                         // raises(dom::DOMException) on setting
 559
 560              attribute DOMString        textShadow;
 561                                         // raises(dom::DOMException) on setting
 562
 563              attribute DOMString        textTransform;
 564                                         // raises(dom::DOMException) on setting
 565
 566              attribute DOMString        top;
 567                                         // raises(dom::DOMException) on setting
 568
 569              attribute DOMString        unicodeBidi;
 570                                         // raises(dom::DOMException) on setting
 571
 572              attribute DOMString        verticalAlign;
 573                                         // raises(dom::DOMException) on setting
 574
 575              attribute DOMString        visibility;
 576                                         // raises(dom::DOMException) on setting
 577
 578              attribute DOMString        voiceFamily;
 579                                         // raises(dom::DOMException) on setting
 580
 581              attribute DOMString        volume;
 582                                         // raises(dom::DOMException) on setting
 583
 584              attribute DOMString        whiteSpace;
 585                                         // raises(dom::DOMException) on setting
 586
 587              attribute DOMString        widows;
 588                                         // raises(dom::DOMException) on setting
 589
 590              attribute DOMString        width;
 591                                         // raises(dom::DOMException) on setting
 592
 593              attribute DOMString        wordSpacing;
 594                                         // raises(dom::DOMException) on setting
 595
 596              attribute DOMString        zIndex;
 597                                         // raises(dom::DOMException) on setting
 598
 599   };
 600
 601   // Introduced in DOM Level 2:
 602   interface CSSStyleSheet : stylesheets::StyleSheet {
 603     readonly attribute CSSRule          ownerRule;
 604     readonly attribute CSSRuleList      cssRules;
 605     unsigned long      insertRule(in DOMString rule,
 606                                   in unsigned long index)
 607                                         raises(dom::DOMException);
 608     void               deleteRule(in unsigned long index)
 609                                         raises(dom::DOMException);
 610   };
 611
 612   // Introduced in DOM Level 2:
 613   interface ViewCSS : views::AbstractView {
 614     CSSStyleDeclaration getComputedStyle(in Element elt,
 615                                          in DOMString pseudoElt);
 616   };
 617
 618   // Introduced in DOM Level 2:
 619   interface DocumentCSS : stylesheets::DocumentStyle {
 620     CSSStyleDeclaration getOverrideStyle(in Element elt,
 621                                          in DOMString pseudoElt);
 622   };
 623
 624   // Introduced in DOM   Level 2:
 625   interface DOMImplementationCSS : DOMImplementation {
 626     CSSStyleSheet      createCSSStyleSheet(in DOMString title,
 627                                            in DOMString media)
 628                                         raises(dom::DOMException);
 629   };
 630 };
 631
 632 #endif // _CSS_IDL_
 633