tdetoolbar.h

/* This file is part of the KDE libraries
    Copyright (C) 2000 Reginald Stadlbauer (reggie@kde.org)
    (C) 1997, 1998 Stephan Kulow (coolo@kde.org)
    (C) 1997, 1998 Sven Radej (radej@kde.org)
    (C) 1997, 1998 Mark Donohoe (donohoe@kde.org)
    (C) 1997, 1998 Matthias Ettrich (ettrich@kde.org)
    (C) 1999, 2000 Kurt Granroth (granroth@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 TDETOOLBAR_H
#define TDETOOLBAR_H
 
#include <tqtoolbar.h>
#include <tqmainwindow.h>
#include <tqcombobox.h>
#include <tqmap.h>
#include <tqptrlist.h>
#include <tqguardedptr.h>
#include <tqframe.h>
#include <tqiconset.h>
 
#include <tdeglobal.h>
 
class TQDomElement;
class TQSize;
class TQPixmap;
class TQPopupMenu;
class TQStringList;
class TQDomDocument;
class TQTimer;
 
class KLineEdit;
class TDEToolBar;
class TDEToolBarButton;
class TDEToolBoxManager;
class KAnimWidget;
class TDEPopupMenu;
class TDEInstance;
class KComboBox;
class KXMLGUIClient;
 
class TDEToolBarPrivate;
 
class TDEUI_EXPORT TDEToolBarSeparator : public TQFrame
{
    TQ_OBJECT
    
public:
    TDEToolBarSeparator( Orientation, bool l, TQToolBar *parent, const char* name=0 );
 
    TQSize sizeHint() const;
    Orientation orientation() const { return orient; }
    TQSizePolicy sizePolicy() const;
    bool showLine() const { return line; }
public slots:
   void setOrientation( Orientation );
protected:
    void styleChange( TQStyle& );
    void drawContents( TQPainter* );
private:
    Orientation orient;
    bool line;
};
 
 
class TDEUI_EXPORT TDEToolBar : public TQToolBar
{
    TQ_OBJECT
    
    TQ_ENUMS( IconText BarPosition )
    TQ_PROPERTY( IconText iconText READ iconText WRITE setIconText )
    TQ_PROPERTY( BarPosition barPos READ barPos WRITE setBarPos )
    TQ_PROPERTY( bool fullSize READ fullSize WRITE setFullSize )
    TQ_PROPERTY( int iconSize READ iconSize WRITE setIconSize )
    TQ_PROPERTY( TQString text READ text WRITE setText )
 
public:
    enum IconText{IconOnly = 0, IconTextRight, TextOnly, IconTextBottom};
    enum BarStatus{Toggle, Show, Hide};
    enum BarPosition{ Unmanaged, Floating, Top, Bottom, Right, Left, Flat};
 
    TDEToolBar( TQWidget *parent, const char *name = 0, bool honorStyle = false, bool readConfig = true );
 
    TDEToolBar( TQMainWindow *parentWindow, TQMainWindow::ToolBarDock dock /*= TQMainWindow::Top*/, bool newLine = false,
              const char *name = 0, bool honorStyle = false, bool readConfig = true );
 
    TDEToolBar( TQMainWindow *parentWindow, TQWidget *dock, bool newLine = false,
              const char *name = 0, bool honorStyle = false, bool readConfig = true );
 
    virtual ~TDEToolBar();
 
    int insertButton(const TQString& icon, int id, bool enabled = true,
             const TQString& text = TQString::null, int index=-1,
             TDEInstance *_instance = TDEGlobal::instance());
 
    int insertButton(const TQString& icon, int id, const char *signal,
             const TQObject *receiver, const char *slot,
             bool enabled = true, const TQString& text = TQString::null,
             int index=-1, TDEInstance *_instance = TDEGlobal::instance() );
 
    int insertButton(const TQPixmap& pixmap, int id, bool enabled = true,
             const TQString& text = TQString::null, int index=-1 );
 
    int insertButton(const TQPixmap& pixmap, int id, const char *signal,
             const TQObject *receiver, const char *slot,
             bool enabled = true, const TQString& text = TQString::null,
             int index=-1 );
 
    int insertButton(const TQString& icon, int id, TQPopupMenu *popup,
             bool enabled, const TQString&_text, int index=-1);
 
    int insertButton(const TQPixmap& pixmap, int id, TQPopupMenu *popup,
             bool enabled, const TQString&_text, int index=-1);
 
    int insertLined (const TQString& text, int id,
             const char *signal,
             const TQObject *receiver, const char *slot,
             bool enabled = true,
             const TQString& toolTipText = TQString::null,
             int size = 70, int index =-1);
 
    int insertCombo (const TQStringList &list, int id, bool writable,
             const char *signal, const TQObject *receiver,
             const char *slot, bool enabled=true,
             const TQString& tooltiptext=TQString::null,
             int size=70, int index=-1,
             TQComboBox::Policy policy = TQComboBox::AtBottom);
 
    int insertCombo (const TQString& text, int id, bool writable,
             const char *signal, TQObject *receiver,
             const char *slot, bool enabled=true,
             const TQString& tooltiptext=TQString::null,
             int size=70, int index=-1,
             TQComboBox::Policy policy = TQComboBox::AtBottom);
 
    int insertSeparator( int index = -1, int id = -1 );
 
    int insertLineSeparator( int index = -1, int id = -1 );
 
    int insertWidget(int id, int width, TQWidget *_widget, int index=-1);
 
    int insertAnimatedWidget(int id, TQObject *receiver, const char *slot,
                 const TQString& icons, int index = -1);
 
    KAnimWidget *animatedWidget( int id );
 
    void addConnection (int id, const char *signal,
                        const TQObject *receiver, const char *slot);
    void setItemEnabled( int id, bool enabled );
 
    void setButtonIcon( int id, const TQString& _icon );
 
    void setButtonPixmap( int id, const TQPixmap& _pixmap );
 
    void setButtonIconSet( int id, const TQIconSet& iconset );
 
    void setDelayedPopup (int id , TQPopupMenu *_popup, bool toggle = false);
 
    void setAutoRepeat (int id, bool flag=true);
 
 
    void setToggle (int id, bool flag = true);
 
    void toggleButton (int id);
 
    void setButton (int id, bool flag);
 
    bool isButtonOn (int id) const;
 
    void setLinedText (int id, const TQString& text);
 
    TQString getLinedText (int id) const;
 
    void insertComboItem (int id, const TQString& text, int index);
 
    void insertComboList (int id, const TQStringList &list, int index);
 
    void removeComboItem (int id, int index);
 
    void setCurrentComboItem (int id, int index);
 
    void changeComboItem  (int id, const TQString& text, int index=-1);
 
    void clearCombo (int id);
 
    TQString getComboItem (int id, int index=-1) const;
 
    KComboBox * getCombo(int id);
 
    KLineEdit * getLined (int id);
 
    TDEToolBarButton * getButton (int id);
 
    void alignItemRight (int id, bool right = true);
 
    TQWidget *getWidget (int id); // ### KDE4: make this const!
 
    void setItemAutoSized (int id, bool yes = true);
 
    void clear ();
 
    void removeItem (int id);
 
    void removeItemDelayed (int id);
 
    void hideItem (int id);
 
    void showItem (int id);
 
    int itemIndex (int id); // ### KDE4: make this const!
 
    int idAt(int index); // ### KDE4: make this const!
 
    void setFullSize(bool flag = true);
 
    bool fullSize() const;
 
    void enableMoving(bool flag = true) TDE_DEPRECATED;
 
    void setBarPos (BarPosition bpos);
 
    BarPosition barPos() const;
 
    bool enable(BarStatus stat) TDE_DEPRECATED;
 
    void setMaxHeight (int h) TDE_DEPRECATED;  // Set max height for vertical toolbars
 
    int maxHeight() TDE_DEPRECATED;
 
    void setMaxWidth (int dw) TDE_DEPRECATED;
 
    int maxWidth() TDE_DEPRECATED;
 
    void setTitle (const TQString& _title);
 
    void enableFloating (bool flag) TDE_DEPRECATED;
 
    void setIconText(IconText it);
   // Note: don't merge with the next one, it breaks Qt properties
 
    void setIconText(IconText it, bool update);
 
    IconText iconText() const;
 
    void setIconSize(int size);
    // Note: don't merge with the next one, it breaks Qt properties
 
    void setIconSize(int size, bool update);
 
    int iconSize() const;
 
    int iconSizeDefault() const;
 
    void setEnableContextMenu(bool enable = true);
 
    bool contextMenuEnabled() const;
 
    void setItemNoStyle(int id, bool no_style = true);
 
    void setFlat (bool flag);
 
    int count() const;
 
    void saveState(); // BIC: remove for KDE4? This doesn't appear to be used internally,
                      // and apps use saveMainWindowSettings in TDEMainWindow anyway.
 
    void saveSettings(TDEConfig *config, const TQString &configGroup);
 
    void applySettings(TDEConfig *config, const TQString &configGroup,bool force);
    // KDE4 merge with force=false
    void applySettings(TDEConfig *config, const TQString &configGroup);
 
  /*
   * Tell the toolbar what XML-GUI resource file it should use to save
   * it's state.  The state of the toolbar (position, size, etc) is
   * saved in TDEConfig files if the application does not use XML-GUI
   * but if the app does, then it's saved the XML file.  This function
   * allows this to happen.
   *
   * @param xmlfile The XML-GUI resource file to write to
   * @param xml     The DOM document for the XML-GUI building
   * @internal
   */
  //  void setXML(const TQString& xmlfile, const TQDomDocument& xml);
 
    void setXMLGUIClient( KXMLGUIClient *client );
 
    void setText( const TQString & txt );
 
    TQString text() const;
 
    void setStretchableWidget( TQWidget *w );
    TQSizePolicy sizePolicy() const;
    bool highlight() const;
    TQSize sizeHint() const;
    TQSize minimumSizeHint() const;
    TQSize minimumSize() const;
 
    void hide();
    void show();
 
    void updateRects( bool = false ) {}
 
    void loadState( const TQDomElement &e );
    /*
     * Save state into an XML element, called by KXMLGUIBuilder
     */
    void saveState( TQDomElement &e );
 
    void positionYourself( bool force = false);
 
signals:
    void clicked(int id);
 
    void doubleClicked (int id);
 
    void pressed(int);
 
    void released(int);
 
    void toggled(int);
 
    void highlighted(int id, bool isHighlighted);
 
    void highlighted(int id );
 
    void moved( BarPosition );
 
    void modechange ();
 
    void toolbarDestroyed();
 
public:
    static bool highlightSetting();
 
    static bool transparentSetting();
 
    static IconText iconTextSetting();
 
public slots:
    virtual void setIconText( const TQString &txt )
    { TQToolBar::setIconText( txt ); }
 
protected:
    void mousePressEvent( TQMouseEvent * );
    void childEvent( TQChildEvent *e );
    void showEvent( TQShowEvent *e );
    void resizeEvent( TQResizeEvent *e );
    bool event( TQEvent *e );
    void applyAppearanceSettings(TDEConfig *config, const TQString &_configGroup, bool forceGlobal = false);
    TQString settingsGroup() const;
 
private slots:
    void rebuildLayout();
    void slotReadConfig ();
    void slotAppearanceChanged();
    void slotIconChanged(int);
    void slotRepaint();
    void toolBarPosChanged( TQToolBar *tb );
    void slotContextAboutToShow();
    void slotContextAboutToHide();
    void widgetDestroyed();
 
private:
    void init( bool readConfig = true, bool honorStyle = false );
    void doConnections( TDEToolBarButton *button );
    void insertWidgetInternal( TQWidget *w, int &index, int id );
    void removeWidgetInternal( TQWidget *w );
    void getAttributes( TQString &position, TQString &icontext, int &index );
    int dockWindowIndex();
    TDEPopupMenu *contextMenu();
    void doModeChange();
 
    TQMap<TQWidget*, int > widget2id;
    typedef TQMap<int, TQWidget* > Id2WidgetMap;
    Id2WidgetMap id2widget;
    TDEPopupMenu *context;
    TQPtrList<TQWidget> widgets;
    TQTimer *layoutTimer;
    TQGuardedPtr<TQWidget> stretchableWidget, rightAligned;
protected:
    virtual void virtual_hook( int id, void* data );
private:
    TDEToolBarPrivate *d;
};
 
#endif