uiaction.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        Nanne Hemstra
 Date:          May 2007
________________________________________________________________________

-*/

#include "uibasemod.h"

#include "separstr.h"
#include "uistring.h"
#include "uibaseobject.h"


class i_ActionMessenger;
class uiActionContainer;
class uiIcon;
class uiMenu;
class uiPixmap;
class MenuItem;

mFDQtclass(QAction)
mFDQtclass(QMenu)


mExpClass(uiBase) uiAction : public CallBacker
{
friend class            i_ActionMessenger;
public:
                        uiAction(const uiString&);
                        uiAction(const uiString&,const CallBack&);
                        uiAction(const uiString&,const CallBack&,
                                 const uiIcon&);
                        uiAction(const uiString&,const CallBack&,
                                 const char* icon_identifier);
                        uiAction(const uiString&,const char* icon_identifier);
                        uiAction(const MenuItem&);
                        uiAction(mQtclass(QAction*));
                        ~uiAction();

    void                setText(const uiString&);
    const uiString&     text() const;
    void                setIconText(const uiString&);
    const uiString&     iconText() const;
    void                setToolTip(const uiString&);
    const uiString&     toolTip() const;
    static void         updateToolTips();
    void                setMenu(uiMenu*);

    uiMenu*             getMenu()               { return menu_; }
    const uiMenu*       getMenu() const         { return menu_; }

    void                setShortcut(const char*);

    void                setIcon(const char* identifier);
    void                setIcon(const uiIcon&);
    const char*         getIconName() const             { return iconfile_; }
    void                setPixmap(const uiPixmap&);

    void                setCheckable(bool);
    bool                isCheckable() const;
    void                setChecked(bool);
    bool                isChecked() const;
    void                setEnabled(bool);
    bool                isEnabled() const;
    void                setVisible(bool);
    bool                isVisible() const;

    void                setSeparator(bool);
    bool                isSeparator() const;

    void                setParentContainer(const uiActionContainer*);
    int                 getID() const;
    mQtclass(QAction*)          qaction()       { return qaction_; }
    const mQtclass(QAction*)    qaction() const { return qaction_; }

    Notifier<uiAction>  toggled;
    Notifier<uiAction>  triggered;

    void                reloadIcon();

protected:

    virtual void        trigger(bool checked);
    void                translateCB(CallBacker*);

    void                updateToolTip(CallBacker* = 0);
    uiString            tooltip_;
    uiString            text_;
    uiString            icontext_;

    void                updateEnabled(CallBacker* = 0);
    void                updateCheckable(CallBacker* = 0);
    void                updateChecked(CallBacker* = 0);
    void                updateVisible(CallBacker* = 0);
    bool                enabled_;
    bool                checkable_;
    bool                ischecked_;
    bool                visible_;

private:

    uiMenu*                     menu_;

    BufferString                iconfile_;
    const uiActionContainer*    parentcontainer_;
    i_ActionMessenger*          msgr_;
    mQtclass(QAction*)          qaction_;

    bool                        checked_;

    int                         cmdrecrefnr_;

    void                        init(const uiString&);

public:
    static void         addCmdRecorder(const CallBack&);
    static void         removeCmdRecorder(const CallBack&);
    int  /* refnr */    beginCmdRecEvent(const char* msg=0);
    void                endCmdRecEvent(int refnr,const char* msg=0);
};

mExpClass(uiBase) uiActionSeparString : public SeparString
{
public:
    uiActionSeparString(const char* str=0) : SeparString(str,'`')       {}
};


/*Generalization of a menubar, a menu or a toolbar that can contain actions. */
mExpClass(uiBase) uiActionContainer
{
public:
    virtual                     ~uiActionContainer();

    int                         nrActions() const;
    const ObjectSet<uiAction>&  actions() const;
    bool                        isEmpty() const;

    uiAction*                   findAction(const uiActionSeparString&);
    uiAction*                   findAction(const char* itmtxt);
    uiAction*                   findAction(const uiString& itmtxt);
    uiAction*                   findAction(int id);
    uiAction*                   findAction(const uiMenu*);
    uiAction*                   findAction( const FixedString& fs )
                                        { return findAction(fs.str()); }
    int                         getID(const uiAction*) const;
    int                         getID(const mQtclass(QAction)*) const;

    int                         insertAction(uiAction*,int id=-1,
                                             const uiAction* before = 0);
    int                         insertAction(const MenuItem&);

    uiMenu*                     addMenu(uiMenu*,const uiMenu* before = 0);
    uiAction*                   insertSeparator();

    void                        removeAction(uiAction*);
    void                        removeAction(int id);
    void                        removeAllActions();
    void                        reloadIcons();

protected:
                        uiActionContainer();

    int                 getFreeID() const;

    virtual void        doInsertSeparator(mQtclass(QAction)* before)    = 0;
    virtual void        doInsertMenu(mQtclass(QMenu)*,
                                 mQtclass(QAction)* before )            = 0;
    virtual void        doInsertAction(mQtclass(QAction)*,
                                       mQtclass(QAction)* before )      = 0;
    virtual void        doClear()                                       = 0;
    virtual void        doRemoveAction(mQtclass(QAction)*)              = 0;

    ObjectSet<uiAction> actions_;
    TypeSet<int>        ids_;

public:

    int                 insertItem(uiAction* a,int id=-1,
                                   const uiAction* before = 0)
                        { return insertAction( a, id, before ); }
    int                 insertItem(uiMenu* mnu);
    void                removeItem(uiAction* a) { removeAction(a); }
    void                removeItem(int id) { removeAction(id); }
};