mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-23 10:22:50 +00:00
125 lines
3.1 KiB
C++
125 lines
3.1 KiB
C++
/*
|
|
Copyright (c) 2008 Volker Krause <vkrause@kde.org>
|
|
|
|
This library is free software; you can redistribute it and/or modify it
|
|
under the terms of the GNU Library General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or (at your
|
|
option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
|
|
License for more details.
|
|
|
|
You should have received a copy of the GNU Library General Public License
|
|
along with this library; see the file COPYING.LIB. If not, write to the
|
|
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
|
02110-1301, USA.
|
|
*/
|
|
|
|
#ifndef AKONADI_ENTITYDISPLAYATTRIBUTE_H
|
|
#define AKONADI_ENTITYDISPLAYATTRIBUTE_H
|
|
|
|
#include <QColor>
|
|
|
|
#include <akonadi/attribute.h>
|
|
|
|
class KIcon;
|
|
|
|
namespace Akonadi {
|
|
|
|
/**
|
|
* @short Attribute that stores the properties that are used to display an entity.
|
|
*
|
|
* Display properties of a collection or item, such as translated names and icons.
|
|
*
|
|
* @author Volker Krause <vkrause@kde.org>
|
|
* @since 4.2
|
|
*/
|
|
class AKONADI_EXPORT EntityDisplayAttribute : public Attribute
|
|
{
|
|
public:
|
|
/**
|
|
* Creates a new entity display attribute.
|
|
*/
|
|
EntityDisplayAttribute();
|
|
|
|
/**
|
|
* Destroys the entity display attribute.
|
|
*/
|
|
~EntityDisplayAttribute();
|
|
|
|
/**
|
|
* Sets the @p name that should be used for display.
|
|
*/
|
|
void setDisplayName(const QString &name);
|
|
|
|
/**
|
|
* Returns the name that should be used for display.
|
|
* Users of this should fall back to Collection::name() if this is empty.
|
|
*/
|
|
QString displayName() const;
|
|
|
|
/**
|
|
* Sets the icon @p name for the default icon.
|
|
*/
|
|
void setIconName(const QString &name);
|
|
|
|
/**
|
|
* Returns the icon that should be used for this collection or item.
|
|
*/
|
|
KIcon icon() const;
|
|
|
|
/**
|
|
* Returns the icon name of the icon returned by icon().
|
|
*/
|
|
QString iconName() const;
|
|
|
|
/**
|
|
* Sets the icon @p name for the active icon.
|
|
* @param name the icon name to use
|
|
* @since 4.4
|
|
*/
|
|
void setActiveIconName(const QString &name);
|
|
|
|
/**
|
|
* Returns the icon that should be used for this collection or item when active.
|
|
* @since 4.4
|
|
*/
|
|
KIcon activeIcon() const;
|
|
|
|
/**
|
|
* Returns the icon name of an active item.
|
|
* @since 4.4
|
|
*/
|
|
QString activeIconName() const;
|
|
|
|
/**
|
|
* Returns the backgroundColor or an invalid color if none is set.
|
|
* @since 4.4
|
|
*/
|
|
QColor backgroundColor() const;
|
|
|
|
/**
|
|
* Sets the backgroundColor to @p color.
|
|
* @param color the background color to use
|
|
* @since 4.4
|
|
*/
|
|
void setBackgroundColor(const QColor &color);
|
|
|
|
/* reimpl */
|
|
QByteArray type() const;
|
|
EntityDisplayAttribute *clone() const;
|
|
QByteArray serialized() const;
|
|
void deserialize(const QByteArray &data);
|
|
|
|
private:
|
|
//@cond PRIVATE
|
|
class Private;
|
|
Private *const d;
|
|
//@endcond
|
|
};
|
|
|
|
}
|
|
|
|
#endif
|