diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2024-05-22 21:34:44 -0400 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2024-05-22 21:34:44 -0400 |
| commit | e11e177d96736ab665b0cc37c19f184b93690fe2 (patch) | |
| tree | cb86d81e87d0533bde64adc972c720e1c516ddef /python | |
| parent | dff192e3bd6d5737633a740988c31e4ecba92998 (diff) | |
actual fix for incorrect settings table
Diffstat (limited to 'python')
| -rw-r--r-- | python/settings.py | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/python/settings.py b/python/settings.py index 6c73c4e6..fa7cc275 100644 --- a/python/settings.py +++ b/python/settings.py @@ -59,28 +59,28 @@ class Settings: :func:`register_group` method allows for specifying a UI friendly title for use in the Binary Ninja UI. Defining a new setting requires a \ unique setting key and a JSON string of property, value pairs. The following table describes the available properties and values. - ================== ====================================== ================== ======== ======================================================================= - Property JSON Data Type Prerequisite Optional {Allowed Values} and Notes - ================== ====================================== ================== ======== ======================================================================= - "title" string None No Concise Setting Title - "type" string None No {"array", "boolean", "number", "string"} - "elementType" string "type" is "array" No {"string"} - "enum" array : {string} "type" is "string" Yes Enumeration definitions - "enumDescriptions" array : {string} "type" is "string" Yes Enumeration descriptions that match "enum" array - "minValue" number "type" is "number" Yes Specify 0 to infer unsigned (default is signed) - "maxValue" number "type" is "number" Yes Values less than or equal to INT_MAX result in a QSpinBox UI element - "precision" number "type" is "number" Yes Specify precision for a QDoubleSpinBox - "default" {array, boolean, number, string, null} None Yes Specify optimal default value - "aliases" array : {string} None Yes Array of deprecated setting key(s) - "description" string None No Detailed setting description - "ignore" array : {string} None Yes {"SettingsUserScope", "SettingsProjectScope", "SettingsResourceScope"} - "message" string None Yes An optional message with additional emphasis - "readOnly" boolean None Yes Only enforced by UI elements - "optional" boolean None Yes Indicates setting can be null - "hidden" bool "type" is "string" Yes Indicates the UI should conceal the content - "requiresRestart boolean None Yes Enable restart notification in the UI upon change - "uiSelectionAction" string "type" is "string" Yes {"file", "directory", <Registered UIAction Name>} Informs the UI to add a button to open a selection dialog or run a registered UIAction - ================== ====================================== ================== ======== ======================================================================= + =================== ====================================== ================== ======== ======================================================================= + Property JSON Data Type Prerequisite Optional {Allowed Values} and Notes + =================== ====================================== ================== ======== ======================================================================= + "title" string None No Concise Setting Title + "type" string None No {"array", "boolean", "number", "string"} + "elementType" string "type" is "array" No {"string"} + "enum" array : {string} "type" is "string" Yes Enumeration definitions + "enumDescriptions" array : {string} "type" is "string" Yes Enumeration descriptions that match "enum" array + "minValue" number "type" is "number" Yes Specify 0 to infer unsigned (default is signed) + "maxValue" number "type" is "number" Yes Values less than or equal to INT_MAX result in a QSpinBox UI element + "precision" number "type" is "number" Yes Specify precision for a QDoubleSpinBox + "default" {array, boolean, number, string, null} None Yes Specify optimal default value + "aliases" array : {string} None Yes Array of deprecated setting key(s) + "description" string None No Detailed setting description + "ignore" array : {string} None Yes {"SettingsUserScope", "SettingsProjectScope", "SettingsResourceScope"} + "message" string None Yes An optional message with additional emphasis + "readOnly" boolean None Yes Only enforced by UI elements + "optional" boolean None Yes Indicates setting can be null + "hidden" bool "type" is "string" Yes Indicates the UI should conceal the content + "requiresRestart boolean None Yes Enable restart notification in the UI upon change + "uiSelectionAction" string "type" is "string" Yes {"file", "directory", <Registered UIAction Name>} Informs the UI to add a button to open a selection dialog or run a registered UIAction + =================== ====================================== ================== ======== ======================================================================= .. note:: In order to facilitate deterministic analysis results, settings from the *'default'* schema that impact analysis are serialized \ from Default, User, and Project scope into Resource scope during initial BinaryView analysis. This allows an analysis database to be opened \ |