FXRealSpinDial.h

Go to the documentation of this file.

/********************************************************************************
*                                                                               *
*             R e a l - V a l u e d   S p i n n e r  W i d g e t                *
*                                                                               *
*********************************************************************************
* Copyright (C)      2003 by Bill Baxter.    All Rights Reserved.               *
*********************************************************************************
* Based on FXSpinner.cpp                                                        *
* Copyright (C) 1998,2003 by Lyle Johnson.   All Rights Reserved.               *
*********************************************************************************
* This library is free software; you can redistribute it and/or                 *
* modify it under the terms of the GNU Lesser General Public                    *
* License as published by the Free Software Foundation; either                  *
* version 2.1 of the License, or (at your option) any later version.            *
*                                                                               *
* 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             *
* Lesser General Public License for more details.                               *
*                                                                               *
* You should have received a copy of the GNU Lesser General Public              *
* License along with this library; if not, write to the Free Software           *
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA.    *
*********************************************************************************
* $Id: FXRealSpinDial.h 8236 2010-02-10 11:16:41Z behrisch $                     *
********************************************************************************/
#ifndef FXREALSPINDIAL_H
#define FXREALSPINDIAL_H


// ===========================================================================
// included modules
// ===========================================================================
#ifdef _MSC_VER
#include <windows_config.h>
#else
#include <config.h>
#endif

#ifndef FXPACKER_H
#include "FXPacker.h"
#endif

namespace FX {


// Spinner Options
enum {
    SPINDIAL_CYCLIC    =  SPIN_CYCLIC,   // Cyclic spinner
    SPINDIAL_NOTEXT    =  SPIN_NOTEXT,   // No text visible
    SPINDIAL_NOMAX     =  SPIN_NOMAX,    // Spin all the way up to infinity
    SPINDIAL_NOMIN     =  SPIN_NOMIN,    // Spin all the way down to -infinity
    SPINDIAL_LOG       =  0x00200000,    // Logarithmic rather than linear
    SPINDIAL_NODIAL    =  0x00400000,    // No dial visible
    SPINDIAL_NOBUTTONS =  0x00800000,    // No spinbuttons visible
    SPINDIAL_NORMAL    =  SPINDIAL_NOBUTTONS// Normal, non-cyclic, no buttons
};

enum {
    SPINDIAL_INC_NORMAL=0,
    SPINDIAL_INC_FINE=-1,
    SPINDIAL_INC_COARSE=1
};

class FXRealSpinDialText;
class FXDial;


class /*FXAPI*/ FXRealSpinDial : public FXPacker {
    FXDECLARE(FXRealSpinDial)
protected:
    FXRealSpinDialText *textField; // Text field
    FXArrowButton *upButton;          // The up button
    FXArrowButton *downButton;        // The down button
    FXDial        *dial;              // The up/down dial
    FXdouble       range[2];          // Reported data range
    FXdouble       incr[3];           // Increments (fine,normal,coarse)
    FXdouble       pos;               // Current position
    FXint          dialpos;           // Current position of dial
    FXint          keystate;          // Current key modifiers
protected:
    FXRealSpinDial();
private:
    FXRealSpinDial(const FXRealSpinDial&);
    FXRealSpinDial& operator=(const FXRealSpinDial&);
public:
    long onUpdDial(FXObject*,FXSelector,void*);
    long onChgDial(FXObject*,FXSelector,void*);
    long onCmdDial(FXObject*,FXSelector,void*);
    long onUpdIncrement(FXObject*,FXSelector,void*);
    long onCmdIncrement(FXObject*,FXSelector,void*);
    long onUpdDecrement(FXObject*,FXSelector,void*);
    long onCmdDecrement(FXObject*,FXSelector,void*);
    long onMouseWheel(FXObject*,FXSelector,void*);
    long onUpdEntry(FXObject*,FXSelector,void*);
    long onCmdEntry(FXObject*,FXSelector,void*);
    long onChgEntry(FXObject*,FXSelector,void*);
    long onKeyPress(FXObject*,FXSelector,void*);
    long onKeyRelease(FXObject*,FXSelector,void*);
    long onCmdSetValue(FXObject*,FXSelector,void*);
    long onCmdSetIntValue(FXObject*,FXSelector,void*);
    long onCmdGetIntValue(FXObject*,FXSelector,void*);
    long onCmdSetIntRange(FXObject*,FXSelector,void*);
    long onCmdGetIntRange(FXObject*,FXSelector,void*);
    long onCmdSetRealValue(FXObject*,FXSelector,void*);
    long onCmdGetRealValue(FXObject*,FXSelector,void*);
    long onCmdSetRealRange(FXObject*,FXSelector,void*);
    long onCmdGetRealRange(FXObject*,FXSelector,void*);
    long onMotion(FXObject*,FXSelector,void*);
    //long onDefault(FXObject*,FXSelector,void*);
public:
    enum {
        ID_DIAL=FXPacker::ID_LAST,
        ID_INCREMENT,
        ID_DECREMENT,
        ID_ENTRY,
        ID_LAST
    };
public:

    FXRealSpinDial(FXComposite *p,FXint cols,FXObject *tgt=NULL,
                   FXSelector sel=0,FXuint opts=SPINDIAL_NORMAL,
                   FXint x=0,FXint y=0,FXint w=0,FXint h=0,
                   FXint pl=DEFAULT_PAD,FXint pr=DEFAULT_PAD,FXint pt=DEFAULT_PAD,FXint pb=DEFAULT_PAD
                  );

    virtual void create();

    virtual void layout();

    virtual void disable();

    virtual void enable();

    virtual FXint getDefaultWidth();

    virtual FXint getDefaultHeight();

    void increment(FXint incMode=SPINDIAL_INC_NORMAL);

    void decrement(FXint incMode=SPINDIAL_INC_NORMAL);

    FXbool isCyclic() const;

    void setCyclic(FXbool cyclic);

    FXbool isTextVisible() const;

    void setTextVisible(FXbool shown);

    FXbool isDialVisible() const;

    void setDialVisible(FXbool shown);

    virtual void setValue(FXdouble value);

    FXdouble getValue() const {
        return pos;
    }

    void setRange(FXdouble lo,FXdouble hi);

    void getRange(FXdouble& lo,FXdouble& hi) const {
        lo=range[0];
        hi=range[1];
    }

    void setIncrement(FXdouble increment);
    void setIncrements(FXdouble fine, FXdouble norm, FXdouble coarse);
    void setFineIncrement(FXdouble increment);
    void setCoarseIncrement(FXdouble increment);

    FXdouble getIncrement() const {
        return incr[1];
    }
    FXdouble getFineIncrement() const {
        return incr[0];
    }
    FXdouble getCoarseIncrement() const {
        return incr[-1];
    }

    void setFont(FXFont *fnt);

    FXFont *getFont() const;

    void setHelpText(const FXString& text);

    FXString getHelpText() const;

    void setTipText(const FXString& text);

    FXString getTipText() const;

    void setSpinnerStyle(FXuint style);

    FXuint getSpinnerStyle() const;

    void setEditable(FXbool edit=TRUE);

    FXbool isEditable() const;

    void setDialColor(FXColor clr);

    FXColor getDialColor() const;

    void setUpArrowColor(FXColor clr);

    FXColor getUpArrowColor() const;

    void setDownArrowColor(FXColor clr);

    FXColor getDownArrowColor() const;

    void setTextColor(FXColor clr);

    FXColor getTextColor() const;

    void setSelBackColor(FXColor clr);

    FXColor getSelBackColor() const;

    void setSelTextColor(FXColor clr);

    FXColor getSelTextColor() const;

    void setCursorColor(FXColor clr);

    FXColor getCursorColor() const;

    virtual void save(FXStream& store) const;

    virtual void load(FXStream& store);

    void setNumberFormat(FXint prec, FXbool bExp=FALSE);

    FXint getNumberFormatPrecision() const;

    FXbool getNumberFormatExponent() const;

    void setFormatString(FXchar *fmt);

    FXString getNumberFormatString() const;

    void selectAll();

    const FXDial &getDial() const;

    virtual ~FXRealSpinDial();
};

}


#endif //  FXREALSPINDIAL_H