Skip to content
This repository
tag: v612
Fetching contributors…

Cannot retrieve contributors at this time

file 105 lines (87 sloc) 2.543 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105
/*
Copyright © 2011 MLstate

This file is part of OPA.

OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.

OPA is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.

You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*/

package opace

/**
* {1 About this module}
* Ace editor is a standalone code editor written in JavaScript. This
* module provides a binding to this client code editor.
*
* {1 Where should I start?}
* You should start by define an editable zone like that :
* [<div id="myzone">This is an editable zone</div>]
* Then you can use [Ace.edit("myzone")] this function replace the dom
* node with id "myzone" by an Ace editor.
* Finally you can access to Ace properties ('Set & Get Ace editor
* properties') and do some action on your Ace editor ('Action on Ace
* editor').
*/

/**
* {1 Types defined in this module}.
*/
/**
* Type of an Ace editor.
*/
type Ace.t = external

Ace = {{

  /**
* {1 Initialization}
*/
  /**
* [edit(id)] Create an ACE editor which edit element with the given
* [id].
*/
  edit(id) = (%%plugin_ace.edit%%)(id)

  /**
* {1 Set & Get Ace editor properties}
*/
  /**
* [set_mode(ace, mode)] Load [mode] for the given [ace]
* editor. List of mode are defined on ace plugin. If the mode
* doesn't exists returns [false].
*/
  set_mode(ace:Ace.t, mode:string) =
    (%%plugin_ace.set_mode%%)(ace, mode)

  /**
* Get content of ACE editor.
*/
  get_content = %%plugin_ace.get_content%%

  /**
* Set content of ACE editor.
*/
  set_content = %%plugin_ace.set_content%%

  /**
* Add an event handler.
*/
  add_event_listener(ace : Ace.t, kind : Dom.event.kind, action : -> void) =
    (%%plugin_ace.add_event_listener%%)(ace, Dom.Event.get_name(kind), action)

  /**
* {1 Action on Ace editor}
*/
  /**
* Undo the last action.
*/
  undo = %%plugin_ace.undo%%

  /**
* Redo the last action.
*/
  redo = %%plugin_ace.redo%%

  /**
* Set editor as read only
*/
  read_only = %%plugin_ace.read_only%%

  /**
* Set cursor position.
*/
  move_cursor = %%plugin_ace.move_cursor%%

}}
Something went wrong with that request. Please try again.