DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== TOOLBAR_DEFINE ======

---- dataentry event ----
Description:    Add buttons to the toolbar
DefaultAction:  None
Preventable:    yes
Added_dt:       2007-02-27
----

The event is signalled in [[xref>toolbar_JSdefines()]] in [[xref>inc/toolbar.php]] before and after the standard toolbar is being filled. You can use this event for adding additional buttons to the toolbar.

===== Passed Data =====

$data contains an array of already defined toolbar buttons. Each element of the array may contain keys such as:
  * ''type'' --- Type of action, see below.

All types use:
  * ''title'' --- Hover text
  * ''icon'' --- Image for the button
  * ''key'' --- The shortcut key is the platform equivalent of ALT, plus this letter

''format'' types use:
  * ''open'' --- Text to place before cursor/selection
  * ''close'' --- Text to place after cursor/selection
  * ''sample'' --- ??

''insert'' types use:
  * ''insert'' --- Text to insert

''mediapopup'' types use:
  * ''url'' --- Popup URL
  * ''name'' --- Popup window name?
  * ''options'' --- Added to URL?

''picker'' types use:
  * ''list'' --- function with options
  * ''icobase'' --- ??

''signature'' types use:
  * No others?

The array is coverted to JSON, and passed to ''/lib/scripts/edit.js''

===== Plugins handling this event =====

The following plugins are known to handle this event and their source code may be a good start for understanding and implementing a handler yourself.

* [[plugin:bahnde]], [[plugin:blockquote]], [[plugin:colorpicker]], [[plugin:creole]], [[plugin:itrackviewer]], [[plugin:jalbum]], [[plugin:keyboard]], [[plugin:snippets]], [[plugin:underconstruction]], [[plugin:custombuttons]]

===== See also =====

* [[devel:Action Plugins]]
  * [[devel:Events]]
  * [[devel:Toolbar]]

Please fill all the letters into the box to prove you're human. S H P S U Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International