Moodle  2.2.1
http://www.collinsharper.com
texteditor Class Reference
Inheritance diagram for texteditor:

Public Member Functions

 supported_by_browser ()
 get_supported_formats ()
 get_preferred_format ()
 supports_repositories ()
 use_editor ($elementid, array $options=null, $fpoptions=null)
 head_setup ()

Detailed Description

Definition at line 198 of file editorlib.php.


Member Function Documentation

get_preferred_format ( ) [abstract]

Returns main preferred text format.

Returns:
int text format

Reimplemented in tinymce_texteditor, and textarea_texteditor.

get_supported_formats ( ) [abstract]

Returns list of supported text formats

Returns:
array Array (FORMAT=>FORMAT)

Reimplemented in tinymce_texteditor, and textarea_texteditor.

Setup all JS and CSS needed for editor.

Returns:
void

Reimplemented in tinymce_texteditor.

Definition at line 236 of file editorlib.php.

supported_by_browser ( ) [abstract]

Is editor supported in current browser?

Returns:
bool

Reimplemented in tinymce_texteditor, and textarea_texteditor.

supports_repositories ( ) [abstract]

Supports file picker and repos?

Returns:
object book object

Reimplemented in tinymce_texteditor, and textarea_texteditor.

use_editor ( elementid,
array options = null,
fpoptions = null 
) [abstract]

Add required JS needed for editor

Parameters:
string$elementidid of text area to be converted to editor
array$options
obejct$fpoptionsfile picker options
Returns:
void

Reimplemented in tinymce_texteditor, and textarea_texteditor.


The documentation for this class was generated from the following file:
 All Data Structures Namespaces Files Functions Variables Enumerations