MarkdownEditor Class Reference

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. 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.

Definition at line 45 of file MarkdownEditor.h.

Constructor & Destructor Documentation

◆ MarkdownEditor()

MarkdownEditor ( QWidget *  parent = 0)
explicit

Definition at line 36 of file MarkdownEditor.cpp.

+ Here is the call graph for this function:

◆ ~MarkdownEditor()

~MarkdownEditor ( )
override

Definition at line 48 of file MarkdownEditor.cpp.

Member Function Documentation

◆ openSyntaxUrl

void openSyntaxUrl ( )
slot

Definition at line 115 of file MarkdownEditor.cpp.

+ Here is the caller graph for this function:

◆ setPlainText()

void setPlainText ( const QString &  plainText)

Definition at line 65 of file MarkdownEditor.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ showMarkdown

void showMarkdown ( const QString &  rawString = "")
slot

Definition at line 79 of file MarkdownEditor.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ textChanged

void textChanged ( )
signal
+ Here is the caller graph for this function:

◆ toggleEditor

void toggleEditor ( bool  toggled)
slot

Definition at line 97 of file MarkdownEditor.cpp.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ toPlainText()

QString toPlainText ( ) const

Definition at line 53 of file MarkdownEditor.cpp.

+ Here is the caller graph for this function:

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