Inhoudsopgave
- Typen van Eigenschappen/mModifiers
- Elementen voor algemeen gebruik (general purpose) in elk XML-bestand (
.xml
,.rkh
,.pluginmap
) - Te gebruiken elementen in de XML-beschrijving van de plugin
- Eigenschappen van plugin-elementen
- Ingebedde plugins meegeleverd met de officiële uitgave van RKWard
- Elementen voor gebruik in
.pluginmap
-bestanden - Te gebruiken elementen in .rkh (help) bestanden
- Functies die in logische scripts voor de GUI kunnen worden gebruikt
Op enkele plaatsen in de inleiding hebben we gesproken over “eigenschappen” van GUI-elementen en andere. In feite zijn er meerdere verschillende typen van eigenschappen. Gewoonlijk hoeft u zich hier niet om te bekommeren, omdat we met wat gezond verstand elke eigenschap met elke andere kunnen verbinden. Maar intern zijn er verschillende typen van eigenschappen. Dit is van belang wanneer er sommige speciale waarden worden opgehaald in het JS-sjabloon (JS template). In getString ("id")/getBoolean ("id")/getList ("id")-statements kunt u ook enkele zogenoemde “modifiers” (veranderaars) opgeven zoals getString ("id.modifier")
. Deze modifier heeft invloed op hoe de waarde wordt afgedrukt. Lees verder voor de lijst van eigenschappen en de modifiers die elk ervan beschikbaar maakt:
- String-eigenschappen
Het eenvoudigste type eigenschap, gebruikt voor het bevatten van een stuk tekst. Modifiers:
- Geen modifier ("")
De string zoals gedefinieerd / ingesteld.
- met aanhalingstekens
De string met aanhalingstekens (geschikt voor doorgeven aan R als karakter).
- Booleaanse eigenschappen
Eigenschappen die aan of uit kunnen zijn, waar of onwaar, true of false. Bijvoorbeeld de eigenschappen die worden aangemaakt door <convert>-tags (conversie, omzetten), en ook de eigenschap bij een <keuzevakje> (zie onder). De volgende waarden worden teruggegeven, volgens de gegeven modifier:
- Geen modifier ("")
Standaard geeft de eigenschap 1 terug als die true is (waar), en anders 0. De aanbevolen manier voor het ophalen van booleaanse waarden is met
getBoolean()
. Merk op dat bijgetString()
de string "0" wordt teruggegeven als de eigenschap false is (onwaar). De waarde van deze string is in JS true, en niet false.- "labeled" (met naam)
Geeft de string "true" terug indien true, "false" indien false, of welke eigen opgegeven strings ook (typisch in een <keuzevakje>).
- "waar"
Geef de string terug als true, ook al is de eigenschap false
- "onwaar"
Geef de string terug als false, ook al is de eigenschap true
- "niet"
Dit geeft een andere booleaanse eigenschap terug, die het omgekeerde is van de huidige (bijv. false indien true, true indien false)
- "numeriek"
Verouderd, dient voor achterwaartse compatibiliteit (backwards compatibility) Zelfde als de modifier "". Geeft "1" terug als de eigenschap true is, of "0" als die false is.
- Integer eigenschappen (integers zijn gehele getallen)
Een eigenschap die een geheel getal moet bevatten (maar natuurlijk toch een numerieke karakterstring teruggeeft aan de JS-sjabloon (JS template)). Er zijn hier geen modifiers voor. Wordt in <spinveld>en gebruikt (zie onder)
- Eigenschappen voor real numbers (kommagetallen)
Een eigenschap die een kommagetal moet bevatten (maar natuurlijk toch een numerieke karakterstring teruggeeft aan de JS-sjabloon (JS template)). Wordt in <spinveld>en gebruikt (zie onder)
- Geen modifier ("")
Voor
getValue() / getString()
, geeft dit hetzelfde terug als "formatted". In volgende versies zal het mogelijk zijn in plaats hiervan een numerieke weergave te verkrijgen.- "formatted"
Geeft het getal geformatteerd terug (als een string).
- RObject eigenschappen
Een eigenschap, bedoeld als een selectie van een of meer R-objecten. Het meest gebruikt in varselectors en varslots. De volgende waarden worden teruggegeven volgens de opgegeven modifier:
- Geen modifier ("")
Standaard geeft de eigenschap de volledige naam terug van het geselecteerde object. Indien meerdere objecten zijn geselecteerd, worden de objectnamen gescheiden door einde regels ("\").
- "shortname" (korte naam)
Net als hierboven, maar nu worden alleen korte namen van de objecten teruggegeven. Bijvoorbeeld, een object in een lijst krijgt alleen de naam die het in de lijst heeft, zonder de naam van de lijst.
- "label" (naam)
Zoals hierboven, maar nu worden de RKWard-label(s) (namen) van object(en) teruggegeven. (als er geen label beschikbaar is, is die gelijk aan de shortname).
- Eigenschappen van string lists
Deze eigenschap bevat een list van strings (lijst met karakterrijen).
- Geen modifier ("")
getValue()/getString()
geeft alle strings terug gescheiden door "\n". Alle "\n" karakters in elke item worden ge-escaped met "\n". Echter, aanbevolen wordt de waarde op te halen metgetList()
, die een array van strings teruggeeft.- "joined"
Geeft een lijst terug als een enkele string, waarin de items verbonden (joined) zijn door "\n". In tegenstelling tot geen modifier (""), worden de individuele strings _not_ escaped (niet_escaped).
- Code-eigenschappen (code is programmacode)
Een eigenschap van plugins die code hebben gegenereerd. Dit is van belang voor het inbedden (embedding) van plugins, om de code, gegenereerd door de ingebedde plugin, in te bedden in de code gegenereerd door de inbeddende (bovenliggende niveau) plugin. De volgende waarden worden teruggegeven volgens de opgegeven modifier:
- Geen modifier ("")
Geeft de volledige code terug, bijv. de secties "preprocess", "calculate" (berekenen), "printout" (afdrukken), en samengevoegd tot een string (maar niet "preview" (voorbeeld)).
- "preprocess" (onvertaalbaar, want vaste programmeerterm, maar zoiets als voorbewerking)
Geeft alleen de preprocess-sectie terug van de code.
- "calculate"
Geeft alleen de berekenen-sectie terug van de code
- "printout"
Geeft alleen de afdruk-sectie terug van de code
- "preview" (voorbeeld, voorvertoning)
Geeft alleen de voorbeeld-sectie terug van de code