uitoolbar.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Lammertink
 Date:          30/05/2001
________________________________________________________________________

-*/

#include "uibasemod.h"

#include "uiaction.h"
#include "uiparent.h"
#include "uitoolbutton.h"

mFDQtclass(QAction)
mFDQtclass(QToolBar)

class MenuItem;
class uiButton;
class uiIcon;
class uiObject;
class uiMainWinBody;
class i_ToolBarMessenger;


mExpClass(uiBase) uiToolBar : public uiActionContainer, public uiParent
{
friend class i_ToolBarMessenger;
public:
    /*
        Toolbars can be created on docks,
    */
    enum ToolBarArea
    {
            Left=0x1,   
            Right=0x2,  
            Top=0x4,    
            Bottom=0x8, 
            None=0,     
            All=0xf     
    };

                        uiToolBar(uiParent*,const uiString& nm,
                                  ToolBarArea d=Top,bool newline=false);
                        ~uiToolBar();

    uiParent*           parent()                        { return parent_; }

    int                 addButton(const uiToolButtonSetup&);
    int                 addButton(const char* fnm,const uiString& tooltip,
                                  const CallBack& =CallBack(),
                                  bool toggle=false,int id=-1);
    int                 addButton(const MenuItem&);
    void                addObject(uiObject*);

    void                setLabel(const uiString&);

    void                setToggle(int id, bool);
    void                setIcon(int id,const char*);
    void                setIcon(int id,const uiIcon&);
    void                setToolTip(int id,const uiString&);
    void                setShortcut(int id,const char*);
    void                turnOn(int id,bool yn);
    bool                isOn(int id) const;
    void                setSensitive(int id,bool yn);
    void                setSensitive(bool yn);
    bool                isSensitive() const;
    OD::Orientation     getOrientation() const;

    void                setButtonMenu(int,uiMenu*,
                         uiToolButton::PopupMode=uiToolButton::MenuButtonPopup);

    virtual void        display(bool yn=true,bool s=false,bool m=false);
    void                setToolBarMenuAction(uiAction*);
    void                translateText();

    bool                isHidden() const;
    bool                isVisible() const;

    void                addSeparator() { insertSeparator(); }

    void                clear();

    static ToolBarArea  pluginArea()            { return uiToolBar::Right; }
    ToolBarArea         prefArea() const        { return tbarea_; }
    int                 getNrWidgets() const    { return 1; }
    mQtclass(QWidget)*  getWidget(int);
    mQtclass(QToolBar)* getQToolbar()           { return qtoolbar_; }

    static ObjectSet<uiToolBar>& toolBars();

    CNotifier<uiToolBar,int>    buttonClicked;
    Notifier<uiToolBar>         orientationChanged;

protected:

    void                        doInsertMenu(mQtclass(QMenu)*,
                                             mQtclass(QAction)* before);
    void                        doInsertAction(mQtclass(QAction)*,
                                               mQtclass(QAction)* before);
    void                        doInsertSeparator(mQtclass(QAction)* before);
    void                        doRemoveAction(mQtclass(QAction)*);
    void                        doClear();
    void                        handleFinalise(bool pre);

    uiAction*                   toolbarmenuaction_;

    mQtclass(QToolBar*)         qtoolbar_;
    i_ToolBarMessenger*         msgr_;

    ToolBarArea                 tbarea_;
    ObjectSet<uiObject>         addedobjects_;

    uiString                    label_;
    int                         getButtonID(mQtclass(QAction*));

    uiParent*                   parent_;
    friend class                uiMainWinBody;

public:
    void                getEntityList(ObjectSet<const CallBacker>&) const;
};