SessionFile Class Reference

Class storing the information about the files used in a session. More...

#include <sessionInformation.h>

List of all members.

Public Types
enum	type {   CLUSTER = 0, SPIKE = 1, EVENT = 2, POSITION = 3,   CLUSTER = 0, SPIKE = 1, EVENT = 2, POSITION = 3 }
	Type of file.
enum	type {   CLUSTER = 0, SPIKE = 1, EVENT = 2, POSITION = 3,   CLUSTER = 0, SPIKE = 1, EVENT = 2, POSITION = 3 }
	Type of file.
Public Member Functions
	SessionFile (KURL url, type fileType, QDateTime modification)
void	setUrl (KURL url)
	Sets the url of the file.
void	setType (type fileType)
	Sets the type of the file (see SessionFile::type).
void	setModification (QDateTime modification)
	Sets date and time when the file was last modified.
void	setItemColor (EventDescription itemId, QString color)
	Sets the color for a given item.
void	setBackgroundPath (QString path)
	Sets the url of the background image.
KURL	getUrl () const
	Gets the url of the file.
type	getType () const
	Gets the type of the file (see SessionFile::type).
QDateTime	getModification () const
	Gets date and time when the file was last modified.
QMap< EventDescription, QColor >	getItemColors () const
	Gets the colors of the items.
QString	getBackgroundPath () const
	Gets the url of the background image.
	SessionFile (KURL url, type fileType, QDateTime modification)
void	setUrl (KURL url)
	Sets the url of the file.
void	setType (type fileType)
	Sets the type of the file (see SessionFile::type).
void	setModification (QDateTime modification)
	Sets date and time when the file was last modified.
void	setItemColor (EventDescription itemId, QString color)
	Sets the color for a given item.
void	setBackgroundPath (QString path)
	Sets the url of the background image.
KURL	getUrl () const
	Gets the url of the file.
type	getType () const
	Gets the type of the file (see SessionFile::type).
QDateTime	getModification () const
	Gets date and time when the file was last modified.
QMap< EventDescription, QColor >	getItemColors () const
	Gets the colors of the items.
QString	getBackgroundPath () const
	Gets the url of the background image.

---

Detailed Description

Class storing the information about the files used in a session.

Author:

Lynn Hazan

---

Member Function Documentation

void SessionFile::setUrl

(

KURL

url

)

[inline]

Sets the url of the file.

Parameters:

url

url of the file.

void SessionFile::setType

(

type

fileType

)

[inline]

Sets the type of the file (see SessionFile::type).

Parameters:

fileType

type of the file.

void SessionFile::setModification

(

QDateTime

modification

)

[inline]

Sets date and time when the file was last modified.

Parameters:

modification

modification information.

void SessionFile::setItemColor	(	EventDescription	itemId,
		QString	color
	)			[inline]

Sets the color for a given item.

Parameters:

	itemId	item identification.
	color	color of the item.

void SessionFile::setBackgroundPath

(

QString

path

)

[inline]

Sets the url of the background image.

Parameters:

path

path of the background image. obsolete: the background image information is now store in an other class.

KURL SessionFile::getUrl

(

)

const [inline]

Gets the url of the file.

Returns:

url of the file.

type SessionFile::getType

(

)

const [inline]

Gets the type of the file (see SessionFile::type).

Returns:

type of the file.

QDateTime SessionFile::getModification

(

)

const [inline]

Gets date and time when the file was last modified.

Returns:

modification information.

QMap<EventDescription,QColor> SessionFile::getItemColors

(

)

const [inline]

Gets the colors of the items.

Returns:

map given the color of each item.

QString SessionFile::getBackgroundPath

(

)

const [inline]

Gets the url of the background image.

Returns:

url of the background image. obsolete: the background image information is now store in an other class.

void SessionFile::setUrl

(

KURL

url

)

[inline]

Sets the url of the file.

Parameters:

url

url of the file.

void SessionFile::setType

(

type

fileType

)

[inline]

Sets the type of the file (see SessionFile::type).

Parameters:

fileType

type of the file.

void SessionFile::setModification

(

QDateTime

modification

)

[inline]

Sets date and time when the file was last modified.

Parameters:

modification

modification information.

void SessionFile::setItemColor	(	EventDescription	itemId,
		QString	color
	)			[inline]

Sets the color for a given item.

Parameters:

	itemId	item identification.
	color	color of the item.

void SessionFile::setBackgroundPath

(

QString

path

)

[inline]

Sets the url of the background image.

Parameters:

path

path of the background image. obsolete: the background image information is now store in an other class.

KURL SessionFile::getUrl

(

)

const [inline]

Gets the url of the file.

Returns:

url of the file.

type SessionFile::getType

(

)

const [inline]

Gets the type of the file (see SessionFile::type).

Returns:

type of the file.

QDateTime SessionFile::getModification

(

)

const [inline]

Gets date and time when the file was last modified.

Returns:

modification information.

QMap<EventDescription,QColor> SessionFile::getItemColors

(

)

const [inline]

Gets the colors of the items.

Returns:

map given the color of each item.

QString SessionFile::getBackgroundPath

(

)

const [inline]

Gets the url of the background image.

Returns:

url of the background image. obsolete: the background image information is now store in an other class.

---

The documentation for this class was generated from the following files:

• debug/src/sessionInformation.h
• src/sessionInformation.h

---