/* Copyright (C) 2010 Jonathon Jongsma * * 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, write to the Free * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ _CONFIGINCLUDE(giommconfig.h) #include #include #include #include _DEFS(giomm,gio) _PINCLUDE(glibmm/private/object_p.h) namespace Gio { _WRAP_ENUM(SettingsBindFlags, GSettingsBindFlags) /** A high-level API for application settings * * The Settings class provides a convenient API for storing and retrieving * application settings. * * @newin{2,28} */ class Settings : public Glib::Object { _CLASS_GOBJECT(Settings, GSettings, G_SETTINGS, Glib::Object, GObject) protected: _WRAP_CTOR(Settings(const Glib::ustring& schema_id), g_settings_new) _WRAP_CTOR(Settings(const Glib::ustring& schema_id, const Glib::ustring& path), g_settings_new_with_path) //TODO: Requires SettingsBackend: _WRAP_CTOR(Settings(const Glib::ustring& schema_id, const Glib::RefPtr& backend), g_settings_new_with_backend) //TODO: Requires SettingsBackend: _WRAP_CTOR(Settings(const Glib::ustring& schema_id, const Glib::RefPtr& backend, const Glib::ustring& path), g_settings_new_with_backend_and_path) public: _WRAP_CREATE(const Glib::ustring& schema_id) _WRAP_CREATE(const Glib::ustring& schema_id, const Glib::ustring& path) //TODO: Requires SettingsBackend: _WRAP_CREATE(const Glib::ustring& schema_id, const Glib::RefPtr& backend) //TODO: Requires SettingsBackend: _WRAP_CREATE(const Glib::ustring& schema_id, const Glib::RefPtr& backend, const Glib::ustring& path) //TODO: Rename these to get/set_*_value_variant() and add templated get/set_*_value() methods as elsewhere? _WRAP_METHOD(bool set_value(const Glib::ustring& key, const Glib::VariantBase& value), g_settings_set_value) /** Gets the value that is stored in the settings for a @a key. * * It is a programmer error to give a @a key that isn't contained in the * schema for the settings. * * @param key The key to get the value for. * @param value A Variant of the expected type. * * @newin{2,28} */ void get_value(const Glib::ustring& key, Glib::VariantBase& value) const; _IGNORE(g_settings_get_value) //TODO: We've added a bool return to handle the NULL return value case, //but maybe other get_value() methods can return NULLs too. /** Checks the "user value" of a @a key, if there is one. * * The user value of a key is the last value that was set by the user. * * After calling reset() this function should always return * false (assuming something is not wrong with the system * configuration). * * It is possible that get_value() will return a different * value than this method. This can happen in the case that the user * set a value for a key that was subsequently locked down by the system * administrator -- this method will return the user's old value. * * This method may be useful for adding a "reset" option to a UI or * for providing indication that a particular value has been changed. * * It is a programmer error to give a @a key that isn't contained in the * schema for the settings. * * @param key The key to get the user value for. * @param value A Variant of the expected type. * @result true if a user value was found. * * @newin{2,40} */ bool get_user_value(const Glib::ustring& key, Glib::VariantBase& value) const; _IGNORE(g_settings_get_user_value) /** Gets the "default value" of a key. * * This is the value that would be read if reset() were to be * called on the key. * * Note that this may be a different value than returned by * get_default_value() if the system administrator * has provided a default value. * * Comparing the return values of get_default_value() and * value() is not sufficient for determining if a value * has been set because the user may have explicitly set the value to * something that happens to be equal to the default. The difference * here is that if the default changes in the future, the user's key * will still be set. * * This method may be useful for adding an indication to a UI of what * the default value was before the user set it. * * It is a programmer error to give a @a key that isn't contained in the * schema for the settings. * * @param key The key to get the default value for. * @param value A Variant of the expected type. * * @newin{2,40} */ void get_default_value(const Glib::ustring& key, Glib::VariantBase& value) const; _IGNORE(g_settings_get_default_value) _WRAP_METHOD(int get_int(const Glib::ustring& key) const, g_settings_get_int) _WRAP_METHOD(void set_int(const Glib::ustring& key, int value), g_settings_set_int) _WRAP_METHOD(guint get_uint(const Glib::ustring& key) const, g_settings_get_uint) _WRAP_METHOD(void set_uiint(const Glib::ustring& key, guint value), g_settings_set_uint) _WRAP_METHOD(bool get_boolean(const Glib::ustring& key) const, g_settings_get_boolean) _WRAP_METHOD(void set_boolean(const Glib::ustring& key, bool value), g_settings_set_boolean) _WRAP_METHOD(Glib::ustring get_string(const Glib::ustring& key) const, g_settings_get_string) _WRAP_METHOD(void set_string(const Glib::ustring& key, const Glib::ustring& value), g_settings_set_string) _WRAP_METHOD(double get_double(const Glib::ustring& key) const, g_settings_get_double) _WRAP_METHOD(void set_double(const Glib::ustring& key, double value), g_settings_set_double) #m4 _CONVERSION(`gchar**',`Glib::StringArrayHandle',`Glib::StringArrayHandle($3, Glib::OWNERSHIP_DEEP)') _WRAP_METHOD(Glib::StringArrayHandle get_string_array(const Glib::ustring& key) const, g_settings_get_strv) _WRAP_METHOD(bool set_string_array(const Glib::ustring& key, const Glib::StringArrayHandle& value), g_settings_set_strv) _WRAP_METHOD(int get_enum(const Glib::ustring& key) const, g_settings_get_enum ) _WRAP_METHOD(bool get_enum(const Glib::ustring& key, int value), g_settings_set_enum) _WRAP_METHOD(guint get_flags(const Glib::ustring& key) const, g_settings_get_flags) _WRAP_METHOD(bool get_flags(const Glib::ustring& key, guint value), g_settings_set_flags) // Ignore varargs functions. _IGNORE(g_settings_get, g_settings_set) _WRAP_METHOD(Glib::RefPtr get_child(const Glib::ustring& name), g_settings_get_child) _WRAP_METHOD(Glib::RefPtr get_child(const Glib::ustring& name) const, g_settings_get_child, constversion) _WRAP_METHOD(bool is_writable(const Glib::ustring& name) const, g_settings_is_writable) _WRAP_METHOD(void delay(), g_settings_delay) _WRAP_METHOD(void apply(), g_settings_apply) _WRAP_METHOD(void revert(), g_settings_revert) _WRAP_METHOD(bool get_has_unapplied() const, g_settings_get_has_unapplied) _WRAP_METHOD(void reset(const Glib::ustring& key), g_settings_reset) _DEPRECATE_IFDEF_START //We must hand-code this because gmmproc is confused by the static keyword with the vector. //#m4 _CONVERSION(`const gchar*const*',`std::vector',`Glib::ArrayHandler::array_to_vector($3, Glib::OWNERSHIP_NONE)') _WRAP_METHOD_DOCS_ONLY(g_settings_list_schemas) static std::vector list_schemas(); _IGNORE(g_settings_list_schemas) _DEPRECATE_IFDEF_END #m4 _CONVERSION(`gchar**',`std::vector',`Glib::ArrayHandler::array_to_vector($3, Glib::OWNERSHIP_DEEP)') _WRAP_METHOD(std::vector list_children() const, g_settings_list_children) _WRAP_METHOD(std::vector list_keys() const, g_settings_list_keys, deprecated "Use SettingsSchema::list_kes().") _IGNORE(g_settings_get_range, g_settings_list_relocatable_schemas) // deprecated _WRAP_METHOD(bool range_check(const Glib::ustring& key, const Glib::VariantBase& value) const, g_settings_range_check, deprecated "Use g_settings_schema_key_range_check() instead.") //TODO: Wrap GSettingsSchema #m4 _CONVERSION(`Glib::ObjectBase*',`gpointer',(gpointer)$3->gobj()) _WRAP_METHOD(void bind(const Glib::ustring& key, Glib::ObjectBase* object, const Glib::ustring& property, SettingsBindFlags flags=SETTINGS_BIND_DEFAULT), g_settings_bind) void bind(const Glib::ustring& key, const Glib::PropertyProxy_Base& property_proxy, SettingsBindFlags flags=SETTINGS_BIND_DEFAULT); // TODO: implement bind_with_mapping _WRAP_METHOD(void bind_writable(const Glib::ustring& key, Glib::ObjectBase* object, const Glib::ustring& property, bool inverted=false), g_settings_bind_writable) void bind_writable(const Glib::ustring& key, const Glib::PropertyProxy_Base& property_proxy, bool inverted=false); // TODO: unbind is not actually a class method _WRAP_METHOD(Glib::RefPtr create_action(const Glib::ustring& key), g_settings_create_action) //TODO?: _WRAP_PROPERTY("backend", Glib::RefPtr) _WRAP_PROPERTY("delay-apply", bool) _WRAP_PROPERTY("has-unapplied", bool) _WRAP_PROPERTY("path", std::string) _WRAP_PROPERTY("schema", Glib::ustring, deprecated "Use the 'schema-id' property instead. In a future version, this property may instead refer to a SettingsSchema.") _WRAP_PROPERTY("schema-id", Glib::ustring) //TODO: _WRAP_PROPERTY("settings-schema", Glib::RefPtr) //TODO?: _WRAP_SIGNAL(bool change_event(const Glib::ArrayHandle& keys, int n_keys), "change-event") //TODO: Remove two_signal_methods when we can break ABI. #m4 _CONVERSION(`const char*',`const Glib::ustring&',__GCHARP_TO_USTRING) _WRAP_SIGNAL(void changed(const Glib::ustring& key), "changed", detail_name key, two_signal_methods) _WRAP_SIGNAL(bool writable_change_event(guint key), "writable-change-event") _WRAP_SIGNAL(void writable_changed(const Glib::ustring& key), writable_changed) }; } // namespace Gio