KHTML
DOM::MediaList Class Reference
TheMediaList
interface provides the abstraction of an ordered collection of media, without defining or constraining how this collection is implemented.
More...
#include <css_stylesheet.h>
Public Member Functions | |
void | appendMedium (const DOM::DOMString &newMedium) |
void | deleteMedium (const DOM::DOMString &oldMedium) |
MediaListImpl * | handle () const |
bool | isNull () const |
DOM::DOMString | item (unsigned long index) const |
unsigned long | length () const |
MediaList (MediaListImpl *impl) | |
MediaList (const MediaList &other) | |
MediaList () | |
DOM::DOMString | mediaText () const |
MediaList & | operator= (const MediaList &other) |
void | setMediaText (const DOM::DOMString &value) |
~MediaList () | |
Protected Attributes | |
MediaListImpl * | impl |
Detailed Description
TheMediaList
interface provides the abstraction of an ordered collection of media, without defining or constraining how this collection is implemented.
All media are lowercase strings.
Definition at line 363 of file css_stylesheet.h.
Constructor & Destructor Documentation
MediaList::MediaList | ( | ) |
Definition at line 260 of file css_stylesheet.cpp.
MediaList::MediaList | ( | const MediaList & | other | ) |
Definition at line 265 of file css_stylesheet.cpp.
MediaList::MediaList | ( | MediaListImpl * | impl | ) |
Definition at line 271 of file css_stylesheet.cpp.
MediaList::~MediaList | ( | ) |
Definition at line 287 of file css_stylesheet.cpp.
Member Function Documentation
void MediaList::appendMedium | ( | const DOM::DOMString & | newMedium | ) |
Adds the medium newMedium to the end of the list.
If the newMedium is already used, it is first removed.
- Parameters:
-
newMedium The new medium to add.
- Exceptions:
-
DOMException INVALID_CHARACTER_ERR: If the medium contains characters that are invalid in the underlying style language.
Definition at line 322 of file css_stylesheet.cpp.
void MediaList::deleteMedium | ( | const DOM::DOMString & | oldMedium | ) |
Deletes the medium indicated by oldMedium from the list.
- Parameters:
-
oldMedium The medium to delete in the media list.
- Exceptions:
-
DOMException NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
Definition at line 316 of file css_stylesheet.cpp.
MediaListImpl * MediaList::handle | ( | ) | const |
bool MediaList::isNull | ( | ) | const |
Definition at line 333 of file css_stylesheet.cpp.
DOM::DOMString MediaList::item | ( | unsigned long | index | ) | const |
Returns the indexth in the list.
If index is greater than or equal to the number of media in the list, this returns null.
- Parameters:
-
index Index into the collection.
- Returns:
- The medium at the indexth position in the MediaList, or null if that is not a valid index.
Definition at line 310 of file css_stylesheet.cpp.
unsigned long MediaList::length | ( | ) | const |
The number of media in the list.
The range of valid media is 0 to length-1 inclusive.
Definition at line 304 of file css_stylesheet.cpp.
DOM::DOMString MediaList::mediaText | ( | ) | const |
The parsable textual representation of the media list.
This is a comma-separated list of media.
- Exceptions:
-
DOMException SYNTAX_ERR: Raised if the specified string value has a syntax error and is unparsable.
Definition at line 292 of file css_stylesheet.cpp.
Definition at line 277 of file css_stylesheet.cpp.
void MediaList::setMediaText | ( | const DOM::DOMString & | value | ) |
Member Data Documentation
MediaListImpl* DOM::MediaList::impl [protected] |
Definition at line 442 of file css_stylesheet.h.
The documentation for this class was generated from the following files: