Join modifications from BR_Dev_For_4_0 tag V4_1_1.

[modules/gui.git] / src / DDS / DDS_KeyWords.cxx

diff --git a/src/DDS/DDS_KeyWords.cxx b/src/DDS/DDS_KeyWords.cxx
index 8ea7f6a97915cee2a65e5b47ff203de93c76a243..626bd0fd03e82a14a6defaea4b427617a8b68df5 100644 (file)
--- a/src/DDS/DDS_KeyWords.cxx
+++ b/src/DDS/DDS_KeyWords.cxx
@@ -21,6 +21,62 @@
 IMPLEMENT_STANDARD_HANDLE(DDS_KeyWords, MMgt_TShared)
 IMPLEMENT_STANDARD_RTTIEXT(DDS_KeyWords, MMgt_TShared)
 
+/*!
+  \class DDS_KeyWords
+
+  This object contains the pairs of internal keys and XML tag or attribute names. This class allow to user
+  define set of XML keywords used in datums definition file.
+
+  Default keywords table:
+  \li D_URI - dictionary
+  \li COMPONENT - component
+  \li COMPONENT_NAME - name
+  \li UNIT_SYSTEMS - unitSystems
+  \li UNIT_SYSTEM - system
+  \li UNIT_SYSTEM_NAME - name
+  \li UNIT_SYSTEM_LABEL - label
+  \li DATUM - datum
+  \li DATUM_ID - id
+  \li DATUM_LABEL - label
+  \li DATUM_UNITS - units
+  \li DATUM_FORMAT - format
+  \li DATUM_FILTER - filter
+  \li DATUM_REQUIRED - required
+  \li VALUE_LIST - valueList
+  \li VALUE_LIST_ID - listid
+  \li VALUE_LIST_NAME - name
+  \li VALUE_LIST_TYPE - type
+  \li VALUE_LIST_VALUE - value
+  \li VALUE_LIST_VALUEID - id
+  \li VALUE_LIST_VALUEICON - icon
+  \li DY_DOMAIN - domain
+  \li WARNING_LEVEL - warningLevel
+  \li WRONG_VALUE - wrongValue
+  \li VALUE_DESCR - valueDescr
+  \li VALUE_LIST_REF - listRef
+  \li DESCR - description
+  \li LONG_D - longDescr
+  \li SHORT_D - shortDescr
+  \li VD_TYPE - type
+  \li VD_DEFV - default
+  \li VD_MAXV - max
+  \li VD_MINV - min
+  \li VD_SPEC - specVal
+  \li VLR_LIST - list
+  \li PRS - presentation
+  \li LATERAL_ZOOM - lateralZoom
+  \li LZ_MINV - min
+  \li LZ_MAXV - max
+  \li LZ_ORDER - order
+  \li OPTIONS - options
+  \li OPTION - option
+  \li OPTION_NAME - name
+*/
+
+/*!
+  Constructor
+*/
+
 DDS_KeyWords::DDS_KeyWords()
 : MMgt_TShared()
 {
@@ -71,8 +127,16 @@ DDS_KeyWords::DDS_KeyWords()
   SetKeyWord( "LZ_MINV",              "min" );
   SetKeyWord( "LZ_MAXV",              "max" );
   SetKeyWord( "LZ_ORDER",             "order" );
+
+  SetKeyWord( "OPTIONS",              "options" );
+  SetKeyWord( "OPTION",               "option" );
+  SetKeyWord( "OPTION_NAME",          "name" );
 }
 
+/*!
+  Returns the static instance of the class DDS_KeyWords
+*/
+
 Handle(DDS_KeyWords) DDS_KeyWords::Get()
 {
   static Handle(DDS_KeyWords) keyWords;
@@ -83,6 +147,11 @@ Handle(DDS_KeyWords) DDS_KeyWords::Get()
   return keyWords;
 }
 
+/*!
+  Returns the XML keyword by specified internal key \a key. If the internal key isn't registered
+  then empty string will be returned.
+*/
+
 TCollection_AsciiString DDS_KeyWords::GetKeyWord( const TCollection_AsciiString& key ) const
 {
   TCollection_AsciiString keyWord;
@@ -91,6 +160,10 @@ TCollection_AsciiString DDS_KeyWords::GetKeyWord( const TCollection_AsciiString&
   return keyWord;
 }
 
+/*!
+  Register the pair of the internal key \a key and XML keyword \a keyWord.
+*/
+
 void DDS_KeyWords::SetKeyWord( const TCollection_AsciiString& key,
                                const TCollection_AsciiString& keyWord )
 {