PdQmlWidgets  2.0.0
Properties | List of all members
de::igh::pd::PdText Class Reference

Value hash type. More...

Inheritance diagram for de::igh::pd::PdText:
Inheritance graph
[legend]
Collaboration diagram for de::igh::pd::PdText:
Collaboration graph
[legend]

Properties

var map
 Example: More...
 
string undefText
 type:var this text is shown if no key is found in hash More...
 
alias variable
 type:var connection to the process variable see PdCheckBox More...
 
alias connection
 
alias path
 type:var convinience connection to the process path see PdCheckBox More...
 
string textRole
 type:string Text is selected from that role of the map, which key is: textRole. More...
 
bool hovered
 This signal is emitted when a mouse is hovered over the control. More...
 
alias value
 type:var Raw Process value More...
 
string prefix
 Prefix is prepended to the value without space! More...
 
string suffix
 Suffix is appended to the value without space! More...
 
bool isUndefined
 it true, if no key exists in map for the current value More...
 

Detailed Description

Value hash type.

This hash shall contain a value object for each possible value to display.

Import Statement

import de.igh.pd
Version
2.0

Property Documentation

◆ connection

alias de::igh::pd::PdText::connection
read

◆ hovered

bool de::igh::pd::PdText::hovered
read

This signal is emitted when a mouse is hovered over the control.

true: when the mouse moves over the control, false: otherwise

◆ isUndefined

bool de::igh::pd::PdText::isUndefined
read

it true, if no key exists in map for the current value

◆ map

var de::igh::pd::PdText::map
read

Example:

{
const map = new Map()
map.set(0,{"color":"red","text":"Car"});
map.set(1,{"color":"green","text":"Person"});
map.set(2,{"color":"green","text":"Animal"});
map.set(3,{"color":"#FF9800","text":"nothing"});
return map;
}

◆ path

alias de::igh::pd::PdText::path
read

type:var convinience connection to the process path see PdCheckBox

◆ prefix

string de::igh::pd::PdText::prefix
read

Prefix is prepended to the value without space!

◆ suffix

string de::igh::pd::PdText::suffix
read

Suffix is appended to the value without space!

◆ textRole

string de::igh::pd::PdText::textRole
read

type:string Text is selected from that role of the map, which key is: textRole.

When the map has multiple roles, textRole can be set to determine which role should be displayed. With the above example for map

textRole:"text"

◆ undefText

string de::igh::pd::PdText::undefText
read

type:var this text is shown if no key is found in hash

◆ value

alias de::igh::pd::PdText::value
read

type:var Raw Process value

Remarks
This property is read-only

◆ variable

alias de::igh::pd::PdText::variable
read

type:var connection to the process variable see PdCheckBox


The documentation for this class was generated from the following file: