KContacts::Picture

KContacts::Picture Class Reference

#include <picture.h>

Public Types

typedef QVector< PictureList
 

Public Member Functions

 Picture ()
 
 Picture (const QString &url)
 
 Picture (const QImage &data)
 
 Picture (const Picture &picture)
 
 ~Picture ()
 
QImage data () const
 
bool isEmpty () const
 
bool isIntern () const
 
bool operator!= (const Picture &other) const
 
Pictureoperator= (const Picture &other)
 
bool operator== (const Picture &other) const
 
QByteArray rawData () const
 
void setData (const QImage &data)
 
void setRawData (const QByteArray &rawData, const QString &type)
 
void setUrl (const QString &url)
 
void setUrl (const QString &url, const QString &type)
 
QString toString () const
 
QString type () const
 
QString url () const
 

Friends

KCONTACTS_EXPORT QDataStreamoperator<< (QDataStream &, const Picture &)
 
KCONTACTS_EXPORT QDataStreamoperator>> (QDataStream &, Picture &)
 

Detailed Description

A class to store a picture of an addressee.

It can store the data directly or an url reference to a picture.

Definition at line 26 of file picture.h.

Constructor & Destructor Documentation

Picture::Picture ( )

Creates an empty picture.

Definition at line 46 of file picture.cpp.

Picture::Picture ( const QString url)

Creates a picture which points to the given url.

Parameters
urlA URL that describes the location of the picture file.

Definition at line 51 of file picture.cpp.

Picture::Picture ( const QImage data)

Creates a picture with the given data.

Parameters
dataThe raw data of the picture.

Definition at line 57 of file picture.cpp.

Picture::Picture ( const Picture picture)

Copy constructor.

Fast operation, Picture's data is implicitly shared.

Parameters
pictureThe Picture instance to copy from

Definition at line 63 of file picture.cpp.

Picture::~Picture ( )

Destructor.

Definition at line 68 of file picture.cpp.

Member Function Documentation

QImage Picture::data ( ) const

Returns the image data of this picture.

Definition at line 176 of file picture.cpp.

bool Picture::isEmpty ( ) const

Returns true, if the picture is empty.

Definition at line 123 of file picture.cpp.

bool Picture::isIntern ( ) const

Returns whether the picture is described by a URL (extern) or by the raw data (intern).

When this method returns 'true' you can use data() to get the raw data. Otherwise you can request the URL of this picture by url() and load the raw data from that location.

Definition at line 166 of file picture.cpp.

bool Picture::operator!= ( const Picture other) const

Not-Equal operator.

Definition at line 118 of file picture.cpp.

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

Assignment operator.

Fast operation, Picture's data is implicitly shared.

Parameters
otherThe Picture instance to assign to this

Definition at line 72 of file picture.cpp.

bool Picture::operator== ( const Picture other) const

Equality operator.

Definition at line 81 of file picture.cpp.

QByteArray Picture::rawData ( ) const

Returns the raw data of this picture.

Since
4.10

Definition at line 185 of file picture.cpp.

void Picture::setData ( const QImage data)

Sets the image data of the picture.

When using this function, isIntern() will return 'true' until you use setUrl(). This also sets type to "png" or "jpeg" depending on whether the image has an alpha channel or not.

Parameters
dataThe image data of the picture.

Definition at line 144 of file picture.cpp.

void Picture::setRawData ( const QByteArray rawData,
const QString type 
)

Sets the raw data of the picture.

When using this function, isIntern() will return 'true' until you use setUrl().

Parameters
rawDataThe raw data of the picture.
typeThe encoding format of the image, e.g. jpeg or png
Since
4.10

Definition at line 158 of file picture.cpp.

void Picture::setUrl ( const QString url)

Sets a URL for the location of the picture file.

When using this function, isIntern() will return 'false' until you use setData(). This also clears the type, as it is unknown.

Parameters
urlThe location URL of the picture file.

Definition at line 130 of file picture.cpp.

void Picture::setUrl ( const QString url,
const QString type 
)

Sets a URL for the location of the picture file.

When using this function, isIntern() will return 'false' until you use setData().

Parameters
urlThe location URL of the picture file.
typeThe encoding format of the image, e.g. jpeg or png
Since
4.10

Definition at line 137 of file picture.cpp.

QString Picture::toString ( ) const

Returns string representation of the picture.

Definition at line 203 of file picture.cpp.

QString Picture::type ( ) const

Returns the type of this picture.

Definition at line 198 of file picture.cpp.

QString Picture::url ( ) const

Returns the location URL of this picture.

Definition at line 171 of file picture.cpp.

Friends And Related Function Documentation

KCONTACTS_EXPORT QDataStream& operator<< ( QDataStream ,
const Picture  
)
friend

Serializes the picture object into the stream.

KCONTACTS_EXPORT QDataStream& operator>> ( QDataStream ,
Picture  
)
friend

Initializes the picture object from the stream.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Jul 5 2020 22:54:57 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.