.. _group__a3d__markup__rtf:

###########
RTF parsing
###########

Set of functions used to parse RTF strings.

RTF strings can be present in :c:struct:`~A3DMDFCFDraftingRowData`\ , :c:struct:`~A3DMarkupGDTData`\ , :c:struct:`~A3DMarkupRichTextData`


Sample code
===========

.. code-block:: cpp

   /* code to get each independent field of RTF string */
   /* pRTF_UTF8 is an RTF string* */
   A3DVoid* pRTF = NULL;
   if(A3DMkpRTFInit(pRTF_UTF8, pRTF) == A3D_SUCCESS)
   {
       A3DRTFFieldData sRTFFieldData = A3D_MAKE_DATA(A3DRTFFieldData);
   
       while(A3DMkpRTFGetField(pRTF, &sRTFFieldData) == A3D_SUCCESS)
       {
           // .......
           // TODO: process sRTFFieldData
           // .......
   
           A3DMkpRTFGetField(A3D_NULL_HANDLE, &sRTFFieldData)      // memory cleanup of the sRTFFieldData structure
       }
   
       A3DMkpRTFDelete(pRTF);
   }


.. rst-class:: kind-group kind-enumeration

.. rubric:: Enumerations
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:enum:`~A3DEMarkupSymbol`

.. rst-class:: kind-group kind-enumerator

.. rubric:: Enumerators
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:enumerator:`~kA3DSymbol_1STANG`
* :c:enumerator:`~kA3DSymbol_3RDANG`
* :c:enumerator:`~kA3DSymbol_Angularity`
* :c:enumerator:`~kA3DSymbol_BETWEEN`
* :c:enumerator:`~kA3DSymbol_between`
* :c:enumerator:`~kA3DSymbol_BREAK15`
* :c:enumerator:`~kA3DSymbol_BREAK30`
* :c:enumerator:`~kA3DSymbol_CA`
* :c:enumerator:`~kA3DSymbol_CC`
* :c:enumerator:`~kA3DSymbol_Centerline`
* :c:enumerator:`~kA3DSymbol_CF`
* :c:enumerator:`~kA3DSymbol_CircledR`
* :c:enumerator:`~kA3DSymbol_CircledU`
* :c:enumerator:`~kA3DSymbol_Circularity`
* :c:enumerator:`~kA3DSymbol_Concentricity`
* :c:enumerator:`~kA3DSymbol_ConicalTaper`
* :c:enumerator:`~kA3DSymbol_Counterbore`
* :c:enumerator:`~kA3DSymbol_Countersink`
* :c:enumerator:`~kA3DSymbol_CV`
* :c:enumerator:`~kA3DSymbol_Cylindricity`
* :c:enumerator:`~kA3DSymbol_DATUM1`
* :c:enumerator:`~kA3DSymbol_DATUM2`
* :c:enumerator:`~kA3DSymbol_Degre`
* :c:enumerator:`~kA3DSymbol_Depth`
* :c:enumerator:`~kA3DSymbol_Diameter`
* :c:enumerator:`~kA3DSymbol_Encompassing`
* :c:enumerator:`~kA3DSymbol_FIRSTANGLE`
* :c:enumerator:`~kA3DSymbol_FIRSTANGLECENTERLINES`
* :c:enumerator:`~kA3DSymbol_Flatness`
* :c:enumerator:`~kA3DSymbol_FreeState`
* :c:enumerator:`~kA3DSymbol_FROMTO`
* :c:enumerator:`~kA3DSymbol_GG`
* :c:enumerator:`~kA3DSymbol_GN`
* :c:enumerator:`~kA3DSymbol_GreaterOrEqual`
* :c:enumerator:`~kA3DSymbol_GX`
* :c:enumerator:`~kA3DSymbol_LeastMaterial`
* :c:enumerator:`~kA3DSymbol_LineProfile`
* :c:enumerator:`~kA3DSymbol_LP`
* :c:enumerator:`~kA3DSymbol_LS`
* :c:enumerator:`~kA3DSymbol_MaximumMaterial`
* :c:enumerator:`~kA3DSymbol_Micron`
* :c:enumerator:`~kA3DSymbol_MINUS`
* :c:enumerator:`~kA3DSymbol_MoreOrLess`
* :c:enumerator:`~kA3DSymbol_Ohm`
* :c:enumerator:`~kA3DSymbol_Omega`
* :c:enumerator:`~kA3DSymbol_ORIENTATIONCONSTRAINTONLY`
* :c:enumerator:`~kA3DSymbol_Parallelism`
* :c:enumerator:`~kA3DSymbol_Perpendicularity`
* :c:enumerator:`~kA3DSymbol_PLINE`
* :c:enumerator:`~kA3DSymbol_PLUS`
* :c:enumerator:`~kA3DSymbol_Position`
* :c:enumerator:`~kA3DSymbol_ProjectedTolerance`
* :c:enumerator:`~kA3DSymbol_RegardlessOfFeatureSize`
* :c:enumerator:`~kA3DSymbol_RightwardArrow`
* :c:enumerator:`~kA3DSymbol_Runout`
* :c:enumerator:`~kA3DSymbol_SA`
* :c:enumerator:`~kA3DSymbol_SD`
* :c:enumerator:`~kA3DSymbol_Slope`
* :c:enumerator:`~kA3DSymbol_SM`
* :c:enumerator:`~kA3DSymbol_SmallerOrEqual`
* :c:enumerator:`~kA3DSymbol_SN`
* :c:enumerator:`~kA3DSymbol_Square`
* :c:enumerator:`~kA3DSymbol_SR`
* :c:enumerator:`~kA3DSymbol_Statistical`
* :c:enumerator:`~kA3DSymbol_Straightness`
* :c:enumerator:`~kA3DSymbol_STRETCH`
* :c:enumerator:`~kA3DSymbol_STS`
* :c:enumerator:`~kA3DSymbol_STS_`
* :c:enumerator:`~kA3DSymbol_STS_ANG`
* :c:enumerator:`~kA3DSymbol_STS_ANG_`
* :c:enumerator:`~kA3DSymbol_STS_BAS`
* :c:enumerator:`~kA3DSymbol_STS_BAS_`
* :c:enumerator:`~kA3DSymbol_STS_CIR`
* :c:enumerator:`~kA3DSymbol_STS_CIR_`
* :c:enumerator:`~kA3DSymbol_STS_MAT`
* :c:enumerator:`~kA3DSymbol_STS_MAT_`
* :c:enumerator:`~kA3DSymbol_STS_MLT`
* :c:enumerator:`~kA3DSymbol_STS_MLT_`
* :c:enumerator:`~kA3DSymbol_STS_NOM`
* :c:enumerator:`~kA3DSymbol_STS_NOM_`
* :c:enumerator:`~kA3DSymbol_STS_PAR`
* :c:enumerator:`~kA3DSymbol_STS_PAR_`
* :c:enumerator:`~kA3DSymbol_STS_PER`
* :c:enumerator:`~kA3DSymbol_STS_PER_`
* :c:enumerator:`~kA3DSymbol_STS_PRT`
* :c:enumerator:`~kA3DSymbol_STS_PRT_`
* :c:enumerator:`~kA3DSymbol_STS_RAD`
* :c:enumerator:`~kA3DSymbol_STS_RAD_`
* :c:enumerator:`~kA3DSymbol_SubsetOf`
* :c:enumerator:`~kA3DSymbol_SurfaceProfile`
* :c:enumerator:`~kA3DSymbol_SX`
* :c:enumerator:`~kA3DSymbol_Symmetry`
* :c:enumerator:`~kA3DSymbol_TangentPlane`
* :c:enumerator:`~kA3DSymbol_THIRDANGLE`
* :c:enumerator:`~kA3DSymbol_THIRDANGLECENTERLINES`
* :c:enumerator:`~kA3DSymbol_TotalRunout`
* :c:enumerator:`~kA3DSymbol_Triangle`
* :c:enumerator:`~kA3DSymbol_UNKNOWN`

.. rst-class:: kind-group kind-function

.. rubric:: Functions
   :class: kind-group-title


.. rst-class:: api-xref-list


* :c:func:`~A3DMkpRTFFieldCreate`
* :c:func:`~A3DMkpRTFFieldDelete`
* :c:func:`~A3DMkpRTFFieldGet`


