spell_checker Class Reference

Inheritance diagram for spell_checker:

Public Member Functions
	spell_checker (&$wysiwyg)
	_add_button ($id, $cmd, $tooltip, $textmode, $position, $context='')
	paint_generic ()
	print_plugin_button_click ()
Public Member Functions inherited from wysiwyg_plugin
	WYSIWYG_Plugin (&$wysiwyg)
	_add_button ($id, $cmd, $tooltip, $textmode, $position, $context='')
	_open_menu ($id, $tooltip, $textmode, $position, $context='')
	_close_menu ($id)
	print_plugin_vars ()
	print_plugin_shortcuts ()
	print_plugin_create_select ()
	paint ()
	process (&$html)
	set_contents (&$contents)
	paint_generic ()
	print_plugin_button_click ()
	print_plugin_combo_selected ()
	print_plugin_exec_command ()
	print_plugin_update_toolbar ()
	print_plugin_button_type ()
	print_plugin_get_html ()
	print_plugin_pre_get_html ()
	print_plugin_form_submit ()
	print_plugin_event_handler ()
	get_popup_href ($filename, $classname='')

Static Public Member Functions
static	check_usable ()
Static Public Member Functions inherited from wysiwyg_plugin
static	check_usable ()

Additional Inherited Members
Data Fields inherited from wysiwyg_plugin
	$buttons = Array()
	$_show_in_toolbar = TRUE
	$wysiwyg = NULL

Detailed Description

Definition at line 32 of file spell_checker.inc.

Member Function Documentation

_add_button	(		$id,
			$cmd,
			$tooltip,
			$textmode,
			$position,
			$context = ''
	)

Adds a printable toolbar button to this plugin

Parameters

string	$id	A unique ID for this button
string	$cmd	The command to run when the button is clicked This command will be used to switch on action of a pressed button to determine the functionality
string	$tooltip	The tooltip for this button (appears on hover)
string	$textmode	Should this button be available in text mode? Value is either 'true' or 'false' (with quotes)
string	$position	The position of the button in the toolbar image This is zero indexed (first button is id zero)
string	$context	Enable this button if outside this element

Returns

void private

Definition at line 69 of file spell_checker.inc.

static check_usable ( )

static

Check whether this plugin is ready to be used.

Return a TRUE if ok or a error message.

Returns

mixed string|boolean public

Definition at line 161 of file spell_checker.inc.

paint_generic

(

)

Prints a generic insert image function that can be used by any editor A URL must be entered for the image you want to insert. Alt text must also be entered before the image will be inserted.

Returns

void public

Definition at line 92 of file spell_checker.inc.

print_plugin_button_click

(

)

Call the insert image function when the button is clicked

Returns

void public

Definition at line 140 of file spell_checker.inc.

spell_checker

(

&

$wysiwyg

)

Constructor Adds the spell check button to this plugin

public

Definition at line 42 of file spell_checker.inc.

---

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

• /Users/webmaster/Desktop/squiz_matrix/fudge/wysiwyg/plugins/spell_checker/spell_checker.inc