Attica::Content Class Reference

#include <Attica/Content>

Public Types
typedef QList< Content >	List

Public Member Functions
	Content ()
	Content (const Content &other)
	~Content ()
void	addAttribute (const QString &key, const QString &value)
QString	attribute (const QString &key) const
QMap< QString, QString >	attributes () const
QString	author () const
QString	changelog () const
QDateTime	created () const
QString	depend () const
QString	description () const
QUrl	detailpage () const
int	downloads () const
DownloadDescription	downloadUrlDescription (int number) const
QList< DownloadDescription >	downloadUrlDescriptions () const
QList< HomePageEntry >	homePageEntries ()
HomePageEntry	homePageEntry (int number) const
QList< Icon >	icons ()
QList< Icon >	icons () const
QString	id () const
bool	isValid () const
QString	license () const
QString	licenseName () const
QString	name () const
int	numberOfComments () const
Content &	operator= (const Content &other)
QString	previewPicture (const QString &number=QStringLiteral("1")) const
int	rating () const
void	setCreated (const QDateTime &created)
void	setDownloads (int downloads)
void	setIcons (QList< Icon > icons)
void	setId (const QString &id)
void	setName (const QString &name)
void	setNumberOfComments (int numComments)
void	setRating (int rating)
void	setTags (const QStringList &tags)
void	setUpdated (const QDateTime &updated)
void	setVideos (QList< QUrl > videos)
QString	smallPreviewPicture (const QString &number=QStringLiteral("1")) const
QString	summary () const
QStringList	tags () const
QDateTime	updated () const
QString	version () const
QList< QUrl >	videos ()

Detailed Description

Represents a single content.

Definition at line 32 of file content.h.

Member Typedef Documentation

List

typedef QList<Content> Attica::Content::List

Definition at line 35 of file content.h.

Constructor & Destructor Documentation

Content() [1/2]

Attica::Content::Content

(

)

Creates an empty Content.

Content() [2/2]

Attica::Content::Content

(

const Content &

other

)

Copy constructor.

Parameters

other

the Content to copy from

~Content()

Attica::Content::~Content

(

)

Destructor.

Member Function Documentation

addAttribute()

void Content::addAttribute	(	const QString &	key,
		const QString &	value )

Add an attribute that is not included in the basis set of attributes exposed by the Content class.

If the attribute already exists it gets overwritten.

Parameters

key	the key of the attribute
value	the value of the attribute

Definition at line 130 of file content.cpp.

attribute()

QString Content::attribute

(

const QString &

key

)

const

Get an attribute that is not included in the basis set of attributes exposed by the Content class.

Parameters

key	the key of the attribute

Returns

the value of the attribute with the specified key, or an empty string, if the key has not been found

Definition at line 135 of file content.cpp.

attributes()

QMap< QString, QString > Content::attributes

(

)

const

Get all attributes that are not included in the basis set of attributes exposed by the Content class.

Returns

the attribute mappings

Definition at line 140 of file content.cpp.

author()

QString Content::author

(

)

const

Definition at line 270 of file content.cpp.

changelog()

QString Content::changelog

(

)

const

Definition at line 165 of file content.cpp.

created()

QDateTime Content::created

(

)

const

Gets the date and time the Content has been created.

Returns

the date and time of the last update

Definition at line 115 of file content.cpp.

depend()

QString Content::depend

(

)

const

Definition at line 170 of file content.cpp.

description()

QString Content::description

(

)

const

A description of this content.

Definition at line 155 of file content.cpp.

detailpage()

QUrl Content::detailpage

(

)

const

A webpage with the detailed description of this content.

Definition at line 160 of file content.cpp.

downloads()

int Content::downloads

(

)

const

Gets the number of downloads for the Content (how often this has been downloaded from the server).

Returns

the number of downloads

Definition at line 95 of file content.cpp.

downloadUrlDescription()

Attica::DownloadDescription Content::downloadUrlDescription

(

int

number

)

const

Get the details about a download (a content can have multiple links, eg for different distros).

This is not very helpful if we don't know the allowed numbers.

Definition at line 198 of file content.cpp.

downloadUrlDescriptions()

QList< Attica::DownloadDescription > Content::downloadUrlDescriptions

(

)

const

Get all possible downloads.

This is slow searching through lots of strings, so beware and don't call it too often.

Definition at line 175 of file content.cpp.

homePageEntries()

QList< HomePageEntry > Content::homePageEntries

(

)

Get all home pages for this content.

This is slow searching through lots of strings, so beware and don't call it too often.

Definition at line 229 of file content.cpp.

homePageEntry()

Attica::HomePageEntry Content::homePageEntry

(

int

number

)

const

Get the details about a home page (a content can have multiple home pages, blog, bugs, ...).

This is not very helpful if we don't know the allowed numbers.

Definition at line 252 of file content.cpp.

icons() [1/2]

QList< Icon > Content::icons

(

)

Get all icons for this content.

Definition at line 295 of file content.cpp.

icons() [2/2]

QList< Icon > Content::icons

(

)

const

Get all icons for this content.

Definition at line 300 of file content.cpp.

id()

QString Content::id

(

)

const

Gets the id of the Content.

The id uniquely identifies a Content with the OCS API.

Returns

the id

Definition at line 65 of file content.cpp.

isValid()

bool Content::isValid

(

)

const

Checks whether this Content has an id.

Returns

true if an id has been set, false otherwise

Definition at line 145 of file content.cpp.

license()

QString Content::license

(

)

const

Definition at line 275 of file content.cpp.

licenseName()

QString Content::licenseName

(

)

const

Definition at line 280 of file content.cpp.

name()

QString Content::name

(

)

const

Gets the name of the Content.

Returns

the name

Definition at line 75 of file content.cpp.

numberOfComments()

int Content::numberOfComments

(

)

const

Gets the number of comments for the Content.

Returns

the number of comments

Definition at line 105 of file content.cpp.

operator=()

Content & Attica::Content::operator=

(

const Content &

other

)

Assignment operator.

Parameters

other

the Content to assign from

Returns

pointer to this Content

previewPicture()

QString Content::previewPicture

(

const QString &

number = QStringLiteral("1")

)

const

Definition at line 285 of file content.cpp.

rating()

int Content::rating

(

)

const

Gets the rating of the Content.

Returns

the rating in the range 0-100

Definition at line 85 of file content.cpp.

setCreated()

void Content::setCreated

(

const QDateTime &

created

)

Sets the date and time the Content has been created.

Parameters

created

the new creation date and time

Definition at line 110 of file content.cpp.

setDownloads()

void Content::setDownloads

(

int

downloads

)

Sets the number of downloads for the Content.

Parameters

downloads

the new number of downloads

Definition at line 90 of file content.cpp.

setIcons()

void Content::setIcons

(

QList< Icon >

icons

)

Set list of icons.

Parameters

icons

list of icons for this content

Definition at line 305 of file content.cpp.

setId()

void Content::setId

(

const QString &

id

)

Sets the id of the Content.

The id uniquely identifies a Content with the OCS API.

Parameters

id	the new id

Definition at line 60 of file content.cpp.

setName()

void Content::setName

(

const QString &

name

)

Sets the name of the Content.

Parameters

name	the new name

Definition at line 70 of file content.cpp.

setNumberOfComments()

void Content::setNumberOfComments

(

int

numComments

)

Sets the number of comments for the Content.

Parameters

numComments

the new number of downloads

Definition at line 100 of file content.cpp.

setRating()

void Content::setRating

(

int

rating

)

Sets the rating of the Content.

Parameters

rating

the new rating, has to be in the range 0-100

Definition at line 80 of file content.cpp.

setTags()

void Content::setTags

(

const QStringList &

tags

)

Set the list of tags.

Parameters

tags	list of tags for this content

Since

5.50

Definition at line 325 of file content.cpp.

setUpdated()

void Content::setUpdated

(

const QDateTime &

updated

)

Sets the time the Content has been last updated.

Parameters

updated

the new date and time of the last update

Definition at line 120 of file content.cpp.

setVideos()

void Content::setVideos

(

QList< QUrl >

videos

)

Set list of videos.

Parameters

videos

list of videos for this content

Definition at line 315 of file content.cpp.

smallPreviewPicture()

QString Content::smallPreviewPicture

(

const QString &

number = QStringLiteral("1")

)

const

Definition at line 290 of file content.cpp.

summary()

QString Content::summary

(

)

const

A summary description of this content.

Definition at line 150 of file content.cpp.

tags()

QStringList Content::tags

(

)

const

Get all the tags for this content.

Since

5.50

Definition at line 320 of file content.cpp.

updated()

QDateTime Content::updated

(

)

const

Gets the date and time the Content has been last updated.

Returns

the date and time of the last update

Definition at line 125 of file content.cpp.

version()

QString Content::version

(

)

const

Definition at line 265 of file content.cpp.

videos()

QList< QUrl > Content::videos

(

)

Get all videos for this content.

Definition at line 310 of file content.cpp.

---

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

• content.h
• content.cpp