vos/gui/gui/input_numeric.hh

Go to the documentation of this file.

/* $Id: input_numeric.hh,v 1.6 2003/07/24 05:18:26 tetron Exp $ */

/*  Copyright (C) 2003 Reed Hedges <reed@interreality.org>

    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 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

*/

#ifndef _GUI_INPUT_NUM_HH_
#define _GUI_INPUT_NUM_HH_

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef VOSGUI_EXPORTS
#  define VOSGUI_API __declspec(dllexport)
# else
#  define VOSGUI_API __declspec(dllimport)
# endif
#else
# define VOSGUI_API
#endif

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>
#include <vos/gui/gui/input.hh>

namespace VOSGUI {

/** MetaObject for a numeric input object.
    Suggested representation is a text input with small increment/decrement
    controls.
    @bug Only floating point numbers are implemented yet.
    @todo General interface using template methods, for floating point, integer,
        and vector (of float or int) types.
*/

class VOSGUI_API NumericInput : public virtual Input {

public:

    /** Constructor */
    NumericInput(MetaObject* superobject);

    /** Destructor */
    virtual ~NumericInput();

    /** Return type string ("gui:widget.input") */
    virtual const string getType();

    /** Register Extenders */
    static void registerExtenders();

    /** @name Access Subobjects */
    //@{

    virtual void setValue(double v);
    virtual double getValue();

    /** Set the maximum and minimum values */
    virtual void setRange(double min, double max, PropertyAccessControl* ac =
        0);

    /** Get the maximum value */
    virtual double getMaximum();

    /** Get the datatype of gui:maximum property. */
    virtual string getMaximumDatatype();

    /** Set gui:maximum property. 
        @param value The new value
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used. 
    */
    virtual void setMaximum(const double value, PropertyAccessControl* ac = 
        0);

    /** Get the gui:maximum object. */
    virtual Property* getMaximumObject();

    /** Set the gui:maximum object.
        @param newobj   The new subobject. */
    virtual void setMaximumObject(Property* newobj);


    /** Get the minimum value */
    virtual double getMinimum();

    /** Get the datatype of gui:minimum property. */
    virtual string getMinimumDatatype();

    /** Set gui:minimum property. 
        @param value The new value
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used. 
    */
    virtual void setMinimum(const double value, PropertyAccessControl* ac = 
        0);

    /** Get the gui:minimum object. */
    virtual Property* getMinimumObject();

    /** Set the gui:minimum object.
        @param newobj   The new subobject. */
    virtual void setMinimumObject(Property* newobj);




    /** Get the increment value */
    virtual double getIncrement();

    /** Get the datatype of gui:increment property. */
    virtual string getIncrementDatatype();

    /** Set gui:increment property. 
        @param value The new value
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used. 
    */
    virtual void setIncrement(const double value, PropertyAccessControl* ac = 
        0);

    /** Get the gui:increment object. */
    virtual Property* getIncrementObject();

    /** Set the gui:increment object.
        @param newobj   The new subobject. */
    virtual void setIncrementObject(Property* newobj);
    //@}
};

/** Local version of NumericInput. */

class VOSGUI_API LocalNumericInput : public virtual NumericInput, public virtual LocalInput {

public:

    /** Constructor */
    LocalNumericInput(MetaObject* superobject);

    /** Destructor */
    ~LocalNumericInput();


    /** Static generator, for site factory. */
    static MetaObject* new_LocalNumericInput(MetaObject* superobject, const string& type);

};

/** Remote proxy for NumericInput */

class VOSGUI_API RemoteNumericInput : public virtual NumericInput, public virtual RemoteInput {

public:

    /** Constructor */
    RemoteNumericInput(MetaObject* superobject);

    /** Destructor */
    virtual ~RemoteNumericInput();

    /** Static generator, for factory. */
    static MetaObject* new_RemoteNumericInput(MetaObject* superobject, const string& type);

};


} // end of namespace VOSGUI
#endif // #ifndef _GUI_INPUT_NUM_HH_

---