k3panelapplet.h

Go to the documentation of this file.

/*****************************************************************

Copyright (c) 2000 Matthias Elter

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

******************************************************************/

#ifndef __kpanelapplet_h__
#define __kpanelapplet_h__

#include <kde3support_export.h>
#include <QtGui/QFrame>

#include <ksharedconfig.h>

class QMenu;

class KDE3SUPPORT_EXPORT K3PanelApplet : public QFrame
{
    Q_OBJECT

public:
    enum Type { Normal = 0, Stretch };
    enum Action { About = 1, Help = 2, Preferences = 4, ReportBug = 8 };
    enum Position { Left = 0, Right, Up, Down, Top = Up, Bottom = Down, Floating };
    enum Alignment { LeftTop = 0, Center, RightBottom };

    explicit K3PanelApplet(const QString& configFile, Type t = Normal,
                          int actions = 0, QWidget *parent = 0, Qt::WFlags f = 0);

    ~K3PanelApplet();

    virtual int widthForHeight(int height) const { return height; }

    virtual int heightForWidth(int width) const { return width; }

    KConfig* config() const;
    KSharedConfig::Ptr sharedConfig() const;

    Type type() const;

    int actions() const;

    virtual void action( Action a );

    const QMenu* customMenu() const;

    void setPosition( Position p );
    void setAlignment( Alignment a );

Q_SIGNALS:
    void updateLayout();

    void requestFocus();

    void requestFocus(bool focus);

protected:

    virtual void about() {}

    virtual void help() {}

    virtual void preferences() {}

   virtual void reportBug() {}

    Qt::Orientation orientation() const;
    Position position() const;
    Alignment alignment() const;

    virtual void positionChange( Position p );

    virtual void alignmentChange( Alignment /*a*/ ) {}

    void setCustomMenu(const QMenu*);

    void watchForFocus(QWidget* widget, bool watch = true);

    void needsFocus(bool focus);

    // FIXME: Remove for KDE 4
    virtual KDE_DEPRECATED void orientationChange( Qt::Orientation /* orientation*/) {}

    Position popupDirection();

    // FIXME: Remove for KDE 4
    virtual KDE_DEPRECATED void popupDirectionChange( Position /*direction*/ ) {}

    bool eventFilter(QObject *, QEvent *);

protected:
    class Private;
    Private *d;
};

#endif