/builddir/build/BUILD/libcomps-libcomps-0.1.8/libcomps/src/comps_doccategory.h File Reference

COMPS_DocCategory header file. More...

#include "comps_obj.h"
#include "comps_objdict.h"
#include "comps_objlist.h"
#include "comps_utils.h"
#include "comps_docgroupid.h"
#include "comps_validate.h"
#include "comps_radix.h"
#include "comps_log.h"
#include "comps_default.h"
#include <stddef.h>
#include <assert.h>

Go to the source code of this file.

Data Structures

struct  COMPS_DocCategory

Functions

 HEAD_COMPS_STRPROP_SETTER (category, COMPS_DocCategory, id) HEAD_COMPS_STRPROP_SETTER(category
name HEAD_COMPS_STRPROP_SETTER (category, COMPS_DocCategory, desc) HEAD_COMPS_NUMPROP_SETTER(category
 HEAD_COMPS_PROP_GETTER (category, COMPS_DocCategory, id) HEAD_COMPS_PROP_GETTER_OBJ(category
id HEAD_COMPS_PROP_GETTER (category, COMPS_DocCategory, name) HEAD_COMPS_PROP_GETTER(category
signed char comps_doccategory_cmp_u (COMPS_Object *cat1, COMPS_Object *cat2)
void comps_doccategory_add_groupid (COMPS_DocCategory *cat, COMPS_DocGroupId *gid)
COMPS_DocCategorycomps_doccategory_union (COMPS_DocCategory *c1, COMPS_DocCategory *c2)
COMPS_DocCategorycomps_doccategory_intersect (COMPS_DocCategory *c1, COMPS_DocCategory *c2)

Detailed Description

COMPS_DocCategory header file.

See also:
COMPS_DocCategory properties setters
COMPS_CategoryGroup properties getters
COMPS_DocCategory list setters
COMPS_DocCategory list getters

COMPS_DocCategory object support union operation. Read more about Libcomps objects unioning


Function Documentation

void comps_doccategory_add_groupid ( COMPS_DocCategory cat,
COMPS_DocGroupId gid 
)

add group_id to group_ids list in category

Parameters:
cat COMPS_DocCategory object
gid COMPS_DocGroupId object
Warning:
COMPS_DocGroupId reference counter isn't incremented
signed char comps_doccategory_cmp_u ( COMPS_Object cat1,
COMPS_Object cat2 
)

COMPS_DocCategory compare callback

Parameters:
cat1 COMPS_DocCategory object
cat2 COMPS_DocCategory object
Returns:
non-zero if objects are equal, otherwise 0
COMPS_DocCategory* comps_doccategory_intersect ( COMPS_DocCategory c1,
COMPS_DocCategory c2 
)

intersect two categories into one and return new COMPS_DocCategory object

Parameters:
c1 COMPS_DocCategory object
c2 COMPS_DocCategory object
Returns:
new COMPS_DocCategory object
COMPS_DocCategory* comps_doccategory_union ( COMPS_DocCategory c1,
COMPS_DocCategory c2 
)

union two categories into one and return new COMPS_DocCategory object

Parameters:
c1 COMPS_DocCategory object
c2 COMPS_DocCategory object
Returns:
new COMPS_DocCategory object
 All Data Structures Files Functions Variables Enumerations Defines

Generated on 1 Mar 2019 for libcomps by  doxygen 1.6.1