~vcs-imports/gconfmm/main

// -*- Mode: C++; c-basic-offset: 4  -*-

/* $Id: entry.hg,v 1.4 2002/12/10 23:26:01 murrayc Exp $ */

 

/* entry.hg

 * 

 * Copyright (C) 2000-2002 GConfmm Development Team

 *

 * This library is free software; you can redistribute it and/or

 * modify it under the terms of the GNU Library 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

 * Library General Public License for more details.

 *

 * You should have received a copy of the GNU Library General Public

 * License along with this library; if not, write to the Free

 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.

 */

 

#include <gconfmm/value.h>

#include <gconfmm/schema.h>

 

_DEFS(gconfmm,gconf)

 

extern "C" {

  typedef struct _GConfEntry GConfEntry;

}

 

namespace Gnome

{

 

namespace Conf

{

 

/** An Entry stores an entry from a GConf "directory", including a 

 * key-value pair, the name of the Schema applicable to this entry, 

 * whether the value is a default value, and whether GConf can write 

 * a new value at this key. The key should be an absolute key, not a relative key.

 */

class Entry

{

  _CLASS_OPAQUE_COPYABLE(Entry,GConfEntry,NONE,entry_copy,gconf_entry_free)

  _IGNORE(gconf_entry_free, gconf_entry_new, gconf_entry_new_nocopy)

  _IGNORE(gconf_entry_equal, gconf_entry_set_value_nocopy)

  _IGNORE(gconf_entry_steal_value)

 

public:

  /** Construct an Entry with the given @p key and @p value */

  Entry(const Glib::ustring& key, const Value& value);

 

  /** Set the Value of the entry. */

  _WRAP_METHOD(void set_value(const Value& val), gconf_entry_set_value)

 

  /** Set the Schema name of the entry. */

  _WRAP_METHOD(void set_schema_name(const Glib::ustring& val), gconf_entry_set_schema_name)

 

  /** Set whether the value has orginated from the default given in the Schema */

  _WRAP_METHOD(void set_is_default(bool is_default = true), gconf_entry_set_is_default)

 

  /** Set whether the given configuration key iw writeable. */

  _WRAP_METHOD(void set_is_writable(bool is_writable = true), gconf_entry_set_is_writable)

 

  /** Retrieve the value of the entry.

   * @return a copy the entry's value. */

  Value get_value() const;

  _IGNORE(gconf_entry_get_value)

 

  /** Retrieve the Schema name associated with the given entry */

  _WRAP_METHOD(Glib::ustring get_schema_name() const, gconf_entry_get_schema_name)

 

  /* Retrieve the configuration key this entry points to */

  _WRAP_METHOD(Glib::ustring get_key() const, gconf_entry_get_key)

 

  /* Retrieve wether this Entry contains the default value, as defined in the Schema. */

  _WRAP_METHOD(bool get_is_default() const, gconf_entry_get_is_default)

 

  /* Get the writeable status of the configuration key of this entry. */

  _WRAP_METHOD(bool get_is_writable() const, gconf_entry_get_is_writable)

 

private:

  static GConfEntry* entry_copy(const GConfEntry*);

};

 

} /* namespace Conf */

} /* namespace Gnome */

 

 

#ifndef DOXYGEN_SHOULD_SKIP_THIS

namespace Glib

{

namespace Container_Helpers

{

 

template<>

struct TypeTraits<Gnome::Conf::Entry> 

{

    typedef Gnome::Conf::Entry CppType;

    typedef const GConfEntry* CType;

    typedef GConfEntry* CTypeNonConst;

    

    static CType   to_c_type      (const CppType& item) { return item.gobj(); }

    static CType   to_c_type      (const CType&   item) { return item; }

    static CppType to_cpp_type    (const CType&   item) { return Gnome::Conf::Entry(const_cast<CTypeNonConst>(item)); }

    static void    release_c_type (const CType&)        {}

};

 

} // Namespace Container_Helpers

} // namespace Glib

#endif // DOXYGEN_SHOULD_SKIP_THIS