#ifndef _GLIBMM_PROPERTYPROXY_H #define _GLIBMM_PROPERTYPROXY_H /* propertyproxy.h * * Copyright 2002 The gtkmm Development Team * * 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, see . */ #include #include namespace Glib { /** A PropertyProxy can be used to get and set the value of an object's property. * There are usually also get and set methods on the class itself, which you might find more * convenient. * With the PropertyProxy, you may use either get_value() and set_value(), or operator=() and * operator PropertyType(), like so: * @code * int height = cellrenderer.property_height(); * cellrenderer.property_editable() = true; * @endcode * * You may also receive notification when a property's value changes, by connecting to * signal_changed(). */ template class PropertyProxy : public PropertyProxy_Base { public: using PropertyType = T; PropertyProxy(ObjectBase* obj, const char* name) : PropertyProxy_Base(obj, name) {} /** Set the value of this property. * @param data The new value for the property. */ void set_value(const PropertyType& data); /** Get the value of this property. * @result The current value of the property. */ PropertyType get_value() const; /** Set the value of this property back to its default value */ void reset_value() { reset_property_(); } PropertyProxy& operator=(const PropertyType& data) { this->set_value(data); return *this; } operator PropertyType() const { return this->get_value(); } }; /** See PropertyProxy(). * This property can be written, but not read, so there is no get_value() method. */ template class PropertyProxy_WriteOnly : public PropertyProxy_Base { public: using PropertyType = T; PropertyProxy_WriteOnly(ObjectBase* obj, const char* name) : PropertyProxy_Base(obj, name) {} /** Set the value of this property. * @param data The new value for the property. */ void set_value(const PropertyType& data); /** Set the value of this property back to its default value */ void reset_value() { reset_property_(); } PropertyProxy_WriteOnly& operator=(const PropertyType& data) { this->set_value(data); return *this; } }; /** See PropertyProxy(). * This property can be read, but not written, so there is no set_value() method. */ template class PropertyProxy_ReadOnly : public PropertyProxy_Base { public: using PropertyType = T; // obj is const, because this should be returned by const accessors. PropertyProxy_ReadOnly(const ObjectBase* obj, const char* name) : PropertyProxy_Base(const_cast(obj), name) { } /** Get the value of this property. * @result The current value of the property. */ PropertyType get_value() const; operator PropertyType() const { return this->get_value(); } }; /**** Template Implementation **********************************************/ #ifndef DOXYGEN_SHOULD_SKIP_THIS template void PropertyProxy::set_value(const T& data) { Glib::Value value; value.init(Glib::Value::value_type()); value.set(data); set_property_(value); } template T PropertyProxy::get_value() const { Glib::Value value; value.init(Glib::Value::value_type()); get_property_(value); return value.get(); } // We previously just static_cast<> PropertyProxy_WriteOnly<> to PropertyProxy<> to call its // set_value(), // to avoid code duplication. // But the AIX compiler does not like that hack. template void PropertyProxy_WriteOnly::set_value(const T& data) { Glib::Value value; value.init(Glib::Value::value_type()); value.set(data); set_property_(value); } // We previously just static_cast<> PropertyProxy_WriteOnly<> to PropertyProxy<> to call its // set_value(), // to avoid code duplication. // But the AIX compiler does not like that hack. template T PropertyProxy_ReadOnly::get_value() const { Glib::Value value; value.init(Glib::Value::value_type()); get_property_(value); return value.get(); } #endif /* DOXYGEN_SHOULD_SKIP_THIS */ } // namespace Glib #endif /* _GLIBMM_PROPERTYPROXY_H */