Class virtual Custop.param


class virtual ['a] param : object .. end
What the user of this library must provide. 'a represents the type of the elements which can be defined by the code of the user.
Inherits
method virtual about : unit -> unit
This method should display a "About ..." window.
method virtual compare : 'a -> 'a -> int
This method will be used to compare two elements.
method display_box : display_box option
Return the optional display box. Default is None.
method virtual display_elt : ('a -> unit) option
This method will be called to display the selected element. It should be Some ... if there is a display box.
method virtual elts_columns : (string * ('a -> string)) list
This method returns a description of the columns to display in the list of elements, and for each column a function to get a string from an element.
method virtual execute : string -> string * ('a * int) list
This method is called to execute the user's code. It returns the output (result) string and for each defined element a pair (element, position of first character).
method virtual ini_file : string
This method returns the absolute name of the file to use to store options.
method virtual sourceview_language : string
This method returns the mime type of the sourceview language to use for syntax highlighting.
method virtual window_title_prefix : string
This method returns the prefix string to use in the window title.

Methods returning strings used in interface

These can be overriden.
method s_color_error_background : string
method s_color_output : string
method s_color_user_code : string
method s_configuration : string
method s_display_frame_width : string
method s_elements_frame_width : string
method s_error : string
method s_font_code : string
method s_load_file : string
method s_output_frame_height : string
method s_save : string