uispinbox.h

Go to the documentation of this file.

#ifndef uispinbox_h
#define uispinbox_h

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Lammertink
 Date:          01/02/2001
 RCS:           $Id$
________________________________________________________________________

-*/

#include "uibasemod.h"
#include "uiobj.h"
#include "uigroup.h"
#include "ranges.h"

class uiSpinBoxBody;
class uiLabel;


mExpClass(uiBase) uiSpinBox : public uiObject
{ mODTextTranslationClass(uiSpinBox)
friend class            uiSpinBoxBody;

public:
                        uiSpinBox(uiParent*,int nrdecimals=0,
                                  const char* nm="SpinBox");
                        ~uiSpinBox();

    void                setNrDecimals(int);
    void                setAlpha(bool);
    bool                isAlpha() const;

    void                setSpecialValueText(const char*); // First entry

    void                setValue(int);
    void                setValue(float);
    void                setValue(double);
    void                setValue(const char*);

    int                 getIntValue() const;
    double              getDValue() const;
    float               getFValue() const;
    bool                getBoolValue() const;
    const char*         text() const;

    void                setInterval( int start, int stop, int s=1 )
                        { setInterval( StepInterval<int>(start,stop,s) ); }
    void                setInterval( const Interval<int>& i, int s=1 )
                        { setInterval( StepInterval<int>(i.start,i.stop,s) ); }
    void                setInterval(const StepInterval<int>&);
    StepInterval<int>   getInterval() const;

    void                setInterval( float start, float stop, float s=1 )
                        { setInterval(StepInterval<float>(start,stop,s)); }
    void                setInterval(const StepInterval<float>&);
    StepInterval<float> getFInterval() const;

    void                setInterval( double start, double stop, double s=1 )
                        { setInterval(StepInterval<double>(start,stop,s)); }
    void                setInterval(const StepInterval<double>&);

    void                setMinValue(int);
    void                setMinValue(float);
    void                setMinValue( double d ) { setMinValue( (float)d ); }
    int                 minValue() const;
    float               minFValue() const;

    void                setMaxValue(int);
    void                setMaxValue(float);
    void                setMaxValue(double);
    int                 maxValue() const;
    float               maxFValue() const;

    void                setStep(int,bool snap_cur_value=false);
    void                setStep(float,bool snap_cur_value=false);
    void                setStep(double d,bool snap_cur_value=false );
    float               fstep() const;
    int                 step() const;

    void                stepBy( int nrsteps );

    uiString            prefix() const;
    void                setPrefix(const uiString&);
    uiString            suffix() const;
    void                setSuffix(const uiString&);
    void                doSnap( bool yn )               { dosnap_ = yn; }

    void                setKeyboardTracking(bool);
    bool                keyboardTracking() const;
    void                setFocusChangeTrigger(bool);
    bool                focusChangeTrigger() const;

    bool                handleLongTabletPress();
    void                popupVirtualKeyboard(int globalx=-1,int globaly=-1);

    Notifier<uiSpinBox> valueChanged;
    Notifier<uiSpinBox> valueChanging;

    void                notifyHandler(bool editingfinished);

    void                translateText();
private:

    float               oldvalue_;

    uiString            prefix_;
    uiString            suffix_;
    uiSpinBoxBody*      body_;
    uiSpinBoxBody&      mkbody(uiParent*, const char*);

    bool                dosnap_; 
    bool                focuschgtrigger_;
    void                snapToStep(CallBacker*);

public:
// deprecated, do not use
    /*mDeprecated*/ int getValue() const        { return getIntValue(); }
    /*mDeprecated*/ float       getfValue() const       { return getFValue(); }
    /*mDeprecated*/ double      getdValue() const       { return getDValue(); }
};


mExpClass(uiBase) uiLabeledSpinBox : public uiGroup
{ mODTextTranslationClass(uiLabeledSpinBox)
public:
                        uiLabeledSpinBox(uiParent*,const uiString&,
                                         int nrdecimals=0,const char* nm=0);

    uiSpinBox*          box()                   { return sb_; }
    const uiSpinBox*    box() const             { return sb_; }
    uiLabel*            label()                 { return lbl_; }

protected:

    uiSpinBox*          sb_;
    uiLabel*            lbl_;
};

#endif