XML Format for CBCGPEditCtrl

This article describes format of XML files to be used with CBCGPEditCtrl. The XML parser is invoked by calling to CBCGPEditCtrl::LoadXMLSettings or CBCGPEditCtrl::LoadXMLSettingsFromBuffer.

The overall structure is following:

<SETTINGS>
    <OPTIONS>
        <WordDelimeters></WordDelimeters>
        <SpecialDelimiters></SpecialDelimiters>
        <IntelliSenseChars></IntelliSenseChars>
    </OPTIONS>

    <COLOR_DATA>
        <EditTextColor></EditTextColor>
        <EditBackColor></EditBackColor>
        <SelTextColor></SelTextColor>
        <SelBackColor></SelBackColor>

        <KEYWORDS>
            <Color></Color>
            <BackColor></BackColor>
            <CaseSensitive></CaseSensitive>
            <Keyword></Keyword>
            <Keyword></Keyword>

            ... more keywords ....

            <Keyword></Keyword>
        </KEYWORDS>

        <WORDS>
            <WORD>
                <Val></Val>
                <Color></Color>
                <BackColor></BackColor>
                <CaseSensitive></CaseSensitive>
            </WORD>

            ... more WORDs ...

            <WORD>
                ....... 
            </WORD>
        </WORDS>

        <BLOCKS>
            <BLOCK>
                <Start></Start>
                <End></End>
                <Color></Color>
                <BackColor></BackColor>
                <WholeText></WholeText>
                <CaseSensitive></CaseSensitive>
            </BLOCK>

            ... more blocks ...

            <BLOCK>
                .......
            </BLOCK>
        <BLOCKS> 
    </COLOR_DATA>
</SETTINGS>

There are no mandatory tags except the main "SETTINGS" tag.

"OPTIONS" tag describes common settings applied to the edit control.

• WordDelimeters - defines CBCGPEditCtrl::m_strWordDelimiters
• SpecialDelimiters - defines CBCGPEditCtrl::m_strSpecialDelimiters
• IntelliSenseChars - defines CBCGPEditCtrl::m_strIntelliSenseChars

"COLOR_DATA" tag defines general edit control colors as well as colors for syntax highlighting and blocks.

• EditTextColor - defines CBCGPEditCtrl::m_clrText
• EditBackColor - defines CBCGPEditCtrl::m_clrBack
• SelTextColor - defines CBCGPEditCtrl::m_clrTextSelActive
• SelBackColor - defines CBCGPEditCtrl::m_clrBackSelActive

"KEYWORDS" tag is intended for syntax highlighting definitions. It's usable when you need to define a set of keywords of the same color. For each keyword the XML parser will call CBCGPEditCtrl::SetWordColor.

• Color - clrFrgnd parameter
• BackColor - clrBkgnd parameter
• CaseSensitive - bCaseSensitive parameter
• Keyword - strWord parameter

"WORDS" tag is intended for separate words to be displayed with various color settings. For each word the XML parser will call CBCGPEditCtrl::SetWordColor.

"WORD" tag represents a single word.

• Val - strWord parameter
• Color - clrFrgnd parameter
• BackColor - clrBkgnd parameter
• CaseSensitive - bCaseSensitive parameter

"BLOCKS" tag defines a list of color blocks. For each color block the XML parser will call CBCGPEditCtrl::SetBlockColor

"BLOCK" tag represents a single color block

• Start - strBlockOpen parameter
• End - strBlockClose parameter
• Color - clrFrgnd parameter
• BackColor - clrBkgnd parameter
• WholeText - bWholeText parameter
• CaseSensitive - bCaseSensitive parameter.

The following is the list of colors recognized by XML parser:

• black
• darkred
• darkgreen
• brown
• darkblue
• darkmagenta
• darkcyan
• gray
• darkgray
• red
• green
• yellow
• blue
• magenta
• cyan
• white

For boolean values you can use "true" or "false".