Interface for plugins implementing a text editor component. More...

#include "itexteditor.h"

Public Member Functions
virtual	~ITextEditor ()

virtual bool	SupportsEditor (LC::ContentType type) const =0
	Whether this editor plugin supports editing the content type. More...

virtual QWidget *	GetTextEditor (LC::ContentType type)=0
	Creates and returns a new text editor for the given type. More...

Detailed Description

Interface for plugins implementing a text editor component.

If a plugin can provide a text editor widget for other plugins to use it should implement this interface.

For example, plugins like a blog client (Blogique) or mail client (Snails) would use such editor widget to allow the user to write posts or mails.

Definition at line 198 of file itexteditor.h.

Constructor & Destructor Documentation

◆ ~ITextEditor()

virtual ITextEditor::~ITextEditor ( )

inlinevirtual

Definition at line 201 of file itexteditor.h.

Member Function Documentation

◆ GetTextEditor()

virtual QWidget* ITextEditor::GetTextEditor ( LC::ContentType type )

pure virtual

Creates and returns a new text editor for the given type.

This function should create a new text editor widget implementing IEditorWidget for the given content type. If creation fails for some reason (like unsupported type) this function should return 0.

It is generally OK to return a WYSIWYG-enabled editor for the ContentType::PlainText type as long as it supports editing plain text.

Parameters

[in] type The content type for which to create the editor.

Returns: An editor widget implementing IEditorWidget or nullptr in case of failure.

◆ SupportsEditor()

virtual bool ITextEditor::SupportsEditor ( LC::ContentType type ) const

pure virtual

Whether this editor plugin supports editing the content type.

Plain text editors should return true only for the ContentType::PlainText type, while WYSIWYG-enabled editors should return true for ContentType::HTML as well.