Provide utilities to manipulate configuration options for output.
◆ AllOption_t
◆ OptionDesc
◆ OptionFunc
A type for a function pointer for a function used to print out options descriptions.
- Parameters
-
◆ cmpOpt()
static int cmpOpt |
( |
const void * | e1_, |
|
|
const void * | e2_ ) |
|
static |
A simple option comparator, used for sorting the options.
- Returns
- Returns an integer indicating the result of the comparison.
- Parameters
-
e1_ | Item A to compare. |
e2_ | Item B to compare. |
◆ ConfigCategoryId()
Returns the configuration category id for the specified configuration category id.
This will be used as an XML class attribute value.
- Parameters
-
id | The TidyConfigCategory for which to lookup the category name. |
- Returns
- Returns the configuration category, such as "diagnostics".
◆ ForEachOption()
An iterator for the unsorted options.
- Parameters
-
tdoc | The Tidy document. |
OptionPrint | The printing function to be used. |
◆ ForEachSortedOption()
An iterator for the sorted options.
- Parameters
-
tdoc | The Tidy document. |
OptionPrint | The printing function to be used. |
◆ GetOption()
Create OptionDesc "d" related to "opt".
- Parameters
-
| tdoc | The tidy document. |
| topt | The option to create a description for. |
[out] | d | The new option description. |
◆ getSortedOption()
Returns options sorted.
- Parameters
-
| tdoc | The Tidy document. |
[out] | tOption | The list of options. |
◆ hasPickList()
Utility to determine if an option has a picklist.
- Parameters
-
- Returns
- Returns a Bool indicating whether the option has a picklist or not.
◆ PrintAllowedValues()
Prints an option's allowed values.
- Parameters
-
topt | The Tidy option. |
d | The OptionDesc for the option. |
◆ PrintAllowedValuesFromPick()
static void PrintAllowedValuesFromPick |
( |
TidyOption | topt | ) |
|
|
static |
Prints an option's allowed value as specified in its pick list.
- Parameters
-