vos/gui/gui/select_value.hh

Go to the documentation of this file.

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

    Copyright (C) 2003 Reed Hedges <reed@zerohour.net>

    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_SELECT_VALUE_HH_
#define _GUI_SELECT_VALUE_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/select.hh>

namespace VOSGUI {

/** MetaObject implementing SelectValue Object Type. 
 *  This control presents a choice of values for a property, one of which
 *  may be selected using a radio button or popup menu.
 *
 * @todo add property specifying order to try determining what text to display
 *  in value (e.g. "subobj(misc:title),property-contents,context-name"). or use
 *  a value of properties.  Or change the choices group to contain small structure 
 *  objects (linking to label and the actual object)
 *
 *  @warning You must call initialize() for this object to work correctly.
*/
class VOSGUI_API SelectValue : public virtual Select
{

protected:
    vRef<Vobject>   choices;
    vRef<Property>  selected;


public:

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

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

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

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

    /** Get the property containing the value  */
    //@{
    Property* getSelectedObj();
    inline Property* getTargetObj() {
        return getSelectedObj();
    }
    //@}

    /** Set the property containing the chosen value */
    //@{
    void setSelectedObj(Property* p);
    inline void setTargetObj(Property* p) {
        setSelectedObj(p);
    }
    //@}



    /** Get the selected value */
    std::string getValue();

    /** Get the selected value */
    void getValue(std::string& v);

    /** Set the selected value */
    void setValue(const std::string& v);

    /** Add a value choice */
    void add(const std::string& label, Property* property);

    /** Add a value choice */
    void add(Property* property);

    /** Add a value choice */
    void add(const std::string& label, const std::string& value,
            PropertyAccessControl* defaultValueAC = &NoPropertyAccessControl::static_);


    /** Add a value choice */
    void add(const std::string& value,
            PropertyAccessControl* defaultValueAC = &NoPropertyAccessControl::static_);

    /** Remove (the first occurance of) an object from the value */
    void remove(const std::string& value) throw (NoSuchObjectError);

    /** Set and get the style of the object */
    //@{
    void setStyle(const std::string& style, PropertyAccessControl* pac = 0);
    void setPopup(PropertyAccessControl* pac = 0);
    void setRadio(PropertyAccessControl* pac = 0);
    std::string getStyle();
    Property* getStyleObj();
    //@}

    /** If style is "radio", you can specify the orientation and maximum size
        of the radio box */
    //@{
    void setRadioOrientation(const std::string& ori, PropertyAccessControl* pac = 0);
    std::string getRadioOrientation();
    void setRadioSize(int n, PropertyAccessControl* pac = 0);
    int getRadioSize();
    //@}

    /** Return the Vobject containing choices objects */
    Vobject* getChoicesObj();

    /** Set the choices container object. Don't call after
        initialize() or it won't work right. */
    void setChoicesObj(Vobject* obj);

    /** Find/create certain subobjects. 
     * You MUST call this for things to work correctly. */
    virtual void initialize();

};



/** Local version of SelectValue. 
 * @warning You must call initialize() for this object to work properly. */
class VOSGUI_API LocalSelectValue : public virtual SelectValue, public virtual LocalSelect
{

public:

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

    /** Destructor */
    ~LocalSelectValue();

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

    /** Creates required subobjects, and adds DoNothingListener to them
     * (this makes future operations faster). 
     * You MUST call this function (or setSelectedObj, setChoicesObj and
     * setMultiple) for things to work correctly.
     * @bug always sets the property access control on the "multiple" property
     *       to NoPropertyAccessControl::static_ 
     */
    virtual void initialize();


};


/** Remote version of SelectValue. */
class VOSGUI_API RemoteSelectValue : public virtual SelectValue, public virtual RemoteSelect
{
public:

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

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

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


};

} //namespace VOSGUI 

#endif // #ifdef _GUI_SELECT_VALUE_HH_

---