\doxysection{comps\+\_\+doccategory.\+h File Reference}
\hypertarget{comps__doccategory_8h}{}\label{comps__doccategory_8h}\index{comps\_doccategory.h@{comps\_doccategory.h}}


\doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} header file.  


{\ttfamily \#include "{}comps\+\_\+obj.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+objdict.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+objlist.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+utils.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+docgroupid.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+validate.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+radix.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+log.\+h"{}}\newline
{\ttfamily \#include "{}comps\+\_\+default.\+h"{}}\newline
{\ttfamily \#include $<$stddef.\+h$>$}\newline
{\ttfamily \#include $<$assert.\+h$>$}\newline
\doxysubsubsection*{Data Structures}
\begin{DoxyCompactItemize}
\item 
struct \mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Functions}
\begin{DoxyCompactItemize}
\item 
void \mbox{\hyperlink{group__COMPS__DocCategory__prop__setters_ga219e951c229e9a40e45278995dda5e01}{comps\+\_\+doccategory\+\_\+set\+\_\+id}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category, char \texorpdfstring{$\ast$}{*}id, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocCategory__prop__setters_ga47d6629618885dee26f81266823e23c3}{comps\+\_\+doccategory\+\_\+set\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category, char \texorpdfstring{$\ast$}{*}name, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocCategory__prop__setters_ga2e563a9ef05e592b84b5ef005387ec11}{comps\+\_\+doccategory\+\_\+set\+\_\+desc}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category, char \texorpdfstring{$\ast$}{*}desc, char copy)
\item 
void \mbox{\hyperlink{group__COMPS__DocCategory__prop__setters_gac092c1ad631dededaf7c699bc937a7bf}{comps\+\_\+doccategory\+\_\+set\+\_\+display\+\_\+order}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category, int display\+\_\+order, bool unset)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocCategory__prop__getters_gab60c44444b5d4d1e66ab66b7b89e8bf0}{comps\+\_\+doccategory\+\_\+get\+\_\+id}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocCategory__prop__getters_ga377520ecb0f6a4f350d33f5107380f22}{comps\+\_\+doccategory\+\_\+get\+\_\+name}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocCategory__prop__getters_ga1c46a8044997f48d60e117fffd8624b2}{comps\+\_\+doccategory\+\_\+get\+\_\+desc}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category)
\item 
\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocCategory__prop__getters_ga0db45fcea847ed976e20abe91184dd28}{comps\+\_\+doccategory\+\_\+get\+\_\+display\+\_\+order}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}category)
\item 
\mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{group__COMPS__DocCategory__list__getters_ga981ef7cdfef27d302f79d6ff6f04eb12}{comps\+\_\+doccategory\+\_\+group\+\_\+ids}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}obj)
\item 
void \mbox{\hyperlink{group__COMPS__DocCategory__list__setters_ga0da1a02b7f02fc4fbcd6d6fb97c3dbfa}{comps\+\_\+doccategory\+\_\+set\+\_\+group\+\_\+ids}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}obj, \mbox{\hyperlink{structCOMPS__ObjList}{COMPS\+\_\+\+Obj\+List}} \texorpdfstring{$\ast$}{*}list)
\item 
signed char \mbox{\hyperlink{comps__doccategory_8h_a7868a20117eb11c8769cd05c0635bdf0}{comps\+\_\+doccategory\+\_\+cmp\+\_\+u}} (\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*}cat1, \mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*}cat2)
\item 
void \mbox{\hyperlink{comps__doccategory_8h_a1596649bc82d0a3faaef03d47eabc150}{comps\+\_\+doccategory\+\_\+add\+\_\+groupid}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}cat, \mbox{\hyperlink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id}} \texorpdfstring{$\ast$}{*}gid)
\item 
\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__doccategory_8h_a8b4f8faef75999be26f9c342df082f99}{comps\+\_\+doccategory\+\_\+union}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}c1, \mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}c2)
\item 
\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*} \mbox{\hyperlink{comps__doccategory_8h_af31d86385046314571982a7976faecbc}{comps\+\_\+doccategory\+\_\+intersect}} (\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}c1, \mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}c2)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} header file. 

\begin{DoxySeeAlso}{See also}
\doxylink{group__COMPS__DocCategory__prop__setters}{COMPS\+\_\+\+Doc\+Category properties setters} 

\doxylink{group__COMPS__DocCategory__prop__getters}{COMPS\+\_\+\+Category\+Group properties getters} 

\doxylink{group__COMPS__DocCategory__list__setters}{COMPS\+\_\+\+Doc\+Category list setters} 

\doxylink{group__COMPS__DocCategory__list__getters}{COMPS\+\_\+\+Doc\+Category list getters}
\end{DoxySeeAlso}
\doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object support union operation. Read more about \doxylink{}{Libcomps objects unioning } 

\label{doc-func-members}
\Hypertarget{comps__doccategory_8h_doc-func-members}
\doxysubsection{Function Documentation}
\Hypertarget{comps__doccategory_8h_a1596649bc82d0a3faaef03d47eabc150}\index{comps\_doccategory.h@{comps\_doccategory.h}!comps\_doccategory\_add\_groupid@{comps\_doccategory\_add\_groupid}}
\index{comps\_doccategory\_add\_groupid@{comps\_doccategory\_add\_groupid}!comps\_doccategory.h@{comps\_doccategory.h}}
\doxysubsubsection{\texorpdfstring{comps\_doccategory\_add\_groupid()}{comps\_doccategory\_add\_groupid()}}
{\footnotesize\ttfamily \label{comps__doccategory_8h_a1596649bc82d0a3faaef03d47eabc150} 
void comps\+\_\+doccategory\+\_\+add\+\_\+groupid (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}}]{cat}{, }\item[{\mbox{\hyperlink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id}} \texorpdfstring{$\ast$}{*}}]{gid}{}\end{DoxyParamCaption})}

add group\+\_\+id to group\+\_\+ids list in category 
\begin{DoxyParams}{Parameters}
{\em cat} & \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object \\
\hline
{\em gid} & \doxylink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id} object \\
\hline
\end{DoxyParams}
\begin{DoxyWarning}{Warning}
\doxylink{structCOMPS__DocGroupId}{COMPS\+\_\+\+Doc\+Group\+Id} reference counter isn\textquotesingle{}t incremented 
\end{DoxyWarning}
\Hypertarget{comps__doccategory_8h_a7868a20117eb11c8769cd05c0635bdf0}\index{comps\_doccategory.h@{comps\_doccategory.h}!comps\_doccategory\_cmp\_u@{comps\_doccategory\_cmp\_u}}
\index{comps\_doccategory\_cmp\_u@{comps\_doccategory\_cmp\_u}!comps\_doccategory.h@{comps\_doccategory.h}}
\doxysubsubsection{\texorpdfstring{comps\_doccategory\_cmp\_u()}{comps\_doccategory\_cmp\_u()}}
{\footnotesize\ttfamily \label{comps__doccategory_8h_a7868a20117eb11c8769cd05c0635bdf0} 
signed char comps\+\_\+doccategory\+\_\+cmp\+\_\+u (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*}}]{cat1}{, }\item[{\mbox{\hyperlink{structCOMPS__Object}{COMPS\+\_\+\+Object}} \texorpdfstring{$\ast$}{*}}]{cat2}{}\end{DoxyParamCaption})}

\doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} compare callback 
\begin{DoxyParams}{Parameters}
{\em cat1} & \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object \\
\hline
{\em cat2} & \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
non-\/zero if objects are equal, otherwise 0 
\end{DoxyReturn}
\Hypertarget{comps__doccategory_8h_af31d86385046314571982a7976faecbc}\index{comps\_doccategory.h@{comps\_doccategory.h}!comps\_doccategory\_intersect@{comps\_doccategory\_intersect}}
\index{comps\_doccategory\_intersect@{comps\_doccategory\_intersect}!comps\_doccategory.h@{comps\_doccategory.h}}
\doxysubsubsection{\texorpdfstring{comps\_doccategory\_intersect()}{comps\_doccategory\_intersect()}}
{\footnotesize\ttfamily \label{comps__doccategory_8h_af31d86385046314571982a7976faecbc} 
\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*} comps\+\_\+doccategory\+\_\+intersect (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}}]{c1}{, }\item[{\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}}]{c2}{}\end{DoxyParamCaption})}

intersect two categories into one and return new \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object 
\begin{DoxyParams}{Parameters}
{\em c1} & \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object \\
\hline
{\em c2} & \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
new \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object 
\end{DoxyReturn}
\Hypertarget{comps__doccategory_8h_a8b4f8faef75999be26f9c342df082f99}\index{comps\_doccategory.h@{comps\_doccategory.h}!comps\_doccategory\_union@{comps\_doccategory\_union}}
\index{comps\_doccategory\_union@{comps\_doccategory\_union}!comps\_doccategory.h@{comps\_doccategory.h}}
\doxysubsubsection{\texorpdfstring{comps\_doccategory\_union()}{comps\_doccategory\_union()}}
{\footnotesize\ttfamily \label{comps__doccategory_8h_a8b4f8faef75999be26f9c342df082f99} 
\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*} comps\+\_\+doccategory\+\_\+union (\begin{DoxyParamCaption}\item[{\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}}]{c1}{, }\item[{\mbox{\hyperlink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category}} \texorpdfstring{$\ast$}{*}}]{c2}{}\end{DoxyParamCaption})}

union two categories into one and return new \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object 
\begin{DoxyParams}{Parameters}
{\em c1} & \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object \\
\hline
{\em c2} & \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object \\
\hline
\end{DoxyParams}
\begin{DoxyReturn}{Returns}
new \doxylink{structCOMPS__DocCategory}{COMPS\+\_\+\+Doc\+Category} object 
\end{DoxyReturn}
