uibutton.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:          21/01/2000
________________________________________________________________________

-*/

#include "uibasemod.h"
#include "uiobj.h"
#include "uistring.h"
#include "odiconfile.h"

class uiButtonBody;
class uiCheckBoxBody;
class uiPushButtonBody;
class uiRadioButtonBody;
mFDQtclass(QAbstractButton)

class uiMenu;
class uiPixmap;
mFDQtclass(QEvent)
mFDQtclass(QMenu)



mExpClass(uiBase) uiButton : public uiObject
{
public:
                        uiButton(uiParent*,const uiString&,const CallBack*,
                                 uiObjectBody&);
    virtual             ~uiButton()             {}

    virtual void        setText(const uiString&);
    const uiString&     text() const                    { return text_; }
    void                setIcon(const char* icon_identifier);
    void                setPixmap( const uiPixmap& pm ) { setPM(pm); }
    void                setIconScale(float val); 
    virtual void        updateIconSize()        {}

    virtual void        click()         = 0;

    Notifier<uiButton>  activated;

    mQtclass(QAbstractButton*)  qButton();

    static uiButton*    getStd(uiParent*,OD::StdActionType,const CallBack&,
                                bool immediate);
    static uiButton*    getStd(uiParent*,OD::StdActionType,const CallBack&,
                                bool immediate,const uiString& nonstd_text);

    static bool         haveCommonPBIcons()     { return havecommonpbics_; }
    static void         setHaveCommonPBIcons( bool yn=true )
                                                { havecommonpbics_ = yn; }

protected:

    uiString            text_;
    float               iconscale_;
    static bool         havecommonpbics_;

    virtual void        translateText();
    virtual void        setPM(const uiPixmap&);

};


mExpClass(uiBase) uiPushButton : public uiButton
{
public:
                        uiPushButton(uiParent*,const uiString& txt,
                                     bool immediate);
                        uiPushButton(uiParent*,const uiString& txt,
                                     const CallBack&,bool immediate);
                        uiPushButton(uiParent*,const uiString& txt,
                                     const uiPixmap&,bool immediate);
                        uiPushButton(uiParent*,const uiString& txt,
                                     const uiPixmap&,const CallBack&,
                                     bool immediate);

    void                setDefault(bool yn=true);
    void                click();
    void                setMenu(uiMenu*);
    void                setFlat(bool);

private:

    void                translateText();
    void                updateText();
    void                updateIconSize();

    bool                immediate_;
    uiPushButtonBody*   pbbody_;
    uiPushButtonBody&   mkbody(uiParent*,const uiString&);
};


mExpClass(uiBase) uiRadioButton : public uiButton
{
public:
                        uiRadioButton(uiParent*,const uiString&);
                        uiRadioButton(uiParent*,const uiString&,
                                      const CallBack&);

    bool                isChecked() const;
    virtual void        setChecked(bool yn=true);

    void                click();

private:

    uiRadioButtonBody*  rbbody_;
    uiRadioButtonBody&  mkbody(uiParent*,const uiString&);

};


mExpClass(uiBase) uiCheckBox: public uiButton
{
public:

                        uiCheckBox(uiParent*,const uiString&);
                        uiCheckBox(uiParent*,const uiString&,
                                   const CallBack&);

    bool                isChecked() const;
    void                setChecked(bool yn=true);
    void                setTriState(bool yn=true);
    void                setCheckState(OD::CheckState);
    OD::CheckState      getCheckState() const;

    void                click();

private:

    uiCheckBoxBody*     cbbody_;
    uiCheckBoxBody&     mkbody(uiParent*,const uiString&);

};



mExpClass(uiBase) uiButtonMessenger
{
    friend class        i_ButMessenger;

public:

                        uiButtonMessenger()             {}
    virtual             ~uiButtonMessenger()            {}

    enum notifyTp       { clicked, pressed, released, toggled };

protected:

    virtual void        notifyHandler(notifyTp)         = 0;

};