Difference between revisions of "CT STRUCTURED TEXT"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "Integer" to "Integer")
m (Text replacement - "<tt>([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}")
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category: Control Types]]
 
 
 
{{CT|intro
 
{{CT|intro
  
Line 7: Line 5:
 
|description = The Structured Text control can display [[Structured Text]]. This is a separate [[:Category: Data Types|data type]] in Arma.
 
|description = The Structured Text control can display [[Structured Text]]. This is a separate [[:Category: Data Types|data type]] in Arma.
 
Structured Text can not only hold some text values, it also can contain some attributes to format the text, as you can see in the example picture below.
 
Structured Text can not only hold some text values, it also can contain some attributes to format the text, as you can see in the example picture below.
You ''can'' contain a subclass '''Attributes''' to change the default attributes for your control. But the ''Attributes class'' and all of its attributes are ''optional'' and do not have to be specified.
+
 
 +
You ''can'' add the {{hl|Attributes}} subclass to change the default Structured Text attributes of your control, but the {{hl|Attributes}} class and all of its attributes are ''optional'' and do not have to be specified.
 
|gallery=Image:ControlStructuredText.jpg{{!}}A StructuredText control with some formatting included.
 
|gallery=Image:ControlStructuredText.jpg{{!}}A StructuredText control with some formatting included.
 
|commands =
 
|commands =
Line 27: Line 26:
 
shadow = 1;
 
shadow = 1;
 
};
 
};
|description=Subclass with options how the text should be rendered. Attributes represent the [[Structured Text]] options.<br>
+
|description=Subclass with options how the text should be rendered. Attributes represent the [[Structured Text]] options. {{Feature|Warning|Attributes ( {{hl|class Attributes}}) are not inherited from an existing [[CT_STRUCTURED_TEXT]] control. While no error is shown, properties of {{hl|class Attributes}} will be set to some default values. Re-define needed properties manually. }}
 
{{{!}}class="wikitable" border="1" align="left" cellpadding="3" cellspacing="0" {{!}}
 
{{{!}}class="wikitable" border="1" align="left" cellpadding="3" cellspacing="0" {{!}}
 
! colspan="4" bgcolor="#bbbbff" {{!}} Optional SubClass Attributes Properties
 
! colspan="4" bgcolor="#bbbbff" {{!}} Optional SubClass Attributes Properties
Line 102: Line 101:
  
 
{{CT|examples}}
 
{{CT|examples}}
 +
 
=== RscStructuredText ===
 
=== RscStructuredText ===
 +
 
<syntaxhighlight lang="cpp">
 
<syntaxhighlight lang="cpp">
 
class RscStructuredText
 
class RscStructuredText
Line 130: Line 131:
 
};
 
};
 
</syntaxhighlight>
 
</syntaxhighlight>
 +
  
 
== Other Examples ==
 
== Other Examples ==
 +
 
The following example uses almost the same code as the controls shown in the example screenshot.
 
The following example uses almost the same code as the controls shown in the example screenshot.
<syntaxhighlight lang="cpp">class MyRscStructuredText
+
<syntaxhighlight lang="cpp">
 +
class MyRscStructuredText
 
{
 
{
  idc = -1;  
+
idc = -1;
  type = CT_STRUCTURED_TEXT; // defined constant
+
type = CT_STRUCTURED_TEXT; // defined constant
  style = ST_LEFT;           // defined constant
+
style = ST_LEFT; // defined constant
  colorBackground[] = { 1, 1, 1, 1 };  
+
colorBackground[] = { 1, 1, 1, 1 };
  x = 0.1;  
+
x = 0.1;
  y = 0.1;  
+
y = 0.1;
  w = 0.3;  
+
w = 0.3;
  h = 0.1;  
+
h = 0.1;
  size = 0.018;
+
size = 0.018;
  text = "";
+
text = "";
  class Attributes
+
class Attributes
  {
+
{
    font = "TahomaB";
+
font = "TahomaB";
    color = "#000000";
+
color = "#000000";
    align = "center";
+
align = "center";
    valign = "middle";
+
valign = "middle";
    shadow = false;
+
shadow = false;
    shadowColor = "#ff0000";
+
shadowColor = "#ff0000";
    size = "1";
+
size = "1";
  };
+
};
};</syntaxhighlight>
+
};
 +
</syntaxhighlight>
 +
 
 +
 
 +
[[Category: Control Types]]

Revision as of 00:56, 16 November 2021

Introduction

The Structured Text control can display Structured Text. This is a separate data type in Arma. Structured Text can not only hold some text values, it also can contain some attributes to format the text, as you can see in the example picture below.

You can add the Attributes subclass to change the default Structured Text attributes of your control, but the Attributes class and all of its attributes are optional and do not have to be specified.

Related commands & functions

Related User Interface Eventhandlers

Alphabetical Order

TokenNames common to most controls, such as x, y, w, h, text, idc... can be found here.
Not all of the listed attributes might have an effect nor might the list be complete. All attributes were gathered with this config crawler.
#define CT_STRUCTURED_TEXT 13


A

Attributes

Type
Class
Description
Subclass with options how the text should be rendered. Attributes represent the Structured Text options.
Attributes ( class Attributes) are not inherited from an existing CT_STRUCTURED_TEXT control. While no error is shown, properties of class Attributes will be set to some default values. Re-define needed properties manually.
Optional SubClass Attributes Properties
Name Type Remark Default Value
font string fontname to use "Zeppelin32"
size Float Set the size of the text where 1 is the size value of parent class. 1
color string text color defined in HMTL-like syntax. "#ffffff"
align string align of text. Values can be "left", "center" or "right" "center"
valign string vertical align of text. Values can be "top", "middle", "bottom". "middle"
shadow Integer affects the shadow of the text. 1 (true)
shadowColor string shadow color defined in HMTL-like syntax. "#000000"
shadowOffset
image string
underline
href string
linkColor string

class Attributes
{
	font = "RobotoCondensed";
	color = "#ffffff";
	colorLink = "#D09B43";
	align = "left";
	shadow = 1;
};



Default Classes

Arma 3
AddOns: Classes need to be initialised first with class SomeClass;
Missions: Since Arma 3 v2.02 one can use import SomeClass; to initialise a class (see import). In older versions, use "Default" call BIS_fnc_exportGUIBaseClasses; and paste the result into the description.ext.


RscStructuredText

class RscStructuredText
{
	deletable = 0;
	fade = 0;
	access = 0;
	type = CT_STRUCTURED_TEXT;
	idc = -1;
	style = ST_LEFT;
	colorText[] = {1,1,1,1};
	class Attributes
	{
		font = "RobotoCondensed";
		color = "#ffffff";
		colorLink = "#D09B43";
		align = "left";
		shadow = 1;
	};
	x = 0;
	y = 0;
	h = 0.035;
	w = 0.1;
	text = "";
	size = GUI_TEXT_SIZE_MEDIUM;
	shadow = 1;
};


Other Examples

The following example uses almost the same code as the controls shown in the example screenshot.

class MyRscStructuredText
{
	idc = -1;
	type = CT_STRUCTURED_TEXT;	// defined constant
	style = ST_LEFT;				// defined constant
	colorBackground[] = { 1, 1, 1, 1 };
	x = 0.1;
	y = 0.1;
	w = 0.3;
	h = 0.1;
	size = 0.018;
	text = "";
	class Attributes
	{
		font = "TahomaB";
		color = "#000000";
		align = "center";
		valign = "middle";
		shadow = false;
		shadowColor = "#ff0000";
		size = "1";
	};
};