DOM::MediaList

#include <css_stylesheet.h>

Public Member Functions

 MediaList (const MediaList &other)
 
 MediaList (MediaListImpl *impl)
 
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
 
DOM::DOMString mediaText () const
 
MediaListoperator= (const MediaList &other)
 
void setMediaText (const DOM::DOMString &value)
 

Protected Attributes

MediaListImpl * impl
 

Detailed Description

The MediaList 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 389 of file css_stylesheet.h.

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
newMediumThe new medium to add.
Exceptions
DOMExceptionINVALID_CHARACTER_ERR: If the medium contains characters that are invalid in the underlying style language.

NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.

Definition at line 439 of file css_stylesheet.cpp.

void MediaList::deleteMedium ( const DOM::DOMString oldMedium)

Deletes the medium indicated by oldMedium from the list.

Parameters
oldMediumThe medium to delete in the media list.
Exceptions
DOMExceptionNO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.

NOT_FOUND_ERR: Raised if oldMedium is not in the list.

Definition at line 427 of file css_stylesheet.cpp.

MediaListImpl * MediaList::handle ( ) const

Definition at line 451 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
indexIndex 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 419 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 411 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
DOMExceptionSYNTAX_ERR: Raised if the specified string value has a syntax error and is unparsable.

NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is readonly.

Definition at line 391 of file css_stylesheet.cpp.

void MediaList::setMediaText ( const DOM::DOMString value)

see mediaText

Definition at line 399 of file css_stylesheet.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Jul 7 2020 22:44:41 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.