plasma-framework/widgets/layoutitem.h
Matias Valdenegro Toro bef5a33ed5 - Full Doxygenization
- Ported PushButton to Plasma::Widget API
- Two new classes, Rectangle and Label.
- All Widgets should now inherit from Plasma::Widget


svn path=/trunk/KDE/kdebase/workspace/libs/plasma/; revision=691090
2007-07-22 22:16:40 +00:00

139 lines
3.8 KiB
C++

/*
* Copyright (C) 2007 by Matias Valdenegro T. <mvaldenegro@informatica.utem.cl>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Library General Public License version 2 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 General Public License for more details
*
* You should have received a copy of the GNU 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 __LAYOUT_ITEM__
#define __LAYOUT_ITEM__
#include <QtCore/QRectF>
#include <QtCore/QSizeF>
#include <plasma/plasma_export.h>
namespace Plasma
{
class Layout;
/**
* Base class for Plasma layout-managed items
*
* @author Matias Valdenegro T. <mvaldenegro@informatica.utem.cl>
*
* All layout-managed items should implement this class, but regular users just need to use
* Plasma::Widget and Plasma::Layout.
*/
class PLASMA_EXPORT LayoutItem
{
public:
/**
* Constructor.
*/
LayoutItem();
/**
* Virtual Destructor.
*/
virtual ~LayoutItem();
/**
* Returns a bitmask with the directions that this Item can be expanded.
*/
virtual Qt::Orientations expandingDirections() const = 0;
/**
* Returns the minimum size of this Item and it's contents.
*/
virtual QSizeF minimumSize() const = 0;
/**
* Returns the maximum size of this Item.
*/
virtual QSizeF maximumSize() const = 0;
/**
* Returns true whatever this Item can use height-for-width layout management,
* false otherwise.
*/
virtual bool hasHeightForWidth() const;
/**
* Returns the corresponding height for a given width.
* @param w Width
*/
virtual qreal heightForWidth(qreal w) const;
/**
* Returns true whatever this Item can use width-for-height layout management,
* false otherwise.
*/
virtual bool hasWidthForHeight() const;
/**
* Returns the corresponding width for a given height.
* @param h Height
*/
virtual qreal widthForHeight(qreal h) const;
/**
* Returns the geometry of this Item.
*/
virtual QRectF geometry() const = 0;
/**
* Sets the geometry of this Item.
*/
virtual void setGeometry(const QRectF& geometry) = 0;
/**
* Returns the most appropiate size of this Item to hold whatever contents it has.
*/
virtual QSizeF sizeHint() const = 0;
/**
* Resets the layout to 0 and doesn't notify the previous layout.
* Should only be used by the current layout when relinquishing the item,
* e.g. during layout destruction.
*/
void resetLayout();
/**
* Sets the layout so that the LayoutItem may inform the layout of its
* deletion. Should only be used by the layout it is added to.
*
* If the layout item is currently associated with another layout, it will
* first remove itself from that layout.
*
* @param layout The Layout that this LayoutItem will be managed by.
*/
void setLayout(Layout* layout);
/**
* Returns the layout this item is currently associated with.
*/
Layout* layout();
private:
class Private;
Private *const d;
};
}
#endif /* __LAYOUT_ITEM__ */