gconfmm 2.28.3
Gnome::Conf::Entry Class Reference

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. More...

#include <gconfmm/entry.h>

Collaboration diagram for Gnome::Conf::Entry:

Public Member Functions

 Entry ()
 
 Entry (GConfEntry* castitem, bool make_a_copy=false)
 
 Entry (const Entry& src)
 
Entryoperator= (const Entry& src)
 
 ~Entry ()
 
GConfEntry* gobj ()
 
const GConfEntry* gobj () const
 
GConfEntry* gobj_copy () const
 Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.
 
 Entry (const Glib::ustring& key, const Value& value)
 Construct an Entry with the given key and value.
 
void set_value (const Value& val)
 Set the Value of the entry.
 
void set_schema_name (const Glib::ustring& val)
 Set the Schema name of the entry.
 
void set_is_default (bool is_default=true)
 Set whether the value has orginated from the default given in the Schema.
 
void set_is_writable (bool is_writable=true)
 Set whether the given configuration key iw writeable.
 
Value get_value () const
 Retrieve the value of the entry.
 
Glib::ustring get_schema_name () const
 Retrieve the Schema name associated with the given entry.
 
Glib::ustring get_key () const
 
bool get_is_default () const
 
bool get_is_writable () const
 

Protected Attributes

GConfEntry* gobject_
 

Related Symbols

(Note that these are not member symbols.)

Gnome::Conf::Entry wrap (GConfEntry* object, bool take_copy=false)
 A Glib::wrap() method for this object.
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ Entry() [1/4]

Gnome::Conf::Entry::Entry ( )

◆ Entry() [2/4]

Gnome::Conf::Entry::Entry ( GConfEntry * castitem,
bool make_a_copy = false )
explicit

◆ Entry() [3/4]

Gnome::Conf::Entry::Entry ( const Entry& src)

◆ ~Entry()

Gnome::Conf::Entry::~Entry ( )

◆ Entry() [4/4]

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

Construct an Entry with the given key and value.

Member Function Documentation

◆ get_is_default()

bool Gnome::Conf::Entry::get_is_default ( ) const

◆ get_is_writable()

bool Gnome::Conf::Entry::get_is_writable ( ) const

◆ get_key()

Glib::ustring Gnome::Conf::Entry::get_key ( ) const

◆ get_schema_name()

Glib::ustring Gnome::Conf::Entry::get_schema_name ( ) const

Retrieve the Schema name associated with the given entry.

◆ get_value()

Value Gnome::Conf::Entry::get_value ( ) const

Retrieve the value of the entry.

Returns
a copy the entry's value.

◆ gobj() [1/2]

GConfEntry * Gnome::Conf::Entry::gobj ( )
inline

◆ gobj() [2/2]

const GConfEntry * Gnome::Conf::Entry::gobj ( ) const
inline

◆ gobj_copy()

GConfEntry * Gnome::Conf::Entry::gobj_copy ( ) const

Provides access to the underlying C instance. The caller is responsible for freeing it. Use when directly setting fields in structs.

◆ operator=()

Entry& Gnome::Conf::Entry::operator= ( const Entry& src)

◆ set_is_default()

void Gnome::Conf::Entry::set_is_default ( bool is_default = true)

Set whether the value has orginated from the default given in the Schema.

◆ set_is_writable()

void Gnome::Conf::Entry::set_is_writable ( bool is_writable = true)

Set whether the given configuration key iw writeable.

◆ set_schema_name()

void Gnome::Conf::Entry::set_schema_name ( const Glib::ustring & val)

Set the Schema name of the entry.

◆ set_value()

void Gnome::Conf::Entry::set_value ( const Value& val)

Set the Value of the entry.

Friends And Related Symbol Documentation

◆ wrap()

Gnome::Conf::Entry wrap ( GConfEntry * object,
bool take_copy = false )
related

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns
A C++ instance that wraps this C instance.

Member Data Documentation

◆ gobject_

GConfEntry* Gnome::Conf::Entry::gobject_
protected

The documentation for this class was generated from the following file: