template.h

linux下的电话本的最底层

/*	librecord2 - Record Object manipulation and storage library 2
 *
 *	Authors: YE Nan <[e-mail]> 
 *	
 *	This software and associated documentation files (the "Software") 
 *	are copyright (C) 2005 LiPS Linux Phone Standards Forum [FranceTelecom] 
 *	All Rights Reserved. 
 *
 *	A copyright license is hereby granted for redistribution and use of 
 *	the Software in source and binary forms, with or without modification, 
 *	provided that the following conditions are met: 
 *	- Redistributions of source code must retain the above copyright notice, 
 *	this copyright license and the following disclaimer. 
 *  - Redistributions in binary form must reproduce the above copyright 
 * 	notice, this copyright license and the following disclaimer in the 
 *	documentation and/or other materials provided with the distribution. 
 *	- Neither the name of LiPS  nor the names of its Members may be used 
 *	to endorse or promote products derived from the Software without 
 *	specific prior written permission. 
 *
 *	A patent license for any Necessary Claims owned by Members of LiPS Forum 
 *	to make, have made, use, import, offer to sell, lease and sell or otherwise 
 *	distribute any implementation compliant with the any specification adopted 
 *	by the LiPS Forumcan be obtained from the respective Members on reasonable 
 *	and non-discriminatory terms and conditions and under reciprocity, as 
 *	regulated in more detail in the Internal Policy of the LiPS Forum. 
 *
 *	THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER, ITS MEMBERS AND CONTRIBUTORS 
 *	"AS IS", AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
 *	THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 
 *	AND NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER, 
 *	ITS MEMBERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 *	SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 *	PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 
 *	OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 *	WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 *	ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *	POSSIBILITY OF SUCH DAMAGE. 
 */

#ifndef __RECORD_TEMPLATE_H
#define __RECORD_TEMPLATE_H

#include <glib.h>

#include <iterator.h>
#include <field-desc.h>

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

#define		FIELD_TEMPLATE_ID_INVALID				0
#define		FIELD_TEMPLATE_ID_START					1
#define		FIELD_TEMPLATE_ID_USER_DEFINE		10000

#define		FIELD_ID_INVALID								FIELD_TEMPLATE_ID_INVALID

typedef	struct	_FieldTemplate	FieldTemplate;

FieldTemplate *		field_template_new							(void);
FieldTemplate *		field_template_new_from_file		(const gchar					*fname);
void							field_template_free							(FieldTemplate				*templ);

gboolean					field_template_append_from_file	(FieldTemplate				*templ,
																									 const gchar					*fname);

void							field_template_add							(FieldTemplate				*templ,
																									 FieldDescriptor			*fdesc);
FieldDescriptor *	field_template_remove						(FieldTemplate				*templ,
																									 guint32							 ftid);

FieldDescriptor *	field_template_get							(const FieldTemplate	*templ,
																									 guint32							 ftid);
Iterator *				field_template_get_ftids				(const FieldTemplate	*templ);
gboolean					field_template_is_vaild_ftid		(const FieldTemplate	*templ,
																									 guint32							 ftid);

gint							field_template_size							(const FieldTemplate	*templ);

void							field_template_print						(const FieldTemplate	*templ);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif /* __RECORD_TEMPLATE_H */

/*
vi:ts=2:nowrap:ai:expandtab
*/