pandemonium_engine/modules/web/doc_classes/MarkdownRendererCustomRendererCallback.xml

201 lines
9.1 KiB
XML
Raw Normal View History

2024-04-26 17:32:25 +02:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="MarkdownRendererCustomRendererCallback" inherits="Reference" version="4.4">
<brief_description>
2024-04-26 18:20:41 +02:00
Helper class used by [MarkdownRenderer].
2024-04-26 17:32:25 +02:00
</brief_description>
<description>
2024-04-26 18:20:41 +02:00
Helper class used by [MarkdownRenderer].
2024-04-26 17:32:25 +02:00
</description>
<tutorials>
</tutorials>
<methods>
</methods>
<members>
<member name="alt" type="String" setter="set_alt" getter="get_alt" default="&quot;&quot;">
2024-04-26 18:20:41 +02:00
Alt text.
2024-04-26 17:32:25 +02:00
</member>
<member name="auto_link_type" type="int" setter="set_auto_link_type" getter="get_auto_link_type" enum="MarkdownRendererCustomRendererCallback.AutolinkType" default="0">
2024-04-26 18:20:41 +02:00
Auto link type.
2024-04-26 17:32:25 +02:00
</member>
<member name="callback_type" type="int" setter="set_callback_type" getter="get_callback_type" enum="MarkdownRendererCustomRendererCallback.CallbackType" default="0">
2024-04-26 18:20:41 +02:00
Callback type.
2024-04-26 17:32:25 +02:00
</member>
<member name="content" type="String" setter="set_content" getter="get_content" default="&quot;&quot;">
2024-04-26 18:20:41 +02:00
Content.
2024-04-26 17:32:25 +02:00
</member>
<member name="display_mode" type="int" setter="set_display_mode" getter="get_display_mode" default="0">
2024-04-26 18:20:41 +02:00
Display mode.
2024-04-26 17:32:25 +02:00
</member>
<member name="inline_render" type="int" setter="set_inline_render" getter="get_inline_render" default="0">
2024-04-26 18:20:41 +02:00
Inline render.
2024-04-26 17:32:25 +02:00
</member>
<member name="lang" type="String" setter="set_lang" getter="get_lang" default="&quot;&quot;">
2024-04-26 18:20:41 +02:00
Lang.
2024-04-26 17:32:25 +02:00
</member>
<member name="level" type="int" setter="set_level" getter="get_level" default="0">
2024-04-26 18:20:41 +02:00
Lebel.
2024-04-26 17:32:25 +02:00
</member>
<member name="link" type="String" setter="set_link" getter="get_link" default="&quot;&quot;">
2024-04-26 18:20:41 +02:00
Link.
2024-04-26 17:32:25 +02:00
</member>
<member name="list_flags" type="int" setter="set_list_flags" getter="get_list_flags" default="0">
2024-04-26 18:20:41 +02:00
List Flags.
2024-04-26 17:32:25 +02:00
</member>
<member name="num" type="int" setter="set_num" getter="get_num" default="0">
2024-04-26 18:20:41 +02:00
Num.
2024-04-26 17:32:25 +02:00
</member>
<member name="result" type="String" setter="set_result" getter="get_result" default="&quot;&quot;">
2024-04-26 18:20:41 +02:00
Set this to send the renderer the resulting text.
2024-04-26 17:32:25 +02:00
</member>
<member name="result_code" type="int" setter="set_result_code" getter="get_result_code" default="1">
2024-04-26 18:20:41 +02:00
Result code. Some of the [member callback_type]s use it.
2024-04-26 17:32:25 +02:00
</member>
<member name="table_flags" type="int" setter="set_table_flags" getter="get_table_flags" default="0">
2024-04-26 18:20:41 +02:00
Table flags.
2024-04-26 17:32:25 +02:00
</member>
<member name="text" type="String" setter="set_text" getter="get_text" default="&quot;&quot;">
2024-04-26 18:20:41 +02:00
Text.
2024-04-26 17:32:25 +02:00
</member>
<member name="title" type="String" setter="set_title" getter="get_title" default="&quot;&quot;">
2024-04-26 18:20:41 +02:00
Title.
2024-04-26 17:32:25 +02:00
</member>
</members>
<constants>
<constant name="CALLBACK_BLOCKCODE" value="0" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Blockcode callback. Sets [member text], [member lang].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_BLOCKQUOTE" value="1" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Blockquote callback. Sets [member content].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_HEADER" value="2" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Header callback. Sets [member content], [member level].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_HRULE" value="3" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Hrule callback. No properties.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_LIST" value="4" enum="CallbackType">
2024-04-26 18:20:41 +02:00
List callback. Sets [member content], [member flags].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_LISTITEM" value="5" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Listitem callback. Sets [member content], [member flags].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_PARAGRAPH" value="6" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Paragraph callback. Sets [member content].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_TABLE" value="7" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Table callback. Sets [member content].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_TABLE_HEADER" value="8" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Table Header callback. Sets [member content].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_TABLE_BODY" value="9" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Table Body callback. Sets [member content].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_TABLE_ROW" value="10" enum="CallbackType">
2024-04-26 18:20:41 +02:00
table_row callback. Sets [member content].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_TABLE_CELL" value="11" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Table Cell callback. Sets [member content], [member flags].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_FOOTNOTES" value="12" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Footnotes callback. Sets [member content].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_FOOTNOTE_DEF" value="13" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Footnote Def callback. Sets [member content], [member num].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_BLOCKHTML" value="14" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Blockhtml callback. Sets [member text].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_AUTOLINK" value="15" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Autolink callback. Sets [member link], [member type]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_CODESPAN" value="16" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Codespan callback. Sets [member text]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_DOUBLE_EMPHASIS" value="17" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Double Emphasis callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_EMPHASIS" value="18" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Emphasis callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_UNDERLINE" value="19" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Underline callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_HIGHLIGHT" value="20" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Highlight callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_QUOTE" value="21" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Quote callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_IMAGE" value="22" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Image callback. Sets [member link], [member title], [member alt]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_LINEBREAK" value="23" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Linebreak callback. No properties. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_LINK" value="24" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Link callback. Sets [member content], [member link], [member title]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_TRIPLE_EMPHASIS" value="25" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Triple Emphasis callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_STRIKETHROUGH" value="26" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Strikethrough callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_SUPERSCRIPT" value="27" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Superscript callback. Sets [member content]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_FOOTNOTE_REF" value="28" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Footnote Ref callback. Sets [member num]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_MATH" value="29" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Math callback. Sets [member text], [member displaymode]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_RAW_HTML" value="30" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Raw html callback. Sets [member text]. Uses [member result_code]. If set to 0 just copies input to output.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_ENTITY" value="31" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Entity callback. Sets [member text].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_NORMAL_TEXT" value="32" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Normal Text callback. Sets [member text].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_DOC_HEADER" value="33" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Doc Header callback. Sets [member inline_render].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="CALLBACK_DOC_FOOTER" value="34" enum="CallbackType">
2024-04-26 18:20:41 +02:00
Doc Footer callback. Sets [member inline_render].
2024-04-26 17:32:25 +02:00
</constant>
<constant name="LIST_FLAG_ORDERED" value="1" enum="ListFlags">
2024-04-26 18:20:41 +02:00
Ordered list.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="LIST_FLAG_LI_BLOCK" value="2" enum="ListFlags">
2024-04-26 18:20:41 +02:00
li block.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="TABLE_FLAG_ALIGN_LEFT" value="1" enum="TableFlags">
2024-04-26 18:20:41 +02:00
Left algin.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="TABLE_FLAG_ALIGN_RIGHT" value="2" enum="TableFlags">
2024-04-26 18:20:41 +02:00
Right align.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="TABLE_FLAG_ALIGN_CENTER" value="3" enum="TableFlags">
2024-04-26 18:20:41 +02:00
Center align.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="TABLE_FLAG_ALIGNMASK" value="3" enum="TableFlags">
2024-04-26 18:20:41 +02:00
Align mask.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="TABLE_FLAG_HEADER" value="4" enum="TableFlags">
2024-04-26 18:20:41 +02:00
Header flag.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="AUTOLINK_TYPE_NONE" value="0" enum="AutolinkType">
2024-04-26 18:20:41 +02:00
No autolink.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="AUTOLINK_TYPE_NORMAL" value="1" enum="AutolinkType">
2024-04-26 18:20:41 +02:00
Normal autolink.
2024-04-26 17:32:25 +02:00
</constant>
<constant name="AUTOLINK_TYPE_EMAIL" value="2" enum="AutolinkType">
2024-04-26 18:20:41 +02:00
Email autolink.
2024-04-26 17:32:25 +02:00
</constant>
</constants>
</class>