Meta_GuiHints
Module: Metanodes / Definitions
Extra GUI hints, if further hints for a user interface are desired. e.g. its caption, help topic, tooltip, group layout, etc. Not specifically related to the usage of the property, but hints as to how it is intended to be seen by a user. A UI implementation is free to ignore this if it wants...
#include <meta_semantics.hpp>
Public Types
| Type | Name |
|---|---|
| enum | IDX { Idx_Step, Idx_Precision, Idx_Prompt, Idx_Tooltip, Idx_HelpTopic, Idx_Caption, Idx_CustomText, Idx_CustomText2, Idx_Group, Idx_NoGui, Idx_About, Idx_ImageFilename, Idx_CreateNewEnabled, Idx_SearchPaths, Idx_SearchMode, Idx_Paths, Idx_ExpanderSetting } |
| enum | SearchMode { SearchMode_SingleNode, SearchMode_ImmediateChildren, SearchMode_Recursive } |
Public Types Documentation
enum IDX
| Enumerator | Value | Description |
|---|---|---|
| Idx_Step | The step size to use (specified as double, even for int properties). Value of 0 means no step override. | |
| Idx_Precision | The number of decimal places. a negative number means no precision override. | |
| Idx_Prompt | A string to display while prompting the user for input (e.g. on file pickers) | |
| Idx_Tooltip | A string to display when the user hovers over the property editor. | |
| Idx_HelpTopic | The section in the help document describing how to use this property. | |
| Idx_Caption | The caption (label) to display next to this property editor. | |
| Idx_CustomText | The first custom text (for PropSemantics::Type == Type_Custom) | |
| Idx_CustomText2 | The second custom text (for PropSemantics::Type == Type_Custom) | |
| Idx_Group | Link to the group this property is a member of (if any) | |
| Idx_NoGui | If true, a GUI system should not create any controls for this property at all. | |
| Idx_About | More detailed description of the object (when a tooltip would just be too big) | |
| Idx_ImageFilename | Icon to display next to the item. | |
| Idx_CreateNewEnabled | The control should present options for creating new things based on its filter. | |
| Idx_SearchPaths | Where the control should search in order to display relevant nodes (e.g. for the link picker) | |
| Idx_SearchMode | The the control should recruse down the specified search paths in order to locate relevant nodes (see searchmode enum) | |
| Idx_Paths | string property specifying paths to search | |
| Idx_ExpanderSetting |
enum SearchMode
| Enumerator | Value | Description |
|---|---|---|
| SearchMode_SingleNode | ||
| SearchMode_ImmediateChildren | ||
| SearchMode_Recursive |