# Source: kdualcolorbtn.h |
Annotated List
Files
Globals
Hierarchy
Index

    /* This file is part of the KDE libraries
       Copyright (C) 1999 Daniel M. Duley <mosfet@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., 59 Temple Place - Suite 330,
       Boston, MA 02111-1307, USA.
    */
    #ifndef __KDUALCOLORBTN_H
    #define __KDUALCOLORBTN_H

    #include <qbitmap.h>
    #include <qbrush.h>
    #include <qwidget.h>

    /**
     * KDualColorButton allows the user to select two cascaded colors (usually a
     * foreground and background color). Other features include drag and drop
     * from other KDE color widgets, a reset to black and white control, and a
     * swap colors control.
     *
     * When the user clicks on the foreground or background rectangle the
     * rectangle is first sunken and the @ref currentChanged() signal is emitted.
     * Further clicks will present a color dialog and emit either the @ref fgChanged()
     * or @ref bgChanged() if a new color is selected.
     *
     * Note: With drag and drop when dropping a color the current selected color
     * will be set, while when dragging a color it will use whatever color
     * rectangle the mouse was pressed inside.
     *
     * @short A widget for selecting two related colors.
     * @author Daniel M. Duley <mosfet@kde.org>
     */
    class KDualColorButton : public QWidget
    {
        Q_OBJECT
        Q_ENUMS( DualColor )
        Q_PROPERTY( QColor foreground READ foreground WRITE setForeground )
        Q_PROPERTY( QColor background READ background WRITE setBackground )
        Q_PROPERTY( QColor currentColor READ currentColor WRITE setCurrentColor STORED false DESIGNABLE false )
        Q_PROPERTY( DualColor current READ current WRITE setCurrent )

    public:

        enum DualColor { Foreground, Background };
        /**
         * Constructs a new KDualColorButton using the default black and white
         * colors.
         *
         */
        KDualColorButton(QWidget *parent=0, const char *name=0);

        /**
         * Constructs a new KDualColorButton using the default black and white
         * colors.
         *
         * BIC: merge with the above next Wednesday, dialogParent defaults to 0L
         */
        KDualColorButton(QWidget *parent, const char *name, QWidget* dialogParent);

        /**
         * Constructs a new KDualColorButton with the supplied foreground and
         * background colors.
         */
        KDualColorButton(const QColor &fgColor, const QColor &bgColor,
                         QWidget *parent=0, const char *name=0);

        /**
         * Constructs a new KDualColorButton with the supplied foreground and
         * background colors.
         *
         * BIC: merge with the above next Wednesday, dialogParent defaults to 0L
         */
        KDualColorButton(const QColor &fgColor, const QColor &bgColor,
                         QWidget *parent, const char *name, QWidget* dialogParent);

        ~KDualColorButton();
        /**
         * Returns the current foreground color.
         */
        QColor foreground() const;
        /**
         * Returns the current background color.
         */
        QColor background() const;
        /**
         * Returns the current color item selected by the user.
         */
        DualColor current() const;
        /**
         * Returns the color of the selected item.
         */
        QColor currentColor() const;
        /**
         * Returns the minimum size needed to display the widget and all its
         * controls.
         */
        virtual QSize sizeHint() const;
    public slots:
        /**
         * Sets the foreground color.
         */
        void setForeground(const QColor &c);
        /**
         * Sets the background color.
         */
        void setBackground(const QColor &c);
        /**
         * Sets the current selected color item.
         */
        void setCurrent(DualColor s);
        /**
         * Sets the color of the selected item.
         */
        void setCurrentColor(const QColor &c);
    signals:
        /**
         * Emitted when the foreground color is changed.
         */
        void fgChanged(const QColor &c);
        /**
         * Emitted when the background color is changed.
         */
        void bgChanged(const QColor &c);
        /**
         * Emitted when the user changes the current color selection.
         */
        void currentChanged(KDualColorButton::DualColor s);
    protected:
        /**
         * Sets the supplied rectangles to the proper size and position for the
         * current widget size. You can reimplement this to change the layout
         * of the widget. Restrictions are that the swap control will always
         * be at the top right, the reset control will always be at the bottom
         * left, and you must leave at least a 14x14 space in those corners.
         */
        virtual void metrics(QRect &fgRect, QRect &bgRect);
        virtual void paintEvent(QPaintEvent *ev);
        virtual void mousePressEvent(QMouseEvent *ev);
        virtual void mouseMoveEvent(QMouseEvent *ev);
        virtual void mouseReleaseEvent(QMouseEvent *ev);
        // Dnd
        virtual void dragEnterEvent(QDragEnterEvent *ev);
        virtual void dropEvent(QDropEvent *ev);
    private:
        QBitmap *arrowBitmap;
        QPixmap *resetPixmap;
        QBrush fg, bg;
        QPoint mPos;
        bool dragFlag, miniCtlFlag;
        DualColor curColor, tmpColor;

        class KDualColorPrivate;
        KDualColorPrivate *d;
    };

    #endif

Generated by: root@sparc.ports.openbsd.org on Wed May 2 09:37:45 2001, using kdoc 2.0a53.