vos/gui/gui/input.hh

Go to the documentation of this file.

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

/** @file input.hh Defines MetaObject class for "gui:widget.input" object type (revision 0). */

/*  Copyright (C) 2002 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_HH_
#define _GUI_INPUT_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/widget.hh>

namespace VOSGUI {

/** MetaObject implementing Input Object Type.
    A text input widget. May be single or multiline.
*/

class VOSGUI_API Input : public virtual Widget {

public:

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

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

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

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


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

    /** Get the value of gui:target property (The contents/target of the control). */
    virtual string getTarget();

    /** Get the datatype of gui:target property. */
    virtual string getTargetDatatype();

    /** Set gui:target property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
        @param ac Property access control policy. If omitted, then &NoAccessControl::static_ will be used. 
    */
    virtual void setTarget(const string& value, const string& datatype = "?", PropertyAccessControl* ac = 0);

    /* TODO: perhaps customize this accessor for type property:property. */

    /** Get the gui:target object. */
    virtual Property* getTargetObj();

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

    /** Get the value of gui:multiline 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 getMultiline();

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

    /** Get the gui:multiline object. */
    virtual Property* getMultilineObj();

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

};

/** Local version of Input. */

class VOSGUI_API LocalInput : public virtual Input, public virtual LocalWidget {

public:

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

    /** Destructor */
    ~LocalInput();

    /** Initialize subobjects and access control. */
    virtual void initialize(PropertyAccessControl* ac);

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

};

/** Remote proxy for Input */

class VOSGUI_API RemoteInput : public virtual Input, public virtual RemoteWidget {

public:

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

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

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

};


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

---