Commit 4277751b authored by Thomas BOUTROUE's avatar Thomas BOUTROUE

Add missing help sections

parent 6bedf3bf
......@@ -2106,7 +2106,7 @@ static ObjectHelp actuatorsList {
};
static ObjectHelp dashboard {
"Dashboard", "item", { }, { "CircleButton", "LedLight", "CircularGauge", "TicksJauge", "LinearGauge", "Oscilloscope", "OnOffSwitcher", "NumberValueDisplay", "RotativeKnob" }, "instantiable",
"Dashboard", "item", { }, { "CircleButton", "LedLight", "CircularGauge", "TicksJauge", "LinearGauge", "Oscilloscope", "OnOffSwitcher", "NumberValueDisplay", "NumberValueInput", "RotativeKnob", "MultiChoiceList" }, "instantiable",
{
new PropertyHelp {
"uid", "string", "writable", false,
......@@ -2477,6 +2477,94 @@ static ObjectHelp numberValueDisplay {
"This item displays a floating number formatted value along with legend and unit."
};
static ObjectHelp numberValueInput {
"NumberValueInput", "item", { }, { }, "instantiable",
{
new PropertyHelp {
"size", "uint32", "writable", false,
"The font size of the value, all the other sizes are derived from this."
},
new PropertyHelp {
"decimals", "uint32", "writable", false,
"The number of decimals displayed (0 by default)."
},
new PropertyHelp {
"digits", "uint32", "writable", false,
"The number of digits displayed (3 by default)."
},
new PropertyHelp {
"sign", "bool", "writable", false,
"Whether the value can be negative (true by default)."
},
new PropertyHelp {
"value", "float", "writable", false,
"The value edited in the component."
},
new PropertyHelp {
"minValue", "float", "writable", false,
"The minimum boundary for the value edited in the component."
},
new PropertyHelp {
"maxnValue", "float", "writable", false,
"The maximum boundary for the value edited in the component."
},
new PropertyHelp {
"background", "color", "writable", false,
"The base color for background gradient (gray by default)."
},
new PropertyHelp {
"legend", "string", "writable", false,
"The legend text displayed under the value (empty by default)."
},
new PropertyHelp {
"unit", "string", "writable", false,
"The unit of the value (empty by default)."
},
},
{ },
{ },
{ },
"This item displays a floating number formatted value along with legend and unit."
};
static ObjectHelp multiChoiceList {
"MultiChoiceList", "item", { }, { }, "instantiable",
{
new PropertyHelp {
"size", "uint32", "writable", false,
"The font size of the value, all the other sizes are derived from this (20 by default)."
},
new PropertyHelp {
"side", "enum (Borders)", "writable", false,
"The border side for the legend (top by default)."
},
new PropertyHelp {
"legend", "string", "writable", false,
"The legend text displayed for the list (empty by default)."
},
new PropertyHelp {
"model", "map<string,variant>", "writable", true,
"The model for the list. Must be a JSON Array of Object, with the fields 'key' and 'value' for each item."
},
new PropertyHelp {
"currentIdx", "uint32", "writable", false,
"The index of the current selection in the list (0 by default)."
},
new PropertyHelp {
"currentKey", "variant", "readonly", false,
"The key of the current selection in the list (depends on the model and the currentIdx)."
},
new PropertyHelp {
"currentValue", "variant", "readonly", false,
"The value of the current selection in the list (depends on the model and the currentIdx)."
},
},
{ },
{ },
{ },
"This item displays a selectable list of values associated with internal values."
};
static ObjectHelp circleButton {
"CircleButton", "item", { }, { }, "instantiable",
{
......@@ -2792,10 +2880,12 @@ void Help::initMap (void) {
registerHelp (ledLight);
registerHelp (onOffSwitcher);
registerHelp (numberValueDisplay);
registerHelp (numberValueInput);
registerHelp (circularGauge);
registerHelp (linearGauge);
registerHelp (ticksJauge);
registerHelp (rotativeKnob);
registerHelp (multiChoiceList);
}
void Help::initIndex (void) {
......@@ -2903,7 +2993,9 @@ void Help::initIndex (void) {
new HelpPage { 1, "OnOffSwitcher" },
new HelpPage { 1, "LedLight" },
new HelpPage { 1, "NumberValueDisplay" },
new HelpPage { 1, "NumberValueInput" },
new HelpPage { 1, "CircleButton" },
new HelpPage { 1, "MultiChoiceList" },
}
},
};
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment