• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.8.3 API Reference
  • KDE Home
  • Contact Us
 

Syndication Library

  • Syndication
  • Enclosure
Public Member Functions
Syndication::Enclosure Class Reference

#include <enclosure.h>

List of all members.

Public Member Functions

virtual ~Enclosure ()
virtual QString debugInfo () const
virtual uint duration () const =0
virtual bool isNull () const =0
virtual uint length () const =0
virtual QString title () const =0
virtual QString type () const =0
virtual QString url () const =0

Detailed Description

An enclosure describes a (media) file available on the net.

Most of the time, enclosures are used for "podcasts", i.e. audio files announced and distributed via syndication.

Author:
Frank Osterfeld

Definition at line 47 of file enclosure.h.


Constructor & Destructor Documentation

Syndication::Enclosure::~Enclosure ( ) [virtual]

destructor

Definition at line 29 of file enclosure.cpp.


Member Function Documentation

QString Syndication::Enclosure::debugInfo ( ) const [virtual]

description of this enclosure for debugging purposes

Returns:
debug string

Definition at line 33 of file enclosure.cpp.

virtual uint Syndication::Enclosure::duration ( ) const [pure virtual]

for audio/video files, the duration of the file in seconds

Returns:
the duration of the file in seconds, or 0 if not specified
virtual bool Syndication::Enclosure::isNull ( ) const [pure virtual]

returns whether this enclosure is a null object.

virtual uint Syndication::Enclosure::length ( ) const [pure virtual]

returns the length of the linked file in bytes

Returns:
the length of the file in bytes, 0 if not specified
virtual QString Syndication::Enclosure::title ( ) const [pure virtual]

title of the enclosure.

This is a human-readable description of the linked file. If available, the title should be used in user interfaces instead of the URL. If no title is set (e.g., RSS2 enclosures don't have titles), use url() as fallback.

Returns:
title describing the enclosure, or a null string if not specified.
virtual QString Syndication::Enclosure::type ( ) const [pure virtual]

mimetype of the enclosure.

TODO: link mimetype specs

Examples are "audio/mpeg" for MP3, or "application/pdf" for PDF.

Returns:
the mimetype of the file, or a null string if not specified
virtual QString Syndication::Enclosure::url ( ) const [pure virtual]

The URL of the linked resource (required).


The documentation for this class was generated from the following files:
  • enclosure.h
  • enclosure.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2012 The KDE developers.
Generated on Mon May 7 2012 23:57:26 by doxygen 1.8.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

Syndication Library

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

kdepimlibs-4.8.3 API Reference

Skip menu "kdepimlibs-4.8.3 API Reference"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal