vos/gui/gui/input_numeric_slider.hh

Go to the documentation of this file.

/* $Id: input_numeric_slider.hh,v 1.7 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_NUMSL_HH_
#define _GUI_INPUT_NUMSL_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_numeric.hh>

namespace VOSGUI {

/** MetaObject for a "sliding" numeric input.  */

class VOSGUI_API SliderNumericInput : public virtual NumericInput {

public:

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

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

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

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

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

    /** Get the value of gui:orientation property ("horizontal" or "vertical" */
    virtual string getOrientation();

    /** Set gui:orientation property. 
        @param value The new value, muste be either "horizontal" or "vertical" 
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used. 
    */
    virtual void setOrientation(const string& value, PropertyAccessControl* ac = 0);

    /** Get the gui:orientation object. */
    virtual Property* getOrientationObject();

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

    /** Get the value of gui:show-labels property (If the value of this property is "yes", then the
        input widget may be more than one line tall, and the user
        may input more than one line (seperated by a newline
        charater, ASCII value 10). If absent, a default value of
        "no" should be used.
    ). */
    virtual bool getShowLabels();

    /** Set gui:show-labels property. 
        @param value The new value
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used. 
    */
    virtual void setShowLabels(bool value = true, PropertyAccessControl* ac = 0);

    /** Get the gui:show-labels object. */
    virtual Property* getShowLabelsObject();

    /** Set the gui:show-labels object.
        @param newobj   The new subobject. */
    virtual void setShowLabelsObject(Property* newobj);

};

/** Local version of SliderNumericInput. */

class VOSGUI_API LocalSliderNumericInput : public virtual SliderNumericInput, public virtual LocalNumericInput {

public:

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

    /** Destructor */
    ~LocalSliderNumericInput();

    /** Initialize required subproperties with given access control. */
    virtual void initialize(PropertyAccessControl* ac);


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

};

/** Remote proxy for SliderNumericInput */

class VOSGUI_API RemoteSliderNumericInput : public virtual SliderNumericInput, public virtual RemoteNumericInput {

public:

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

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

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

};


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

---