kde-extraapps/kdeplasma-addons/libs/lancelot/widgets/Panel.h
2015-01-15 17:07:43 +00:00

155 lines
3.9 KiB
C++

/*
* Copyright (C) 2007, 2008, 2009, 2010 Ivan Cukic <ivan.cukic(at)kde.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser/Library General Public License version 2,
* or (at your option) any later version, as published by the Free
* Software Foundation
*
* This program 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 Lesser/Library General Public License for more details
*
* You should have received a copy of the GNU Lesser/Library General Public
* License along with this program; if not, write to the
* Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#ifndef LANCELOT_PANEL_H
#define LANCELOT_PANEL_H
#include <QtGui/QIcon>
#include <Plasma/Plasma>
#include <lancelot/lancelot_export.h>
#include <lancelot/widgets/Widget.h>
namespace Lancelot
{
/**
* A container widget with optional title-bar
*
* @author Ivan Cukic
*/
class LANCELOT_EXPORT Panel: public Lancelot::Widget
{
Q_OBJECT
Q_PROPERTY ( QIcon icon READ icon WRITE setIcon )
Q_PROPERTY ( QSize iconSize READ iconSize WRITE setIconSize )
Q_PROPERTY ( QString title READ title WRITE setTitle ) L_EXTRA ( i18n )
Q_PROPERTY ( bool showingTitle READ isShowingTitle WRITE setShowingTitle )
// @puck L_WIDGET
// @puck L_INCLUDE(lancelot/widgets/Panel.h QIcon QSize QString)
public:
/**
* Creates a new Lancelot::Widget
* @param parent parent item
*/
Panel(QGraphicsItem * parent = 0);
/**
* Creates a new Lancelot::Panel
* @param icon the icon for the widget
* @param title the title of the widget
* @param parent parent item
*/
explicit Panel(QIcon icon, QString title = QString(),
QGraphicsItem * parent = 0);
/**
* Creates a new Lancelot::Widget
* @param title the title of the widget
* @param parent parent item
*/
explicit Panel(QString title, QGraphicsItem * parent = 0);
/**
* Destroys Lancelot::Panel
*/
virtual ~Panel();
/**
* Sets title of this Lancelot::Panel
* @param title new title
*/
void setTitle(const QString & title);
/**
* @returns title of this Lancelot::Panel
*/
QString title() const;
/**
* Sets icon of this Lancelot::Panel
* @param icon new icon
*/
void setIcon(QIcon icon);
/**
* @returns icon of this Lancelot::Panel
*/
QIcon icon() const;
/**
* Sets icon size of this Lancelot::Panel
* @param size new icon size
*/
void setIconSize(QSize size);
/**
* @returns icon size of this Lancelot::Panel
*/
QSize iconSize() const;
/**
* Sets whether the title is shown
*/
void setShowingTitle(bool value);
/**
* @returns whether the title is shown
*/
bool isShowingTitle() const;
/**
* Sets the layout item for the components in case the panel
* should contain more than one item at a time
* @param layoutItem the contained layout item
*/
void setLayoutItem(QGraphicsLayoutItem * layoutItem);
/**
* @returns the layout item
*/
QGraphicsLayoutItem * layoutItem() const;
/**
* @param edge edge
* @returns size of the specified edge
*/
qreal borderSize(Plasma::MarginEdge edge) const;
L_Override void setGroup(Group * group = NULL);
protected:
// L_Override void paint(QPainter * painter, const QStyleOptionGraphicsItem * option, QWidget * widget = 0);
L_Override QSizeF sizeHint(Qt::SizeHint which,
const QSizeF & constraint = QSizeF()) const;
L_Override void resizeEvent(QGraphicsSceneResizeEvent * event);
private:
class Private;
Private * const d;
};
} // namespace Lancelot
#endif /* LANCELOT_PANEL_H */