kpanelextension.h

/*****************************************************************
 
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 __kpanelextension_h__
#define __kpanelextension_h__
 
#include <tqframe.h>
#include <tdelibs_export.h>
 
class TQPopupMenu;
class TDEConfig;
class KPanelExtensionPrivate;
 
class TDEUI_EXPORT KPanelExtension : public TQFrame
{
    TQ_OBJECT
 
public:
 
    enum Type { Normal = 0, Stretch };
    // KDE4: Merge these with KPanelApplet's enums
    enum Action { About = 1, Help = 2, Preferences = 4, ReportBug = 8 };
    enum Position { Left = 0, Right, Top, Bottom, Floating };
    enum Alignment { LeftTop = 0, Center, RightBottom };
    enum Size { SizeTiny = 0, SizeSmall, SizeNormal, SizeLarge, SizeCustom };
 
    KPanelExtension(const TQString& configFile, Type t = Normal,
         int actions = 0, TQWidget *parent = 0, const char *name = 0);
 
    ~KPanelExtension();
 
    virtual TQSize sizeHint(Position /*p*/, TQSize maxsize) const { return maxsize; }
 
    TDEConfig* config() const { return _config; }
 
    Type type() const { return _type; }
 
    int actions() const { return _actions; }
 
    virtual void action( Action a );
 
 
    virtual Position preferedPosition() const { return Bottom; }
 
    void setPosition( Position p );
    void setAlignment( Alignment a );
    void setSize( Size size, int customSize );
 
    Size sizeSetting() const;
 
    int customSize() const;
 
    TQPopupMenu* customMenu() const;
 
    bool reserveStrut() const;
 
signals:
    void updateLayout();
 
    void maintainFocus(bool);
 
protected:
 
    virtual void about() {}
 
    virtual void help() {}
 
    virtual void preferences() {}
 
    virtual void reportBug() {}
 
    Position position() const { return _position; }
 
    Alignment alignment() const { return _alignment; }
 
    Orientation orientation();
 
    int sizeInPixels() const;
 
    virtual void positionChange( Position ) {}
 
    virtual void alignmentChange( Alignment ) {}
 
    void setCustomMenu(TQPopupMenu*);
 
    void setReserveStrut(bool shouldUseStrut);
 
private:
    Type                _type;
    Position            _position;
    Alignment           _alignment;
    TDEConfig*          _config;
    int                 _actions;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    KPanelExtensionPrivate     *d;
};
 
#endif