MarkdownEditor Class Reference

The MarkdownEditor is a widget that provides editing of raw text and viewing of processed markdown text to html. More...

#include <ArmarXGui/libraries/ArmarXGuiBase/widgets/MarkdownEditor.h>

Inheritance diagram for MarkdownEditor:

Public Slots
void	openSyntaxUrl ()
void	showMarkdown (const QString &rawString="")
void	toggleEditor (bool toggled)

Signals
void	textChanged ()

Public Member Functions
	MarkdownEditor (QWidget *parent=0)
void	setPlainText (const QString &plainText)
QString	toPlainText () const
	~MarkdownEditor () override

Detailed Description

The MarkdownEditor is a widget that provides editing of raw text and viewing of processed markdown text to html.

The widget has a view mode (default and read only) which displays to html converted markdown text like a internet browser and an edit mode that show the raw markdown text, which can be edited. The mode can be toggled with the Edit button. Raw markdown text can be inserted with the the setPlainText() function and retrieved with the toPlainText() function.

Constructor & Destructor Documentation

MarkdownEditor()

MarkdownEditor ( QWidget * parent = 0 )

explicit

~MarkdownEditor()

~MarkdownEditor ( )

override

Member Function Documentation

openSyntaxUrl

void openSyntaxUrl ( )

slot

setPlainText()

void setPlainText

(

const QString &

plainText

)

showMarkdown

void showMarkdown ( const QString & rawString = "" )

slot

textChanged

void textChanged ( )

signal

toggleEditor

void toggleEditor ( bool toggled )

slot

toPlainText()

QString toPlainText

(

)

const

---

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

• ArmarXGui/libraries/ArmarXGuiBase/widgets/MarkdownEditor.h
• ArmarXGui/libraries/ArmarXGuiBase/widgets/MarkdownEditor.cpp