Settings¶
Imports¶
In Protobuf files:
import "melo/api/Settings.proto";
In C++ files:
#include <melo/api/Settings.pb.h>
Descriptor¶
This message describe a Settings node.
Field |
Type |
Label |
Description |
|---|---|---|---|
name |
string |
Name of the settings
|
|
description |
string |
Description of the settings
|
|
icon |
string |
Icon ID of the settings
|
Entry¶
This message describe one entry in a Settings.
Field |
Type |
Label |
Description |
|---|---|---|---|
id |
string |
ID of the entry
|
|
type |
Entry.Type |
ID of the entry
|
|
name |
string |
Name of the entry
|
|
description |
string |
Description of the entry
|
|
boolean |
bool |
Boolean value
|
|
integer |
int64 |
Integer value
|
|
double |
double |
Double value
|
|
string |
string |
string value
|
|
min_integer |
int64 |
Minimal integer value
|
|
min_double |
double |
Minimal double value
|
|
max_integer |
int64 |
Maximal integer value
|
|
max_double |
double |
Maximal double value
|
|
items |
Entry.Item |
repeated |
Possible items for Select / Combo box
|
Entry.Item¶
Item for Select / Combo box
Field |
Type |
Label |
Description |
|---|---|---|---|
name |
string |
Name to display
|
|
icon |
string |
Icon to display
|
|
value |
int64 |
Value to use
|
Event¶
This message is used as payload for Settings Event messages.
Request¶
This message is used as payload for Settings Request messages.
Field |
Type |
Label |
Description |
|---|---|---|---|
list |
Request.List |
List sections and entries
|
Request.List¶
Message to list sections and entries
Response¶
This message is used as payload for Settings Response messages.
Field |
Type |
Label |
Description |
|---|---|---|---|
list |
Response.List |
List sections
|
Response.List¶
Message with list of sections
Field |
Type |
Label |
Description |
|---|---|---|---|
sections |
Section |
repeated |
List of sections
|
Section¶
This message describe one section in a Settings.
Field |
Type |
Label |
Description |
|---|---|---|---|
id |
string |
ID of the section
|
|
name |
string |
Name of the section
|
|
description |
string |
Description of the section
|
|
entries |
Entry |
repeated |
List of entries in the section
|
Entry.Type¶
Type of entry
Name |
Number |
Description |
|---|---|---|
ENTRY_TYPE_BOOLEAN |
0 |
Basic types
/ Boolean value
|
ENTRY_TYPE_INTEGER |
1 |
Integer value (up to 64-bit signed)
|
ENTRY_TYPE_DOUBLE |
2 |
Double value (up to 64-bit)
|
ENTRY_TYPE_STRING |
3 |
String value
|
ENTRY_TYPE_PASSWORD |
4 |
Extended types
/ Password value (same as string but write-only)
|
ENTRY_TYPE_SELECT |
5 |
Select value (comes with icon / name / value list)
|