SCR_BIKIStringBuilder Interface Reference

Public Member Functions
void	AddLine (string line)
	Add text line that gets ended by a line return.
void	AddTitle (int titleLevel, string text)
	Add a wiki title (e.g == title lv 2 ==)
void	BeginTable (string style=string.Empty)
	Begin a wiki table.
void	AddTableHeadersLine (notnull array< string > titles)
	This method allows empty headers.
void	AddTableHeadersLine (string title1, string title2=string.Empty, string title3=string.Empty, string title4=string.Empty, string title5=string.Empty)
	Add a table line of header cells This method forbids empty headers and stops on the first encountered one.
void	AddTableHeader (string title, string style=string.Empty)
	This method allows an empty header.
void	AddTableDataCellsLine (notnull array< string > data)
	Add a table line of cells This method allows empty data cells.
void	AddTableDataCellsLine (string data1, string data2=string.Empty, string data3=string.Empty, string data4=string.Empty, string data5=string.Empty)
	Add a table line of cells This method forbids empty data cells and stops on the first encountered one.
void	AddTableDataCell (string datum, string style=string.Empty)
	This method allows an empty data cell.
void	AddHeaderAndDataCellsLine (string title, notnull array< string > data)
	Add a title header followed by provided data (horizontal, line)
void	EndTable ()
	Add the end of a previously opened table.
void	AddCategory (string catLv1=string.Empty, string catLv2=string.Empty, string catLv3=string.Empty, string catLv4=string.Empty, string catLv5=string.Empty)
	Add {{GameCategory|armaR}} wiki category directly after the current content (empty lines not managed)
string	GetContent ()
void	Clear ()
	Empty the String Builder's content.

Protected Attributes
string	m_sContent

Member Function Documentation

AddCategory()

void SCR_BIKIStringBuilder.AddCategory	(	string	catLv1 = string::Empty,
		string	catLv2 = string::Empty,
		string	catLv3 = string::Empty,
		string	catLv4 = string::Empty,
		string	catLv5 = string::Empty )

Add {{GameCategory|armaR}} wiki category directly after the current content (empty lines not managed)

Parameters

[in]	catLv1
[in]	catLv2
[in]	catLv3
[in]	catLv4
[in]	catLv5

AddHeaderAndDataCellsLine()

void SCR_BIKIStringBuilder.AddHeaderAndDataCellsLine	(	string	title,
		notnull array< string >	data )

Add a title header followed by provided data (horizontal, line)

See also

BeginTable()

EndTable()

Parameters

[in]	title
[in]	data

AddLine()

void SCR_BIKIStringBuilder.AddLine

(

string

line

)

Add text line that gets ended by a line return.

Parameters

[in]

line

AddTableDataCell()

void SCR_BIKIStringBuilder.AddTableDataCell	(	string	datum,
		string	style = string::Empty )

This method allows an empty data cell.

Parameters

[in]	datum
[in]	style	cell's CSS

AddTableDataCellsLine() [1/2]

void SCR_BIKIStringBuilder.AddTableDataCellsLine

(

notnull array< string >

data

)

Add a table line of cells This method allows empty data cells.

See also

BeginTable()

EndTable()

Parameters

[in]

data

AddTableDataCellsLine() [2/2]

void SCR_BIKIStringBuilder.AddTableDataCellsLine	(	string	data1,
		string	data2 = string::Empty,
		string	data3 = string::Empty,
		string	data4 = string::Empty,
		string	data5 = string::Empty )

Add a table line of cells This method forbids empty data cells and stops on the first encountered one.

See also

BeginTable()

EndTable()

Parameters

[in]	data1
[in]	data2
[in]	data3
[in]	data4
[in]	data5

AddTableHeader()

void SCR_BIKIStringBuilder.AddTableHeader	(	string	title,
		string	style = string::Empty )

This method allows an empty header.

Parameters

[in]	title
[in]	style

AddTableHeadersLine() [1/2]

void SCR_BIKIStringBuilder.AddTableHeadersLine

(

notnull array< string >

titles

)

This method allows empty headers.

Parameters

[in]

titles

list of titles to display on one line

AddTableHeadersLine() [2/2]

void SCR_BIKIStringBuilder.AddTableHeadersLine	(	string	title1,
		string	title2 = string::Empty,
		string	title3 = string::Empty,
		string	title4 = string::Empty,
		string	title5 = string::Empty )

Add a table line of header cells This method forbids empty headers and stops on the first encountered one.

See also

BeginTable()

EndTable()

AddTitle()

void SCR_BIKIStringBuilder.AddTitle	(	int	titleLevel,
		string	text )

Add a wiki title (e.g == title lv 2 ==)

Parameters

[in]	titleLevel	in range 1..6
[in]	text	can be empty (e.g == ==)

BeginTable()

void SCR_BIKIStringBuilder.BeginTable

(

string

style = string::Empty

)

Begin a wiki table.

See also

EndTable()

Parameters

[in]

style

Clear()

void SCR_BIKIStringBuilder.Clear

(

)

Empty the String Builder's content.

EndTable()

void SCR_BIKIStringBuilder.EndTable

(

)

Add the end of a previously opened table.

See also

BeginTable()

GetContent()

string SCR_BIKIStringBuilder.GetContent

(

)

Returns

the content so far

Member Data Documentation

m_sContent

string SCR_BIKIStringBuilder.m_sContent

protected

---

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

• WorkbenchGame/ResourceManager/BIKI/SCR_BIKIStringBuilder.c