IPod Class Reference

#include <ipod.h>

List of all members.

Public Member Functions

 IPod (const QString &ipodBase)
virtual ~IPod ()
bool open ()
void initialize (const QString &title)
bool isOpen ()
bool isStillConnected ()
void close ()
QString getName () const
void setName (const QString &name)
const QString & getItunesDBError () const
const IPodSysInfogetSysInfo () const
IPodSysInfogetSysInfo ()
const ITunesDBgetITunesDB () const
ITunesDBgetITunesDB ()
void synchronize ()
bool isDirty () const
void lock (bool write_lock)
bool isLocked ()
void unlock ()
const QString & getBasePath () const
bool hasPodcasts ()

Static Public Member Functions

static QString createDistinctIPodName (const IPod &ipod)

Protected Attributes

QString m_ipodBase


Detailed Description

This class represents all functionalities to access and modify information about the iPod/itunesDB

Author:
Michael Schulze


Constructor & Destructor Documentation

IPod::IPod const QString &  ipodBase  ) 
 

Constructs a new IPod instance for an iPod at the given path. Does not actually read the contents - you need to open it with open().

IPod::~IPod  )  [virtual]
 

The destructor.


Member Function Documentation

void IPod::close  ) 
 

Clears all data we got from this instance whether or not it was changed. Resets the state of this instance.

ITunesDB & IPod::getITunesDB  ) 
 

Returns the ITunesDB for this iPod.

Returns:
the ITunesDB for this iPod.

const ITunesDB & IPod::getITunesDB  )  const
 

Returns the ITunesDB for this iPod (const).

Returns:
the ITunesDB for this iPod.

const QString & IPod::getItunesDBError  )  const
 

returns the error occured during read or write

QString IPod::getName  )  const
 

Returns the name of the iPod

IPodSysInfo & IPod::getSysInfo  ) 
 

Returns the IPodSysInfo for this IPod instance.

Returns:
the IPodSysInfo for this IPod instance.

const IPodSysInfo & IPod::getSysInfo  )  const
 

Returns the IPodSysInfo for this IPod instance (const).

Returns:
the IPodSysInfo for this IPod instance.

void IPod::initialize const QString &  title  ) 
 

initializes this ipod by creating the nessessary directories and files This IPod instance then contains the information about the initialized ipod - no need to call open() afterwards.

bool IPod::isDirty  )  const [inline]
 

Returns true if this instances data differ somehow from the original data from the iPod and need to be synchronized.

bool IPod::isOpen  ) 
 

Returns true if open() was called successfully for this instance.

Returns:
true if open() was called successfully for this instance.

bool IPod::isStillConnected  ) 
 

Returns true if the ipod represented by this instance is still connected to the system

Returns:
true if the ipod represented by this instance is still connected to the system false otherwise

void IPod::lock bool  write_lock  ) 
 

Lock control functions to prevent concurrent access to the iPod from different programs

bool IPod::open  ) 
 

Tries to open an ipod. That means reading all important information from the device.

Returns:
true if successful, otherwise false

void IPod::setName const QString &  name  ) 
 

Sets the name of the iPod. When the iPod is not opened (isOpen() == false) nothing is changed

void IPod::synchronize  ) 
 

Writes back all the changed data to the device. This only includes control structures like the iTunesDB and DeviceInfo data.


The documentation for this class was generated from the following files:
Generated on Sun Oct 1 20:34:30 2006 for libqtpod.kdevelop by  doxygen 1.4.6