• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • kdelibs
  • KDE Home
  • Contact Us
 

KHTML

  • DOM
  • MediaList
Public Member Functions | Protected Attributes
DOM::MediaList Class Reference

#include <css_stylesheet.h>

List of all members.

Public Member Functions

 MediaList ()
 MediaList (const MediaList &other)
 MediaList (MediaListImpl *impl)
 ~MediaList ()
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
MediaList & operator= (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.


Constructor & Destructor Documentation

MediaList::MediaList ( )

Definition at line 290 of file css_stylesheet.cpp.

MediaList::MediaList ( const MediaList &  other)

Definition at line 295 of file css_stylesheet.cpp.

MediaList::MediaList ( MediaListImpl *  impl)

Definition at line 301 of file css_stylesheet.cpp.

MediaList::~MediaList ( )

Definition at line 317 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:
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 360 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 350 of file css_stylesheet.cpp.

MediaListImpl * MediaList::handle ( ) const

Definition at line 370 of file css_stylesheet.cpp.

bool MediaList::isNull ( ) const

Definition at line 375 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 344 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 338 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 322 of file css_stylesheet.cpp.

MediaList & MediaList::operator= ( const MediaList &  other)

Definition at line 307 of file css_stylesheet.cpp.

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

see mediaText

Definition at line 328 of file css_stylesheet.cpp.


Member Data Documentation

MediaListImpl* DOM::MediaList::impl [protected]

Definition at line 456 of file css_stylesheet.h.


The documentation for this class was generated from the following files:
  • css_stylesheet.h
  • css_stylesheet.cpp

KHTML

Skip menu "KHTML"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal