`tlc.core.builtins.constants.string_roles`#

Defines some common keywords which can be used to annotate string values in Schemas

Module Contents#

Data#

Data	Description
`STRING_ROLE_NONE`	Default string role
`STRING_ROLE_SEARCH`	String which is used in a search field
`STRING_ROLE_SEARCH_SET_FOCUS`	String which sets focus to the search field
`STRING_ROLE_OBJECT_TYPE`	String which represents the type of an object
`STRING_ROLE_VERSION`	String which represents a version number
`STRING_ROLE_DATETIME`	String which represents a date and time
`STRING_ROLE_ICON`	String which represents an icon
`STRING_ROLE_LOG_MESSAGE`	String which represents a message in a Log table
`STRING_ROLE_MULTILINE`	String which can be displayed over multiple lines
`STRING_ROLE_URL`	String which represents a URL
`STRING_ROLE_IMAGE_URL`	URL which refers to an image
`STRING_ROLE_SEGMENTATION_MASK_URL`	URL which refers to a segmentation mask image
`STRING_ROLE_TABLE_URL`	URL which refers to a table
`STRING_ROLE_FOLDER_URL`	URL which refers to a folder on disk
`STRING_ROLE_INPUT_URL`	URL which refers to an input object
`STRING_ROLE_SEARCH_URL`	URL which is used in a search field

API#

tlc.core.builtins.constants.string_roles.STRING_ROLE_NONE = <Multiline-String>#: Default string role

tlc.core.builtins.constants.string_roles.STRING_ROLE_SEARCH = Search#: String which is used in a search field

tlc.core.builtins.constants.string_roles.STRING_ROLE_SEARCH_SET_FOCUS = Search/SetFocus#: String which sets focus to the search field

tlc.core.builtins.constants.string_roles.STRING_ROLE_OBJECT_TYPE = ObjectType#: String which represents the type of an object

tlc.core.builtins.constants.string_roles.STRING_ROLE_VERSION = Version#: String which represents a version number

tlc.core.builtins.constants.string_roles.STRING_ROLE_DATETIME = Datetime#: String which represents a date and time

tlc.core.builtins.constants.string_roles.STRING_ROLE_ICON = Icon#: String which represents an icon

tlc.core.builtins.constants.string_roles.STRING_ROLE_LOG_MESSAGE = LogMessage#: String which represents a message in a Log table

tlc.core.builtins.constants.string_roles.STRING_ROLE_MULTILINE = MultiLine#: String which can be displayed over multiple lines

tlc.core.builtins.constants.string_roles.STRING_ROLE_URL = URL#: String which represents a URL

tlc.core.builtins.constants.string_roles.STRING_ROLE_IMAGE_URL = URL/Image#: URL which refers to an image

tlc.core.builtins.constants.string_roles.STRING_ROLE_SEGMENTATION_MASK_URL = URL/SegmentationMask#: URL which refers to a segmentation mask image

tlc.core.builtins.constants.string_roles.STRING_ROLE_TABLE_URL = URL/Table#: URL which refers to a table

tlc.core.builtins.constants.string_roles.STRING_ROLE_FOLDER_URL = URL/Folder#: URL which refers to a folder on disk

tlc.core.builtins.constants.string_roles.STRING_ROLE_INPUT_URL = URL/Input#: URL which refers to an input object

tlc.core.builtins.constants.string_roles.STRING_ROLE_SEARCH_URL = URL/Search#: URL which is used in a search field