datadescription_ui.h File Reference

Classes

class  SubMenuEntry
 
class  DataDescriptionUIInterface
 

Namespaces

 maxon
 
 maxon::DESCRIPTION
 
 maxon::DESCRIPTION::UI
 
 maxon::DESCRIPTION::UI::BASE
 
 maxon::DESCRIPTION::UI::BASE::ADDMINMAX
 
 maxon::DESCRIPTION::UI::INFO
 
 maxon::DESCRIPTION::UI::NET
 
 maxon::DESCRIPTION::UI::NET::MAXON
 
 maxon::DESCRIPTION::UI::NET::MAXON::UI
 
 maxon::DESCRIPTION::UI::NET::MAXON::UI::DATA
 
 maxon::DESCRIPTION::UI::NET::MAXON::UI::NUMBER
 
 maxon::DESCRIPTION::UI::NET::MAXON::UI::STRING
 
 maxon::DESCRIPTION::UI::NET::MAXON::UI::URL
 
 maxon::DESCRIPTION::UI::NET::MAXON::UI::VARIADICPORT
 

Macros

#define STRING_FILTERENUMCOMMAND
 

Typedefs

using ContextVarTuple = Tuple< DataDictionary, GetDataCallbackType >
 
using ContextVarsMap = HashMap< Id, ContextVarTuple >
 
using GetDescEntriesCallbackType = Delegate< Result< Tuple< InternedId, DataDictionary, DataDictionary > >(const InternedId &id, GETDATAFLAGS flags)>
 
using ConditionToken = Tuple< const CString &, const CString &, CONDITIONTOKENTYPE >
 

Enumerations

enum class  CONDITIONTOKENTYPE {
  NONE ,
  ATTRIBUTEID ,
  DYN_ATTRIBUTEID ,
  VARIABLE ,
  CONSTANT ,
  FUNCTION ,
  OPERATOR ,
  PARENTHESIS
}
 

Functions

 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.base")
 
 MAXON_ATTRIBUTE (Id, DEFAULTCLASSIFICATION, "net.maxon.description.ui.base.defaultclassification", RESOURCE_DEFINE(ENUM_OUTPUT, Id("output")))
 
 MAXON_ATTRIBUTE (Id, GUITYPEID, "net.maxon.description.ui.base.guitypeid")
 
 MAXON_ATTRIBUTE (Array< Id >, BASELINK_ACCEPT, "net.maxon.description.ui.base.baselink.accept")
 
 MAXON_ATTRIBUTE (InternedId, GROUPID, "net.maxon.description.ui.base.groupid")
 
 MAXON_ATTRIBUTE (Bool, SHOWGROUPINPORTLIST, "net.maxon.description.ui.base.showgroupinportlist")
 
 MAXON_ATTRIBUTE (CString, SHOW, "net.maxon.description.ui.base.show")
 
 MAXON_ATTRIBUTE (CString, ENABLE, "net.maxon.description.ui.base.enable")
 
 MAXON_ATTRIBUTE (InternedId, PARENTFOLDERID, "net.maxon.description.ui.base.parentfolderid")
 
 MAXON_ATTRIBUTE (Bool, PARENTFOLDERIDDEFAULTOPEN, "net.maxon.description.ui.base.parentfolderiddefaultopen")
 
 MAXON_ATTRIBUTE (Id, PRESETDATABASEID, "net.maxon.description.ui.base.presetdatabaseid")
 
 MAXON_ATTRIBUTE (MAXON_MACROARG_TYPE(Array< Tuple< InternedId, InternedId >>), PRESETMEMBERS, "net.maxon.description.ui.base.presetmembers")
 
 MAXON_ATTRIBUTE (Id, PRESETDATABASEDYNAMICID, "net.maxon.description.ui.base.presetdatabasedynamicid")
 
 MAXON_ATTRIBUTE (Array< Id >, ENUM, "net.maxon.description.ui.base.enum")
 
 MAXON_ATTRIBUTE (Bool, ENUMSORTMODE, "net.maxon.description.ui.base.enumsortmode")
 
 MAXON_ATTRIBUTE (Int, PORTSTATE, "net.maxon.description.ui.base.portstate", RESOURCE_DEFINE(ENUM_HASWARNING, 16))
 
 MAXON_ATTRIBUTE (Bool, OPTIONALCHILDRENSTRINGS, "net.maxon.description.ui.base.optionalchildrenstrings")
 
 MAXON_ATTRIBUTE (Id, COMMANDTYPE, "net.maxon.description.ui.base.commandtype", RESOURCE_DEFINE(ENUM_MENU, Id("menu")))
 
 MAXON_ATTRIBUTE (Id, COMMANDCONTEXT, "net.maxon.description.ui.base.commandcontext", RESOURCE_DEFINE(ENUM_APPWIDGET, Id("appwidget")))
 
 MAXON_ATTRIBUTE (Id, COMMANDICONID, "net.maxon.description.ui.base.commandiconid")
 
 MAXON_ATTRIBUTE (Id, COMMANDSHORTCUTID, "net.maxon.description.ui.base.commandshortcutid")
 
 MAXON_ATTRIBUTE (Bool, GROUPDEFAULTOPEN, "net.maxon.description.ui.base.groupdefaultopen")
 
 MAXON_ATTRIBUTE (Bool, UIDEFAULTOPEN, "net.maxon.description.ui.base.uidefaultopen")
 
 MAXON_ATTRIBUTE (Bool, GROUPTITLEBAR, "net.maxon.description.ui.base.grouptitlebar")
 
 MAXON_ATTRIBUTE (Int, GROUPCOLUMNS, "net.maxon.description.ui.base.groupcolumns")
 
 MAXON_ATTRIBUTE (Bool, SCALEV, "net.maxon.description.ui.base.scalev")
 
 MAXON_ATTRIBUTE (Bool, SCALEH, "net.maxon.description.ui.base.scaleh")
 
 MAXON_ATTRIBUTE (Bool, ANIMATABLE, "net.maxon.description.ui.base.animatable")
 
 MAXON_ATTRIBUTE (Bool, HIDEWHENINLINE, "net.maxon.description.ui.base.hidewheninline")
 
 MAXON_ATTRIBUTE (Bool, MULTILINETITLE, "net.maxon.description.ui.base.multilinetitle")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.base.addminmax")
 
 MAXON_ATTRIBUTE (Bool, LIMITVALUE, "net.maxon.description.ui.base.addminmax.limitvalue")
 
 MAXON_ATTRIBUTE (Data, MINVALUE, "net.maxon.description.ui.base.addminmax.minvalue")
 
 MAXON_ATTRIBUTE (Data, MAXVALUE, "net.maxon.description.ui.base.addminmax.maxvalue")
 
 MAXON_ATTRIBUTE (Data, STEPVALUE, "net.maxon.description.ui.base.addminmax.stepvalue")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.info")
 
 MAXON_ATTRIBUTE (Id, MENUCATEGORY, "net.maxon.description.ui.info.menucategory")
 
 MAXON_ATTRIBUTE (CString, DEFAULTNAME, "net.maxon.description.ui.info.defaultname")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.net.maxon.ui.data")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.net.maxon.ui.number")
 
 MAXON_ATTRIBUTE (Bool, SLIDER, "net.maxon.description.ui.net.maxon.ui.number.slider")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.net.maxon.ui.string")
 
 MAXON_ATTRIBUTE (Bool, READONLY, "net.maxon.description.ui.net.maxon.ui.string.readonly")
 
 MAXON_ATTRIBUTE (Bool, MULTILINE, "net.maxon.description.ui.net.maxon.ui.string.multiline")
 
 MAXON_ATTRIBUTE (Bool, PYTHON, "net.maxon.description.ui.net.maxon.ui.string.python")
 
 MAXON_ATTRIBUTE (Bool, SYNTAXCOLOR, "net.maxon.description.ui.net.maxon.ui.string.syntaxcolor")
 
 MAXON_ATTRIBUTE (Bool, STATUSBAR, "net.maxon.description.ui.net.maxon.ui.string.statusbar")
 
 MAXON_ATTRIBUTE (Bool, WORDWRAP, "net.maxon.description.ui.net.maxon.ui.string.wordwrap")
 
 MAXON_ATTRIBUTE (Bool, MONOSPACED, "net.maxon.description.ui.net.maxon.ui.string.monospaced")
 
 MAXON_ATTRIBUTE (Bool, BOLD, "net.maxon.description.ui.net.maxon.ui.string.bold")
 
 MAXON_ATTRIBUTE (Bool, BORDER, "net.maxon.description.ui.net.maxon.ui.string.border")
 
 MAXON_ATTRIBUTE (Bool, HIGHLIGHTLINE, "net.maxon.description.ui.net.maxon.ui.string.highlightline")
 
 MAXON_ATTRIBUTE (Bool, SCROLLBARS, "net.maxon.description.ui.net.maxon.ui.string.scrollbars")
 
 MAXON_ATTRIBUTE (Bool, DARKBACKGROUND, "net.maxon.description.ui.net.maxon.ui.string.darkbackground")
 
 MAXON_ATTRIBUTE (Bool, DROPTEXTQUOTED, "net.maxon.description.ui.net.maxon.ui.string.droptextquoted")
 
 MAXON_ATTRIBUTE (Int, LINECOUNT, "net.maxon.description.ui.net.maxon.ui.string.linecount")
 
 MAXON_ATTRIBUTE (Group, MULTILINE_GROUP, "net.maxon.description.ui.net.maxon.ui.string.multiline.group")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.net.maxon.ui.url")
 
 MAXON_ATTRIBUTE (Bool, TEXTUREHANDLING, "net.maxon.description.ui.net.maxon.ui.url.texturehandling")
 
 MAXON_RESOURCE_DATABASE_SCOPE ("net.maxon.description.ui.net.maxon.ui.variadicport")
 
 MAXON_ATTRIBUTE (Int32, COMPLEXCUSTOMUI, "net.maxon.description.ui.net.maxon.ui.variadicport.complexcustomui")
 
enum maxon::CONDITIONTOKENTYPE MAXON_ENUM_LIST (CONDITIONTOKENTYPE)
 

Variables

 NONE
 
 ATTRIBUTEID
 
 DYN_ATTRIBUTEID
 
 VARIABLE
 
 CONSTANT
 
 FUNCTION
 
 OPERATOR
 
 PARENTHESIS
 

Macro Definition Documentation

◆ STRING_FILTERENUMCOMMAND

#define STRING_FILTERENUMCOMMAND

Appending this string to any enum entry will skip/filter that element when scrolling through the elements using the keyboard or mouse wheel.

Variable Documentation

◆ NONE

NONE

◆ ATTRIBUTEID

ATTRIBUTEID

◆ DYN_ATTRIBUTEID

DYN_ATTRIBUTEID

Identifier for which DataDescriptionDefinitionInterface::GetDataValueOrDefaults will be called.

◆ VARIABLE

VARIABLE

Same as ATTRIBUTEID but the attribute is animated, this makes the whole condition bypassed as true.

◆ CONSTANT

CONSTANT

External variable, see DataDescriptionDefinitionInterface::EvaluateCondition.

◆ FUNCTION

FUNCTION

Constant value for comparison.

◆ OPERATOR

OPERATOR

A function call.

◆ PARENTHESIS

PARENTHESIS

Comparison operator, logic operator, this token often contains constants and parenthesis.