KoVBox.h 2.18 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/* This file is part of the KDE libraries
   Copyright (C) 2005 David Faure <faure@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 version 2 as published by the Free Software Foundation.

   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 KoVBOX_H
#define KoVBOX_H

22
#include <kritawidgets_export.h>
23 24 25 26 27 28 29 30

#include <QFrame>

class QChildEvent;

/**
 * A container widget which arranges its children vertically.
 * 
31
 * When using a KoVBox you don't need to create a layout nor
32 33 34 35 36 37 38
 * to add the child widgets to it.
 *
 * Both margin and spacing are initialized to 0. Use QHBoxLayout
 * if you need standard layout margins.
 *
 * @see KVBox
 */
39
class KRITAWIDGETS_EXPORT KoVBox : public QFrame
40 41 42 43 44 45 46 47 48 49 50 51
{
    Q_OBJECT

public:
    /**
     * Creates a new hbox.
     */
    explicit KoVBox(QWidget *parent = 0);

    /**
     * Destructor.
     */
52
    ~KoVBox() override;
53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73

    /**
     * Sets the @p margin of the hbox.
     */
    void setMargin(int margin);

    /**
     * Sets the spacing between the child widgets to @p space.
     *
     * To get the default layout spacing, set @p space to -1.
     */
    void setSpacing(int space);

    /**
     * Sets the stretch factor of @p widget to @p stretch.
     */
    void setStretchFactor(QWidget *widget, int stretch);

    /**
     * Calculate the recommended size for this hbox.
     */
74
    QSize sizeHint() const override;
75 76 77 78

    /**
     * Calculate the recommended minimum size for this hbox.
     */
79
    QSize minimumSizeHint() const override;
80 81 82

protected:

83
    void childEvent(QChildEvent *ev) override;
84 85 86 87 88 89 90 91 92 93

private:
    class Private;
    friend class Private;
    Private *const d;

    Q_DISABLE_COPY(KoVBox)
};

#endif